BLOCXX_NAMESPACE::UTF8Utils Namespace Reference


Functions

size_t charCount (const char *utf8str)
 Count the number of UTF-8 chars in the string.
UInt16 UTF8toUCS2 (const char *utf8char)
 Convert one UTF-8 char (possibly multiple bytes) into a UCS2 16-bit char.
String UCS2toUTF8 (UInt16 ucs2char)
 Convert one UCS2 16-bit char into a UTF-8 char (possibly multiple bytes).
UInt32 UTF8toUCS4 (const char *utf8char)
 Convert one UTF-8 char (possibly multiple bytes) into a UCS4 32-bit char.
String UCS4toUTF8 (UInt32 ucs4char)
 Convert one UCS4 32-bit char into a UTF-8 char (possibly multiple bytes).
void UCS4toUTF8 (UInt32 ucs4char, StringBuffer &sb)
 Convert one UCS4 32-bit char into a UTF-8 char (possibly multiple bytes) This version is faster to use in a loop than the version which returns a String.
void UCS4toUTF8 (UInt32 ucs4char, char *p)
Array< UInt16 > StringToUCS2Common (const String &input, bool throwException)
Array< UInt16 > StringToUCS2ReplaceInvalid (const String &input)
 Convert a UTF-8 (or ASCII) string into a UCS2 string.
Array< UInt16 > StringToUCS2 (const String &input)
 Convert a UTF-8 (or ASCII) string into a UCS2 string.
String UCS2ToString (const void *input, size_t inputLength)
 Convert a UCS2 string into a UTF-8 (or ASCII) string.
String UCS2ToString (const Array< UInt16 > &input)
 Convert a UCS2 string into a UTF-8 (or ASCII) string.
String UCS2ToString (const Array< char > &input)
 Convert a UCS2 string into a UTF-8 (or ASCII) string.
int UTF8CharLen (UInt32 ucs4char)
template<typename TransformT>
bool transformInPlace (char *input, TransformT transformer)
template<typename TransformT>
String transform (const char *input, TransformT transformer)
bool toUpperCaseInPlace (char *input)
 Convert the UTF-8 string to upper case.
String toUpperCase (const char *input)
 Convert the UTF-8 string to upper case and return the result.
bool toLowerCaseInPlace (char *input)
 Convert the UTF-8 string to lower case.
String toLowerCase (const char *input)
 Convert the UTF-8 string to lower case and return the result.
int compareToIgnoreCase (const char *str1, const char *str2)
 Compares 2 UTF-8 strings, ignoring any case differences as defined by the Unicode spec CaseFolding.txt file.

Variables

UInt8 SequenceLengthTable [256]
const CaseMapping lowerMappings []
const CaseMapping upperMappings []
const CaseMapping *const lowerMappingsEnd
const CaseMapping *const upperMappingsEnd

Function Documentation

size_t BLOCXX_NAMESPACE::UTF8Utils::charCount ( const char *  utf8str  ) 

Count the number of UTF-8 chars in the string.

This may be different than the number of bytes (as would be returned by strlen()). If utf8str is not a valid UTF-8 string, then the result is undefined.

Parameters:
utf8str string in UTF-8 encoding.
Returns:
Number of chars in the string.

Definition at line 104 of file UTF8Utils.cpp.

References BLOCXX_ASSERT.

Referenced by BLOCXX_NAMESPACE::String::UTF8Length().

int BLOCXX_NAMESPACE::UTF8Utils::compareToIgnoreCase ( const char *  str1,
const char *  str2 
)

Compares 2 UTF-8 strings, ignoring any case differences as defined by the Unicode spec CaseFolding.txt file.

Parameters:
str1 first string
str2 second string
Returns:
a value less than, equal to, or greater than 0 if str1 is found to be less than, equal to, or greater than str2

Definition at line 45 of file UTF8UtilscompareToIgnoreCase.cpp.

Referenced by BLOCXX_NAMESPACE::String::compareToIgnoreCase(), and BLOCXX_NAMESPACE::String::endsWith().

Array< UInt16 > BLOCXX_NAMESPACE::UTF8Utils::StringToUCS2 ( const String &  input  ) 

Convert a UTF-8 (or ASCII) string into a UCS2 string.

Parameters:
input The UTF-8 string
Returns:
An Array of UCS2 characters
Exceptions:
InvalidUTF8Exception if input contains invalid UTF-8 characters.

Definition at line 373 of file UTF8Utils.cpp.

References StringToUCS2Common().

Array<UInt16> BLOCXX_NAMESPACE::UTF8Utils::@299::StringToUCS2Common ( const String &  input,
bool  throwException 
) [static]

Definition at line 265 of file UTF8Utils.cpp.

References BLOCXX_ASSERT, BLOCXX_THROW, BLOCXX_NAMESPACE::String::c_str(), BLOCXX_NAMESPACE::String::length(), BLOCXX_NAMESPACE::Array< T >::push_back(), and SequenceLengthTable.

Referenced by StringToUCS2(), and StringToUCS2ReplaceInvalid().

Array< UInt16 > BLOCXX_NAMESPACE::UTF8Utils::StringToUCS2ReplaceInvalid ( const String &  input  ) 

Convert a UTF-8 (or ASCII) string into a UCS2 string.

Invalid characters will be changed to U+FFFD (the Unicode Replacement character)

Parameters:
input The UTF-8 string
Returns:
An Array of UCS2 characters

Definition at line 367 of file UTF8Utils.cpp.

References StringToUCS2Common().

String BLOCXX_NAMESPACE::UTF8Utils::toLowerCase ( const char *  input  ) 

Convert the UTF-8 string to lower case and return the result.

Definition at line 2093 of file UTF8Utils.cpp.

References transform().

Referenced by BLOCXX_NAMESPACE::String::toLowerCase().

bool BLOCXX_NAMESPACE::UTF8Utils::toLowerCaseInPlace ( char *  input  ) 

Convert the UTF-8 string to lower case.

The string is modified in place. If a character is encountered whose replacement occupies a greater number of bytes than the original, processing will cease and false will be returned. The current implementation does not handle any of the special cases as defined in the Unicode SpecialCasing.txt file, and thus characters will not grow, so currently false will never be returned.

Returns:
true if successful. false if the lower-cased replacement would be larger than the original.

Definition at line 2087 of file UTF8Utils.cpp.

References transformInPlace().

Referenced by BLOCXX_NAMESPACE::String::toLowerCase().

String BLOCXX_NAMESPACE::UTF8Utils::toUpperCase ( const char *  input  ) 

Convert the UTF-8 string to upper case and return the result.

Definition at line 2081 of file UTF8Utils.cpp.

References transform().

Referenced by BLOCXX_NAMESPACE::String::toUpperCase().

bool BLOCXX_NAMESPACE::UTF8Utils::toUpperCaseInPlace ( char *  input  ) 

Convert the UTF-8 string to upper case.

The string is modified in place. If a character is encountered whose replacement occupies a greater number of bytes than the original, processing will cease and false will be returned. The current implementation does not handle any of the special cases as defined in the Unicode SpecialCasing.txt file, and thus characters will not grow, so currently false will never be returned.

Returns:
true if successful. false if the upper-cased replacement would be larger than the original.

Definition at line 2075 of file UTF8Utils.cpp.

References transformInPlace().

Referenced by BLOCXX_NAMESPACE::String::toUpperCase().

template<typename TransformT>
String BLOCXX_NAMESPACE::UTF8Utils::@299::transform ( const char *  input,
TransformT  transformer 
) [inline, static]

Definition at line 477 of file UTF8Utils.cpp.

References BLOCXX_NAMESPACE::StringBuffer::releaseString(), SequenceLengthTable, UCS4toUTF8(), and UTF8toUCS4().

Referenced by toLowerCase(), and toUpperCase().

template<typename TransformT>
bool BLOCXX_NAMESPACE::UTF8Utils::@299::transformInPlace ( char *  input,
TransformT  transformer 
) [inline, static]

Definition at line 437 of file UTF8Utils.cpp.

References SequenceLengthTable, UCS4toUTF8(), UTF8CharLen(), and UTF8toUCS4().

Referenced by toLowerCaseInPlace(), and toUpperCaseInPlace().

String BLOCXX_NAMESPACE::UTF8Utils::UCS2ToString ( const Array< char > &  input  ) 

Convert a UCS2 string into a UTF-8 (or ASCII) string.

Parameters:
input An Array of UCS2 characters
Returns:
The UTF-8 string

Definition at line 403 of file UTF8Utils.cpp.

References BLOCXX_NAMESPACE::Array< T >::empty(), BLOCXX_NAMESPACE::Array< T >::size(), and UCS2ToString().

String BLOCXX_NAMESPACE::UTF8Utils::UCS2ToString ( const Array< UInt16 > &  input  ) 

Convert a UCS2 string into a UTF-8 (or ASCII) string.

Parameters:
input An Array of UCS2 characters
Returns:
The UTF-8 string

Definition at line 394 of file UTF8Utils.cpp.

References BLOCXX_NAMESPACE::Array< T >::empty(), BLOCXX_NAMESPACE::Array< T >::size(), and UCS2ToString().

String BLOCXX_NAMESPACE::UTF8Utils::UCS2ToString ( const void *  input,
size_t  inputLength 
)

Convert a UCS2 string into a UTF-8 (or ASCII) string.

Parameters:
input An Array of UCS2 characters
inputLength The size (in bytes) of input.
Returns:
The UTF-8 string

Definition at line 379 of file UTF8Utils.cpp.

References i, BLOCXX_NAMESPACE::StringBuffer::releaseString(), and UCS4toUTF8().

Referenced by UCS2ToString().

String BLOCXX_NAMESPACE::UTF8Utils::UCS2toUTF8 ( UInt16  ucs2char  ) 

Convert one UCS2 16-bit char into a UTF-8 char (possibly multiple bytes).

Parameters:
ucs2char UCS2 char to convert.
Returns:
The corresponding UTF-8 char.

Definition at line 135 of file UTF8Utils.cpp.

References UCS4toUTF8().

Referenced by BLOCXX_NAMESPACE::Char16::toString(), and BLOCXX_NAMESPACE::Char16::toUTF8().

void BLOCXX_NAMESPACE::UTF8Utils::@299::UCS4toUTF8 ( UInt32  ucs4char,
char *  p 
) [static]

Definition at line 237 of file UTF8Utils.cpp.

Referenced by transform().

void BLOCXX_NAMESPACE::UTF8Utils::UCS4toUTF8 ( UInt32  ucs4char,
StringBuffer &  sb 
)

Convert one UCS4 32-bit char into a UTF-8 char (possibly multiple bytes) This version is faster to use in a loop than the version which returns a String.

Parameters:
ucs4char UCS4 char to convert.
sb The corresponding UTF-8 char will be appended to the end of sb.

Definition at line 207 of file UTF8Utils.cpp.

String BLOCXX_NAMESPACE::UTF8Utils::UCS4toUTF8 ( UInt32  ucs4char  ) 

Convert one UCS4 32-bit char into a UTF-8 char (possibly multiple bytes).

Parameters:
ucs4char UCS4 char to convert.
Returns:
The corresponding UTF-8 char.

Definition at line 199 of file UTF8Utils.cpp.

References BLOCXX_NAMESPACE::StringBuffer::releaseString().

Referenced by transformInPlace(), UCS2ToString(), and UCS2toUTF8().

int BLOCXX_NAMESPACE::UTF8Utils::@299::UTF8CharLen ( UInt32  ucs4char  )  [static]

Definition at line 416 of file UTF8Utils.cpp.

Referenced by transformInPlace().

UInt16 BLOCXX_NAMESPACE::UTF8Utils::UTF8toUCS2 ( const char *  utf8char  ) 

Convert one UTF-8 char (possibly multiple bytes) into a UCS2 16-bit char.

Parameters:
utf8char pointer to the UTF-8 char to convert
Returns:
The corresponding UCS2 char. 0xFFFF if utf8char points to an invalid UTF-8 sequence. Not all UTF-8 chars are handled. UTF-8 chars outside the range of a UCS2 char will produce 0xFFFF.

Definition at line 122 of file UTF8Utils.cpp.

References UTF8toUCS4().

Referenced by BLOCXX_NAMESPACE::Char16::Char16().

UInt32 BLOCXX_NAMESPACE::UTF8Utils::UTF8toUCS4 ( const char *  utf8char  ) 

Convert one UTF-8 char (possibly multiple bytes) into a UCS4 32-bit char.

Parameters:
utf8char pointer to the UTF-8 char to convert
Returns:
The corresponding UCS4 char. 0xFFFFFFFF if utf8char points to an invalid UTF-8 sequence.

Definition at line 141 of file UTF8Utils.cpp.

References BLOCXX_ASSERT, and SequenceLengthTable.

Referenced by transform(), transformInPlace(), and UTF8toUCS2().

Variable Documentation

const CaseMapping BLOCXX_NAMESPACE::UTF8Utils::lowerMappings[] [static]

Definition at line 508 of file UTF8Utils.cpp.

const CaseMapping* const BLOCXX_NAMESPACE::UTF8Utils::lowerMappingsEnd [static]

Initial value:

 lowerMappings +
   (sizeof(lowerMappings)/sizeof(lowerMappings[0]))

Definition at line 2033 of file UTF8Utils.cpp.

UInt8 BLOCXX_NAMESPACE::UTF8Utils::SequenceLengthTable[256] [static]

Initial value:

{
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
    0, 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 
    2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 
    3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 
    4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0  
}

Definition at line 84 of file UTF8Utils.cpp.

Referenced by StringToUCS2Common(), transform(), transformInPlace(), and UTF8toUCS4().

const CaseMapping BLOCXX_NAMESPACE::UTF8Utils::upperMappings[] [static]

Definition at line 1266 of file UTF8Utils.cpp.

const CaseMapping* const BLOCXX_NAMESPACE::UTF8Utils::upperMappingsEnd [static]

Initial value:

 upperMappings +
   (sizeof(upperMappings)/sizeof(upperMappings[0]))

Definition at line 2036 of file UTF8Utils.cpp.

Generated on Wed Feb 25 19:05:20 2009 for blocxx by  doxygen 1.5.6