#include "unicode/utypes.h"
#include "unicode/ucol.h"
#include "unicode/ucoleitr.h"
#include "unicode/ubrk.h"
Go to the source code of this file.
Defines | |
#define | USEARCH_DONE -1 |
DONE is returned by previous() and next() after all valid matches have been returned, and by first() and last() if there are no matches at all. More... | |
Typedefs | |
typedef UStringSearch | UStringSearch |
Enumerations | |
enum | USearchAttribute { USEARCH_OVERLAP, USEARCH_CANONICAL_MATCH, USEARCH_ATTRIBUTE_COUNT } |
enum | USearchAttributeValue { USEARCH_DEFAULT = -1, USEARCH_OFF, USEARCH_ON, USEARCH_ATTRIBUTE_VALUE_COUNT } |
Functions | |
U_CAPI UStringSearch *U_EXPORT2 | usearch_open (const UChar *pattern, int32_t patternlength, const UChar *text, int32_t textlength, const char *locale, UBreakIterator *breakiter, UErrorCode *status) |
Creating a search iterator data struct using the argument locale language rule set. More... | |
U_CAPI UStringSearch *U_EXPORT2 | usearch_openFromCollator (const UChar *pattern, int32_t patternlength, const UChar *text, int32_t textlength, const UCollator *collator, UBreakIterator *breakiter, UErrorCode *status) |
Creating a search iterator data struct using the argument collator language rule set. More... | |
U_CAPI void U_EXPORT2 | usearch_close (UStringSearch *strsrch) |
Destroying and cleaning up the search iterator data struct. More... | |
U_CAPI void U_EXPORT2 | usearch_setOffset (UStringSearch *strsrch, int32_t position, UErrorCode *status) |
Sets the current position in the text string which the next search will start from. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_getOffset (const UStringSearch *strsrch) |
Return the current index in the string text being searched. More... | |
U_CAPI void U_EXPORT2 | usearch_setAttribute (UStringSearch *strsrch, USearchAttribute attribute, USearchAttributeValue value, UErrorCode *status) |
Sets the text searching attributes located in the enum USearchAttribute with values from the enum USearchAttributeValue. More... | |
U_CAPI USearchAttributeValue U_EXPORT2 | usearch_getAttribute (const UStringSearch *strsrch, USearchAttribute attribute) |
Gets the text searching attributes. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_getMatchedStart (const UStringSearch *strsrch) |
Returns the index to the match in the text string that was searched. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_getMatchedLength (const UStringSearch *strsrch) |
Returns the length of text in the string which matches the search pattern. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_getMatchedText (const UStringSearch *strsrch, UChar *result, int32_t resultCapacity, UErrorCode *status) |
Returns the text that was matched by the most recent call to usearch_first , usearch_next , usearch_previous , or usearch_last . More... | |
U_CAPI void U_EXPORT2 | usearch_setBreakIterator (UStringSearch *strsrch, UBreakIterator *breakiter, UErrorCode *status) |
Set the BreakIterator that will be used to restrict the points at which matches are detected. More... | |
U_CAPI const UBreakIterator *U_EXPORT2 | usearch_getBreakIterator (const UStringSearch *strsrch) |
Returns the BreakIterator that is used to restrict the points at which matches are detected. More... | |
U_CAPI void U_EXPORT2 | usearch_setText (UStringSearch *strsrch, const UChar *text, int32_t textlength, UErrorCode *status) |
Set the string text to be searched. More... | |
U_CAPI const UChar *U_EXPORT2 | usearch_getText (const UStringSearch *strsrch, int32_t *length) |
Return the string text to be searched. More... | |
U_CAPI UCollator *U_EXPORT2 | usearch_getCollator (const UStringSearch *strsrch) |
Gets the collator used for the language rules. More... | |
U_CAPI void U_EXPORT2 | usearch_setCollator (UStringSearch *strsrch, const UCollator *collator, UErrorCode *status) |
Sets the collator used for the language rules. More... | |
U_CAPI void U_EXPORT2 | usearch_setPattern (UStringSearch *strsrch, const UChar *pattern, int32_t patternlength, UErrorCode *status) |
Sets the pattern used for matching. More... | |
U_CAPI const UChar *U_EXPORT2 | usearch_getPattern (const UStringSearch *strsrch, int32_t *length) |
Gets the search pattern. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_first (UStringSearch *strsrch, UErrorCode *status) |
Returns the first index at which the string text matches the search pattern. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_following (UStringSearch *strsrch, int32_t position, UErrorCode *status) |
Returns the first index greater than position at which the string text matches the search pattern. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_last (UStringSearch *strsrch, UErrorCode *status) |
Returns the last index in the target text at which it matches the search pattern. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_preceding (UStringSearch *strsrch, int32_t position, UErrorCode *status) |
Returns the first index less than position at which the string text matches the search pattern. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_next (UStringSearch *strsrch, UErrorCode *status) |
Returns the index of the next point at which the string text matches the search pattern, starting from the current position. More... | |
U_CAPI int32_t U_EXPORT2 | usearch_previous (UStringSearch *strsrch, UErrorCode *status) |
Returns the index of the previous point at which the string text matches the search pattern, starting at the current position. More... | |
U_CAPI void U_EXPORT2 | usearch_reset (UStringSearch *strsrch) |
Reset the iteration. More... |
|
DONE is returned by previous() and next() after all valid matches have been returned, and by first() and last() if there are no matches at all.
|
|
|
|
|
|
|
|
Destroying and cleaning up the search iterator data struct.
If a collator is created in
|
|
Returns the first index at which the string text matches the search pattern.
The iterator is adjusted so that its current index (as returned by
|
|
Returns the first index greater than
The iterator is adjusted so that its current index (as returned by Search positions that may render incorrect results are highlighted in the header comments. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned
|
|
Gets the text searching attributes.
|
|
Returns the BreakIterator that is used to restrict the points at which matches are detected.
This will be the same object that was passed to the constructor or to
|
|
Gets the collator used for the language rules.
Deleting the returned
|
|
Returns the length of text in the string which matches the search pattern.
This call returns a valid result only after a successful call to
|
|
Returns the index to the match in the text string that was searched.
This call returns a valid result only after a successful call to
Use
|
|
Returns the text that was matched by the most recent call to
If the iterator is not pointing at a valid match (e.g. just after construction or after
|
|
Return the current index in the string text being searched.
If the iteration has gone past the end of the text (or past the beginning for a backwards search),
|
|
Gets the search pattern.
|
|
Return the string text to be searched.
|
|
Returns the last index in the target text at which it matches the search pattern.
The iterator is adjusted so that its current index (as returned by
|
|
Returns the index of the next point at which the string text matches the search pattern, starting from the current position.
The iterator is adjusted so that its current index (as returned by
|
|
Creating a search iterator data struct using the argument locale language rule set.
A collator will be created in the process, which will be owned by this search and will be deleted in
|
|
Creating a search iterator data struct using the argument collator language rule set. Note, user retains the ownership of this collator, thus the responsibility of deletion lies with the user.
|
|
Returns the first index less than
The iterator is adjusted so that its current index (as returned by Search positions that may render incorrect results are highlighted in the header comments. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned
|
|
Returns the index of the previous point at which the string text matches the search pattern, starting at the current position.
The iterator is adjusted so that its current index (as returned by
|
|
Reset the iteration. Search will begin at the start of the text string if a forward iteration is initiated before a backwards iteration. Otherwise if a backwards iteration is initiated before a forwards iteration, the search will begin at the end of the text string.
|
|
Sets the text searching attributes located in the enum USearchAttribute with values from the enum USearchAttributeValue.
|
|
Set the BreakIterator that will be used to restrict the points at which matches are detected.
|
|
Sets the collator used for the language rules. User retains the ownership of this collator, thus the responsibility of deletion lies with the user. This method causes internal data such as Boyer-Moore shift tables to be recalculated, but the iterator's position is unchanged.
|
|
Sets the current position in the text string which the next search will start from. Clears previous states. This method takes the argument index and sets the position in the text string accordingly without checking if the index is pointing to a valid starting point to begin searching. Search positions that may render incorrect results are highlighted in the header comments
|
|
Sets the pattern used for matching. Internal data like the Boyer Moore table will be recalculated, but the iterator's position is unchanged.
|
|
Set the string text to be searched. Text iteration will hence begin at the start of the text string. This method is useful if you want to re-use an iterator to search for the same pattern within a different body of text.
|