organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-17 02:37:25 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 8

ICU-1030

Browse source 
Added @draft to documentation.

X-SVN-Rev: 6480
This commit is contained in:
Syn Wee Quek 2001-10-29 22:26:32 +00:00
parent 3784bba968
commit 1d40137fb2
3 changed files with 70 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
icu4c/source/i18n/unicode/search.h
View file

@ -72,11 +72,13 @@ public:
* Copy constructor that creates a SearchIterator instance with the same
* behavior, and iterating over the same text.
* @param other the SearchIterator instance to be copied.
* @draft ICU 2.0
*/
SearchIterator(const SearchIterator &other);
/**
* Destructor. Cleans up the search iterator data struct.
* @draft ICU 2.0
*/
virtual ~SearchIterator();
@ -91,6 +93,7 @@ public:
* valid starting point to begin searching.
* @param position within the text to be set
* @param status for errors if it occurs
* @draft ICU 2.0
*/
virtual void setOffset(UTextOffset position, UErrorCode &status) = 0;
@ -100,6 +103,7 @@ public:
* (or past the beginning for a backwards search), {@link #USEARCH_DONE}
* is returned.
* @return current index in the text being searched.
* @draft ICU 2.0
*/
virtual UTextOffset getOffset(void) const = 0;
@ -110,6 +114,7 @@ public:
* @param attribute text attribute (enum USearchAttribute) to be set
* @param value text attribute value
* @param status for errors if it occurs
* @draft ICU 2.0
*/
void setAttribute(USearchAttribute attribute,
USearchAttributeValue value,
@ -119,6 +124,7 @@ public:
* Gets the text searching attributes
* @param attribute text attribute (enum USearchAttribute) to be retrieve
* @return text attribute value
* @draft ICU 2.0
*/
USearchAttributeValue getAttribute(USearchAttribute attribute) const;
@ -132,6 +138,7 @@ public:
* Use getMatchedLength to get the matched string length.
* @return index of a substring within the text string that is being
* searched.
* @draft ICU 2.0
*/
UTextOffset getMatchedStart(void) const;
@ -143,6 +150,7 @@ public:
* <tt>USEARCH_DONE</tt>, this method will return 0.
* @return The length of the match in the target text, or 0 if there
* is no match currently.
* @draft ICU 2.0
*/
int32_t getMatchedLength(void) const;
@ -154,6 +162,7 @@ public:
* returns an empty string.
* @param result stores the matched string or an empty string if a match
* is not found.
* @draft ICU 2.0
*/
void getMatchedText(UnicodeString &result) const;
@ -168,7 +177,8 @@ public:
* the match will be rejected and another will be searched
* for. If this parameter is <tt>NULL</tt>, no break
* detection is attempted.
* @param status for errors if it occurs
* @param status for errors if it occurs
* @draft ICU 2.0
*/
void setBreakIterator(BreakIterator *breakiter, UErrorCode &status);
@ -179,6 +189,7 @@ public:
* Note that <tt>NULL</tt> is a legal value; it means that break
* detection should not be attempted.
* @return BreakIterator used to restrict matchings.
* @draft ICU 2.0
*/
const BreakIterator * getBreakIterator(void) const;
@ -190,6 +201,7 @@ public:
* @param text string to be searched.
* @param status for errors. If the text length is 0,
* an U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
virtual void setText(const UnicodeString &text, UErrorCode &status);
@ -206,12 +218,14 @@ public:
* @param text string iterator to be searched.
* @param status for errors if any. If the text length is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
virtual void setText(CharacterIterator &text, UErrorCode &status);
/**
* Return the string text to be searched.
* @return text string to be searched.
* @draft ICU 2.0
*/
const UnicodeString & getText(void) const;
@ -223,6 +237,7 @@ public:
* @return TRUE if both BreakIterators are of the same class, have the
* same behavior, terates over the same text and have the same
* attributes. FALSE otherwise.
* @draft ICU 2.0
*/
virtual UBool operator==(const SearchIterator &that) const;
@ -230,6 +245,7 @@ public:
* Not-equal operator.
* @param that SearchIterator instance to be compared.
* @return FALSE if operator== returns TRUE, and vice versa.
* @draft ICU 2.0
*/
UBool operator!=(const SearchIterator &that) const;
@ -240,6 +256,7 @@ public:
* iterating over the same text, as this one. Note that all data will be
* replicated, except for the text string to be searched.
* @return cloned object
* @draft ICU 2.0
*/
virtual SearchIterator* safeClone(void) const = 0;
@ -253,6 +270,7 @@ public:
* @param status for errors if it occurs
* @return The character index of the first match, or
* <tt>USEARCH_DONE</tt> if there are no matches.
* @draft ICU 2.0
*/
UTextOffset first(UErrorCode &status);
@ -268,6 +286,7 @@ public:
* @return The character index of the first match following
* <tt>position</tt>, or <tt>USEARCH_DONE</tt> if there are no
* matches.
* @draft ICU 2.0
*/
UTextOffset following(UTextOffset position, UErrorCode &status);
@ -281,6 +300,7 @@ public:
* @param status for errors if it occurs
* @return The index of the first match, or <tt>USEARCH_DONE</tt> if
* there are no matches.
* @draft ICU 2.0
*/
UTextOffset last(UErrorCode &status);
@ -296,6 +316,7 @@ public:
* @return The character index of the first match preceding
* <tt>position</tt>, or <tt>USEARCH_DONE</tt> if there are
* no matches.
* @draft ICU 2.0
*/
UTextOffset preceding(UTextOffset position, UErrorCode &status);
@ -310,6 +331,7 @@ public:
* @param status for errors if it occurs
* @return The index of the next match after the current position,
* or <tt>USEARCH_DONE</tt> if there are no more matches.
* @draft ICU 2.0
*/
UTextOffset next(UErrorCode &status);
@ -323,6 +345,7 @@ public:
* @param status for errors if it occurs
* @return The index of the previous match before the current position,
* or <tt>USEARCH_DONE</tt> if there are no more matches.
* @draft ICU 2.0
*/
UTextOffset previous(UErrorCode &status);
@ -332,6 +355,7 @@ public:
* 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.
* @draft ICU 2.0
*/
virtual void reset();

19
icu4c/source/i18n/unicode/stsearch.h
View file

@ -112,6 +112,7 @@ U_NAMESPACE_BEGIN
* </code></pre>
* @see SearchIterator
* @see RuleBasedCollator
* @since ICU 2.0
*/
class U_I18N_API StringSearch : public SearchIterator
@ -139,6 +140,7 @@ public:
* @param status for errors if any. If pattern or text is NULL, or if
* either the length of pattern or text is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
StringSearch(const UnicodeString &pattern, const UnicodeString &text,
const Locale &locale,
@ -164,6 +166,7 @@ public:
* <tt>NULL</tt> can be passed in instead.
* @param status for errors if any. If either the length of pattern or
* text is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
StringSearch(const UnicodeString &pattern,
const UnicodeString &text,
@ -194,6 +197,7 @@ public:
* <tt>NULL</tt> can be passed in instead.
* @param status for errors if any. If either the length of pattern or
* text is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
StringSearch(const UnicodeString &pattern, CharacterIterator &text,
const Locale &locale,
@ -223,6 +227,7 @@ public:
* <tt>NULL</tt> can be passed in instead.
* @param status for errors if any. If either the length of pattern or
* text is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
StringSearch(const UnicodeString &pattern, CharacterIterator &text,
RuleBasedCollator *coll,
@ -233,12 +238,14 @@ public:
* Copy constructor that creates a StringSearch instance with the same
* behavior, and iterating over the same text.
* @param that StringSearch instance to be copied.
* @draft ICU 2.0
*/
StringSearch(const StringSearch &that);
/**
* Destructor. Cleans up the search iterator data struct.
* If a collator is created in the constructor, it will be destroyed here.
* @draft ICU 2.0
*/
virtual ~StringSearch(void);
@ -248,6 +255,7 @@ public:
* Assignment operator. Sets this iterator to have the same behavior,
* and iterate over the same text, as the one passed in.
* @param that instance to be copied.
* @draft ICU 2.0
*/
StringSearch & operator=(const StringSearch &that);
@ -257,6 +265,7 @@ public:
* @return TRUE if both instances have the same attributes,
* breakiterators, collators and iterate over the same text
* while looking for the same pattern.
* @draft ICU 2.0
*/
virtual UBool operator==(const SearchIterator &that) const;
@ -271,6 +280,7 @@ public:
* valid starting point to begin searching.
* @param position within the text to be set
* @param status for errors if it occurs
* @draft ICU 2.0
*/
virtual void setOffset(UTextOffset position, UErrorCode &status);
@ -280,6 +290,7 @@ public:
* (or past the beginning for a backwards search), {@link #USEARCH_DONE}
* is returned.
* @return current index in the text being searched.
* @draft ICU 2.0
*/
virtual UTextOffset getOffset(void) const;
@ -292,6 +303,7 @@ public:
* @param text text string to be searched
* @param status for errors if any. If the text length is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
virtual void setText(const UnicodeString &text, UErrorCode &status);
@ -307,6 +319,7 @@ public:
* @param text text string to be searched
* @param status for errors if any. If the text length is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
virtual void setText(CharacterIterator &text, UErrorCode &status);
@ -317,6 +330,7 @@ public:
* the destructor would cause the string search to fail.
* The destructor will delete the collator if this instance owns it
* @return collator used for string search
* @draft ICU 2.0
*/
RuleBasedCollator * getCollator() const;
@ -328,6 +342,7 @@ public:
* unchanged.
* @param coll collator
* @param status for errors if any
* @draft ICU 2.0
*/
void setCollator(RuleBasedCollator *coll, UErrorCode &status);
@ -338,12 +353,14 @@ public:
* @param pattern search pattern to be found
* @param status for errors if any. If the pattern length is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
* @draft ICU 2.0
*/
void setPattern(const UnicodeString &pattern, UErrorCode &status);
/**
* Gets the search pattern.
* @return pattern used for matching
* @draft ICU 2.0
*/
const UnicodeString & getPattern() const;
@ -355,6 +372,7 @@ public:
* 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.
* @draft ICU 2.0
*/
virtual void reset();
@ -364,6 +382,7 @@ public:
* replicated, except for the user-specified collator and the
* breakiterator.
* @return cloned object
* @draft ICU 2.0
*/
virtual SearchIterator * safeClone(void) const;

26
icu4c/source/i18n/unicode/usearch.h
View file

@ -114,6 +114,7 @@
* }
* }
* </code></pre>
* @since ICU 2.0
*/
/**
@ -171,6 +172,7 @@ typedef enum {
* patternlength or textlength is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
* @return search iterator data structure, or NULL if there is an error.
* @draft ICU 2.0
*/
U_CAPI UStringSearch * U_EXPORT2 usearch_open(const UChar *pattern,
int32_t patternlength,
@ -200,6 +202,7 @@ U_CAPI UStringSearch * U_EXPORT2 usearch_open(const UChar *pattern,
* or if patternlength or textlength is 0 then an
* U_ILLEGAL_ARGUMENT_ERROR is returned.
* @return search iterator data structure, or NULL if there is an error.
* @draft ICU 2.0
*/
U_CAPI UStringSearch * U_EXPORT2 usearch_openFromCollator(
const UChar *pattern,
@ -214,6 +217,7 @@ U_CAPI UStringSearch * U_EXPORT2 usearch_openFromCollator(
* Destroying and cleaning up the search iterator data struct.
* If a collator is created in usearch_open, it will be destroyed here.
* @param searchiter data struct to clean up
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_close(UStringSearch *strsrch);
@ -230,6 +234,7 @@ U_CAPI void U_EXPORT2 usearch_close(UStringSearch *strsrch);
* @param strsrch search iterator data struct
* @param position position to start next search from.
* @param status error status if any.
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_setOffset(UStringSearch *strsrch,
UTextOffset position,
@ -240,6 +245,7 @@ U_CAPI void U_EXPORT2 usearch_setOffset(UStringSearch *strsrch,
* If the iteration has gone past the end of the text (or past the beginning
* for a backwards search), {@link #USEARCH_DONE} is returned.
* @param strsrch search iterator data struct
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_getOffset(const UStringSearch *strsrch);
@ -252,6 +258,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_getOffset(const UStringSearch *strsrch);
* @param value text attribute value
* @param status for errors if it occurs
* @see #usearch_getAttribute
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_setAttribute(UStringSearch *strsrch,
USearchAttribute attribute,
@ -264,6 +271,7 @@ U_CAPI void U_EXPORT2 usearch_setAttribute(UStringSearch *strsrch,
* @param attribute text attribute to be retrieve
* @return text attribute value
* @see #usearch_setAttribute
* @draft ICU 2.0
*/
U_CAPI USearchAttributeValue U_EXPORT2 usearch_getAttribute(
const UStringSearch *strsrch,
@ -281,6 +289,7 @@ U_CAPI USearchAttributeValue U_EXPORT2 usearch_getAttribute(
* @param strsrch search iterator data struct
* @return index to a substring within the text string that is being
* searched.
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_getMatchedStart(
const UStringSearch *strsrch);
@ -295,6 +304,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_getMatchedStart(
* @param strsrch search iterator data struct
* @return The length of the match in the string text, or 0 if there is no
* match currently.
* @draft ICU 2.0
*/
U_CAPI int32_t U_EXPORT2 usearch_getMatchedLength(
const UStringSearch *strsrch);
@ -317,6 +327,7 @@ U_CAPI int32_t U_EXPORT2 usearch_getMatchedLength(
* @param resultCapacity length of the result buffer
* @param status error returned if result is not large enough
* @return exact length of the matched text, not counting the null-termination
* @draft ICU 2.0
*/
U_CAPI int32_t U_EXPORT2 usearch_getMatchedText(const UStringSearch *strsrch,
UChar *result,
@ -336,6 +347,7 @@ U_CAPI int32_t U_EXPORT2 usearch_getMatchedText(const UStringSearch *strsrch,
* attempted.
* @param status for errors if it occurs
* @see #usearch_getBreakIterator
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_setBreakIterator(UStringSearch *strsrch,
UBreakIterator *breakiter,
@ -350,6 +362,7 @@ U_CAPI void U_EXPORT2 usearch_setBreakIterator(UStringSearch *strsrch,
* @param strsrch search iterator data struct
* @return break iterator used
* @see #usearch_setBreakIterator
* @draft ICU 2.0
*/
U_CAPI const UBreakIterator * U_EXPORT2 usearch_getBreakIterator(
const UStringSearch *strsrch);
@ -365,6 +378,7 @@ U_CAPI const UBreakIterator * U_EXPORT2 usearch_getBreakIterator(
* then an U_ILLEGAL_ARGUMENT_ERROR is returned with no change
* done to strsrch.
* @see #usearch_getText
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_setText( UStringSearch *strsrch,
const UChar *text,
@ -377,6 +391,7 @@ U_CAPI void U_EXPORT2 usearch_setText( UStringSearch *strsrch,
* @param length returned string text length
* @return string text
* @see #usearch_setText
* @draft ICU 2.0
*/
U_CAPI const UChar * U_EXPORT2 usearch_getText(const UStringSearch *strsrch,
int32_t *length);
@ -389,6 +404,7 @@ U_CAPI const UChar * U_EXPORT2 usearch_getText(const UStringSearch *strsrch,
* <tt>usearch_close</tt> will delete the collator if this search owns it.
* @param strsrch search iterator data struct
* @return collator
* @draft ICU 2.0
*/
U_CAPI UCollator * U_EXPORT2 usearch_getCollator(
const UStringSearch *strsrch);
@ -401,6 +417,7 @@ U_CAPI UCollator * U_EXPORT2 usearch_getCollator(
* @param strsrch search iterator data struct
* @param collator to be used
* @param status for errors if it occurs
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_setCollator( UStringSearch *strsrch,
const UCollator *collator,
@ -416,6 +433,7 @@ U_CAPI void U_EXPORT2 usearch_setCollator( UStringSearch *strsrch,
* @param status for errors if it occurs. If text is NULL, or textlength is 0
* then an U_ILLEGAL_ARGUMENT_ERROR is returned with no change
* done to strsrch.
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_setPattern( UStringSearch *strsrch,
const UChar *pattern,
@ -428,6 +446,7 @@ U_CAPI void U_EXPORT2 usearch_setPattern( UStringSearch *strsrch,
* @param length return length of the pattern, -1 indicates that the pattern
* is null-terminated
* @return pattern string
* @draft ICU 2.0
*/
U_CAPI const UChar * U_EXPORT2 usearch_getPattern(
const UStringSearch *strsrch,
@ -446,6 +465,7 @@ U_CAPI const UChar * U_EXPORT2 usearch_getPattern(
* @param status for errors if it occurs
* @return The character index of the first match, or
* <tt>USEARCH_DONE</tt> if there are no matches.
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_first(UStringSearch *strsrch,
UErrorCode *status);
@ -466,6 +486,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_first(UStringSearch *strsrch,
* @param status for errors if it occurs
* @return The character index of the first match following <tt>pos</tt>,
* or <tt>USEARCH_DONE</tt> if there are no matches.
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_following(UStringSearch *strsrch,
UTextOffset position,
@ -482,6 +503,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_following(UStringSearch *strsrch,
* @param status for errors if it occurs
* @return The index of the first match, or <tt>USEARCH_DONE</tt> if there
* are no matches.
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_last(UStringSearch *strsrch,
UErrorCode *status);
@ -501,6 +523,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_last(UStringSearch *strsrch,
* @param status for errors if it occurs
* @return The character index of the first match preceding <tt>pos</tt>,
* or <tt>USEARCH_DONE</tt> if there are no matches.
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_preceding(UStringSearch *strsrch,
UTextOffset position,
@ -519,6 +542,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_preceding(UStringSearch *strsrch,
* @return The index of the next match after the current position, or
* <tt>USEARCH_DONE</tt> if there are no more matches.
* @see #usearch_first
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_next(UStringSearch *strsrch,
UErrorCode *status);
@ -535,6 +559,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_next(UStringSearch *strsrch,
* @param status for errors if it occurs
* @return The index of the previous match before the current position,
* or <tt>USEARCH_DONE</tt> if there are no more matches.
* @draft ICU 2.0
*/
U_CAPI UTextOffset U_EXPORT2 usearch_previous(UStringSearch *strsrch,
UErrorCode *status);
@ -546,6 +571,7 @@ U_CAPI UTextOffset U_EXPORT2 usearch_previous(UStringSearch *strsrch,
* iteration is initiated before a forwards iteration, the search will begin
* at the end of the text string.
* @param strsrch search iterator data struct
* @draft ICU 2.0
*/
U_CAPI void U_EXPORT2 usearch_reset(UStringSearch *strsrch);