# Transcoder Class Reference

List of all members.

## Detailed Description

Simple transcoder for converting between external char and wchar_t strings and internal strings.

## Public Types

enum | { LOSSCHAR = 0x3F }

## Static Public Member Functions

static void | decodeUTF8 (const std::string &src, LogString &dst)
| Appends this specified string of UTF-8 characters to LogString.
static void | encodeUTF8 (const LogString &src, std::string &dst)
| Converts the LogString to a UTF-8 string.
static char * | encodeUTF8 (const LogString &src, log4cxx::helpers::Pool &p)
| Converts the LogString to a UTF-8 string.
static void | encodeUTF8 (unsigned int sv, ByteBuffer &dst)
| Append UCS-4 code point to a byte buffer as UTF-8.
static void | encodeUTF16LE (unsigned int sv, ByteBuffer &dst)
| Append UCS-4 code point to a byte buffer as UTF-16LE.
static void | encodeUTF16BE (unsigned int sv, ByteBuffer &dst)
| Append UCS-4 code point to a byte buffer as UTF-16BE.
static unsigned int | decode (const std::string &in, std::string::const_iterator &iter)
| Decodes next character from a UTF-8 string.
static void | encode (unsigned int ch, std::string &dst)
| Appends UCS-4 value to a UTF-8 string.
static void | decode (const std::string &src, LogString &dst)
| Appends string in the current code-page to a LogString.
static void | encode (const LogString &src, std::string &dst)
| Appends a LogString to a string in the current code-page.
static char * | encode (const LogString &src, log4cxx::helpers::Pool &p)
| Encodes the specified LogString to the current character set.
static void | decode (const std::wstring &src, LogString &dst)
static void | encode (const LogString &src, std::wstring &dst)
static wchar_t * | wencode (const LogString &src, log4cxx::helpers::Pool &p)
static unsigned int | decode (const std::wstring &in, std::wstring::const_iterator &iter)
| Decodes next character from a wstring.
static void | encode (unsigned int ch, std::wstring &dst)
| Appends UCS-4 value to a UTF-8 string.
static void | decode (const std::basic_string< UniChar > &src, LogString &dst)
static void | encode (const LogString &src, std::basic_string< UniChar > &dst)
static unsigned int | decode (const std::basic_string< UniChar > &in, std::basic_string< UniChar >::const_iterator &iter)
| Decodes next character from a UniChar string.
static void | encode (unsigned int ch, std::basic_string< UniChar > &dst)
| Appends UCS-4 value to a UTF-8 string.
static void | decode (const CFStringRef &src, LogString &dst)
static CFStringRef | encode (const LogString &src)
static logchar | decode (char v)
| Returns a logchar value given a character literal in the ASCII charset.
static LogString | decode (const char *v)
| Returns a LogString given a string literal in the ASCII charset.
static std::string | encodeCharsetName (const LogString &charsetName)
| Encodes a charset name in the default encoding without using a CharsetEncoder (which could trigger recursion).

## Member Enumeration Documentation

anonymous enum

Enumerator:

  LOSSCHAR |

## Member Function Documentation

static LogString decode | ( | const char * | v | ) | `[static]`

| Returns a LogString given a string literal in the ASCII charset. Used to implement the LOG4CXX_STR macro for EBCDIC and UNICHAR.

static logchar decode | ( | char | v | ) | `[static]`

| Returns a logchar value given a character literal in the ASCII charset. Used to implement the LOG4CXX_STR macro for EBCDIC and UNICHAR.

static void decode | ( | const CFStringRef & | src,
|  | LogString & | dst
| ) | `[static]`

static unsigned int decode | ( | const std::basic_string< UniChar > & | in,
|  | std::basic_string< UniChar >::const_iterator & | iter
| ) | `[static]`

Decodes next character from a UniChar string.

Parameters:

  | in | string from which the character is extracted.
  | iter | iterator addressing start of character, will be advanced to next character if successful.

Returns:
  scalar value (UCS-4) or 0xFFFF if invalid sequence.

static void decode | ( | const std::basic_string< UniChar > & | src,
|  | LogString & | dst
| ) | `[static]`

static unsigned int decode | ( | const std::wstring & | in,
|  | std::wstring::const_iterator & | iter
| ) | `[static]`

Decodes next character from a wstring.

Parameters:

  | in | string from which the character is extracted.
  | iter | iterator addressing start of character, will be advanced to next character if successful.

Returns:
  scalar value (UCS-4) or 0xFFFF if invalid sequence.

static void decode | ( | const std::wstring & | src,
|  | LogString & | dst
| ) | `[static]`

static void decode | ( | const std::string & | src,
|  | LogString & | dst
| ) | `[static]`

| Appends string in the current code-page to a LogString.

static unsigned int decode | ( | const std::string & | in,
|  | std::string::const_iterator & | iter
| ) | `[static]`

Decodes next character from a UTF-8 string.

Parameters:

  | in | string from which the character is extracted.
  | iter | iterator addressing start of character, will be advanced to next character if successful.

Returns:
  scalar value (UCS-4) or 0xFFFF if invalid sequence.

static void decodeUTF8 | ( | const std::string & | src,
|  | LogString & | dst
| ) | `[static]`

| Appends this specified string of UTF-8 characters to LogString.

static CFStringRef encode | ( | const LogString & | src | ) | `[static]`

static void encode | ( | unsigned int | ch,
|  | std::basic_string< UniChar > & | dst
| ) | `[static]`

Appends UCS-4 value to a UTF-8 string.

Parameters:

  | ch | UCS-4 value.
  | dst | destination.

static void encode | ( | const LogString & | src,
|  | std::basic_string< UniChar > & | dst
| ) | `[static]`

static void encode | ( | unsigned int | ch,
|  | std::wstring & | dst
| ) | `[static]`

Appends UCS-4 value to a UTF-8 string.

Parameters:

  | ch | UCS-4 value.
  | dst | destination.

static void encode | ( | const LogString & | src,
|  | std::wstring & | dst
| ) | `[static]`

static char* encode | ( | const LogString & | src,
|  | log4cxx::helpers::Pool & | p
| ) | `[static]`

Encodes the specified LogString to the current character set.

Parameters:

  | src | string to encode.
  | p | pool from which to allocate return value.

Returns:
  pool allocated string.

static void encode | ( | const LogString & | src,
|  | std::string & | dst
| ) | `[static]`

| Appends a LogString to a string in the current code-page. Unrepresentable characters may be replaced with loss characters.

static void encode | ( | unsigned int | ch,
|  | std::string & | dst
| ) | `[static]`

Appends UCS-4 value to a UTF-8 string.

Parameters:

  | ch | UCS-4 value.
  | dst | destination.

static std::string encodeCharsetName | ( | const LogString & | charsetName | ) | `[static]`

| Encodes a charset name in the default encoding without using a CharsetEncoder (which could trigger recursion).

static void encodeUTF16BE | ( | unsigned int | sv,
|  | ByteBuffer & | dst
| ) | `[static]`

| Append UCS-4 code point to a byte buffer as UTF-16BE.

static void encodeUTF16LE | ( | unsigned int | sv,
|  | ByteBuffer & | dst
| ) | `[static]`

| Append UCS-4 code point to a byte buffer as UTF-16LE.

static void encodeUTF8 | ( | unsigned int | sv,
|  | ByteBuffer & | dst
| ) | `[static]`

| Append UCS-4 code point to a byte buffer as UTF-8.

static char* encodeUTF8 | ( | const LogString & | src,
|  | log4cxx::helpers::Pool & | p
| ) | `[static]`

| Converts the LogString to a UTF-8 string.

static void encodeUTF8 | ( | const LogString & | src,
|  | std::string & | dst
| ) | `[static]`

| Converts the LogString to a UTF-8 string.

static wchar_t* wencode | ( | const LogString & | src,
|  | log4cxx::helpers::Pool & | p
| ) | `[static]`

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

- transcoder.h