ICU 49.1.1  49.1.1
Public Member Functions
FilteredNormalizer2 Class Reference

Normalization filtered by a UnicodeSet. More...

#include <normalizer2.h>

Inheritance diagram for FilteredNormalizer2:
Normalizer2 UObject UMemory

Public Member Functions

 FilteredNormalizer2 (const Normalizer2 &n2, const UnicodeSet &filterSet)
 Constructs a filtered normalizer wrapping any Normalizer2 instance and a filter set.
 ~FilteredNormalizer2 ()
 Destructor.
virtual UnicodeStringnormalize (const UnicodeString &src, UnicodeString &dest, UErrorCode &errorCode) const
 Writes the normalized form of the source string to the destination string (replacing its contents) and returns the destination string.
virtual UnicodeStringnormalizeSecondAndAppend (UnicodeString &first, const UnicodeString &second, UErrorCode &errorCode) const
 Appends the normalized form of the second string to the first string (merging them at the boundary) and returns the first string.
virtual UnicodeStringappend (UnicodeString &first, const UnicodeString &second, UErrorCode &errorCode) const
 Appends the second string to the first string (merging them at the boundary) and returns the first string.
virtual UBool getDecomposition (UChar32 c, UnicodeString &decomposition) const
 Gets the decomposition mapping of c.
virtual UBool getRawDecomposition (UChar32 c, UnicodeString &decomposition) const
 Gets the raw decomposition mapping of c.
virtual UChar32 composePair (UChar32 a, UChar32 b) const
 Performs pairwise composition of a & b and returns the composite if there is one.
virtual uint8_t getCombiningClass (UChar32 c) const
 Gets the combining class of c.
virtual UBool isNormalized (const UnicodeString &s, UErrorCode &errorCode) const
 Tests if the string is normalized.
virtual UNormalizationCheckResult quickCheck (const UnicodeString &s, UErrorCode &errorCode) const
 Tests if the string is normalized.
virtual int32_t spanQuickCheckYes (const UnicodeString &s, UErrorCode &errorCode) const
 Returns the end of the normalized substring of the input string.
virtual UBool hasBoundaryBefore (UChar32 c) const
 Tests if the character always has a normalization boundary before it, regardless of context.
virtual UBool hasBoundaryAfter (UChar32 c) const
 Tests if the character always has a normalization boundary after it, regardless of context.
virtual UBool isInert (UChar32 c) const
 Tests if the character is normalization-inert.

Detailed Description

Normalization filtered by a UnicodeSet.

Normalizes portions of the text contained in the filter set and leaves portions not contained in the filter set unchanged. Filtering is done via UnicodeSet::span(..., USET_SPAN_SIMPLE). Not-in-the-filter text is treated as "is normalized" and "quick check yes". This class implements all of (and only) the Normalizer2 API. An instance of this class is unmodifiable/immutable but is constructed and must be destructed by the owner.

Stable:
ICU 4.4

Definition at line 449 of file normalizer2.h.


Constructor & Destructor Documentation

FilteredNormalizer2::FilteredNormalizer2 ( const Normalizer2 n2,
const UnicodeSet filterSet 
) [inline]

Constructs a filtered normalizer wrapping any Normalizer2 instance and a filter set.

Both are aliased and must not be modified or deleted while this object is used. The filter set should be frozen; otherwise the performance will suffer greatly.

Parameters:
n2wrapped Normalizer2 instance
filterSetUnicodeSet which determines the characters to be normalized
Stable:
ICU 4.4

Definition at line 461 of file normalizer2.h.

FilteredNormalizer2::~FilteredNormalizer2 ( )

Destructor.

Stable:
ICU 4.4

Member Function Documentation

virtual UnicodeString& FilteredNormalizer2::append ( UnicodeString first,
const UnicodeString second,
UErrorCode errorCode 
) const [virtual]

Appends the second string to the first string (merging them at the boundary) and returns the first string.

The result is normalized if both the strings were normalized. The first and second strings must be different objects.

Parameters:
firststring, should be normalized
secondstring, should be normalized
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
first
Stable:
ICU 4.4

Implements Normalizer2.

virtual UChar32 FilteredNormalizer2::composePair ( UChar32  a,
UChar32  b 
) const [virtual]

Performs pairwise composition of a & b and returns the composite if there is one.

For details see the base class documentation.

This function is independent of the mode of the Normalizer2.

Parameters:
aA (normalization starter) code point.
bAnother code point.
Returns:
The non-negative composite code point if there is one; otherwise a negative value.
Draft:
This API may be changed in the future versions and was introduced in ICU 49

Reimplemented from Normalizer2.

virtual uint8_t FilteredNormalizer2::getCombiningClass ( UChar32  c) const [virtual]

Gets the combining class of c.

The default implementation returns 0 but all standard implementations return the Unicode Canonical_Combining_Class value.

Parameters:
ccode point
Returns:
c's combining class
Draft:
This API may be changed in the future versions and was introduced in ICU 49

Reimplemented from Normalizer2.

virtual UBool FilteredNormalizer2::getDecomposition ( UChar32  c,
UnicodeString decomposition 
) const [virtual]

Gets the decomposition mapping of c.

For details see the base class documentation.

This function is independent of the mode of the Normalizer2.

Parameters:
ccode point
decompositionString object which will be set to c's decomposition mapping, if there is one.
Returns:
TRUE if c has a decomposition, otherwise FALSE
Stable:
ICU 4.6

Implements Normalizer2.

virtual UBool FilteredNormalizer2::getRawDecomposition ( UChar32  c,
UnicodeString decomposition 
) const [virtual]

Gets the raw decomposition mapping of c.

For details see the base class documentation.

This function is independent of the mode of the Normalizer2.

Parameters:
ccode point
decompositionString object which will be set to c's raw decomposition mapping, if there is one.
Returns:
TRUE if c has a decomposition, otherwise FALSE
Draft:
This API may be changed in the future versions and was introduced in ICU 49

Reimplemented from Normalizer2.

virtual UBool FilteredNormalizer2::hasBoundaryAfter ( UChar32  c) const [virtual]

Tests if the character always has a normalization boundary after it, regardless of context.

For details see the Normalizer2 base class documentation.

Parameters:
ccharacter to test
Returns:
TRUE if c has a normalization boundary after it
Stable:
ICU 4.4

Implements Normalizer2.

virtual UBool FilteredNormalizer2::hasBoundaryBefore ( UChar32  c) const [virtual]

Tests if the character always has a normalization boundary before it, regardless of context.

For details see the Normalizer2 base class documentation.

Parameters:
ccharacter to test
Returns:
TRUE if c has a normalization boundary before it
Stable:
ICU 4.4

Implements Normalizer2.

virtual UBool FilteredNormalizer2::isInert ( UChar32  c) const [virtual]

Tests if the character is normalization-inert.

For details see the Normalizer2 base class documentation.

Parameters:
ccharacter to test
Returns:
TRUE if c is normalization-inert
Stable:
ICU 4.4

Implements Normalizer2.

virtual UBool FilteredNormalizer2::isNormalized ( const UnicodeString s,
UErrorCode errorCode 
) const [virtual]

Tests if the string is normalized.

For details see the Normalizer2 base class documentation.

Parameters:
sinput string
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
TRUE if s is normalized
Stable:
ICU 4.4

Implements Normalizer2.

virtual UnicodeString& FilteredNormalizer2::normalize ( const UnicodeString src,
UnicodeString dest,
UErrorCode errorCode 
) const [virtual]

Writes the normalized form of the source string to the destination string (replacing its contents) and returns the destination string.

The source and destination strings must be different objects.

Parameters:
srcsource string
destdestination string; its contents is replaced with normalized src
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
dest
Stable:
ICU 4.4

Implements Normalizer2.

virtual UnicodeString& FilteredNormalizer2::normalizeSecondAndAppend ( UnicodeString first,
const UnicodeString second,
UErrorCode errorCode 
) const [virtual]

Appends the normalized form of the second string to the first string (merging them at the boundary) and returns the first string.

The result is normalized if the first string was normalized. The first and second strings must be different objects.

Parameters:
firststring, should be normalized
secondstring, will be normalized
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
first
Stable:
ICU 4.4

Implements Normalizer2.

virtual UNormalizationCheckResult FilteredNormalizer2::quickCheck ( const UnicodeString s,
UErrorCode errorCode 
) const [virtual]

Tests if the string is normalized.

For details see the Normalizer2 base class documentation.

Parameters:
sinput string
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
UNormalizationCheckResult
Stable:
ICU 4.4

Implements Normalizer2.

virtual int32_t FilteredNormalizer2::spanQuickCheckYes ( const UnicodeString s,
UErrorCode errorCode 
) const [virtual]

Returns the end of the normalized substring of the input string.

For details see the Normalizer2 base class documentation.

Parameters:
sinput string
errorCodeStandard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
"yes" span end index
Stable:
ICU 4.4

Implements Normalizer2.


The documentation for this class was generated from the following file: