aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/icu/include/unicode/rbbi.h
diff options
context:
space:
mode:
authormcheshkov <mcheshkov@yandex-team.ru>2022-02-10 16:46:16 +0300
committerDaniil Cherednik <dcherednik@yandex-team.ru>2022-02-10 16:46:16 +0300
commit1312621288956f199a5bd5342b0133d4395fa725 (patch)
tree1a2c5ffcf89eb53ecd79dbc9bc0a195c27404d0c /contrib/libs/icu/include/unicode/rbbi.h
parente9d19cec64684c9c1e6b0c98297e5b895cf904fe (diff)
downloadydb-1312621288956f199a5bd5342b0133d4395fa725.tar.gz
Restoring authorship annotation for <mcheshkov@yandex-team.ru>. Commit 2 of 2.
Diffstat (limited to 'contrib/libs/icu/include/unicode/rbbi.h')
-rw-r--r--contrib/libs/icu/include/unicode/rbbi.h250
1 files changed, 125 insertions, 125 deletions
diff --git a/contrib/libs/icu/include/unicode/rbbi.h b/contrib/libs/icu/include/unicode/rbbi.h
index e35b98f9a0..7825f603a5 100644
--- a/contrib/libs/icu/include/unicode/rbbi.h
+++ b/contrib/libs/icu/include/unicode/rbbi.h
@@ -1,4 +1,4 @@
-// © 2016 and later: Unicode, Inc. and others.
+// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
***************************************************************************
@@ -18,8 +18,8 @@
#include "unicode/utypes.h"
-#if U_SHOW_CPLUSPLUS_API
-
+#if U_SHOW_CPLUSPLUS_API
+
/**
* \file
* \brief C++ API: Rule Based Break Iterator
@@ -35,10 +35,10 @@
U_NAMESPACE_BEGIN
/** @internal */
-class LanguageBreakEngine;
+class LanguageBreakEngine;
struct RBBIDataHeader;
class RBBIDataWrapper;
-class UnhandledEngine;
+class UnhandledEngine;
class UStack;
/**
@@ -57,51 +57,51 @@ class U_COMMON_API RuleBasedBreakIterator /*U_FINAL*/ : public BreakIterator {
private:
/**
* The UText through which this BreakIterator accesses the text
- * @internal (private)
+ * @internal (private)
*/
- UText fText;
+ UText fText;
-#ifndef U_HIDE_INTERNAL_API
-public:
-#endif /* U_HIDE_INTERNAL_API */
+#ifndef U_HIDE_INTERNAL_API
+public:
+#endif /* U_HIDE_INTERNAL_API */
/**
- * The rule data for this BreakIterator instance.
- * Not for general use; Public only for testing purposes.
+ * The rule data for this BreakIterator instance.
+ * Not for general use; Public only for testing purposes.
* @internal
*/
RBBIDataWrapper *fData;
-private:
+private:
/**
- * The current position of the iterator. Pinned, 0 < fPosition <= text.length.
- * Never has the value UBRK_DONE (-1).
- */
- int32_t fPosition;
+ * The current position of the iterator. Pinned, 0 < fPosition <= text.length.
+ * Never has the value UBRK_DONE (-1).
+ */
+ int32_t fPosition;
/**
- * TODO:
- */
- int32_t fRuleStatusIndex;
+ * TODO:
+ */
+ int32_t fRuleStatusIndex;
/**
- * Cache of previously determined boundary positions.
+ * Cache of previously determined boundary positions.
*/
- class BreakCache;
- BreakCache *fBreakCache;
+ class BreakCache;
+ BreakCache *fBreakCache;
/**
- * Cache of boundary positions within a region of text that has been
- * sub-divided by dictionary based breaking.
+ * Cache of boundary positions within a region of text that has been
+ * sub-divided by dictionary based breaking.
*/
- class DictionaryCache;
- DictionaryCache *fDictionaryCache;
+ class DictionaryCache;
+ DictionaryCache *fDictionaryCache;
/**
*
* If present, UStack of LanguageBreakEngine objects that might handle
* dictionary characters. Searched from top to bottom to find an object to
* handle a given character.
- * @internal (private)
+ * @internal (private)
*/
UStack *fLanguageBreakEngines;
@@ -109,37 +109,37 @@ private:
*
* If present, the special LanguageBreakEngine used for handling
* characters that are in the dictionary set, but not handled by any
- * LanguageBreakEngine.
- * @internal (private)
+ * LanguageBreakEngine.
+ * @internal (private)
*/
UnhandledEngine *fUnhandledBreakEngine;
/**
- * Counter for the number of characters encountered with the "dictionary"
- * flag set.
- * @internal (private)
- */
- uint32_t fDictionaryCharCount;
-
- /**
- * A character iterator that refers to the same text as the UText, above.
- * Only included for compatibility with old API, which was based on CharacterIterators.
- * Value may be adopted from outside, or one of fSCharIter or fDCharIter, below.
- */
- CharacterIterator *fCharIter;
-
- /**
- * When the input text is provided by a UnicodeString, this will point to
- * a characterIterator that wraps that data. Needed only for the
- * implementation of getText(), a backwards compatibility issue.
- */
- StringCharacterIterator fSCharIter;
-
- /**
- * True when iteration has run off the end, and iterator functions should return UBRK_DONE.
- */
- UBool fDone;
-
+ * Counter for the number of characters encountered with the "dictionary"
+ * flag set.
+ * @internal (private)
+ */
+ uint32_t fDictionaryCharCount;
+
+ /**
+ * A character iterator that refers to the same text as the UText, above.
+ * Only included for compatibility with old API, which was based on CharacterIterators.
+ * Value may be adopted from outside, or one of fSCharIter or fDCharIter, below.
+ */
+ CharacterIterator *fCharIter;
+
+ /**
+ * When the input text is provided by a UnicodeString, this will point to
+ * a characterIterator that wraps that data. Needed only for the
+ * implementation of getText(), a backwards compatibility issue.
+ */
+ StringCharacterIterator fSCharIter;
+
+ /**
+ * True when iteration has run off the end, and iterator functions should return UBRK_DONE.
+ */
+ UBool fDone;
+
//=======================================================================
// constructors
//=======================================================================
@@ -152,11 +152,11 @@ private:
*
* The break iterator adopts the memory, and will
* free it when done.
- * @internal (private)
+ * @internal (private)
*/
RuleBasedBreakIterator(RBBIDataHeader* data, UErrorCode &status);
- /** @internal */
+ /** @internal */
friend class RBBIRuleBuilder;
/** @internal */
friend class BreakIterator;
@@ -190,17 +190,17 @@ public:
UErrorCode &status);
/**
- * Construct a RuleBasedBreakIterator from a set of precompiled binary rules.
+ * Construct a RuleBasedBreakIterator from a set of precompiled binary rules.
* Binary rules are obtained from RulesBasedBreakIterator::getBinaryRules().
* Construction of a break iterator in this way is substantially faster than
- * construction from source rules.
+ * construction from source rules.
*
* Ownership of the storage containing the compiled rules remains with the
* caller of this function. The compiled rules must not be modified or
* deleted during the life of the break iterator.
*
* The compiled rules are not compatible across different major versions of ICU.
- * The compiled rules are compatible only between machines with the same
+ * The compiled rules are compatible only between machines with the same
* byte ordering (little or big endian) and the same base character set family
* (ASCII or EBCDIC).
*
@@ -262,19 +262,19 @@ public:
* @return TRUE if both BreakIterators are not same.
* @stable ICU 2.0
*/
- inline UBool operator!=(const BreakIterator& that) const;
+ inline UBool operator!=(const BreakIterator& that) const;
/**
* Returns a newly-constructed RuleBasedBreakIterator with the same
* behavior, and iterating over the same text, as this one.
* Differs from the copy constructor in that it is polymorphic, and
* will correctly clone (copy) a derived class.
- * clone() is thread safe. Multiple threads may simultaneously
+ * clone() is thread safe. Multiple threads may simultaneously
* clone the same source break iterator.
* @return a newly-constructed RuleBasedBreakIterator
* @stable ICU 2.0
*/
- virtual RuleBasedBreakIterator* clone() const;
+ virtual RuleBasedBreakIterator* clone() const;
/**
* Compute a hash code for this BreakIterator
@@ -434,7 +434,7 @@ public:
virtual int32_t preceding(int32_t offset);
/**
- * Returns true if the specified position is a boundary position. As a side
+ * Returns true if the specified position is a boundary position. As a side
* effect, leaves the iterator pointing to the first boundary position at
* or after "offset".
* @param offset the offset to check.
@@ -444,10 +444,10 @@ public:
virtual UBool isBoundary(int32_t offset);
/**
- * Returns the current iteration position. Note that UBRK_DONE is never
- * returned from this function; if iteration has run to the end of a
- * string, current() will return the length of the string while
- * next() will return UBRK_DONE).
+ * Returns the current iteration position. Note that UBRK_DONE is never
+ * returned from this function; if iteration has run to the end of a
+ * string, current() will return the length of the string while
+ * next() will return UBRK_DONE).
* @return The current iteration position.
* @stable ICU 2.0
*/
@@ -455,8 +455,8 @@ public:
/**
- * Return the status tag from the break rule that determined the boundary at
- * the current iteration position. For break rules that do not specify a
+ * Return the status tag from the break rule that determined the boundary at
+ * the current iteration position. For break rules that do not specify a
* status, a default value of 0 is returned. If more than one break rule
* would cause a boundary to be located at some position in the text,
* the numerically largest of the applicable status values is returned.
@@ -473,14 +473,14 @@ public:
* position from <code>next()</code>, <code>previous()</code>, or
* any other break iterator functions that returns a boundary position.
* <p>
- * Note that <code>getRuleStatus()</code> returns the value corresponding to
- * <code>current()</code> index even after <code>next()</code> has returned DONE.
- * <p>
+ * Note that <code>getRuleStatus()</code> returns the value corresponding to
+ * <code>current()</code> index even after <code>next()</code> has returned DONE.
+ * <p>
* When creating custom break rules, one is free to define whatever
* status values may be convenient for the application.
* <p>
- * @return the status from the break rule that determined the boundary
- * at the current iteration position.
+ * @return the status from the break rule that determined the boundary
+ * at the current iteration position.
*
* @see UWordBreak
* @stable ICU 2.2
@@ -488,8 +488,8 @@ public:
virtual int32_t getRuleStatus() const;
/**
- * Get the status (tag) values from the break rule(s) that determined the boundary
- * at the current iteration position.
+ * Get the status (tag) values from the break rule(s) that determined the boundary
+ * at the current iteration position.
* <p>
* The returned status value(s) are stored into an array provided by the caller.
* The values are stored in sorted (ascending) order.
@@ -500,10 +500,10 @@ public:
* @param fillInVec an array to be filled in with the status values.
* @param capacity the length of the supplied vector. A length of zero causes
* the function to return the number of status values, in the
- * normal way, without attempting to store any values.
+ * normal way, without attempting to store any values.
* @param status receives error codes.
- * @return The number of rule status values from the rules that determined
- * the boundary at the current iteration position.
+ * @return The number of rule status values from the rules that determined
+ * the boundary at the current iteration position.
* In the event of a U_BUFFER_OVERFLOW_ERROR, the return value
* is the total number of status values that were available,
* not the reduced number that were actually returned.
@@ -538,13 +538,13 @@ public:
*/
static UClassID U_EXPORT2 getStaticClassID(void);
-#ifndef U_FORCE_HIDE_DEPRECATED_API
+#ifndef U_FORCE_HIDE_DEPRECATED_API
/**
* Deprecated functionality. Use clone() instead.
*
* Create a clone (copy) of this break iterator in memory provided
* by the caller. The idea is to increase performance by avoiding
- * a storage allocation. Use of this function is NOT RECOMMENDED.
+ * a storage allocation. Use of this function is NOT RECOMMENDED.
* Performance gains are minimal, and correct buffer management is
* tricky. Use clone() instead.
*
@@ -557,7 +557,7 @@ public:
* storage for the cloned object.
*
* @param status Error status. U_SAFECLONE_ALLOCATED_WARNING will be
- * returned if the provided buffer was too small, and
+ * returned if the provided buffer was too small, and
* the clone was therefore put on the heap.
*
* @return Pointer to the clone object. This may differ from the stackBuffer
@@ -565,10 +565,10 @@ public:
* or if the stackBuffer was too small to hold the clone.
* @deprecated ICU 52. Use clone() instead.
*/
- virtual RuleBasedBreakIterator *createBufferClone(void *stackBuffer,
- int32_t &BufferSize,
- UErrorCode &status);
-#endif // U_FORCE_HIDE_DEPRECATED_API
+ virtual RuleBasedBreakIterator *createBufferClone(void *stackBuffer,
+ int32_t &BufferSize,
+ UErrorCode &status);
+#endif // U_FORCE_HIDE_DEPRECATED_API
/**
* Return the binary form of compiled break rules,
@@ -580,7 +580,7 @@ public:
* The binary data can only be used with the same version of ICU
* and on the same platform type (processor endian-ness)
*
- * @param length Returns the length of the binary data. (Out parameter.)
+ * @param length Returns the length of the binary data. (Out parameter.)
*
* @return A pointer to the binary (compiled) rule data. The storage
* belongs to the RulesBasedBreakIterator object, not the
@@ -624,65 +624,65 @@ private:
/**
* Dumps caches and performs other actions associated with a complete change
* in text or iteration position.
- * @internal (private)
+ * @internal (private)
*/
void reset(void);
/**
* Common initialization function, used by constructors and bufferClone.
- * @internal (private)
+ * @internal (private)
*/
- void init(UErrorCode &status);
+ void init(UErrorCode &status);
/**
- * Iterate backwards from an arbitrary position in the input text using the
- * synthesized Safe Reverse rules.
- * This locates a "Safe Position" from which the forward break rules
- * will operate correctly. A Safe Position is not necessarily a boundary itself.
- *
- * @param fromPosition the position in the input text to begin the iteration.
- * @internal (private)
+ * Iterate backwards from an arbitrary position in the input text using the
+ * synthesized Safe Reverse rules.
+ * This locates a "Safe Position" from which the forward break rules
+ * will operate correctly. A Safe Position is not necessarily a boundary itself.
+ *
+ * @param fromPosition the position in the input text to begin the iteration.
+ * @internal (private)
*/
- int32_t handleSafePrevious(int32_t fromPosition);
+ int32_t handleSafePrevious(int32_t fromPosition);
/**
- * Find a rule-based boundary by running the state machine.
- * Input
- * fPosition, the position in the text to begin from.
- * Output
- * fPosition: the boundary following the starting position.
- * fDictionaryCharCount the number of dictionary characters encountered.
- * If > 0, the segment will be further subdivided
- * fRuleStatusIndex Info from the state table indicating which rules caused the boundary.
- *
- * @internal (private)
+ * Find a rule-based boundary by running the state machine.
+ * Input
+ * fPosition, the position in the text to begin from.
+ * Output
+ * fPosition: the boundary following the starting position.
+ * fDictionaryCharCount the number of dictionary characters encountered.
+ * If > 0, the segment will be further subdivided
+ * fRuleStatusIndex Info from the state table indicating which rules caused the boundary.
+ *
+ * @internal (private)
*/
- int32_t handleNext();
+ int32_t handleNext();
/**
* This function returns the appropriate LanguageBreakEngine for a
* given character c.
* @param c A character in the dictionary set
- * @internal (private)
+ * @internal (private)
*/
const LanguageBreakEngine *getLanguageBreakEngine(UChar32 c);
- public:
-#ifndef U_HIDE_INTERNAL_API
+ public:
+#ifndef U_HIDE_INTERNAL_API
+ /**
+ * Debugging function only.
+ * @internal
+ */
+ void dumpCache();
+
/**
- * Debugging function only.
- * @internal
+ * Debugging function only.
+ * @internal
*/
- void dumpCache();
+ void dumpTables();
- /**
- * Debugging function only.
- * @internal
- */
- void dumpTables();
-
-#endif /* U_HIDE_INTERNAL_API */
+#endif /* U_HIDE_INTERNAL_API */
};
//------------------------------------------------------------------------------
@@ -699,6 +699,6 @@ U_NAMESPACE_END
#endif /* #if !UCONFIG_NO_BREAK_ITERATION */
-#endif /* U_SHOW_CPLUSPLUS_API */
-
+#endif /* U_SHOW_CPLUSPLUS_API */
+
#endif