ICU 67.1 67.1

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
35 U_NAMESPACE_BEGIN
36
38 class LanguageBreakEngine;
39 struct RBBIDataHeader;
40 class RBBIDataWrapper;
41 class UnhandledEngine;
42 class UStack;
43
55 class U_COMMON_API RuleBasedBreakIterator /*U_FINAL*/ : public BreakIterator {
56
57 private:
62 UText fText;
63
64 #ifndef U_HIDE_INTERNAL_API
65 public:
66 #endif /* U_HIDE_INTERNAL_API */
67
72 RBBIDataWrapper *fData;
73 private:
74
79 int32_t fPosition;
80
84 int32_t fRuleStatusIndex;
85
89 class BreakCache;
90 BreakCache *fBreakCache;
91
96 class DictionaryCache;
97 DictionaryCache *fDictionaryCache;
98
106 UStack *fLanguageBreakEngines;
107
115 UnhandledEngine *fUnhandledBreakEngine;
116
122 uint32_t fDictionaryCharCount;
123
129 CharacterIterator *fCharIter;
130
136 StringCharacterIterator fSCharIter;
137
141 UBool fDone;
142
143 //=======================================================================
144 // constructors
145 //=======================================================================
146
157 RuleBasedBreakIterator(RBBIDataHeader* data, UErrorCode &status);
158
160 friend class RBBIRuleBuilder;
162 friend class BreakIterator;
163
164 public:
165
170 RuleBasedBreakIterator();
171
178 RuleBasedBreakIterator(const RuleBasedBreakIterator& that);
179
188 RuleBasedBreakIterator( const UnicodeString &rules,
189 UParseError &parseError,
190 UErrorCode &status);
191
215 RuleBasedBreakIterator(const uint8_t *compiledRules,
216 uint32_t ruleLength,
217 UErrorCode &status);
218
231 RuleBasedBreakIterator(UDataMemory* image, UErrorCode &status);
232
237 virtual ~RuleBasedBreakIterator();
238
246 RuleBasedBreakIterator& operator=(const RuleBasedBreakIterator& that);
247
256 virtual UBool operator==(const BreakIterator& that) const;
257
265 inline UBool operator!=(const BreakIterator& that) const;
266
277 virtual RuleBasedBreakIterator* clone() const;
278
284 virtual int32_t hashCode(void) const;
285
291 virtual const UnicodeString& getRules(void) const;
292
293 //=======================================================================
294 // BreakIterator overrides
295 //=======================================================================
296
322 virtual CharacterIterator& getText(void) const;
323
324
339 virtual UText *getUText(UText *fillIn, UErrorCode &status) const;
340
348 virtual void adoptText(CharacterIterator* newText);
349
361 virtual void setText(const UnicodeString& newText);
362
376 virtual void setText(UText *text, UErrorCode &status);
377
383 virtual int32_t first(void);
384
390 virtual int32_t last(void);
391
402 virtual int32_t next(int32_t n);
403
409 virtual int32_t next(void);
410
416 virtual int32_t previous(void);
417
425 virtual int32_t following(int32_t offset);
426
434 virtual int32_t preceding(int32_t offset);
435
444 virtual UBool isBoundary(int32_t offset);
445
454 virtual int32_t current(void) const;
455
456
488 virtual int32_t getRuleStatus() const;
489
513 virtual int32_t getRuleStatusVec(int32_t *fillInVec, int32_t capacity, UErrorCode &status);
514
526 virtual UClassID getDynamicClassID(void) const;
527
539 static UClassID U_EXPORT2 getStaticClassID(void);
540
541 #ifndef U_FORCE_HIDE_DEPRECATED_API
542
568 virtual RuleBasedBreakIterator *createBufferClone(void *stackBuffer,
569 int32_t &BufferSize,
570 UErrorCode &status);
571 #endif // U_FORCE_HIDE_DEPRECATED_API
572
590 virtual const uint8_t *getBinaryRules(uint32_t &length);
591
617 virtual RuleBasedBreakIterator &refreshInputText(UText *input, UErrorCode &status);
618
619
620 private:
621 //=======================================================================
622 // implementation
623 //=======================================================================
629 void reset(void);
630
635 void init(UErrorCode &status);
636
646 int32_t handleSafePrevious(int32_t fromPosition);
647
660 int32_t handleNext();
661
662
669 const LanguageBreakEngine *getLanguageBreakEngine(UChar32 c);
670
671 public:
672 #ifndef U_HIDE_INTERNAL_API
673
677 void dumpCache();
678
683 void dumpTables();
684
685 #endif /* U_HIDE_INTERNAL_API */
686 };
687
688 //------------------------------------------------------------------------------
689 //
690 // Inline Functions Definitions ...
691 //
692 //------------------------------------------------------------------------------
693
694 inline UBool RuleBasedBreakIterator::operator!=(const BreakIterator& that) const {
695 return !operator==(that);
696 }
697
698 U_NAMESPACE_END
699
700 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */
701
702 #endif /* U_SHOW_CPLUSPLUS_API */
703
704 #endif
brkiter.h
C++ API: Break Iterator.
icu::BreakIterator::operator=
BreakIterator & operator=(const BreakIterator &other)
icu::RuleBasedBreakIterator::fData
RBBIDataWrapper * fData
The rule data for this BreakIterator instance.
Definition: rbbi.h:72
icu::BreakIterator::next
virtual int32_t next(void)=0
Advance the iterator to the boundary following the current boundary.
icu::BreakIterator::isBoundary
virtual UBool isBoundary(int32_t offset)=0
Return true if the specified position is a boundary position.
icu::BreakIterator::adoptText
virtual void adoptText(CharacterIterator *it)=0
Change the text over which this operates.
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler&#39;s RTTI.
Definition: uobject.h:96
icu::BreakIterator::getText
virtual CharacterIterator & getText(void) const =0
Return a CharacterIterator over the text being analyzed.
icu::BreakIterator::getUText
virtual UText * getUText(UText *fillIn, UErrorCode &status) const =0
Get a UText for the text being analyzed.
icu::BreakIterator::first
virtual int32_t first(void)=0
Sets the current iteration position to the beginning of the text, position zero.
icu::BreakIterator::following
virtual int32_t following(int32_t offset)=0
Advance the iterator to the first boundary following the specified offset.
icu::CharacterIterator
Abstract class that defines an API for iteration on text objects.
Definition: chariter.h:361
schriter.h
C++ API: String Character Iterator.
icu::StringCharacterIterator
A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...
Definition: schriter.h:48
icu::BreakIterator
The BreakIterator class implements methods for finding the location of boundaries in text...
Definition: brkiter.h:106
icu::BreakIterator::last
virtual int32_t last(void)=0
Set the iterator position to the index immediately BEYOND the last character in the text being scanne...
icu::BreakIterator::current
virtual int32_t current(void) const =0
Return character index of the current iterator position within the text.
UChar32
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:425
icu::RuleBasedBreakIterator::operator!=
UBool operator!=(const BreakIterator &that) const
Not-equal operator.
Definition: rbbi.h:694
icu::BreakIterator::operator==
virtual UBool operator==(const BreakIterator &) const =0
Return true if another object is semantically equal to this one.
icu::BreakIterator::getRuleStatusVec
virtual int32_t getRuleStatusVec(int32_t *fillInVec, int32_t capacity, UErrorCode &status)
For RuleBasedBreakIterators, get the status (tag) values from the break rule(s) that determined the b...
udata.h
C API: Data loading interface.
UDataMemory
struct UDataMemory UDataMemory
Forward declaration of the data memory type.
Definition: udata.h:158
icu::BreakIterator::previous
virtual int32_t previous(void)=0
Set the iterator position to the boundary preceding the current boundary.
icu::BreakIterator::getDynamicClassID
virtual UClassID getDynamicClassID(void) const =0
Return a polymorphic class ID for this object.
icu::BreakIterator::setText
virtual void setText(const UnicodeString &text)=0
Change the text over which this operates.
icu::BreakIterator::refreshInputText
virtual BreakIterator & refreshInputText(UText *input, UErrorCode &status)=0
Set the subject text string upon which the break iterator is operating without changing any other asp...
parseerr.h
C API: Parse Error Information.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
icu::BreakIterator::createBufferClone
virtual BreakIterator * createBufferClone(void *stackBuffer, int32_t &BufferSize, UErrorCode &status)=0
Deprecated functionality.
icu::BreakIterator::getRuleStatus
virtual int32_t getRuleStatus() const
For RuleBasedBreakIterators, return the status tag from the break rule that determined the boundary a...
UText
UText struct.
Definition: utext.h:1328
icu::RuleBasedBreakIterator
A subclass of BreakIterator whose behavior is specified using a list of rules.
Definition: rbbi.h:55
icu::BreakIterator::preceding
virtual int32_t preceding(int32_t offset)=0
Set the iterator position to the first boundary preceding the specified offset.
UParseError
A UParseError struct is used to returned detailed information about parsing errors.
Definition: parseerr.h:58
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
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
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:294
icu::BreakIterator::operator!=
UBool operator!=(const BreakIterator &rhs) const
Returns the complement of the result of operator==.
Definition: brkiter.h:135
icu::BreakIterator::clone
virtual BreakIterator * clone() const =0
Return a polymorphic copy of this object.
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:261