| /* CFStringEncodingConverter.h |
| Copyright (c) 1998-2016, Apple Inc. and the Swift project authors |
| |
| Portions Copyright (c) 2014-2016 Apple Inc. and the Swift project authors |
| Licensed under Apache License v2.0 with Runtime Library Exception |
| See http://swift.org/LICENSE.txt for license information |
| See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors |
| */ |
| |
| #if !defined(__COREFOUNDATION_CFSTRINGENCODINGCONVERTER__) |
| #define __COREFOUNDATION_CFSTRINGENCODINGCONVERTER__ 1 |
| |
| #include <CoreFoundation/CFString.h> |
| |
| |
| CF_EXTERN_C_BEGIN |
| |
| /* Values for flags argument for the conversion functions below. These can be combined, but the three NonSpacing behavior flags are exclusive. |
| */ |
| // kCFStringEncodingBasicDirectionLeftToRight ~ kCFStringEncodingPrependBOM will probably be deprecated and superceded by kCFStringEncodingPartialInput flag |
| enum { |
| kCFStringEncodingAllowLossyConversion = (1UL << 0), // Uses fallback functions to substitutes non mappable chars |
| kCFStringEncodingBasicDirectionLeftToRight = (1UL << 1), // Converted with original direction left-to-right. |
| kCFStringEncodingBasicDirectionRightToLeft = (1UL << 2), // Converted with original direction right-to-left. |
| kCFStringEncodingSubstituteCombinings = (1UL << 3), // Uses fallback function to combining chars. |
| kCFStringEncodingComposeCombinings = (1UL << 4), // Checks mappable precomposed equivalents for decomposed sequences. This is the default behavior. |
| kCFStringEncodingIgnoreCombinings = (1UL << 5), // Ignores combining chars. |
| kCFStringEncodingUseCanonical = (1UL << 6), // Always use canonical form |
| kCFStringEncodingUseHFSPlusCanonical = (1UL << 7), // Always use canonical form but leaves 0x2000 ranges |
| kCFStringEncodingPrependBOM = (1UL << 8), // Prepend BOM sequence (i.e. ISO2022KR) |
| kCFStringEncodingDisableCorporateArea = (1UL << 9), // Disable the usage of 0xF8xx area for Apple proprietary chars in converting to UniChar, resulting loosely mapping. |
| kCFStringEncodingASCIICompatibleConversion = (1UL << 10), // This flag forces strict ASCII compatible converion. i.e. MacJapanese 0x5C maps to Unicode 0x5C. |
| kCFStringEncodingLenientUTF8Conversion = (1UL << 11), // 10.1 (Puma) compatible lenient UTF-8 conversion. |
| kCFStringEncodingPartialInput = (1UL << 12), // input buffer is a part of stream |
| kCFStringEncodingPartialOutput = (1UL << 13) // output buffer streaming |
| }; |
| |
| /* Return values for CFStringEncodingUnicodeToBytes & CFStringEncodingBytesToUnicode functions |
| */ |
| enum { |
| kCFStringEncodingConversionSuccess = 0, |
| kCFStringEncodingInvalidInputStream = 1, |
| kCFStringEncodingInsufficientOutputBufferLength = 2, |
| kCFStringEncodingConverterUnavailable = 3 |
| }; |
| |
| /* Macro to shift lossByte argument. |
| */ |
| #define CFStringEncodingLossyByteToMask(lossByte) ((uint32_t)(lossByte << 24)|kCFStringEncodingAllowLossyConversion) |
| #define CFStringEncodingMaskToLossyByte(flags) ((uint8_t)(flags >> 24)) |
| |
| /* Macros for streaming support |
| */ |
| #define CFStringEncodingStreamIDMask (0x00FF0000) |
| #define CFStringEncodingStreamIDFromMask(mask) ((mask >> 16) & 0xFF) |
| #define CFStringEncodingStreamIDToMask(identifier) ((uint32_t)((identifier & 0xFF) << 16)) |
| |
| /* Converts characters into the specified encoding. Returns the constants defined above. |
| If maxByteLen is 0, bytes is ignored. You can pass lossyByte by passing the value in flags argument. |
| i.e. CFStringEncodingUnicodeToBytes(encoding, CFStringEncodingLossyByteToMask(lossByte), ....) |
| */ |
| CF_EXPORT uint32_t CFStringEncodingUnicodeToBytes(uint32_t encoding, uint32_t flags, const UniChar *characters, CFIndex numChars, CFIndex *usedCharLen, uint8_t *bytes, CFIndex maxByteLen, CFIndex *usedByteLen); |
| |
| /* Converts bytes in the specified encoding into unicode. Returns the constants defined above. |
| maxCharLen & usdCharLen are in UniChar length, not byte length. |
| If maxCharLen is 0, characters is ignored. |
| */ |
| CF_EXPORT uint32_t CFStringEncodingBytesToUnicode(uint32_t encoding, uint32_t flags, const uint8_t *bytes, CFIndex numBytes, CFIndex *usedByteLen, UniChar *characters, CFIndex maxCharLen, CFIndex *usedCharLen); |
| |
| /* Fallback functions used when allowLossy |
| */ |
| typedef CFIndex (*CFStringEncodingToBytesFallbackProc)(const UniChar *characters, CFIndex numChars, uint8_t *bytes, CFIndex maxByteLen, CFIndex *usedByteLen); |
| typedef CFIndex (*CFStringEncodingToUnicodeFallbackProc)(const uint8_t *bytes, CFIndex numBytes, UniChar *characters, CFIndex maxCharLen, CFIndex *usedCharLen); |
| |
| CF_EXPORT bool CFStringEncodingIsValidEncoding(uint32_t encoding); |
| |
| /* Returns kCFStringEncodingInvalidId terminated encoding list |
| */ |
| CF_EXPORT const CFStringEncoding *CFStringEncodingListOfAvailableEncodings(void); |
| |
| /* Returns required length of destination buffer for conversion. These functions are faster than specifying 0 to maxByteLen (maxCharLen), but unnecessarily optimal length |
| */ |
| CF_EXPORT CFIndex CFStringEncodingCharLengthForBytes(uint32_t encoding, uint32_t flags, const uint8_t *bytes, CFIndex numBytes); |
| CF_EXPORT CFIndex CFStringEncodingByteLengthForCharacters(uint32_t encoding, uint32_t flags, const UniChar *characters, CFIndex numChars); |
| |
| /* Can register functions used for lossy conversion. Reregisters default procs if NULL |
| */ |
| CF_EXPORT void CFStringEncodingRegisterFallbackProcedures(uint32_t encoding, CFStringEncodingToBytesFallbackProc toBytes, CFStringEncodingToUnicodeFallbackProc toUnicode); |
| |
| CF_EXTERN_C_END |
| |
| #endif /* ! __COREFOUNDATION_CFSTRINGENCODINGCONVERTER__ */ |
| |