log4cxx::helpers::Transcoder Class Reference

Methods for converting between external and internal strings. More...

#include <transcoder.h>

Public Types
enum	{ LOSSCHAR = 0xFFFD }

Static Public Member Functions
static void	decodeUTF8 (const std::string &src, LogString &dst)
	Append the UTF-8 characters in src onto dst.
static void	encodeUTF8 (const LogString &src, std::string &dst)
	Append \src onto dst as a UTF-8 string.
static void	encodeUTF8 (unsigned int sv, ByteBuffer &dst)
	Append the code point sv to dst as UTF-8.
static void	encodeUTF16LE (unsigned int sv, ByteBuffer &dst)
	Append the code point sv to dst as UTF-16LE.
static void	encodeUTF16BE (unsigned int sv, ByteBuffer &dst)
	Append the code point sv to dst as UTF-16BE.
static unsigned int	decode (const std::string &str, std::string::const_iterator &iter)
	Increment iter past the next code point in str.
static unsigned int	getCodePoint (const std::string &str, std::string::const_iterator &pCodePoint)
	Increment pCodePoint past one str code point.
static void	encode (unsigned int ch, std::string &dst)
	Append the UTF8 equivalent to ch onto dst.
static bool	hasReplacementCharacter (const std::string &str)
	Does str contain the Unicode replacement character.
static void	decode (const std::string &src, LogString &dst)
	Append the LogString equivalent of src onto dst.
static void	encode (const LogString &src, std::string &dst)
	Append the UTF8 equivalent of src onto dst.
static void	decode (const std::wstring &src, LogString &dst)
	Append the LogString equivalent of src onto dst.
static void	encode (const LogString &src, std::wstring &dst)
	Append the equivalent of src onto dst.
static unsigned int	decode (const std::wstring &str, std::wstring::const_iterator &iter)
	Increment iter past the next code point in str.
static unsigned int	getCodePoint (const std::wstring &str, std::wstring::const_iterator &pCodePoint)
	Increment pCodePoint past one str code point.
static void	encode (unsigned int ch, std::wstring &dst)
	Append the wchar_t equivalent to ch onto dst.
static bool	hasReplacementCharacter (const std::wstring &str)
	Does str contain the Unicode replacement character.
static void	decode (const CFStringRef &src, LogString &dst)
	Append the LogString equivalent of src onto dst.
static CFStringRef	encode (const LogString &src)
	A CFStringRef equivalent of src.
static logchar	decode (char ch)
	The logchar equivalent to ch.
static LogString	decode (const char *str)
	The LogString equivalent to the characters in the null terminated bytes at str.
static std::string	encodeCharsetName (const LogString &charsetName)
	Encodes a charset name in the default encoding without using a CharsetEncoder (which could trigger recursion).

Detailed Description

Methods for converting between external and internal strings.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
LOSSCHAR

Member Function Documentation

decode() [1/7]

logchar log4cxx::helpers::Transcoder::decode ( char ch )

static

The logchar equivalent to ch.

decode() [2/7]

void log4cxx::helpers::Transcoder::decode ( const CFStringRef & src, LogString & dst )

static

Append the LogString equivalent of src onto dst.

decode() [3/7]

LogString log4cxx::helpers::Transcoder::decode ( const char * str )

static

The LogString equivalent to the characters in the null terminated bytes at str.

decode() [4/7]

void log4cxx::helpers::Transcoder::decode ( const std::string & src, LogString & dst )

static

Append the LogString equivalent of src onto dst.

decode() [5/7]

unsigned int log4cxx::helpers::Transcoder::decode ( const std::string & str, std::string::const_iterator & iter )

static

Increment iter past the next code point in str.

Precondition

iter is a valid, dereferenceable iterator.

iter and the end of str are in the same sequence.

Parameters

str	contains the code point to which iter refers.
iter	the start of the current code point.

Returns

if a valid sequence, the decoded value; otherwise, 0xFFFF and leave iter unchanged.

decode() [6/7]

void log4cxx::helpers::Transcoder::decode ( const std::wstring & src, LogString & dst )

static

Append the LogString equivalent of src onto dst.

decode() [7/7]

unsigned int log4cxx::helpers::Transcoder::decode ( const std::wstring & str, std::wstring::const_iterator & iter )

static

Increment iter past the next code point in str.

Precondition

iter is a valid, dereferenceable iterator.

iter and the end of str are in the same sequence.

Parameters

str	contains the code point to which iter refers.
iter	the start of the current code point.

Returns

if a valid sequence, the decoded value; otherwise, 0xFFFF and leave iter unchanged.

decodeUTF8()

void log4cxx::helpers::Transcoder::decodeUTF8 ( const std::string & src, LogString & dst )

static

Append the UTF-8 characters in src onto dst.

encode() [1/5]

CFStringRef log4cxx::helpers::Transcoder::encode ( const LogString & src )

static

A CFStringRef equivalent of src.

encode() [2/5]

void log4cxx::helpers::Transcoder::encode ( const LogString & src, std::string & dst )

static

Append the UTF8 equivalent of src onto dst.

Unrepresentable characters may be replaced with loss characters.

encode() [3/5]

void log4cxx::helpers::Transcoder::encode ( const LogString & src, std::wstring & dst )

static

Append the equivalent of src onto dst.

encode() [4/5]

void log4cxx::helpers::Transcoder::encode ( unsigned int ch, std::string & dst )

static

Append the UTF8 equivalent to ch onto dst.

encode() [5/5]

void log4cxx::helpers::Transcoder::encode ( unsigned int ch, std::wstring & dst )

static

Append the wchar_t equivalent to ch onto dst.

encodeCharsetName()

std::string log4cxx::helpers::Transcoder::encodeCharsetName ( const LogString & charsetName )

static

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

encodeUTF16BE()

void log4cxx::helpers::Transcoder::encodeUTF16BE ( unsigned int sv, ByteBuffer & dst )

static

Append the code point sv to dst as UTF-16BE.

Precondition

4 <= dst.remaining()

encodeUTF16LE()

void log4cxx::helpers::Transcoder::encodeUTF16LE ( unsigned int sv, ByteBuffer & dst )

static

Append the code point sv to dst as UTF-16LE.

Precondition

4 <= dst.remaining()

encodeUTF8() [1/2]

void log4cxx::helpers::Transcoder::encodeUTF8 ( const LogString & src, std::string & dst )

static

Append \src onto dst as a UTF-8 string.

encodeUTF8() [2/2]

void log4cxx::helpers::Transcoder::encodeUTF8 ( unsigned int sv, ByteBuffer & dst )

static

Append the code point sv to dst as UTF-8.

Precondition

4 <= dst.remaining()

getCodePoint() [1/2]

unsigned int log4cxx::helpers::Transcoder::getCodePoint ( const std::string & str, std::string::const_iterator & pCodePoint )

static

Increment pCodePoint past one str code point.

Precondition

pCodePoint is a valid, dereferenceable iterator.

pCodePoint and the end of str are in the same sequence.

Postcondition

[old_pCodePoint = pCodePoint] (old_pCodePoint < pCodePoint) // pCodePoint is always advanced

Parameters

str	contains the code point to which pCodePoint refers.
pCodePoint	the start of the current code point.

Returns

the code point value or 0xFFFD if not a valid sequence; pCodePoint is always advanced.

getCodePoint() [2/2]

unsigned int log4cxx::helpers::Transcoder::getCodePoint ( const std::wstring & str, std::wstring::const_iterator & pCodePoint )

static

Increment pCodePoint past one str code point.

Precondition

pCodePoint is a valid, dereferenceable iterator.

pCodePoint and the end of str are in the same sequence.

Postcondition

[old_pCodePoint = pCodePoint] (old_pCodePoint < pCodePoint) // pCodePoint is always advanced

Parameters

str	contains the code point to which pCodePoint refers.
pCodePoint	the start of the current code point.

Returns

the code point value or 0xFFFD if not a valid sequence; pCodePoint is always advanced.

hasReplacementCharacter() [1/2]

bool log4cxx::helpers::Transcoder::hasReplacementCharacter ( const std::string & str )

static

Does str contain the Unicode replacement character.

hasReplacementCharacter() [2/2]

bool log4cxx::helpers::Transcoder::hasReplacementCharacter ( const std::wstring & str )

static

Does str contain the Unicode replacement character.

---

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

• log4cxx/helpers/transcoder.h