AICharacterEncoding.h File Reference

#include "AITypes.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AICharacterEncodingSuite
	The character encoding suite provides facilities for translating between different encodings of textual data. More...
Defines
#define	kAICharacterEncodingSuite   "AI Character Encoding Suite"
#define	kAICharacterEncodingSuiteVersion5   AIAPI_VERSION(5)
#define	kAICharacterEncodingSuiteVersion   kAICharacterEncodingSuiteVersion5
#define	kAICharacterEncodingVersion   kAICharacterEncodingSuiteVersion
#define	kDstBufferTooShortErr   'Shrt'
	Returned from AICharacterEncodingSuite::ConvertBuffer() when the conversion requires more bytes than specified in dstBytes.
#define	kSrcHasInvalidBytesErr   'InvB'
	Returned from AICharacterEncodingSuite::ConvertBuffer() when srcBuffer contains bytes that are invalid in the given srcEncoding.
#define	kSrcCantMapBytesErr   '!Map'
	Returned from AICharacterEncodingSuite::ConvertBuffer() when srcBuffer contains bytes that cannot be mapped to the destination encodings.
#define	kSrcCantMapBytesExactlyErr   '~Map'
	Returned from AICharacterEncodingSuite::ConvertBuffer() when srcBuffer contains bytes that cannot be mapped exactly.
Enumerations
enum	AICharacterEncoding {   kAIPlatformCharacterEncoding = 0, kAIUTF8CharacterEncoding, kAIUTF16CharacterEncoding, kAIRomanCharacterEncoding = 0x10,   kAIJapaneseCharacterEncoding, kAITraditionalChineseCharacterEncoding, kAISimplifiedChineseCharacterEncoding, kAIKoreanCharacterEncoding,   kAIArabicCharacterEncoding, kAIHebrewCharacterEncoding, kAIGreekCharacterEncoding, kAICyrillicCharacterEncoding,   kAICentralEuroRomanCharacterEncoding, kAITurkishCharacterEncoding, kAIBalticCharacterEncoding, kAIRomanianCharacterEncoding,   kAIUkrainianCharacterEncoding, kAICentralEuropeanRomanCharacterEncoding = kAICentralEuroRomanCharacterEncoding, kAIIcelandicCharacterEncoding = 0x1C, kAICroatianCharacterEncoding,   kAIMacRomanCharacterEncoding, kAIWinRomanCharacterEncoding, kAIMacArabicCharacterEncoding, kAIWinArabicCharacterEncoding,   kAIMacHebrewCharacterEncoding, kAIWinHebrewCharacterEncoding, kAIMacGreekCharacterEncoding, kAIWinGreekCharacterEncoding,   kAIMacCyrillicCharacterEncoding, kAIWinCyrillicCharacterEncoding, kAIMacCentralEuroRomanCharacterEncoding, kAIMacCentralEuropeanRomanCharacterEncoding = kAIMacCentralEuroRomanCharacterEncoding,   kAIWinCentralEuroRomanCharacterEncoding, kAIWinCentralEuropeanRomanCharacterEncoding = kAIWinCentralEuroRomanCharacterEncoding, kAIMacIcelandicCharacterEncoding, kAIWinIcelandicCharacterEncoding,   kAIMacTurkishCharacterEncoding, kAIWinTurkishCharacterEncoding, kAIMacCroatianCharacterEncoding, kAIWinCroatianCharacterEncoding,   kAIMacRomanianCharacterEncoding, kAIWinRomanianCharacterEncoding, kAIMacUkrainianCharacterEncoding, kAIWinUkrainianCharacterEncoding,   kAIMacBalticCharacterEncoding, kAIWinBalticCharacterEncoding, kAIJapaneseX0213CharacterEncoding = 0x00000100, kAIChineseGB18030CharacterEncoding,   kAIChineseHKSCSCharacterEncoding, kAISymbolCharacterEncoding, kAIDummyCharacterEncoding = 0xFFFFFFFF }
	Constant values for the various character encodings supported by this suite. More...
enum	AIJapaneseEncoding { kAISJISEncoding, kAIJISEncoding, kAIKutenEncoding, kAIDummyJapaneseEncoding = 0xFFFFFFFF }
	Constant values for ways to encode characters in the JIS character set. More...

---

Detailed Description

---

Define Documentation

#define kAICharacterEncodingSuite   "AI Character Encoding Suite"

#define kAICharacterEncodingSuiteVersion   kAICharacterEncodingSuiteVersion5

#define kAICharacterEncodingSuiteVersion5   AIAPI_VERSION(5)

#define kAICharacterEncodingVersion   kAICharacterEncodingSuiteVersion

#define kSrcCantMapBytesErr   '!Map'

Returned from AICharacterEncodingSuite::ConvertBuffer() when srcBuffer contains bytes that cannot be mapped to the destination encodings.

#define kSrcCantMapBytesExactlyErr   '~Map'

Returned from AICharacterEncodingSuite::ConvertBuffer() when srcBuffer contains bytes that cannot be mapped exactly.

#define kSrcHasInvalidBytesErr   'InvB'

Returned from AICharacterEncodingSuite::ConvertBuffer() when srcBuffer contains bytes that are invalid in the given srcEncoding.

---

Enumeration Type Documentation

enum AICharacterEncoding

Constant values for the various character encodings supported by this suite.

The character sets for the specific language encodings (Roman, Japanese, and so on) are platform specific. The character sets for the specific East Asian encodings (GB, JISX0213, and so on) are standard. See AICharacterEncodingSuite::ConvertBuffer().

Enumerator:

kAIPlatformCharacterEncoding	The character set currently supported by the system.
kAIUTF8CharacterEncoding	UTF8 encoding.
kAIUTF16CharacterEncoding	UTF16 encoding (formerly kAIUCS2CharacterEncoding).
kAIRomanCharacterEncoding	Roman.
kAIJapaneseCharacterEncoding	Japanese, encoded using Shift-JIS.
kAITraditionalChineseCharacterEncoding	Traditional Chinese.
kAISimplifiedChineseCharacterEncoding	Simplified Chinese.
kAIKoreanCharacterEncoding	Korean.
kAIArabicCharacterEncoding	Arabic.
kAIHebrewCharacterEncoding	Hebrew.
kAIGreekCharacterEncoding	Greek.
kAICyrillicCharacterEncoding	Cyrillic.
kAICentralEuroRomanCharacterEncoding	Central European Roman (also known as Eastern European Roman).
kAITurkishCharacterEncoding	Turkish.
kAIBalticCharacterEncoding	Baltic.
kAIRomanianCharacterEncoding	Romanian.
kAIUkrainianCharacterEncoding	Ukrainian.
kAICentralEuropeanRomanCharacterEncoding
kAIIcelandicCharacterEncoding
kAICroatianCharacterEncoding
kAIMacRomanCharacterEncoding
kAIWinRomanCharacterEncoding
kAIMacArabicCharacterEncoding
kAIWinArabicCharacterEncoding
kAIMacHebrewCharacterEncoding
kAIWinHebrewCharacterEncoding
kAIMacGreekCharacterEncoding
kAIWinGreekCharacterEncoding
kAIMacCyrillicCharacterEncoding
kAIWinCyrillicCharacterEncoding
kAIMacCentralEuroRomanCharacterEncoding
kAIMacCentralEuropeanRomanCharacterEncoding
kAIWinCentralEuroRomanCharacterEncoding
kAIWinCentralEuropeanRomanCharacterEncoding
kAIMacIcelandicCharacterEncoding
kAIWinIcelandicCharacterEncoding
kAIMacTurkishCharacterEncoding
kAIWinTurkishCharacterEncoding
kAIMacCroatianCharacterEncoding
kAIWinCroatianCharacterEncoding
kAIMacRomanianCharacterEncoding
kAIWinRomanianCharacterEncoding
kAIMacUkrainianCharacterEncoding
kAIWinUkrainianCharacterEncoding
kAIMacBalticCharacterEncoding
kAIWinBalticCharacterEncoding
kAIJapaneseX0213CharacterEncoding	Japanese, JISX0213:2000 + JISX0208:1997, using Shift-JIS.
kAIChineseGB18030CharacterEncoding	Chinese, GB 18030-2000.
kAIChineseHKSCSCharacterEncoding	Chinese, HKSCS.
kAISymbolCharacterEncoding	SymbolEnCoding.
kAIDummyCharacterEncoding

enum AIJapaneseEncoding

Constant values for ways to encode characters in the JIS character set.

See AICharacterEncodingSuite::ConvertJapaneseChar().

Enumerator:

kAISJISEncoding	Shift-JIS.
kAIJISEncoding	JISX0208:1997.
kAIKutenEncoding	Kuten.
kAIDummyJapaneseEncoding