Public Member Functions |
| RuleBasedBreakIterator () |
| Default constructor.
|
| RuleBasedBreakIterator (const RuleBasedBreakIterator &that) |
| Copy constructor.
|
| RuleBasedBreakIterator (const UnicodeString &rules, UParseError &parseError, UErrorCode &status) |
| Construct a RuleBasedBreakIterator from a set of rules supplied as a string.
|
| RuleBasedBreakIterator (const uint8_t *compiledRules, uint32_t ruleLength, UErrorCode &status) |
| Contruct a RuleBasedBreakIterator from a set of precompiled binary rules.
|
| RuleBasedBreakIterator (UDataMemory *image, UErrorCode &status) |
| This constructor uses the udata interface to create a BreakIterator whose internal tables live in a memory-mapped file.
|
virtual | ~RuleBasedBreakIterator () |
| Destructor.
|
RuleBasedBreakIterator & | operator= (const RuleBasedBreakIterator &that) |
| Assignment operator.
|
virtual UBool | operator== (const BreakIterator &that) const |
| Equality operator.
|
UBool | operator!= (const BreakIterator &that) const |
| Not-equal operator.
|
virtual BreakIterator * | clone () const |
| Returns a newly-constructed RuleBasedBreakIterator with the same behavior, and iterating over the same text, as this one.
|
virtual int32_t | hashCode (void) const |
| Compute a hash code for this BreakIterator.
|
virtual const UnicodeString & | getRules (void) const |
| Returns the description used to create this iterator.
|
virtual CharacterIterator & | getText (void) const |
virtual UText * | getUText (UText *fillIn, UErrorCode &status) const |
| Get a UText for the text being analyzed.
|
virtual void | adoptText (CharacterIterator *newText) |
| Set the iterator to analyze a new piece of text.
|
virtual void | setText (const UnicodeString &newText) |
| Set the iterator to analyze a new piece of text.
|
virtual void | setText (UText *text, UErrorCode &status) |
| Reset the break iterator to operate over the text represented by the UText.
|
virtual int32_t | first (void) |
| Sets the current iteration position to the beginning of the text.
|
virtual int32_t | last (void) |
| Sets the current iteration position to the end of the text.
|
virtual int32_t | next (int32_t n) |
| Advances the iterator either forward or backward the specified number of steps.
|
virtual int32_t | next (void) |
| Advances the iterator to the next boundary position.
|
virtual int32_t | previous (void) |
| Moves the iterator backwards, to the last boundary preceding this one.
|
virtual int32_t | following (int32_t offset) |
| Sets the iterator to refer to the first boundary position following the specified position.
|
virtual int32_t | preceding (int32_t offset) |
| Sets the iterator to refer to the last boundary position before the specified position.
|
virtual UBool | isBoundary (int32_t offset) |
| Returns true if the specfied position is a boundary position.
|
virtual int32_t | current (void) const |
| Returns the current iteration position.
|
virtual int32_t | getRuleStatus () const |
| Return the status tag from the break rule that determined the most recently returned break position.
|
virtual int32_t | getRuleStatusVec (int32_t *fillInVec, int32_t capacity, UErrorCode &status) |
| Get the status (tag) values from the break rule(s) that determined the most recently returned break position.
|
virtual UClassID | getDynamicClassID (void) const |
| Returns a unique class ID POLYMORPHICALLY.
|
virtual BreakIterator * | createBufferClone (void *stackBuffer, int32_t &BufferSize, UErrorCode &status) |
| Thread safe client-buffer-based cloning operation Do NOT call delete on a safeclone, since 'new' is not used to create it.
|
virtual const uint8_t * | getBinaryRules (uint32_t &length) |
| Return the binary form of compiled break rules, which can then be used to create a new break iterator at some time in the future.
|
virtual | ~BreakIterator () |
| destructor
|
UBool | isBufferClone (void) |
| Determine whether the BreakIterator was created in user memory by createBufferClone(), and thus should not be deleted.
|
Locale | getLocale (ULocDataLocaleType type, UErrorCode &status) const |
| Returns the locale for this break iterator.
|
const char * | getLocaleID (ULocDataLocaleType type, UErrorCode &status) const |
| Get the locale for this break iterator object.
|
virtual | ~UObject () |
| Destructor.
|
Static Public Member Functions |
static UClassID | getStaticClassID (void) |
| Returns the class ID for this class.
|
static BreakIterator * | createWordInstance (const Locale &where, UErrorCode &status) |
| Create BreakIterator for word-breaks using the given locale.
|
static BreakIterator * | createLineInstance (const Locale &where, UErrorCode &status) |
| Create BreakIterator for line-breaks using specified locale.
|
static BreakIterator * | createCharacterInstance (const Locale &where, UErrorCode &status) |
| Create BreakIterator for character-breaks using specified locale Returns an instance of a BreakIterator implementing character breaks.
|
static BreakIterator * | createSentenceInstance (const Locale &where, UErrorCode &status) |
| Create BreakIterator for sentence-breaks using specified locale Returns an instance of a BreakIterator implementing sentence breaks.
|
static BreakIterator * | createTitleInstance (const Locale &where, UErrorCode &status) |
| Create BreakIterator for title-casing breaks using the specified locale Returns an instance of a BreakIterator implementing title breaks.
|
static const Locale * | getAvailableLocales (int32_t &count) |
| Get the set of Locales for which TextBoundaries are installed.
|
static UnicodeString & | getDisplayName (const Locale &objectLocale, const Locale &displayLocale, UnicodeString &name) |
| Get name of the object for the desired Locale, in the desired langauge.
|
static UnicodeString & | getDisplayName (const Locale &objectLocale, UnicodeString &name) |
| Get name of the object for the desired Locale, in the langauge of the default locale.
|
static URegistryKey | registerInstance (BreakIterator *toAdopt, const Locale &locale, UBreakIteratorType kind, UErrorCode &status) |
| Register a new break iterator of the indicated kind, to use in the given locale.
|
static UBool | unregister (URegistryKey key, UErrorCode &status) |
| Unregister a previously-registered BreakIterator using the key returned from the register call.
|
static StringEnumeration * | getAvailableLocales (void) |
| Return a StringEnumeration over the locales available at the time of the call, including registered locales.
|
Protected Attributes |
UText * | fText |
| The UText through which this BreakIterator accesses the text.
|
CharacterIterator * | fCharIter |
| A character iterator that refers to the same text as the UText, above.
|
StringCharacterIterator * | fSCharIter |
| When the input text is provided by a UnicodeString, this will point to a characterIterator that wraps that data.
|
UCharCharacterIterator * | fDCharIter |
| When the input text is provided by a UText, this dummy CharacterIterator over an empty string will be returned from getText()
|
RBBIDataWrapper * | fData |
| The rule data for this BreakIterator instance.
|
int32_t | fLastRuleStatusIndex |
| Index of the Rule {tag} values for the most recent match.
|
UBool | fLastStatusIndexValid |
| Rule tag value valid flag.
|
uint32_t | fDictionaryCharCount |
| Counter for the number of characters encountered with the "dictionary" flag set.
|
int32_t * | fCachedBreakPositions |
| When a range of characters is divided up using the dictionary, the break positions that are discovered are stored here, preventing us from having to use either the dictionary or the state table again until the iterator leaves this range of text.
|
int32_t | fNumCachedBreakPositions |
| The number of elements in fCachedBreakPositions.
|
int32_t | fPositionInCache |
| if fCachedBreakPositions is not null, this indicates which item in the cache the current iteration position refers to
|
UStack * | fLanguageBreakEngines |
| If present, UStack of LanguageBreakEngine objects that might handle dictionary characters.
|
UnhandledEngine * | fUnhandledBreakEngine |
| If present, the special LanguageBreakEngine used for handling characters that are in the dictionary set, but not handled by any LangugageBreakEngine.
|
int32_t | fBreakType |
| The type of the break iterator, or -1 if it has not been set.
|
UBool | fBufferClone |
A subclass of BreakIterator whose behavior is specified using a list of rules.
Instances of this class are most commonly created by the factory methods of BreakIterator::createWordInstance(), BreakIterator::createLineInstance(), etc., and then used via the abstract API in class BreakIterator
See the ICU User Guide for information on Break Iterator Rules.
This class is not intended to be subclassed. (Class DictionaryBasedBreakIterator is a subclass, but that relationship is effectively internal to the ICU implementation. The subclassing interface to RulesBasedBreakIterator is not part of the ICU API, and may not remain stable.
Definition at line 65 of file rbbi.h.
Contruct 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 constuction 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 comaptible only between machines with the same byte ordering (little or big endian) and the same base character set family (ASCII or EBCDIC).
- See Also
- getBinaryRules
- Parameters
-
compiledRules | A pointer to the compiled break rules to be used. |
ruleLength | The length of the compiled break rules, in bytes. This corresponds to the length value produced by getBinaryRules(). |
status | Information on any errors encountered, including invalid binary rules. |
- Draft:
- This API may be changed in the future versions and was introduced in ICU 4.8
virtual int32_t RuleBasedBreakIterator::getRuleStatus |
( |
| ) |
const |
|
virtual |
Return the status tag from the break rule that determined the most recently returned break 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.
Of the standard types of ICU break iterators, only word break and line break provide status values. The values are defined in the header file ubrk.h. For Word breaks, the status allows distinguishing between words that contain alphabetic letters, "words" that appear to be numbers, punctuation and spaces, words containing ideographic characters, and more. For Line Break, the status distinguishes between hard (mandatory) breaks and soft (potential) break positions.
getRuleStatus()
can be called after obtaining a boundary position from next()
, previous()
, or any other break iterator functions that returns a boundary position.
When creating custom break rules, one is free to define whatever status values may be convenient for the application.
Note: this function is not thread safe. It should not have been declared const, and the const remains only for compatibility reasons. (The function is logically const, but not bit-wise const).
- Returns
- the status from the break rule that determined the most recently returned break position.
- See Also
- UWordBreak
- Stable:
- ICU 2.2
Return a CharacterIterator over the text being analyzed. The returned character iterator is owned by the break iterator, and must not be deleted by the caller. Repeated calls to this function may return the same CharacterIterator.
The returned character iterator must not be used concurrently with the break iterator. If concurrent operation is needed, clone the returned character iterator first and operate on the clone.
When the break iterator is operating on text supplied via a UText, this function will fail. Lacking any way to signal failures, it returns an CharacterIterator containing no text. The function getUText() provides similar functionality, is reliable, and is more efficient.
TODO: deprecate this function?
- Returns
- An iterator over the text being analyzed.
- Stable:
- ICU 2.0
Implements BreakIterator.