ICU 74.2: common/unicode/rbbi.h Source File

ICU 74.2 74.2

rbbi.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4***************************************************************************
5* Copyright (C) 1999-2016 International Business Machines Corporation *
6* and others. All rights reserved. *
7***************************************************************************
8
9**********************************************************************
10* Date Name Description
11* 10/22/99 alan Creation.
12* 11/11/99 rgillam Complete port from Java.
13**********************************************************************
14*/
15
16#ifndef RBBI_H
17#define RBBI_H
18
19#include "unicode/utypes.h"
20
21#if U_SHOW_CPLUSPLUS_API
22
28#if !UCONFIG_NO_BREAK_ITERATION
29
30#include "unicode/brkiter.h"
31#include "unicode/udata.h"
32#include "unicode/parseerr.h"
33#include "unicode/schriter.h"
34
35struct UCPTrie;
36
37U_NAMESPACE_BEGIN
38
40class LanguageBreakEngine;
41struct RBBIDataHeader;
42class RBBIDataWrapper;
43class UnhandledEngine;
44class UStack;
45
46
47#ifndef U_HIDE_DRAFT_API
60 class ExternalBreakEngine : public UObject {
61 public:
66 virtual ~ExternalBreakEngine() {}
67
77 virtual bool isFor(UChar32 c, const char* locale) const = 0;
78
87 virtual bool handles(UChar32 c) const = 0;
88
102 virtual int32_t fillBreaks(UText* text, int32_t start, int32_t end,
103 int32_t* foundBreaks, int32_t foundBreaksCapacity,
104 UErrorCode& status) const = 0;
105};
106#endif /* U_HIDE_DRAFT_API */
107
108
120 class U_COMMON_API RuleBasedBreakIterator /*final*/ : public BreakIterator {
121
122private:
127 UText fText = UTEXT_INITIALIZER;
128
129#ifndef U_HIDE_INTERNAL_API
130public:
131#endif /* U_HIDE_INTERNAL_API */
137 RBBIDataWrapper *fData = nullptr;
138
139private:
144 UErrorCode fErrorCode = U_ZERO_ERROR;
145
150 int32_t fPosition = 0;
151
155 int32_t fRuleStatusIndex = 0;
156
160 class BreakCache;
161 BreakCache *fBreakCache = nullptr;
162
167 class DictionaryCache;
168 DictionaryCache *fDictionaryCache = nullptr;
169
177 UStack *fLanguageBreakEngines = nullptr;
178
186 UnhandledEngine *fUnhandledBreakEngine = nullptr;
187
193 uint32_t fDictionaryCharCount = 0;
194
200 CharacterIterator *fCharIter = &fSCharIter;
201
207 UCharCharacterIterator fSCharIter {u"", 0};
208
212 bool fDone = false;
213
217 int32_t *fLookAheadMatches = nullptr;
218
222 UBool fIsPhraseBreaking = false;
223
224 //=======================================================================
225 // constructors
226 //=======================================================================
227
238 RuleBasedBreakIterator(RBBIDataHeader* data, UErrorCode &status);
239
253 RuleBasedBreakIterator(UDataMemory* image, UBool isPhraseBreaking, UErrorCode &status);
254
256 friend class RBBIRuleBuilder;
258 friend class BreakIterator;
259
266 RuleBasedBreakIterator(UErrorCode *status);
267
268public:
269
275 RuleBasedBreakIterator();
276
283 RuleBasedBreakIterator(const RuleBasedBreakIterator& that);
284
293 RuleBasedBreakIterator( const UnicodeString &rules,
294 UParseError &parseError,
295 UErrorCode &status);
296
320 RuleBasedBreakIterator(const uint8_t *compiledRules,
321 uint32_t ruleLength,
322 UErrorCode &status);
323
336 RuleBasedBreakIterator(UDataMemory* image, UErrorCode &status);
337
342 virtual ~RuleBasedBreakIterator();
343
351 RuleBasedBreakIterator& operator=(const RuleBasedBreakIterator& that);
352
361 virtual bool operator==(const BreakIterator& that) const override;
362
370 inline bool operator!=(const BreakIterator& that) const {
371 return !operator==(that);
372 }
373
384 virtual RuleBasedBreakIterator* clone() const override;
385
391 virtual int32_t hashCode(void) const;
392
398 virtual const UnicodeString& getRules(void) const;
399
400 //=======================================================================
401 // BreakIterator overrides
402 //=======================================================================
403
428 virtual CharacterIterator& getText(void) const override;
429
430
445 virtual UText *getUText(UText *fillIn, UErrorCode &status) const override;
446
454 virtual void adoptText(CharacterIterator* newText) override;
455
467 virtual void setText(const UnicodeString& newText) override;
468
482 virtual void setText(UText *text, UErrorCode &status) override;
483
489 virtual int32_t first(void) override;
490
496 virtual int32_t last(void) override;
497
508 virtual int32_t next(int32_t n) override;
509
515 virtual int32_t next(void) override;
516
522 virtual int32_t previous(void) override;
523
531 virtual int32_t following(int32_t offset) override;
532
540 virtual int32_t preceding(int32_t offset) override;
541
550 virtual UBool isBoundary(int32_t offset) override;
551
560 virtual int32_t current(void) const override;
561
562
594 virtual int32_t getRuleStatus() const override;
595
619 virtual int32_t getRuleStatusVec(int32_t *fillInVec, int32_t capacity, UErrorCode &status) override;
620
632 virtual UClassID getDynamicClassID(void) const override;
633
645 static UClassID U_EXPORT2 getStaticClassID(void);
646
647#ifndef U_FORCE_HIDE_DEPRECATED_API
674 virtual RuleBasedBreakIterator *createBufferClone(void *stackBuffer,
675 int32_t &BufferSize,
676 UErrorCode &status) override;
677#endif // U_FORCE_HIDE_DEPRECATED_API
678
696 virtual const uint8_t *getBinaryRules(uint32_t &length);
697
723 virtual RuleBasedBreakIterator &refreshInputText(UText *input, UErrorCode &status) override;
724
725
726private:
727 //=======================================================================
728 // implementation
729 //=======================================================================
739 int32_t handleSafePrevious(int32_t fromPosition);
740
753 int32_t handleNext();
754
755 /*
756 * Templatized version of handleNext() and handleSafePrevious().
757 *
758 * There will be exactly four instantiations, two each for 8 and 16 bit tables,
759 * two each for 8 and 16 bit trie.
760 * Having separate instantiations for the table types keeps conditional tests of
761 * the table type out of the inner loops, at the expense of replicated code.
762 *
763 * The template parameter for the Trie access function is a value, not a type.
764 * Doing it this way, the compiler will inline the Trie function in the
765 * expanded functions. (Both the 8 and 16 bit access functions have the same type
766 * signature)
767 */
768
769 typedef uint16_t (*PTrieFunc)(const UCPTrie *, UChar32);
770
771 template<typename RowType, PTrieFunc trieFunc>
772 int32_t handleSafePrevious(int32_t fromPosition);
773
774 template<typename RowType, PTrieFunc trieFunc>
775 int32_t handleNext();
776
777
785 const LanguageBreakEngine *getLanguageBreakEngine(UChar32 c, const char* locale);
786
787 public:
788#ifndef U_HIDE_INTERNAL_API
793 void dumpCache();
794
799 void dumpTables();
800#endif /* U_HIDE_INTERNAL_API */
801
802#ifndef U_HIDE_DRAFT_API
812 static void U_EXPORT2 registerExternalBreakEngine(
813 ExternalBreakEngine* toAdopt, UErrorCode& status);
814#endif /* U_HIDE_DRAFT_API */
815
816};
817
818
819U_NAMESPACE_END
820
821#endif /* #if !UCONFIG_NO_BREAK_ITERATION */
822
823#endif /* U_SHOW_CPLUSPLUS_API */
824
825#endif
brkiter.h
C++ API: Break Iterator.
icu::BreakIterator
The BreakIterator class implements methods for finding the location of boundaries in text.
Definition brkiter.h:106
icu::BreakIterator::operator==
virtual bool operator==(const BreakIterator &) const =0
Return true if another object is semantically equal to this one.
icu::CharacterIterator
Abstract class that defines an API for iteration on text objects.
Definition chariter.h:361
icu::ExternalBreakEngine
The ExternalBreakEngine class define an abstract interface for the host environment to provide a low ...
Definition rbbi.h:60
icu::ExternalBreakEngine::isFor
virtual bool isFor(UChar32 c, const char *locale) const =0
icu::ExternalBreakEngine::fillBreaks
virtual int32_t fillBreaks(UText *text, int32_t start, int32_t end, int32_t *foundBreaks, int32_t foundBreaksCapacity, UErrorCode &status) const =0
icu::ExternalBreakEngine::handles
virtual bool handles(UChar32 c) const =0
icu::ExternalBreakEngine::~ExternalBreakEngine
virtual ~ExternalBreakEngine()
destructor
Definition rbbi.h:66
icu::RuleBasedBreakIterator
A subclass of BreakIterator whose behavior is specified using a list of rules.
Definition rbbi.h:120
icu::RuleBasedBreakIterator::current
virtual int32_t current(void) const override
Returns the current iteration position.
icu::RuleBasedBreakIterator::following
virtual int32_t following(int32_t offset) override
Sets the iterator to refer to the first boundary position following the specified position.
icu::RuleBasedBreakIterator::operator==
virtual bool operator==(const BreakIterator &that) const override
Equality operator.
icu::RuleBasedBreakIterator::clone
virtual RuleBasedBreakIterator * clone() const override
Returns a newly-constructed RuleBasedBreakIterator with the same behavior, and iterating over the sam...
icu::RuleBasedBreakIterator::createBufferClone
virtual RuleBasedBreakIterator * createBufferClone(void *stackBuffer, int32_t &BufferSize, UErrorCode &status) override
Deprecated functionality.
icu::RuleBasedBreakIterator::dumpTables
void dumpTables()
Debugging function only.
icu::RuleBasedBreakIterator::getDynamicClassID
virtual UClassID getDynamicClassID(void) const override
Returns a unique class ID POLYMORPHICALLY.
icu::RuleBasedBreakIterator::last
virtual int32_t last(void) override
Sets the current iteration position to the end of the text.
icu::RuleBasedBreakIterator::getRuleStatus
virtual int32_t getRuleStatus() const override
Return the status tag from the break rule that determined the boundary at the current iteration posit...
icu::RuleBasedBreakIterator::getUText
virtual UText * getUText(UText *fillIn, UErrorCode &status) const override
Get a UText for the text being analyzed.
icu::RuleBasedBreakIterator::isBoundary
virtual UBool isBoundary(int32_t offset) override
Returns true if the specified position is a boundary position.
icu::RuleBasedBreakIterator::operator!=
bool operator!=(const BreakIterator &that) const
Not-equal operator.
Definition rbbi.h:370
icu::RuleBasedBreakIterator::dumpCache
void dumpCache()
Debugging function only.
icu::RuleBasedBreakIterator::registerExternalBreakEngine
static void registerExternalBreakEngine(ExternalBreakEngine *toAdopt, UErrorCode &status)
Register a new external break engine.
icu::RuleBasedBreakIterator::refreshInputText
virtual RuleBasedBreakIterator & refreshInputText(UText *input, UErrorCode &status) override
Set the subject text string upon which the break iterator is operating without changing any other asp...
icu::RuleBasedBreakIterator::RuleBasedBreakIterator
RuleBasedBreakIterator()
Default constructor.
icu::RuleBasedBreakIterator::getRuleStatusVec
virtual int32_t getRuleStatusVec(int32_t *fillInVec, int32_t capacity, UErrorCode &status) override
Get the status (tag) values from the break rule(s) that determined the boundary at the current iterat...
icu::RuleBasedBreakIterator::first
virtual int32_t first(void) override
Sets the current iteration position to the beginning of the text, position zero.
icu::RuleBasedBreakIterator::operator=
RuleBasedBreakIterator & operator=(const RuleBasedBreakIterator &that)
Assignment operator.
icu::RuleBasedBreakIterator::getStaticClassID
static UClassID getStaticClassID(void)
Returns the class ID for this class.
icu::RuleBasedBreakIterator::preceding
virtual int32_t preceding(int32_t offset) override
Sets the iterator to refer to the last boundary position before the specified position.
icu::RuleBasedBreakIterator::RuleBasedBreakIterator
RuleBasedBreakIterator(const RuleBasedBreakIterator &that)
Copy constructor.
icu::RuleBasedBreakIterator::getText
virtual CharacterIterator & getText(void) const override
icu::RuleBasedBreakIterator::previous
virtual int32_t previous(void) override
Moves the iterator backwards, to the last boundary preceding this one.
icu::RuleBasedBreakIterator::adoptText
virtual void adoptText(CharacterIterator *newText) override
Set the iterator to analyze a new piece of text.
icu::RuleBasedBreakIterator::RuleBasedBreakIterator
RuleBasedBreakIterator(UDataMemory *image, UErrorCode &status)
This constructor uses the udata interface to create a BreakIterator whose internal tables live in a m...
icu::RuleBasedBreakIterator::getRules
virtual const UnicodeString & getRules(void) const
Returns the description used to create this iterator.
icu::RuleBasedBreakIterator::next
virtual int32_t next(int32_t n) override
Advances the iterator either forward or backward the specified number of steps.
icu::RuleBasedBreakIterator::setText
virtual void setText(UText *text, UErrorCode &status) override
Reset the break iterator to operate over the text represented by the UText.
icu::RuleBasedBreakIterator::~RuleBasedBreakIterator
virtual ~RuleBasedBreakIterator()
Destructor.
icu::RuleBasedBreakIterator::RuleBasedBreakIterator
RuleBasedBreakIterator(const UnicodeString &rules, UParseError &parseError, UErrorCode &status)
Construct a RuleBasedBreakIterator from a set of rules supplied as a string.
icu::RuleBasedBreakIterator::getBinaryRules
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...
icu::RuleBasedBreakIterator::hashCode
virtual int32_t hashCode(void) const
Compute a hash code for this BreakIterator.
icu::RuleBasedBreakIterator::next
virtual int32_t next(void) override
Advances the iterator to the next boundary position.
icu::RuleBasedBreakIterator::RuleBasedBreakIterator
RuleBasedBreakIterator(const uint8_t *compiledRules, uint32_t ruleLength, UErrorCode &status)
Construct a RuleBasedBreakIterator from a set of precompiled binary rules.
icu::RuleBasedBreakIterator::setText
virtual void setText(const UnicodeString &newText) override
Set the iterator to analyze a new piece of text.
icu::UCharCharacterIterator
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...
Definition uchriter.h:38
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition uobject.h:223
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:296
parseerr.h
C API: Parse Error Information.
schriter.h
C++ API: String Character Iterator.
UCPTrie
Immutable Unicode code point trie structure.
Definition ucptrie.h:59
UParseError
A UParseError struct is used to returned detailed information about parsing errors.
Definition parseerr.h:58
UText
UText struct.
Definition utext.h:1328
udata.h
C API: Data loading interface.
UDataMemory
struct UDataMemory UDataMemory
Forward declaration of the data memory type.
Definition udata.h:161
UChar32
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition umachine.h:435
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:96
UTEXT_INITIALIZER
#define UTEXT_INITIALIZER
initializer to be used with local (stack) instances of a UText struct.
Definition utext.h:1558
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
U_ZERO_ERROR
@ U_ZERO_ERROR
No error, no warning.
Definition utypes.h:449
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.
Definition utypes.h:300