## Public API Reference

- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# csUnicodeTransform Class Reference
[Utilities]

Contains functions to convert between several UTF encodings. More...

`#include <csutil/csuctransform.h>`

List of all members.

## Static Public Member Functions

UTF Decoders
static int | Decode (const utf32_char *str, size_t strlen, utf32_char &ch, bool *isValid=0, bool returnNonChar=false)
| Decode an Unicode code point encoded in UTF-32.
static int | Decode (const utf16_char *str, size_t strlen, utf32_char &ch, bool *isValid=0, bool returnNonChar=false)
| Decode an Unicode code point encoded in UTF-16.
static int | Decode (const utf8_char *str, size_t strlen, utf32_char &ch, bool *isValid=0, bool returnNonChar=false)
| Decode an Unicode code point encoded in UTF-8.
static int | UTF16Decode (const utf16_char *str, size_t strlen, utf32_char &ch, bool *isValid=0, bool returnNonChar=false)
| Decode an Unicode code point encoded in UTF-16.
static int | UTF32Decode (const utf32_char *str, size_t strlen, utf32_char &ch, bool *isValid=0, bool returnNonChar=false)
| Decode an Unicode code point encoded in UTF-32.
static int | UTF8Decode (const utf8_char *str, size_t strlen, utf32_char &ch, bool *isValid=0, bool returnNonChar=false)
| Decode an Unicode code point encoded in UTF-8.
UTF Encoders
static int | Encode (const utf32_char ch, utf32_char *buf, size_t bufsize, bool allowNonchars=false)
| Encode an Unicode code point to UTF-32.
static int | Encode (const utf32_char ch, utf16_char *buf, size_t bufsize, bool allowNonchars=false)
| Encode an Unicode code point to UTF-16.
static int | Encode (const utf32_char ch, utf8_char *buf, size_t bufsize, bool allowNonchars=false)
| Encode an Unicode code point to UTF-8.
static int | EncodeUTF16 (const utf32_char ch, utf16_char *buf, size_t bufsize, bool allowNonchars=false)
| Encode an Unicode code point to UTF-16.
static int | EncodeUTF32 (const utf32_char ch, utf32_char *buf, size_t bufsize, bool allowNonchars=false)
| Encode an Unicode code point to UTF-32.
static int | EncodeUTF8 (const utf32_char ch, utf8_char *buf, size_t bufsize, bool allowNonchars=false)
| Encode an Unicode code point to UTF-8.
Code point mappings
static size_t | MapToFold (const utf32_char ch, utf32_char *dest, size_t destSize, uint flags=0)
| Map a code point to its fold equivalent(s).
static size_t | MapToLower (const utf32_char ch, utf32_char *dest, size_t destSize, uint flags=0)
| Map a code point to its lower case equivalent(s).
static size_t | MapToUpper (const utf32_char ch, utf32_char *dest, size_t destSize, uint flags=0)
| Map a code point to its upper case equivalent(s).
Helpers to skip encoded code units in different UTF encodings
static int | UTF16Rewind (const utf16_char *str, size_t maxRew)
| Determine how many code units in an UTF-16 buffer need to skipped back to get to the start of the previous encoded code point.
static int | UTF16Skip (const utf16_char *str, size_t maxSkip)
| Determine how many code units in an UTF-16 buffer need to be skipped to get to the next encoded char.
static int | UTF32Rewind (const utf32_char *str, size_t maxRew)
| Determine how many code units in an UTF-32 buffer need to skipped back to get to the start of the previous encoded code point.
static int | UTF32Skip (const utf32_char *str, size_t maxSkip)
| Determine how many code units in an UTF-32 buffer need to be skipped to get to the next encoded char.
static int | UTF8Rewind (const utf8_char *str, size_t maxRew)
| Determine how many code units in an UTF-8 buffer need to skipped back to get to the start of the previous encoded code point.
static int | UTF8Skip (const utf8_char *str, size_t maxSkip)
| Determine how many code units in an UTF-8 buffer need to be skipped to get to the next encoded char.
Converters between strings in different UTF encodings
static size_t | UTF16to32 (utf32_char *dest, size_t destSize, const utf16_char *source, size_t srcSize=(size_t)-1)
| Convert UTF-16 to UTF-32.
static size_t | UTF16to8 (utf8_char *dest, size_t destSize, const utf16_char *source, size_t srcSize=(size_t)-1)
| Convert UTF-16 to UTF-8.
static size_t | UTF32to16 (utf16_char *dest, size_t destSize, const utf32_char *source, size_t srcSize=(size_t)-1)
| Convert UTF-32 to UTF-16.
static size_t | UTF32to8 (utf8_char *dest, size_t destSize, const utf32_char *source, size_t srcSize=(size_t)-1)
| Convert UTF-32 to UTF-8.
static size_t | UTF8to16 (utf16_char *dest, size_t destSize, const utf8_char *source, size_t srcSize=(size_t)-1)
| Convert UTF-8 to UTF-16.
static size_t | UTF8to32 (utf32_char *dest, size_t destSize, const utf8_char *source, size_t srcSize=(size_t)-1)
| Convert UTF-8 to UTF-32.

## Detailed Description

Contains functions to convert between several UTF encodings.

Definition at line 68 of file csuctransform.h.

## Member Function Documentation

static int csUnicodeTransform::Decode | ( | const utf32_char * | str,
|  | size_t | strlen,
|  | utf32_char & | ch,
|  | bool * | isValid = `0`,
|  | bool | returnNonChar = `false`
| ) | `[inline, static]`

Decode an Unicode code point encoded in UTF-32.

Decode an Unicode code point encoded in UTF-8.

Parameters:

  | str | Pointer to the encoded code point.
  | strlen | Number of code units in the source string.
  | ch | Decoded code point.
  | isValid | When an error occured during decoding, `ch` contains the replacement character (CS_UC_CHAR_REPLACER). In this case, the bool pointed to by `isValid` will be set to false. The parameter can be 0, but in this case the information whether the decoded char is the replacement character because the source data is errorneous is lost.
  | returnNonChar | Whether decoded non-character or high and low surrogates are returned as such. Normally, those code points are replaced with CS_UC_CHAR_REPLACER to signal an invalid encoded code point.

Returns:
  The number of code units in str that have to be skipped to retrieve the next encoded code point.

Definition at line 284 of file csuctransform.h.

static int csUnicodeTransform::Decode | ( | const utf16_char * | str,
|  | size_t | strlen,
|  | utf32_char & | ch,
|  | bool * | isValid = `0`,
|  | bool | returnNonChar = `false`
| ) | `[inline, static]`

Decode an Unicode code point encoded in UTF-16.

Decode an Unicode code point encoded in UTF-8.

Parameters:

  | str | Pointer to the encoded code point.
  | strlen | Number of code units in the source string.
  | ch | Decoded code point.
  | isValid | When an error occured during decoding, `ch` contains the replacement character (CS_UC_CHAR_REPLACER). In this case, the bool pointed to by `isValid` will be set to false. The parameter can be 0, but in this case the information whether the decoded char is the replacement character because the source data is errorneous is lost.
  | returnNonChar | Whether decoded non-character or high and low surrogates are returned as such. Normally, those code points are replaced with CS_UC_CHAR_REPLACER to signal an invalid encoded code point.

Returns:
  The number of code units in str that have to be skipped to retrieve the next encoded code point.

Definition at line 275 of file csuctransform.h.

static int csUnicodeTransform::Decode | ( | const utf8_char * | str,
|  | size_t | strlen,
|  | utf32_char & | ch,
|  | bool * | isValid = `0`,
|  | bool | returnNonChar = `false`
| ) | `[inline, static]`

Decode an Unicode code point encoded in UTF-8.

Decode an Unicode code point encoded in UTF-8.

Parameters:

  | str | Pointer to the encoded code point.
  | strlen | Number of code units in the source string.
  | ch | Decoded code point.
  | isValid | When an error occured during decoding, `ch` contains the replacement character (CS_UC_CHAR_REPLACER). In this case, the bool pointed to by `isValid` will be set to false. The parameter can be 0, but in this case the information whether the decoded char is the replacement character because the source data is errorneous is lost.
  | returnNonChar | Whether decoded non-character or high and low surrogates are returned as such. Normally, those code points are replaced with CS_UC_CHAR_REPLACER to signal an invalid encoded code point.

Returns:
  The number of code units in str that have to be skipped to retrieve the next encoded code point.

Definition at line 266 of file csuctransform.h.

Referenced by csFmtDefaultReader< T >::GetNext().

static int csUnicodeTransform::Encode | ( | const utf32_char | ch,
|  | utf32_char * | buf,
|  | size_t | bufsize,
|  | bool | allowNonchars = `false`
| ) | `[inline, static]`

Encode an Unicode code point to UTF-32.

Encode an Unicode code point to UTF-8.

Parameters:

  | ch | Code point to encode.
  | buf | Pointer to the buffer receiving the encoded code point.
  | bufsize | Number of code units that fit in buf.
  | allowNonchars | Whether non-character or high and low surrogates are encoded. Normally, those code points are rejected to prevent the generation of invalid encoded strings.

Returns:
  The number of code units needed to encode `ch`.

Remarks:
  The buffer will be filled up as much as possible. Check the returned value whether the encoded code point completely fit into the buffer.

Definition at line 444 of file csuctransform.h.

static int csUnicodeTransform::Encode | ( | const utf32_char | ch,
|  | utf16_char * | buf,
|  | size_t | bufsize,
|  | bool | allowNonchars = `false`
| ) | `[inline, static]`

Encode an Unicode code point to UTF-16.

Encode an Unicode code point to UTF-8.

Parameters:

  | ch | Code point to encode.
  | buf | Pointer to the buffer receiving the encoded code point.
  | bufsize | Number of code units that fit in buf.
  | allowNonchars | Whether non-character or high and low surrogates are encoded. Normally, those code points are rejected to prevent the generation of invalid encoded strings.

Returns:
  The number of code units needed to encode `ch`.

Remarks:
  The buffer will be filled up as much as possible. Check the returned value whether the encoded code point completely fit into the buffer.

Definition at line 435 of file csuctransform.h.

static int csUnicodeTransform::Encode | ( | const utf32_char | ch,
|  | utf8_char * | buf,
|  | size_t | bufsize,
|  | bool | allowNonchars = `false`
| ) | `[inline, static]`

Encode an Unicode code point to UTF-8.

Encode an Unicode code point to UTF-8.

Parameters:

  | ch | Code point to encode.
  | buf | Pointer to the buffer receiving the encoded code point.
  | bufsize | Number of code units that fit in buf.
  | allowNonchars | Whether non-character or high and low surrogates are encoded. Normally, those code points are rejected to prevent the generation of invalid encoded strings.

Returns:
  The number of code units needed to encode `ch`.

Remarks:
  The buffer will be filled up as much as possible. Check the returned value whether the encoded code point completely fit into the buffer.

Definition at line 426 of file csuctransform.h.

Referenced by csFmtDefaultWriter< T >::Put().

static int csUnicodeTransform::EncodeUTF16 | ( | const utf32_char | ch,
|  | utf16_char * | buf,
|  | size_t | bufsize,
|  | bool | allowNonchars = `false`
| ) | `[inline, static]`

Encode an Unicode code point to UTF-16.

Encode an Unicode code point to UTF-8.

Parameters:

  | ch | Code point to encode.
  | buf | Pointer to the buffer receiving the encoded code point.
  | bufsize | Number of code units that fit in buf.
  | allowNonchars | Whether non-character or high and low surrogates are encoded. Normally, those code points are rejected to prevent the generation of invalid encoded strings.

Returns:
  The number of code units needed to encode `ch`.

Remarks:
  The buffer will be filled up as much as possible. Check the returned value whether the encoded code point completely fit into the buffer.

Definition at line 377 of file csuctransform.h.

References CS_UC_CHAR_HIGH_SURROGATE_FIRST, CS_UC_CHAR_LOW_SURROGATE_FIRST, CS_UC_IS_NONCHARACTER, CS_UC_IS_SURROGATE, CS_UC_LAST_CHAR, and OUTPUT_CHAR.

static int csUnicodeTransform::EncodeUTF32 | ( | const utf32_char | ch,
|  | utf32_char * | buf,
|  | size_t | bufsize,
|  | bool | allowNonchars = `false`
| ) | `[inline, static]`

Encode an Unicode code point to UTF-32.

Encode an Unicode code point to UTF-8.

Parameters:

  | ch | Code point to encode.
  | buf | Pointer to the buffer receiving the encoded code point.
  | bufsize | Number of code units that fit in buf.
  | allowNonchars | Whether non-character or high and low surrogates are encoded. Normally, those code points are rejected to prevent the generation of invalid encoded strings.

Returns:
  The number of code units needed to encode `ch`.

Remarks:
  The buffer will be filled up as much as possible. Check the returned value whether the encoded code point completely fit into the buffer.

Definition at line 408 of file csuctransform.h.

References CS_UC_IS_NONCHARACTER, CS_UC_IS_SURROGATE, CS_UC_LAST_CHAR, and OUTPUT_CHAR.

static int csUnicodeTransform::EncodeUTF8 | ( | const utf32_char | ch,
|  | utf8_char * | buf,
|  | size_t | bufsize,
|  | bool | allowNonchars = `false`
| ) | `[inline, static]`

Encode an Unicode code point to UTF-8.

Parameters:

  | ch | Code point to encode.
  | buf | Pointer to the buffer receiving the encoded code point.
  | bufsize | Number of code units that fit in buf.
  | allowNonchars | Whether non-character or high and low surrogates are encoded. Normally, those code points are rejected to prevent the generation of invalid encoded strings.

Returns:
  The number of code units needed to encode `ch`.

Remarks:
  The buffer will be filled up as much as possible. Check the returned value whether the encoded code point completely fit into the buffer.

Definition at line 320 of file csuctransform.h.

References CS_UC_IS_NONCHARACTER, CS_UC_IS_SURROGATE, CS_UC_LAST_CHAR, and OUTPUT_CHAR.

static size_t csUnicodeTransform::MapToFold | ( | const utf32_char | ch,
|  | utf32_char * | dest,
|  | size_t | destSize,
|  | uint | flags = `0`
| ) | `[static]`

Map a code point to its fold equivalent(s).

Fold mapping is useful for binary comparison of two Unicode strings. Map a code point to its upper case equivalent(s).

Parameters:

  | ch | Code point to be mapped.
  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | flags | Flags to control the result of the mapping. Currently supported is csUcMapSimple.

Returns:
  Number of code units the complete mapping result would require.

static size_t csUnicodeTransform::MapToLower | ( | const utf32_char | ch,
|  | utf32_char * | dest,
|  | size_t | destSize,
|  | uint | flags = `0`
| ) | `[static]`

Map a code point to its lower case equivalent(s).

Map a code point to its upper case equivalent(s).

Parameters:

  | ch | Code point to be mapped.
  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | flags | Flags to control the result of the mapping. Currently supported is csUcMapSimple.

Returns:
  Number of code units the complete mapping result would require.

static size_t csUnicodeTransform::MapToUpper | ( | const utf32_char | ch,
|  | utf32_char * | dest,
|  | size_t | destSize,
|  | uint | flags = `0`
| ) | `[static]`

Map a code point to its upper case equivalent(s).

Parameters:

  | ch | Code point to be mapped.
  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | flags | Flags to control the result of the mapping. Currently supported is csUcMapSimple.

Returns:
  Number of code units the complete mapping result would require.

static int csUnicodeTransform::UTF16Decode | ( | const utf16_char * | str,
|  | size_t | strlen,
|  | utf32_char & | ch,
|  | bool * | isValid = `0`,
|  | bool | returnNonChar = `false`
| ) | `[inline, static]`

Decode an Unicode code point encoded in UTF-16.

Decode an Unicode code point encoded in UTF-8.

Parameters:

  | str | Pointer to the encoded code point.
  | strlen | Number of code units in the source string.
  | ch | Decoded code point.
  | isValid | When an error occured during decoding, `ch` contains the replacement character (CS_UC_CHAR_REPLACER). In this case, the bool pointed to by `isValid` will be set to false. The parameter can be 0, but in this case the information whether the decoded char is the replacement character because the source data is errorneous is lost.
  | returnNonChar | Whether decoded non-character or high and low surrogates are returned as such. Normally, those code points are replaced with CS_UC_CHAR_REPLACER to signal an invalid encoded code point.

Returns:
  The number of code units in str that have to be skipped to retrieve the next encoded code point.

Definition at line 203 of file csuctransform.h.

References CS_UC_IS_HIGH_SURROGATE, CS_UC_IS_LOW_SURROGATE, CS_UC_IS_NONCHARACTER, CS_UC_IS_SURROGATE, FAIL, GET_NEXT, and SUCCEED.

static int csUnicodeTransform::UTF16Rewind | ( | const utf16_char * | str,
|  | size_t | maxRew
| ) | `[inline, static]`

Determine how many code units in an UTF-16 buffer need to skipped back to get to the start of the previous encoded code point.

Determine how many code units in an UTF-8 buffer need to skipped back to get to the start of the previous encoded code point.

Parameters:

  | str | Pointer to the encoded code point after the code point that is actually to be skipped back.
  | maxRew | The number of code units to go back at max. Typically, this is the number of chars from str to the start of the buffer.

Returns:
  Number of chars to skip back in the buffer. Returns 0 if `maxRew` is 0.

Definition at line 928 of file csuctransform.h.

References CS_UC_IS_HIGH_SURROGATE, and CS_UC_IS_SURROGATE.

static int csUnicodeTransform::UTF16Skip | ( | const utf16_char * | str,
|  | size_t | maxSkip
| ) | `[inline, static]`

Determine how many code units in an UTF-16 buffer need to be skipped to get to the next encoded char.

Determine how many code units in an UTF-8 buffer need to be skipped to get to the next encoded char.

Parameters:

  | str | Pointer to buffer with encoded code point.
  | maxSkip | The number of code units to skip at max. Usually, this is the number of chars from str to the end of the buffer.

Returns:
  Number of chars to skip in the buffer. Returns 0 if `maxSkip` is 0.

Definition at line 915 of file csuctransform.h.

References CS_UC_IS_HIGH_SURROGATE.

static size_t csUnicodeTransform::UTF16to32 | ( | utf32_char * | dest,
|  | size_t | destSize,
|  | const utf16_char * | source,
|  | size_t | srcSize = `(size_t)-1`
| ) | `[inline, static]`

Convert UTF-16 to UTF-32.

Convert UTF-8 to UTF-16.

Parameters:

  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | source | Source buffer.
  | srcSize | Number of code units contained in the source buffer. If this is -1, the length will be determined automatically.

Returns:
  Number of code units in the complete converted string, including null terminator.

Remarks:
  If the complete converted string wouldn't fit the destination buffer, it is truncated. However, it'll also be null-terminated. Hence, if it has a size of 1, you get an empty string. The returned value is the number of code units needed for the *whole* converted string.

Definition at line 538 of file csuctransform.h.

static size_t csUnicodeTransform::UTF16to8 | ( | utf8_char * | dest,
|  | size_t | destSize,
|  | const utf16_char * | source,
|  | size_t | srcSize = `(size_t)-1`
| ) | `[inline, static]`

Convert UTF-16 to UTF-8.

Convert UTF-8 to UTF-16.

Parameters:

  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | source | Source buffer.
  | srcSize | Number of code units contained in the source buffer. If this is -1, the length will be determined automatically.

Returns:
  Number of code units in the complete converted string, including null terminator.

Remarks:
  If the complete converted string wouldn't fit the destination buffer, it is truncated. However, it'll also be null-terminated. Hence, if it has a size of 1, you get an empty string. The returned value is the number of code units needed for the *whole* converted string.

Definition at line 533 of file csuctransform.h.

static int csUnicodeTransform::UTF32Decode | ( | const utf32_char * | str,
|  | size_t | strlen,
|  | utf32_char & | ch,
|  | bool * | isValid = `0`,
|  | bool | returnNonChar = `false`
| ) | `[inline, static]`

Decode an Unicode code point encoded in UTF-32.

Decode an Unicode code point encoded in UTF-8.

Parameters:

  | str | Pointer to the encoded code point.
  | strlen | Number of code units in the source string.
  | ch | Decoded code point.
  | isValid | When an error occured during decoding, `ch` contains the replacement character (CS_UC_CHAR_REPLACER). In this case, the bool pointed to by `isValid` will be set to false. The parameter can be 0, but in this case the information whether the decoded char is the replacement character because the source data is errorneous is lost.
  | returnNonChar | Whether decoded non-character or high and low surrogates are returned as such. Normally, those code points are replaced with CS_UC_CHAR_REPLACER to signal an invalid encoded code point.

Returns:
  The number of code units in str that have to be skipped to retrieve the next encoded code point.

Definition at line 246 of file csuctransform.h.

References CS_UC_IS_NONCHARACTER, CS_UC_IS_SURROGATE, CS_UC_LAST_CHAR, FAIL, GET_NEXT, and SUCCEED.

static int csUnicodeTransform::UTF32Rewind | ( | const utf32_char * | str,
|  | size_t | maxRew
| ) | `[inline, static]`

Determine how many code units in an UTF-32 buffer need to skipped back to get to the start of the previous encoded code point.

Determine how many code units in an UTF-8 buffer need to skipped back to get to the start of the previous encoded code point.

Parameters:

  | str | Pointer to the encoded code point after the code point that is actually to be skipped back.
  | maxRew | The number of code units to go back at max. Typically, this is the number of chars from str to the start of the buffer.

Returns:
  Number of chars to skip back in the buffer. Returns 0 if `maxRew` is 0.

Definition at line 960 of file csuctransform.h.

static int csUnicodeTransform::UTF32Skip | ( | const utf32_char * | str,
|  | size_t | maxSkip
| ) | `[inline, static]`

Determine how many code units in an UTF-32 buffer need to be skipped to get to the next encoded char.

Determine how many code units in an UTF-8 buffer need to be skipped to get to the next encoded char.

Parameters:

  | str | Pointer to buffer with encoded code point.
  | maxSkip | The number of code units to skip at max. Usually, this is the number of chars from str to the end of the buffer.

Returns:
  Number of chars to skip in the buffer. Returns 0 if `maxSkip` is 0.

Definition at line 949 of file csuctransform.h.

static size_t csUnicodeTransform::UTF32to16 | ( | utf16_char * | dest,
|  | size_t | destSize,
|  | const utf32_char * | source,
|  | size_t | srcSize = `(size_t)-1`
| ) | `[inline, static]`

Convert UTF-32 to UTF-16.

Convert UTF-8 to UTF-16.

Parameters:

  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | source | Source buffer.
  | srcSize | Number of code units contained in the source buffer. If this is -1, the length will be determined automatically.

Returns:
  Number of code units in the complete converted string, including null terminator.

Remarks:
  If the complete converted string wouldn't fit the destination buffer, it is truncated. However, it'll also be null-terminated. Hence, if it has a size of 1, you get an empty string. The returned value is the number of code units needed for the *whole* converted string.

Definition at line 549 of file csuctransform.h.

static size_t csUnicodeTransform::UTF32to8 | ( | utf8_char * | dest,
|  | size_t | destSize,
|  | const utf32_char * | source,
|  | size_t | srcSize = `(size_t)-1`
| ) | `[inline, static]`

Convert UTF-32 to UTF-8.

Convert UTF-8 to UTF-16.

Parameters:

  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | source | Source buffer.
  | srcSize | Number of code units contained in the source buffer. If this is -1, the length will be determined automatically.

Returns:
  Number of code units in the complete converted string, including null terminator.

Remarks:
  If the complete converted string wouldn't fit the destination buffer, it is truncated. However, it'll also be null-terminated. Hence, if it has a size of 1, you get an empty string. The returned value is the number of code units needed for the *whole* converted string.

Definition at line 544 of file csuctransform.h.

static int csUnicodeTransform::UTF8Decode | ( | const utf8_char * | str,
|  | size_t | strlen,
|  | utf32_char & | ch,
|  | bool * | isValid = `0`,
|  | bool | returnNonChar = `false`
| ) | `[inline, static]`

Decode an Unicode code point encoded in UTF-8.

Parameters:

  | str | Pointer to the encoded code point.
  | strlen | Number of code units in the source string.
  | ch | Decoded code point.
  | isValid | When an error occured during decoding, `ch` contains the replacement character (CS_UC_CHAR_REPLACER). In this case, the bool pointed to by `isValid` will be set to false. The parameter can be 0, but in this case the information whether the decoded char is the replacement character because the source data is errorneous is lost.
  | returnNonChar | Whether decoded non-character or high and low surrogates are returned as such. Normally, those code points are replaced with CS_UC_CHAR_REPLACER to signal an invalid encoded code point.

Returns:
  The number of code units in str that have to be skipped to retrieve the next encoded code point.

Definition at line 112 of file csuctransform.h.

References FAIL, GET_NEXT, and SUCCEED.

Referenced by csG2DDrawText< Tpixel, Tpixmixer1, Tpixmixer2, Tpixmixer3 >::DrawText().

static int csUnicodeTransform::UTF8Rewind | ( | const utf8_char * | str,
|  | size_t | maxRew
| ) | `[inline, static]`

Determine how many code units in an UTF-8 buffer need to skipped back to get to the start of the previous encoded code point.

Parameters:

  | str | Pointer to the encoded code point after the code point that is actually to be skipped back.
  | maxRew | The number of code units to go back at max. Typically, this is the number of chars from str to the start of the buffer.

Returns:
  Number of chars to skip back in the buffer. Returns 0 if `maxRew` is 0.

Definition at line 888 of file csuctransform.h.

static int csUnicodeTransform::UTF8Skip | ( | const utf8_char * | str,
|  | size_t | maxSkip
| ) | `[inline, static]`

Determine how many code units in an UTF-8 buffer need to be skipped to get to the next encoded char.

Parameters:

  | str | Pointer to buffer with encoded code point.
  | maxSkip | The number of code units to skip at max. Usually, this is the number of chars from str to the end of the buffer.

Returns:
  Number of chars to skip in the buffer. Returns 0 if `maxSkip` is 0.

Definition at line 847 of file csuctransform.h.

static size_t csUnicodeTransform::UTF8to16 | ( | utf16_char * | dest,
|  | size_t | destSize,
|  | const utf8_char * | source,
|  | size_t | srcSize = `(size_t)-1`
| ) | `[inline, static]`

Convert UTF-8 to UTF-16.

Parameters:

  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | source | Source buffer.
  | srcSize | Number of code units contained in the source buffer. If this is -1, the length will be determined automatically.

Returns:
  Number of code units in the complete converted string, including null terminator.

Remarks:
  If the complete converted string wouldn't fit the destination buffer, it is truncated. However, it'll also be null-terminated. Hence, if it has a size of 1, you get an empty string. The returned value is the number of code units needed for the *whole* converted string.

Definition at line 522 of file csuctransform.h.

static size_t csUnicodeTransform::UTF8to32 | ( | utf32_char * | dest,
|  | size_t | destSize,
|  | const utf8_char * | source,
|  | size_t | srcSize = `(size_t)-1`
| ) | `[inline, static]`

Convert UTF-8 to UTF-32.

Convert UTF-8 to UTF-16.

Parameters:

  | dest | Destination buffer.
  | destSize | Number of code units the destination buffer can hold.
  | source | Source buffer.
  | srcSize | Number of code units contained in the source buffer. If this is -1, the length will be determined automatically.

Returns:
  Number of code units in the complete converted string, including null terminator.

Remarks:
  If the complete converted string wouldn't fit the destination buffer, it is truncated. However, it'll also be null-terminated. Hence, if it has a size of 1, you get an empty string. The returned value is the number of code units needed for the *whole* converted string.

Definition at line 527 of file csuctransform.h.

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

- csutil/csuctransform.h