UtfString Namespace Reference

Classes
class	GlobalFunctions
class	UnicodeChar
	Represents a Unicode character in an encoding-neutral way. More...
class	UnicodeCharReference
	Provides a reference to an encoding-neutral Unicode character embedded in an encoding-neutral Unicode string. More...
class	UnicodeString
	Contains and manages an encoding-neutral Unicode string. More...
class	Utf16Char
	Provides a copy of a UTF-16 character embedded in a UTF-16 string. More...
class	Utf16CharReference
	Provides a reference to a UTF-16 character embedded in a UTF-16 string. More...
struct	Utf16String
	Contains and manages a UTF-16 string. More...
class	Utf8Char
	Provides a copy of a UTF-8 character embedded in a UTF-8 string. More...
class	Utf8CharReference
	Provides a reference to a UTF-8 character embedded in a UTF-8 string. More...
struct	Utf8String
	Contains and manages a UTF-8 string. More...
class	UtfStringConverter

Enumerations
enum	UtfBOM {   BOM_UTF8 = 0xEFBBBF, BOM_UTF16BE = 0xFEFF, BOM_UTF16LE = 0xFFFE, BOM_UTF32BE = 0x0000FEFF,   BOM_UTF32LE = 0xFFFE0000 }
enum	UtfEncoding { ENCODING_NONE, ENCODING_UTF8, ENCODING_UTF16 }
enum	Utf16SurrogateBaseNumbers { HighCodeUnitBaseNumber = 0xD800, LowCodeUnitBaseNumber = 0xDC00 }
enum	Utf16SurrogateRange { HighCodeUnitRangeBegin = 0xD800, HighCodeUnitRangeEnd = 0xDBFF, LowCodeUnitRangeBegin = 0xDC00, LowCodeUnitRangeEnd = 0xDFFF }
enum	CodeUnitMax { Utf8CodeUnitMax = 4, Utf16CodeUnitMax = 2 }

Detailed Description

The UtfString namespace contains all the classes, enumerations, constants, etc. used in the UtfString library

Enumeration Type Documentation

enum UtfString::CodeUnitMax

Describes maximum number of code units that can comprise a character in various different encodings

Enumerator
Utf8CodeUnitMax	The maximum number of code units that can encode a code point in UTF-8
Utf16CodeUnitMax	The maximum number of code units that can encode a code ponit in UTF-16

enum UtfString::Utf16SurrogateBaseNumbers

Enumerates the numbers that form the base (the lowest possible number) of UTF-16 surrogate code units

Enumerator
HighCodeUnitBaseNumber	The number used as the base number for the high code unit of a UTF-16 surrogate pair
LowCodeUnitBaseNumber	The number used as the base number for the low code unit of a UTF-16 surrogate pair

enum UtfString::Utf16SurrogateRange

Enumerates the range of numbers that are reserved for UTF-16 surrogate code units. For example, if the lower end of a the range of high code units is 0xD800 and the upper end of the range is 0xDBFF, that means any code unit found in the range 0xD800 - 0xDBFF is a high code unit of a UTF-16 surrogate pair.

Enumerator
HighCodeUnitRangeBegin	The lower end of the range of high code units of a UTF-16 surrogate pair
HighCodeUnitRangeEnd	The upper end of the range of high code units of a UTF-16 surrogate pair
LowCodeUnitRangeBegin	The lower end of the range of low code units of a UTF-16 surrogate pair
LowCodeUnitRangeEnd	The upper end of the range of low code units of a UTF-16 surrogate pair

enum UtfString::UtfBOM

This enumeration describes the different types of BOMS (Byte Order Markers) that precede the different types of UTF strings.

Enumerator
BOM_UTF8	The BOM that indicates UTF-8 encoding
BOM_UTF16BE	The BOM that indicates UTF-16 big-endian encoding
BOM_UTF16LE	The BOM that indicates UTF-16 little-endian encoding
BOM_UTF32BE	The BOM that indicates UTF-32 big-endian encoding
BOM_UTF32LE	The BOM that indicates UTF-32 little-endian encoding

enum UtfString::UtfEncoding

Enumerates the encodings that this library is capable of handling

Enumerator
ENCODING_NONE	No Encoding
ENCODING_UTF8	UTF-8 encoding
ENCODING_UTF16	UTF-16 encoding