#include "unicode/utypes.h"
#include "unicode/uloc.h"
#include "unicode/utext.h"
#include "unicode/parseerr.h"
Go to the source code of this file.
Defines | |
#define | UBRK_DONE ((int32_t) -1) |
Value indicating all text boundaries have been returned. | |
#define | U_BRK_SAFECLONE_BUFFERSIZE 512 |
A recommended size (in bytes) for the memory buffer to be passed to ubrk_saveClone(). | |
Typedefs | |
typedef void | UBreakIterator |
Opaque type representing an ICU Break iterator object. | |
typedef enum UBreakIteratorType | UBreakIteratorType |
The possible types of text boundaries. | |
typedef enum UWordBreak | UWordBreak |
Enum constants for the word break tags returned by getRuleStatus(). | |
typedef enum ULineBreakTag | ULineBreakTag |
Enum constants for the line break tags returned by getRuleStatus(). | |
typedef enum USentenceBreakTag | USentenceBreakTag |
Enum constants for the sentence break tags returned by getRuleStatus(). | |
Enumerations | |
enum | UBreakIteratorType { UBRK_CHARACTER = 0, UBRK_WORD = 1, UBRK_LINE = 2, UBRK_SENTENCE = 3, UBRK_TITLE = 4, UBRK_COUNT = 5 } |
The possible types of text boundaries. More... | |
enum | UWordBreak { UBRK_WORD_NONE = 0, UBRK_WORD_NONE_LIMIT = 100, UBRK_WORD_NUMBER = 100, UBRK_WORD_NUMBER_LIMIT = 200, UBRK_WORD_LETTER = 200, UBRK_WORD_LETTER_LIMIT = 300, UBRK_WORD_KANA = 300, UBRK_WORD_KANA_LIMIT = 400, UBRK_WORD_IDEO = 400, UBRK_WORD_IDEO_LIMIT = 500 } |
Enum constants for the word break tags returned by getRuleStatus(). More... | |
enum | ULineBreakTag { UBRK_LINE_SOFT = 0, UBRK_LINE_SOFT_LIMIT = 100, UBRK_LINE_HARD = 100, UBRK_LINE_HARD_LIMIT = 200 } |
Enum constants for the line break tags returned by getRuleStatus(). More... | |
enum | USentenceBreakTag { UBRK_SENTENCE_TERM = 0, UBRK_SENTENCE_TERM_LIMIT = 100, UBRK_SENTENCE_SEP = 100, UBRK_SENTENCE_SEP_LIMIT = 200 } |
Enum constants for the sentence break tags returned by getRuleStatus(). More... | |
Functions | |
UBreakIterator * | ubrk_open (UBreakIteratorType type, const char *locale, const UChar *text, int32_t textLength, UErrorCode *status) |
Open a new UBreakIterator for locating text boundaries for a specified locale. | |
UBreakIterator * | ubrk_openRules (const UChar *rules, int32_t rulesLength, const UChar *text, int32_t textLength, UParseError *parseErr, UErrorCode *status) |
Open a new UBreakIterator for locating text boundaries using specified breaking rules. | |
UBreakIterator * | ubrk_safeClone (const UBreakIterator *bi, void *stackBuffer, int32_t *pBufferSize, UErrorCode *status) |
Thread safe cloning operation. | |
void | ubrk_close (UBreakIterator *bi) |
Close a UBreakIterator. | |
void | ubrk_setText (UBreakIterator *bi, const UChar *text, int32_t textLength, UErrorCode *status) |
Sets an existing iterator to point to a new piece of text. | |
void | ubrk_setUText (UBreakIterator *bi, UText *text, UErrorCode *status) |
Sets an existing iterator to point to a new piece of text. | |
int32_t | ubrk_current (const UBreakIterator *bi) |
Determine the most recently-returned text boundary. | |
int32_t | ubrk_next (UBreakIterator *bi) |
Determine the text boundary following the current text boundary. | |
int32_t | ubrk_previous (UBreakIterator *bi) |
Determine the text boundary preceding the current text boundary. | |
int32_t | ubrk_first (UBreakIterator *bi) |
Determine the index of the first character in the text being scanned. | |
int32_t | ubrk_last (UBreakIterator *bi) |
Determine the index immediately beyond the last character in the text being scanned. | |
int32_t | ubrk_preceding (UBreakIterator *bi, int32_t offset) |
Determine the text boundary preceding the specified offset. | |
int32_t | ubrk_following (UBreakIterator *bi, int32_t offset) |
Determine the text boundary following the specified offset. | |
const char * | ubrk_getAvailable (int32_t index) |
Get a locale for which text breaking information is available. | |
int32_t | ubrk_countAvailable (void) |
Determine how many locales have text breaking information available. | |
UBool | ubrk_isBoundary (UBreakIterator *bi, int32_t offset) |
Returns true if the specfied position is a boundary position. | |
int32_t | ubrk_getRuleStatus (UBreakIterator *bi) |
Return the status from the break rule that determined the most recently returned break position. | |
int32_t | ubrk_getRuleStatusVec (UBreakIterator *bi, int32_t *fillInVec, int32_t capacity, UErrorCode *status) |
Get the statuses from the break rules that determined the most recently returned break position. | |
const char * | ubrk_getLocaleByType (const UBreakIterator *bi, ULocDataLocaleType type, UErrorCode *status) |
Return the locale of the break iterator. |
The BreakIterator C API defines methods for finding the location of boundaries in text. Pointer to a UBreakIterator maintain a current position and scan over text returning the index of characters where boundaries occur.
Line boundary analysis determines where a text string can be broken when line-wrapping. The mechanism correctly handles punctuation and hyphenated words.
Sentence boundary analysis allows selection with correct interpretation of periods within numbers and abbreviations, and trailing punctuation marks such as quotation marks and parentheses.
Word boundary analysis is used by search and replace functions, as well as within text editing applications that allow the user to select words with a double click. Word selection provides correct interpretation of punctuation marks within and following words. Characters that are not part of a word, such as symbols or punctuation marks, have word-breaks on both sides.
Character boundary analysis allows users to interact with characters as they expect to, for example, when moving the cursor through a text string. Character boundary analysis provides correct navigation of through character strings, regardless of how the character is stored. For example, an accented character might be stored as a base character and a diacritical mark. What users consider to be a character can differ between languages.
Title boundary analysis locates all positions, typically starts of words, that should be set to Title Case when title casing the text.
The text boundary positions are found according to the rules described in Unicode Standard Annex #29, Text Boundaries, and Unicode Standard Annex #14, Line Breaking Properties. These are available at http://www.unicode.org/reports/tr14/ and http://www.unicode.org/reports/tr29/.
In addition to the plain C API defined in this header file, an object oriented C++ API with equivalent functionality is defined in the file brkiter.h.
Code snippits illustrating the use of the Break Iterator APIs are available in the ICU User Guide, http://icu.sourceforge.net/userguide/boundaryAnalysis.html and in the sample program icu/source/samples/break/break.cpp"
Definition in file ubrk.h.
|
A recommended size (in bytes) for the memory buffer to be passed to ubrk_saveClone().
|
|
Value indicating all text boundaries have been returned.
|
|
Opaque type representing an ICU Break iterator object.
|
|
The possible types of text boundaries.
|
|
Enum constants for the line break tags returned by getRuleStatus(). A range of values is defined for each category of word, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values.
|
|
Enum constants for the sentence break tags returned by getRuleStatus(). A range of values is defined for each category of sentence, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values.
|
|
Enum constants for the word break tags returned by getRuleStatus(). A range of values is defined for each category of word, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values.
|
|
The possible types of text boundaries.
|
|
Enum constants for the line break tags returned by getRuleStatus(). A range of values is defined for each category of word, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values.
|
|
Enum constants for the sentence break tags returned by getRuleStatus(). A range of values is defined for each category of sentence, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values.
|
|
Enum constants for the word break tags returned by getRuleStatus(). A range of values is defined for each category of word, to allow for further subdivisions of a category in future releases. Applications should check for tag values falling within the range, rather than for single individual values.
|
|
Close a UBreakIterator. Once closed, a UBreakIterator may no longer be used.
|
|
Determine how many locales have text breaking information available. This function is most useful as determining the loop ending condition for calls to ubrk_getAvailable.
|
|
Determine the most recently-returned text boundary.
|
|
Determine the index of the first character in the text being scanned. This is not always the same as index 0 of the text.
|
|
Determine the text boundary following the specified offset. The value returned is always greater than offset, or UBRK_DONE.
|
|
Get a locale for which text breaking information is available. A UBreakIterator in a locale returned by this function will perform the correct text breaking for the locale.
|
|
Return the locale of the break iterator. You can choose between the valid and the actual locale.
|
|
Return the status from the break rule that determined the most recently returned break position. The values appear in the rule source within brackets, {123}, for example. For rules that do not specify a status, a default value of 0 is returned. For word break iterators, the possible values are defined in enum UWordBreak.
|
|
Get the statuses from the break rules that determined the most recently returned break position. The values appear in the rule source within brackets, {123}, for example. The default status value for rules that do not explicitly provide one is zero. For word break iterators, the possible values are defined in enum UWordBreak.
|
|
Returns true if the specfied position is a boundary position. As a side effect, leaves the iterator pointing to the first boundary position at or after "offset".
|
|
Determine the index immediately beyond the last character in the text being scanned. This is not the same as the last character.
|
|
Determine the text boundary following the current text boundary.
|
|
Open a new UBreakIterator for locating text boundaries for a specified locale. A UBreakIterator may be used for detecting character, line, word, and sentence breaks in text.
|
|
Open a new UBreakIterator for locating text boundaries using specified breaking rules. The rule syntax is ... (TBD)
|
|
Determine the text boundary preceding the specified offset. The value returned is always smaller than offset, or UBRK_DONE.
|
|
Determine the text boundary preceding the current text boundary.
|
|
Thread safe cloning operation.
|
|
Sets an existing iterator to point to a new piece of text.
|
|
Sets an existing iterator to point to a new piece of text.
|