Movatterモバイル変換

If DONE is returned from an iteration function that returns a code point, then there are no more normalization results available.

Deprecated:

ICU 56 UseNormalizer2 instead.

Definition at line144 of filenormlzr.h.

Creates a newNormalizer object for iterating over the normalized form of a given string.

Parameters

str	The string to be normalized. The normalization will start at the beginning of the string.
mode	The normalization mode.

Deprecated:

ICU 56 UseNormalizer2 instead.

Creates a newNormalizer object for iterating over the normalized form of a given string.

Parameters

str	The string to be normalized. The normalization will start at the beginning of the string.
length	Length of the string, or -1 if NUL-terminated.
mode	The normalization mode.

Deprecated:

ICU 56 UseNormalizer2 instead.

Creates a newNormalizer object for iterating over the normalized form of the given text.

Parameters

iter	The input text to be normalized. The normalization will start at the beginning of the string.
mode	The normalization mode.

Deprecated:

ICU 56 UseNormalizer2 instead.

Copy constructor.

Parameters

copy	The object to be copied.

Deprecated:

ICU 56 UseNormalizer2 instead.

Destructor.

Deprecated:

ICU 56 UseNormalizer2 instead.

Returns a pointer to a newNormalizer that is a clone of this one.

The caller is responsible for deleting the new clone.

Returns

a pointer to a newNormalizer

Deprecated:

ICU 56 UseNormalizer2 instead.

Compare two strings for canonical equivalence.

Further options include case-insensitive comparison and code point order (as opposed to code unit order).

Canonical equivalence between two strings is defined as their normalized forms (NFD or NFC) being identical. This function compares strings incrementally instead of normalizing (and optionally case-folding) both strings entirely, improving performance significantly.

Bulk normalization is only necessary if the strings do not fulfill the FCD conditions. Only in this case, and only if the strings are relatively long, is memory allocated temporarily. For FCD strings and short non-FCD strings there is no memory allocation.

Semantically, this is equivalent to strcmp[CodePointOrder](NFD(foldCase(s1)), NFD(foldCase(s2))) where code point order and foldCase are all optional.

UAX 21 2.5 Caseless Matching specifies that for a canonical caseless match the case folding must be performed first, then the normalization.

Parameters

s1	First source string.
s2	Second source string.
options	A bit set of options: U_FOLD_CASE_DEFAULT or 0 is used for default options: Case-sensitive comparison in code unit order, and the input strings are quick-checked for FCD. UNORM_INPUT_IS_FCD Set if the caller knows that both s1 and s2 fulfill the FCD conditions. If not set, the function will quickCheck for FCD and normalize if necessary. U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details). U_COMPARE_IGNORE_CASE Set to compare strings case-insensitively using case folding, instead of case-sensitively. If set, then the following case folding options are used. Options as used with case-insensitive comparisons, currently: U_FOLD_CASE_EXCLUDE_SPECIAL_I (see u_strCaseCompare for details) regular normalization options shifted left by UNORM_COMPARE_NORM_OPTIONS_SHIFT
errorCode	ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns

<0 or 0 or >0 as usual for string comparisons

See also

unorm_compare

normalize

UNORM_FCD

u_strCompare

u_strCaseCompare

Stable:

ICU 2.2

Definition at line800 of filenormlzr.h.

Referencesicu::UnicodeString::getBuffer(),icu::UnicodeString::length(), andunorm_compare().

Compose aUnicodeString.

This is equivalent tonormalize() with mode UNORM_NFC or UNORM_NFKC. This is a wrapper forunorm_normalize(), usingUnicodeString's.

Theoptions parameter specifies which optionalNormalizer features are to be enabled for this operation.

Parameters

source	the string to be composed.
compat	Perform compatibility decomposition before composition. If this argument isfalse, only canonical decomposition will be performed.
options	the optional features to be enabled (0 for no options)
result	The composed string (on output).
status	The error code.

Deprecated:

ICU 56 UseNormalizer2 instead.

Concatenate normalized strings, making sure that the result is normalized as well.

If both the left and the right strings are in the normalization form according to "mode/options", then the result will be

For details see unorm_concatenate inunorm.h.

Parameters

left	Left source string.
right	Right source string.
result	The output string.
mode	The normalization mode.
options	A bit set of normalization options.
errorCode	ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns

result

See also

unorm_concatenate

normalize

unorm_next

unorm_previous

Deprecated:

ICU 56 UseNormalizer2 instead.

Return the current character in the normalized text.

current() may need to normalize some text atgetIndex(). ThegetIndex() is not changed.

Returns

the current normalized code point

Deprecated:

ICU 56 UseNormalizer2 instead.

Static method to decompose aUnicodeString.

This is equivalent tonormalize() with mode UNORM_NFD or UNORM_NFKD. This is a wrapper forunorm_normalize(), usingUnicodeString's.

Theoptions parameter specifies which optionalNormalizer features are to be enabled for this operation.

Parameters

source	the string to be decomposed.
compat	Perform compatibility decomposition. If this argument isfalse, only canonical decomposition will be performed.
options	the optional features to be enabled (0 for no options)
result	The decomposed string (on output).
status	The error code.

Deprecated:

ICU 56 UseNormalizer2 instead.

Retrieve the index of the end of the input text.

This is the end index of theCharacterIterator or the length of the string over which thisNormalizer is iterating. This end index is exclusive, i.e., theNormalizer operates only on characters before this index.

Returns

the first index in the input text where theNormalizer does not operate

Deprecated:

ICU 56 UseNormalizer2 instead.

Return the first character in the normalized text.

This is equivalent to setIndexOnly(startIndex()) followed bynext(). (Post-increment semantics.)

Returns

the first normalized code point

Deprecated:

ICU 56 UseNormalizer2 instead.

ICU "poor man's RTTI", returns a UClassID for the actual class.

Returns

a UClassID for the actual class.

Deprecated:

ICU 56 UseNormalizer2 instead.

Reimplemented fromicu::UObject.

Retrieve the current iteration position in the input text that is being normalized.

A following call tonext() will return a normalized code point from the input text at or after this index.

After a call toprevious(),getIndex() will point at or before the position in the input text where the normalized code point was returned from withprevious().

Returns

the current index in the input text

Deprecated:

ICU 56 UseNormalizer2 instead.

Determine whether an option is turned on or off.

If multiple options are specified, then the result is true if any of them are set.

Parameters

option

the option(s) that are to be checked

Returns

true if any of the option(s) are set

See also

setOption

Deprecated:

ICU 56 UseNormalizer2 instead.

ICU "poor man's RTTI", returns a UClassID for this class.

Returns

a UClassID for this class.

Deprecated:

ICU 56 UseNormalizer2 instead.

Copies the input text into theUnicodeString argument.

Parameters

result

Receives a copy of the text under iteration.

Deprecated:

ICU 56 UseNormalizer2 instead.

Return the normalization mode for this object.

This is an unusual name because there used to be a getMode() that returned a different type.

Returns

the mode for thisNormalizer

See also

setMode

Deprecated:

ICU 56 UseNormalizer2 instead.

Generates a hash code for this iterator.

Returns

the hash code

Deprecated:

ICU 56 UseNormalizer2 instead.

Test if a string is in a given normalization form; same as the other version of isNormalized but takes an extra options parameter like most normalization functions.

Parameters

src	String that is to be tested if it is in a normalization format.
mode	Which normalization form to test for.
options	the optional features to be enabled (0 for no options)
errorCode	ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns

Boolean value indicating whether the source string is in the "mode" normalization form.

See also

quickCheck

Deprecated:

ICU 56 UseNormalizer2 instead.

Test if a string is in a given normalization form.

This is semantically equivalent to source.equals(normalize(source, mode)) .

Unlikeunorm_quickCheck(), this function returns a definitive result, never a "maybe". For NFD, NFKD, and FCD, both functions work exactly the same. For NFC and NFKC where quickCheck may return "maybe", this function will perform further tests to arrive at a true/false result.

Parameters

src	String that is to be tested if it is in a normalization format.
mode	Which normalization form to test for.
errorCode	ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call.

Returns

Boolean value indicating whether the source string is in the "mode" normalization form.

See also

quickCheck

Deprecated:

ICU 56 UseNormalizer2 instead.

Definition at line792 of filenormlzr.h.

Return the last character in the normalized text.

This is equivalent to setIndexOnly(endIndex()) followed byprevious(). (Pre-decrement semantics.)

Returns

the last normalized code point

Deprecated:

ICU 56 UseNormalizer2 instead.

Return the next character in the normalized text.

(Post-increment semantics.) If the end of the text has already been reached, DONE is returned. The DONE value could be confused with a U+FFFF non-character code point in the text. If this is possible, you can testgetIndex()<endIndex() before callingnext(), or (getIndex()<endIndex() ||last()!=DONE) after callingnext(). (Callinglast() will change the iterator state!)

The C APIunorm_next() is more efficient and does not have this ambiguity.

Returns

the next normalized code point

Deprecated:

ICU 56 UseNormalizer2 instead.

Normalizes aUnicodeString according to the specified normalization mode.

This is a wrapper forunorm_normalize(), usingUnicodeString's.

Theoptions parameter specifies which optionalNormalizer features are to be enabled for this operation.

Parameters

source	the input string to be normalized.
mode	the normalization mode
options	the optional features to be enabled (0 for no options)
result	The normalized string (on output).
status	The error code.

Deprecated:

ICU 56 UseNormalizer2 instead.

Returns false when both iterators refer to the same character in the same input text.

Parameters

that	aNormalizer object to compare this one to

Returns

comparison result

Deprecated:

ICU 56 UseNormalizer2 instead.

Definition at line781 of filenormlzr.h.

Referencesicu::operator==().

Returns true when both iterators refer to the same character in the same input text.

Parameters

that	aNormalizer object to compare this one to

Returns

comparison result

Deprecated:

ICU 56 UseNormalizer2 instead.

Return the previous character in the normalized text and decrement.

(Pre-decrement semantics.) If the beginning of the text has already been reached, DONE is returned. The DONE value could be confused with a U+FFFF non-character code point in the text. If this is possible, you can test (getIndex()>startIndex() ||first()!=DONE). (Callingfirst() will change the iterator state!)

The C APIunorm_previous() is more efficient and does not have this ambiguity.

Returns

the previous normalized code point

Deprecated:

ICU 56 UseNormalizer2 instead.

Performing quick check on a string; same as the other version of quickCheck but takes an extra options parameter like most normalization functions.

Parameters

source	string for determining if it is in a normalized format
mode	normalization format
options	the optional features to be enabled (0 for no options)
status	A reference to a UErrorCode to receive any errors

Returns

UNORM_YES, UNORM_NO or UNORM_MAYBE

See also

isNormalized

Deprecated:

ICU 56 UseNormalizer2 instead.

Performing quick check on a string, to quickly determine if the string is in a particular normalization format.

This is a wrapper forunorm_quickCheck(), using aUnicodeString.

Three types of result can be returned UNORM_YES, UNORM_NO or UNORM_MAYBE. Result UNORM_YES indicates that the argument string is in the desired normalized format, UNORM_NO determines that argument string is not in the desired normalized format. A UNORM_MAYBE result indicates that a more thorough check is required, the user may have to put the string in its normalized form and compare the results.

Parameters

source	string for determining if it is in a normalized format
mode	normalization format
status	A reference to a UErrorCode to receive any errors

Returns

UNORM_YES, UNORM_NO or UNORM_MAYBE

See also

isNormalized

Deprecated:

ICU 56 UseNormalizer2 instead.

Definition at line785 of filenormlzr.h.

Reset the index to the beginning of the text.

This is equivalent to setIndexOnly(startIndex)).

Deprecated:

ICU 56 UseNormalizer2 instead.

Set the iteration position in the input text that is being normalized, without any immediate normalization.

AftersetIndexOnly(),getIndex() will return the same index that is specified here.

Parameters

index

the desired index in the input text.

Deprecated:

ICU 56 UseNormalizer2 instead.

Set the normalization mode for this object.

Note:If the normalization mode is changed while iterating over a string, calls tonext() andprevious() may return previously buffers characters in the old normalization mode until the iteration is able to re-sync at the next base character. It is safest to callsetIndexOnly,reset(),setText,first(),last(), etc. after callingsetMode.

Parameters

newMode

the new mode for thisNormalizer.

See also

getUMode

Deprecated:

ICU 56 UseNormalizer2 instead.

Set options that affect thisNormalizer's operation.

Options do not change the basic composition or decomposition operation that is being performed, but they control whether certain optional portions of the operation are done. Currently the only available option is obsolete.

It is possible to specify multiple options that are all turned on or off.

Parameters

option	the option(s) whose value is/are to be set.
value	the new setting for the option. Usetrue to turn the option(s) on andfalse to turn it/them off.

See also

getOption

Deprecated:

ICU 56 UseNormalizer2 instead.

Set the input text over which thisNormalizer will iterate.

The iteration position is set to the beginning.

Parameters

newText	aCharacterIterator object that replaces the current input text
status	a UErrorCode

Deprecated:

ICU 56 UseNormalizer2 instead.

Set the input text over which thisNormalizer will iterate.

The iteration position is set to the beginning.

Parameters

newText	a string that replaces the current input text
status	a UErrorCode

Deprecated:

ICU 56 UseNormalizer2 instead.

Set the input text over which thisNormalizer will iterate.

The iteration position is set to the beginning.

Parameters

newText	a string that replaces the current input text
length	the length of the string, or -1 if NUL-terminated
status	a UErrorCode

Deprecated:

ICU 56 UseNormalizer2 instead.

Retrieve the index of the start of the input text.

This is the begin index of theCharacterIterator or the start (i.e. index 0) of the string over which thisNormalizer is iterating.

Returns

the smallest index in the input text where theNormalizer operates

Deprecated:

ICU 56 UseNormalizer2 instead.