PeterO.Text.NormalizerInput

PeterO.Text.NormalizerInput

public sealed class NormalizerInput :
    PeterO.Text.ICharacterInput

A character input class that implements the Unicode normalization algorithm and contains methods and functionality to test and convert text strings for normalization. This is similar to the deprecated Normalizer class, except it implements the ICharacterInput interface.

The Unicode Standard includes characters, such as an acute accent, that can be combined with other characters to make new characters. For example, the letter E combines with an acute accent to make E-acute (É). In some cases, the combined form (E-acute) should be treated as equivalent to the uncombined form (E plus acute). For this reason, the standard defines four normalization forms that convert strings to a single equivalent form:

• NFD (Normalization Form D) decomposes combined forms to their constituent characters (E plus acute, for example), then reorders combining marks to a standardized order. This is called canonical decomposition.

• NFC does canonical decomposition, then combines certain constituent characters to their composites (E-acute, for example). This is called canonical composition.

• Two normalization forms, NFKC and NFKD, are similar to NFC and NFD, except they also "decompose" certain characters, such as ligatures, font or positional variants, and subscripts, whose visual distinction can matter in some contexts. This is called compatibility decomposition.

For more information, see Standard Annex 15 at http://www.unicode.org/reports/tr15/ .

Thread safety: This class is mutable; its properties can be changed. None of its instance methods are designed to be thread safe. Therefore, access to objects from this class must be synchronized if multiple threads can access them at the same time.

NOTICE: While this class's source code is in the public domain, the class uses an internal class, called NormalizationData, that includes data derived from the Unicode Character Database. In case doing so is required, the permission notice for the Unicode Character Database is given here:

COPYRIGHT AND PERMISSION NOTICE.

Copyright (c) 1991-2014 Unicode, Inc. All rights reserved. Distributed under the Terms of Use in http://www.unicode.org/copyright.html.

Permission is hereby granted, free of charge, to any person obtaining a copy of the Unicode data files and any associated documentation (the "Data Files") or Unicode software and any associated documentation (the "Software") to deal in the Data Files or Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Data Files or Software, and to permit persons to whom the Data Files or Software are furnished to do so, provided that (a) this copyright and permission notice appear with all copies of the Data Files or Software, (b) this copyright and permission notice appear in associated documentation, and (c) there is clear notice in each modified Data File or in the Software as well as in the documentation associated with the Data File(s) or Software that the data or software has been modified.

THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA FILES OR SOFTWARE.

Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise to promote the sale, use or other dealings in these Data Files or Software without prior written authorization of the copyright holder.

Member Summary

• IsNormalized(PeterO.Text.ICharacterInput, PeterO.Text.Normalization) - Determines whether the text provided by a character input is normalized.
• IsNormalized(string, PeterO.Text.Normalization) - Determines whether the given string is in the given Unicode normalization form.
• Normalize(string, PeterO.Text.Normalization) - Converts a string to the given Unicode normalization form.
• Read(int[], int, int) - Reads a sequence of Unicode code points from a data source.
• ReadChar() - Reads a Unicode character from a data source.

NormalizerInput Constructor

public NormalizerInput(
    PeterO.Text.ICharacterInput input);

Initializes a new instance of the PeterO.Text.NormalizerInput class using Normalization Form C.

Parameters:

• input: The parameter input is an ICharacterInput object.

NormalizerInput Constructor

public NormalizerInput(
    PeterO.Text.ICharacterInput stream,
    PeterO.Text.Normalization form);

Initializes a new instance of the PeterO.Text.NormalizerInput class.

Parameters:

• stream: The parameter stream is an ICharacterInput object.

• form: Specifies the normalization form to use when normalizing the text.

Exceptions:

• System.ArgumentNullException: The parameter stream is null.

NormalizerInput Constructor

public NormalizerInput(
    string str);

Initializes a new instance of the PeterO.Text.NormalizerInput class using Normalization Form C.

Parameters:

• str: A string specifying the text to normalize.

NormalizerInput Constructor

public NormalizerInput(
    string str,
    int index,
    int length,
    PeterO.Text.Normalization form);

Initializes a new instance of the PeterO.Text.NormalizerInput class. Uses a portion of a string as the input.

Parameters:

• str: The parameter str is a text string.

• index: An index starting at 0 showing where the desired portion of str begins.

• length: The number of elements in the desired portion of str (but not more than str 's length).

• form: Specifies the normalization form to use when normalizing the text.

Exceptions:

• System.ArgumentException: Either index or length is less than 0 or greater than str 's length, or str 's length minus index is less than length .

• System.ArgumentNullException: The parameter str is null.

NormalizerInput Constructor

public NormalizerInput(
    string str,
    PeterO.Text.Normalization form);

Initializes a new instance of the PeterO.Text.NormalizerInput class.

Parameters:

• str: The parameter str is a text string.

• form: Specifies the normalization form to use when normalizing the text.

IsNormalized

public static bool IsNormalized(
    PeterO.Text.ICharacterInput chars,
    PeterO.Text.Normalization form);

Determines whether the text provided by a character input is normalized.

Parameters:

• chars: A object that implements a streamable character input.

• form: Specifies the normalization form to check.

Return Value:

true if the text is normalized; otherwise, false .

Exceptions:

• System.ArgumentNullException: The parameter chars is null.

IsNormalized

public static bool IsNormalized(
    string str,
    PeterO.Text.Normalization form);

Determines whether the given string is in the given Unicode normalization form.

Parameters:

• str: An arbitrary string.

• form: Specifies the normalization form to use when normalizing the text.

Return Value:

true if the given string is in the given Unicode normalization form; otherwise, false . Returns false if the string contains an unpaired surrogate code point.

Exceptions:

• System.ArgumentNullException: The parameter str is null.

Normalize

public static string Normalize(
    string str,
    PeterO.Text.Normalization form);

Converts a string to the given Unicode normalization form.

Parameters:

• str: An arbitrary string.

• form: The Unicode normalization form to convert to.

Return Value:

The parameter str converted to the given normalization form.

Exceptions:

• System.ArgumentException: The parameter str contains an unpaired surrogate code point.

• System.ArgumentNullException: The parameter str is null.

Read

public sealed int Read(
    int[] chars,
    int index,
    int length);

Reads a sequence of Unicode code points from a data source.

Parameters:

• chars: Output buffer.

• index: An index starting at 0 showing where the desired portion of chars begins.

• length: The number of elements in the desired portion of chars (but not more than chars 's length).

Return Value:

The number of Unicode code points read, or 0 if the end of the source is reached.

Exceptions:

• System.ArgumentNullException: The parameter chars is null.

• System.ArgumentException: Either index or length is less than 0 or greater than chars 's length, or chars 's length minus index is less than length .

ReadChar

public sealed int ReadChar();

Reads a Unicode character from a data source.

Return Value:

Either a Unicode code point (from 0-0xd7ff or from 0xe000 to 0x10ffff), or the value -1 indicating the end of the source.

Back to MailLib start page.