Burger::Win1252 Class Reference

Conversion routines to support the Win1252 text encoding scheme. More...

Inheritance diagram for Burger::Win1252:

Collaboration diagram for Burger::Win1252:

Static Public Member Functions
static uint32_t	translate_from_UTF8 (const char *pInput) noexcept
	Convert a single UTF8 stream character into a Win1252 8 bit char.
static uintptr_t	translate_from_UTF8 (char *pOutput, uintptr_t uOutputSize, const char *pInput) noexcept
	Convert a UTF8 stream into a Win1252 "C" string.
static uintptr_t	translate_from_UTF8 (char *pOutput, uintptr_t uOutputSize, const char *pInput, uintptr_t uInputSize) noexcept
	Convert a UTF8 stream into a Win1252 byte array.

Static Public Attributes
static const uint8_t	g_UpperCaseTable [256]
	Table to convert all characters to upper case.
static const uint8_t	g_LowerCaseTable [256]
	Table to convert all characters to lower case.
static const uint8_t	g_ToUTF8Table [128][4]
	Table to convert Win1252 to UTF8.
static const uint16_t	g_ToUTF16Table [128]
	Table to convert Win1252 to UTF16.
Static Public Attributes inherited from Burger::CodePage
static const uint32_t	kInvalid = UINT32_MAX
	Value returned if a routine failed.

Detailed Description

Conversion routines to support the Win1252 text encoding scheme.

---

Win1252 is a high ASCII encoding that's used by the Windows file system for Windows XP, NT, etc. This class will allow the conversion of other character mappings to Win1252 for use in calling Win32 API functions.

The character map for Win1252 looks like this. Click here.

See also

Win437, ISOLatin1, or MacRomanUS

Member Function Documentation

translate_from_UTF8() [1/3]

uintptr_t BURGER_API Burger::Win1252::translate_from_UTF8 ( char * pOutput, uintptr_t uOutputSize, const char * pInput )

staticnoexcept

Convert a UTF8 stream into a Win1252 "C" string.

---

Take a "C" string that is using UTF8 encoding and convert it into a Win1252 encoded "C" string. The function will return the size of the string after encoding. This size is valid, even if it exceeded the output buffer size. The output pointer and size can be nullptr to have this routine calculate the size of the possible output so the application can allocate a buffer large enough to hold it.

Note

This function will ensure that the string is always zero terminated, even if truncation is necessary to get it to fit in the output buffer. Under no circumstances will the output buffer be overrun.

Parameters

pOutput	Pointer to byte buffer to receive the Win1252 encoded string. nullptr is okay if uOutputSize is zero, otherwise it will page fault.
uOutputSize	Size of the output buffer in bytes.
pInput	A UTF8 encoded "C" string. nullptr will page fault.

Returns

Burger::StringLength() of the potential output. It is valid, even if the output buffer wasn't large enough to contain everything.

translate_from_UTF8() [2/3]

uintptr_t BURGER_API Burger::Win1252::translate_from_UTF8 ( char * pOutput, uintptr_t uOutputSize, const char * pInput, uintptr_t uInputSize )

staticnoexcept

Convert a UTF8 stream into a Win1252 byte array.

---

Take a byte array that is using UTF8 encoding and convert it to a Win1252 encoded "C" string. The function will return the size of the string after encoding. This size is valid, even if it exceeded the output buffer size. The output pointer and size can be nullptr to have this routine calculate the size of the possible output so the application can allocate a buffer large enough to hold it.

Note

This function will ensure that the string is always zero terminated, even if truncation is necessary to get it to fit in the output buffer. Under no circumstances will the output buffer be overrun.

Zeros can be encoded into the stream. This function will not early out if a zero was parsed. Zeros will be placed in the Win1252 stream as is.

Parameters

pOutput	Pointer to a byte buffer to receive the Win1252 string. nullptr is okay if uOutputSize is zero, otherwise a page fault will occur.
uOutputSize	Size of the output buffer in bytes.
pInput	UTF8 encoded byte array. nullptr is okay if uInputSize is zero.
uInputSize	Size of the input byte array.

Returns

Burger::StringLength() of the potential output. It is valid, even if the output buffer wasn't large enough to contain everything.

translate_from_UTF8() [3/3]

uint32_t BURGER_API Burger::Win1252::translate_from_UTF8 ( const char * pInput )

staticnoexcept

Convert a single UTF8 stream character into a Win1252 8 bit char.

---

Take up 3 bytes from a UTF8 stream and return the unsigned 8 bit value of the Win1252 character. Codes 0 through 0x7f are considered ASCII while codes 0x80 through 0xFF are mapped to Win1252. If the UTF8 character cannot be mapped to Win1252 encoding, Burger::CodePage::kInvalid will be returned instead.

Note

This function will not return the number of bytes decoded. Use Burger::UTF8::NextToken(const char *) to get the pointer to the next UTF8 entry.

Parameters

pInput

Pointer to UTF8 buffer that contains the 1 to 3 byte buffer to convert. nullptr will page fault.

Returns

The unsigned 8 bit character code (0x00-0xFF) or Burger::CodePage::kInvalid if the UTF8 value wasn't low ASCII and couldn't be mapped to Win1252.

See also

Burger::UTF8::NextToken(const char *) or Burger::UTF8::GetTokenSize(const char *)

Member Data Documentation

g_LowerCaseTable

const uint8_t Burger::Win1252::g_LowerCaseTable

static

Table to convert all characters to lower case.

---

Using Win1252 mapping, this table will convert all 256 codes into their lower case equivalents.

g_ToUTF16Table

const uint16_t Burger::Win1252::g_ToUTF16Table

static

Table to convert Win1252 to UTF16.

---

Since no Unicode token is larger than 16 bits, an array of uint16_t values holds the 128 high ascii codes for Win1252 converted to UTF16. Some unprintable codes don't exist and are marked as themselves for the pattern. These are codes 0x81, 0x8D, 0x8F, 0x90 and 0x9D.

The character map for Win1252 looks like this. Click here.

g_ToUTF8Table

const uint8_t Burger::Win1252::g_ToUTF8Table

static

Table to convert Win1252 to UTF8.

---

This 128x4 array holds the 128 high ascii codes for Win1252 converted to UTF8. Some unprintable codes don't exist and are marked as themselves for the pattern. These are codes 0x81, 0x8D, 0x8F, 0x90 and 0x9D.

The character map for Win1252 looks like this. Click here.

g_UpperCaseTable

const uint8_t Burger::Win1252::g_UpperCaseTable

static

Table to convert all characters to upper case.

---

Using Win1252 mapping, this table will convert all 256 codes into their upper case equivalents.