UnicodeConverter.h

Go to the documentation of this file.

 
#ifndef __UNICODECONVERTER__
#define __UNICODECONVERTER__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __TEXTCOMMON__
#include <TextCommon.h>
#endif
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
typedef struct OpaqueTextToUnicodeInfo *TextToUnicodeInfo;
typedef struct OpaqueUnicodeToTextInfo *UnicodeToTextInfo;
typedef struct OpaqueUnicodeToTextRunInfo *UnicodeToTextRunInfo;
typedef const TextToUnicodeInfo ConstTextToUnicodeInfo;
typedef const UnicodeToTextInfo ConstUnicodeToTextInfo;
typedef SInt32 UnicodeMapVersion;
enum { kUnicodeUseLatestMapping = -1, kUnicodeUseHFSPlusMapping = 4 };
 
struct UnicodeMapping {
  TextEncoding unicodeEncoding;
  TextEncoding otherEncoding;
  UnicodeMapVersion mappingVersion;
};
typedef struct UnicodeMapping UnicodeMapping;
typedef UnicodeMapping *UnicodeMappingPtr;
typedef const UnicodeMapping *ConstUnicodeMappingPtr;
enum {
  kUnicodeUseFallbacksBit = 0,
  kUnicodeKeepInfoBit = 1,
  kUnicodeDirectionalityBits = 2,
  kUnicodeVerticalFormBit = 4,
  kUnicodeLooseMappingsBit = 5,
  kUnicodeStringUnterminatedBit = 6,
  kUnicodeTextRunBit = 7,
  kUnicodeKeepSameEncodingBit = 8,
  kUnicodeForceASCIIRangeBit = 9,
  kUnicodeNoHalfwidthCharsBit = 10,
  kUnicodeTextRunHeuristicsBit = 11
};
 
enum {
  kUnicodeUseFallbacksMask = 1L << kUnicodeUseFallbacksBit,
  kUnicodeKeepInfoMask = 1L << kUnicodeKeepInfoBit,
  kUnicodeDirectionalityMask = 3L << kUnicodeDirectionalityBits,
  kUnicodeVerticalFormMask = 1L << kUnicodeVerticalFormBit,
  kUnicodeLooseMappingsMask = 1L << kUnicodeLooseMappingsBit,
  kUnicodeStringUnterminatedMask = 1L << kUnicodeStringUnterminatedBit,
  kUnicodeTextRunMask = 1L << kUnicodeTextRunBit,
  kUnicodeKeepSameEncodingMask = 1L << kUnicodeKeepSameEncodingBit,
  kUnicodeForceASCIIRangeMask = 1L << kUnicodeForceASCIIRangeBit,
  kUnicodeNoHalfwidthCharsMask = 1L << kUnicodeNoHalfwidthCharsBit,
  kUnicodeTextRunHeuristicsMask = 1L << kUnicodeTextRunHeuristicsBit
};
 
enum {
  kUnicodeDefaultDirection = 0,
  kUnicodeLeftToRight = 1,
  kUnicodeRightToLeft = 2
};
 
enum {
  kUnicodeDefaultDirectionMask = kUnicodeDefaultDirection
                                 << kUnicodeDirectionalityBits,
  kUnicodeLeftToRightMask = kUnicodeLeftToRight << kUnicodeDirectionalityBits,
  kUnicodeRightToLeftMask = kUnicodeRightToLeft << kUnicodeDirectionalityBits
};
 
enum {
  kUnicodeMatchUnicodeBaseBit = 0,
  kUnicodeMatchUnicodeVariantBit = 1,
  kUnicodeMatchUnicodeFormatBit = 2,
  kUnicodeMatchOtherBaseBit = 3,
  kUnicodeMatchOtherVariantBit = 4,
  kUnicodeMatchOtherFormatBit = 5
};
 
enum {
  kUnicodeMatchUnicodeBaseMask = 1L << kUnicodeMatchUnicodeBaseBit,
  kUnicodeMatchUnicodeVariantMask = 1L << kUnicodeMatchUnicodeVariantBit,
  kUnicodeMatchUnicodeFormatMask = 1L << kUnicodeMatchUnicodeFormatBit,
  kUnicodeMatchOtherBaseMask = 1L << kUnicodeMatchOtherBaseBit,
  kUnicodeMatchOtherVariantMask = 1L << kUnicodeMatchOtherVariantBit,
  kUnicodeMatchOtherFormatMask = 1L << kUnicodeMatchOtherFormatBit
};
 
enum { kUnicodeFallbackSequencingBits = 0 };
 
enum {
  kUnicodeFallbackSequencingMask = 3L << kUnicodeFallbackSequencingBits,
  kUnicodeFallbackInterruptSafeMask =
      1L << 2 
};
 
enum {
  kUnicodeFallbackDefaultOnly = 0L,
  kUnicodeFallbackCustomOnly = 1L,
  kUnicodeFallbackDefaultFirst = 2L,
  kUnicodeFallbackCustomFirst = 3L
};
 
typedef CALLBACK_API(OSStatus, UnicodeToTextFallbackProcPtr)(
    UniChar *iSrcUniStr, ByteCount iSrcUniStrLen, ByteCount *oSrcConvLen,
    TextPtr oDestStr, ByteCount iDestStrLen, ByteCount *oDestConvLen,
    LogicalAddress iInfoPtr, ConstUnicodeMappingPtr iUnicodeMappingPtr);
typedef STACK_UPP_TYPE(UnicodeToTextFallbackProcPtr) UnicodeToTextFallbackUPP;
UnicodeToTextFallbackUPP
NewUnicodeToTextFallbackUPP(UnicodeToTextFallbackProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
enum {
  uppUnicodeToTextFallbackProcInfo = 0x003FFFF0
}; 
#ifdef __cplusplus
inline UnicodeToTextFallbackUPP
NewUnicodeToTextFallbackUPP(UnicodeToTextFallbackProcPtr userRoutine) {
  return (UnicodeToTextFallbackUPP)NewRoutineDescriptor(
      (ProcPtr)(userRoutine), uppUnicodeToTextFallbackProcInfo,
      GetCurrentArchitecture());
}
#else
#define NewUnicodeToTextFallbackUPP(userRoutine)                               \
  (UnicodeToTextFallbackUPP) NewRoutineDescriptor(                             \
      (ProcPtr)(userRoutine), uppUnicodeToTextFallbackProcInfo,                \
      GetCurrentArchitecture())
#endif
#endif
 
void
DisposeUnicodeToTextFallbackUPP(UnicodeToTextFallbackUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
inline void DisposeUnicodeToTextFallbackUPP(UnicodeToTextFallbackUPP userUPP) {
  DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
}
#else
#define DisposeUnicodeToTextFallbackUPP(userUPP)                               \
  DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
OSStatus
InvokeUnicodeToTextFallbackUPP(UniChar *iSrcUniStr, ByteCount iSrcUniStrLen,
                               ByteCount *oSrcConvLen, TextPtr oDestStr,
                               ByteCount iDestStrLen, ByteCount *oDestConvLen,
                               LogicalAddress iInfoPtr,
                               ConstUnicodeMappingPtr iUnicodeMappingPtr,
                               UnicodeToTextFallbackUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
inline OSStatus InvokeUnicodeToTextFallbackUPP(
    UniChar *iSrcUniStr, ByteCount iSrcUniStrLen, ByteCount *oSrcConvLen,
    TextPtr oDestStr, ByteCount iDestStrLen, ByteCount *oDestConvLen,
    LogicalAddress iInfoPtr, ConstUnicodeMappingPtr iUnicodeMappingPtr,
    UnicodeToTextFallbackUPP userUPP) {
  return (OSStatus)CALL_EIGHT_PARAMETER_UPP(
      userUPP, uppUnicodeToTextFallbackProcInfo, iSrcUniStr, iSrcUniStrLen,
      oSrcConvLen, oDestStr, iDestStrLen, oDestConvLen, iInfoPtr,
      iUnicodeMappingPtr);
}
#else
#define InvokeUnicodeToTextFallbackUPP(iSrcUniStr, iSrcUniStrLen, oSrcConvLen, \
                                       oDestStr, iDestStrLen, oDestConvLen,    \
                                       iInfoPtr, iUnicodeMappingPtr, userUPP)  \
  (OSStatus) CALL_EIGHT_PARAMETER_UPP(                                         \
      (userUPP), uppUnicodeToTextFallbackProcInfo, (iSrcUniStr),               \
      (iSrcUniStrLen), (oSrcConvLen), (oDestStr), (iDestStrLen),               \
      (oDestConvLen), (iInfoPtr), (iUnicodeMappingPtr))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewUnicodeToTextFallbackProc(userRoutine)                              \
  NewUnicodeToTextFallbackUPP(userRoutine)
#define CallUnicodeToTextFallbackProc(                                         \
    userRoutine, iSrcUniStr, iSrcUniStrLen, oSrcConvLen, oDestStr,             \
    iDestStrLen, oDestConvLen, iInfoPtr, iUnicodeMappingPtr)                   \
  InvokeUnicodeToTextFallbackUPP(iSrcUniStr, iSrcUniStrLen, oSrcConvLen,       \
                                 oDestStr, iDestStrLen, oDestConvLen,          \
                                 iInfoPtr, iUnicodeMappingPtr, userRoutine)
#endif 
#if TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#if CALL_NOT_IN_CARBON
OSStatus
InitializeUnicodeConverter(StringPtr TECFileName);
 
void
TerminateUnicodeConverter(void);
 
#endif 
#endif 
OSStatus
CreateTextToUnicodeInfo(ConstUnicodeMappingPtr iUnicodeMapping,
                        TextToUnicodeInfo *oTextToUnicodeInfo);
 
OSStatus
CreateTextToUnicodeInfoByEncoding(TextEncoding iEncoding,
                                  TextToUnicodeInfo *oTextToUnicodeInfo);
 
OSStatus
CreateUnicodeToTextInfo(ConstUnicodeMappingPtr iUnicodeMapping,
                        UnicodeToTextInfo *oUnicodeToTextInfo);
 
OSStatus
CreateUnicodeToTextInfoByEncoding(TextEncoding iEncoding,
                                  UnicodeToTextInfo *oUnicodeToTextInfo);
 
OSStatus
CreateUnicodeToTextRunInfo(ItemCount iNumberOfMappings,
                           const UnicodeMapping iUnicodeMappings[],
                           UnicodeToTextRunInfo *oUnicodeToTextInfo);
 
OSStatus
CreateUnicodeToTextRunInfoByEncoding(ItemCount iNumberOfEncodings,
                                     const TextEncoding iEncodings[],
                                     UnicodeToTextRunInfo *oUnicodeToTextInfo);
 
OSStatus
CreateUnicodeToTextRunInfoByScriptCode(
    ItemCount iNumberOfScriptCodes, const ScriptCode iScripts[],
    UnicodeToTextRunInfo *oUnicodeToTextInfo);
 
OSStatus
ChangeTextToUnicodeInfo(TextToUnicodeInfo ioTextToUnicodeInfo,
                        ConstUnicodeMappingPtr iUnicodeMapping);
 
OSStatus
ChangeUnicodeToTextInfo(UnicodeToTextInfo ioUnicodeToTextInfo,
                        ConstUnicodeMappingPtr iUnicodeMapping);
 
OSStatus
DisposeTextToUnicodeInfo(TextToUnicodeInfo *ioTextToUnicodeInfo);
 
OSStatus
DisposeUnicodeToTextInfo(UnicodeToTextInfo *ioUnicodeToTextInfo);
 
OSStatus
DisposeUnicodeToTextRunInfo(UnicodeToTextRunInfo *ioUnicodeToTextRunInfo);
 
OSStatus
ConvertFromTextToUnicode(TextToUnicodeInfo iTextToUnicodeInfo,
                         ByteCount iSourceLen, ConstLogicalAddress iSourceStr,
                         OptionBits iControlFlags, ItemCount iOffsetCount,
                         ByteOffset iOffsetArray[], 
                         ItemCount *oOffsetCount,   
                         ByteOffset oOffsetArray[], 
                         ByteCount iOutputBufLen, ByteCount *oSourceRead,
                         ByteCount *oUnicodeLen, UniChar oUnicodeStr[]);
 
OSStatus
ConvertFromUnicodeToText(UnicodeToTextInfo iUnicodeToTextInfo,
                         ByteCount iUnicodeLen, const UniChar iUnicodeStr[],
                         OptionBits iControlFlags, ItemCount iOffsetCount,
                         ByteOffset iOffsetArray[], 
                         ItemCount *oOffsetCount,   
                         ByteOffset oOffsetArray[], 
                         ByteCount iOutputBufLen, ByteCount *oInputRead,
                         ByteCount *oOutputLen, LogicalAddress oOutputStr);
 
OSStatus
ConvertFromUnicodeToTextRun(UnicodeToTextRunInfo iUnicodeToTextInfo,
                            ByteCount iUnicodeLen, const UniChar iUnicodeStr[],
                            OptionBits iControlFlags, ItemCount iOffsetCount,
                            ByteOffset iOffsetArray[], 
                            ItemCount *oOffsetCount,   
                            ByteOffset oOffsetArray[], 
                            ByteCount iOutputBufLen, ByteCount *oInputRead,
                            ByteCount *oOutputLen, LogicalAddress oOutputStr,
                            ItemCount iEncodingRunBufLen,
                            ItemCount *oEncodingRunOutLen,
                            TextEncodingRun oEncodingRuns[]);
 
OSStatus
ConvertFromUnicodeToScriptCodeRun(
    UnicodeToTextRunInfo iUnicodeToTextInfo, ByteCount iUnicodeLen,
    const UniChar iUnicodeStr[], OptionBits iControlFlags,
    ItemCount iOffsetCount, ByteOffset iOffsetArray[], 
    ItemCount *oOffsetCount,                           
    ByteOffset oOffsetArray[],                         
    ByteCount iOutputBufLen, ByteCount *oInputRead, ByteCount *oOutputLen,
    LogicalAddress oOutputStr, ItemCount iScriptRunBufLen,
    ItemCount *oScriptRunOutLen, ScriptCodeRun oScriptCodeRuns[]);
 
OSStatus
TruncateForTextToUnicode(ConstTextToUnicodeInfo iTextToUnicodeInfo,
                         ByteCount iSourceLen, ConstLogicalAddress iSourceStr,
                         ByteCount iMaxLen, ByteCount *oTruncatedLen);
 
OSStatus
TruncateForUnicodeToText(ConstUnicodeToTextInfo iUnicodeToTextInfo,
                         ByteCount iSourceLen, const UniChar iSourceStr[],
                         OptionBits iControlFlags, ByteCount iMaxLen,
                         ByteCount *oTruncatedLen);
 
OSStatus
ConvertFromPStringToUnicode(TextToUnicodeInfo iTextToUnicodeInfo,
                            ConstStr255Param iPascalStr,
                            ByteCount iOutputBufLen, ByteCount *oUnicodeLen,
                            UniChar oUnicodeStr[]);
 
OSStatus
ConvertFromUnicodeToPString(UnicodeToTextInfo iUnicodeToTextInfo,
                            ByteCount iUnicodeLen, const UniChar iUnicodeStr[],
                            Str255 oPascalStr);
 
OSStatus
CountUnicodeMappings(OptionBits iFilter, ConstUnicodeMappingPtr iFindMapping,
                     ItemCount *oActualCount);
 
OSStatus
QueryUnicodeMappings(OptionBits iFilter, ConstUnicodeMappingPtr iFindMapping,
                     ItemCount iMaxCount, ItemCount *oActualCount,
                     UnicodeMapping oReturnedMappings[]);
 
OSStatus
SetFallbackUnicodeToText(UnicodeToTextInfo iUnicodeToTextInfo,
                         UnicodeToTextFallbackUPP iFallback,
                         OptionBits iControlFlags, LogicalAddress iInfoPtr);
 
OSStatus
SetFallbackUnicodeToTextRun(UnicodeToTextRunInfo iUnicodeToTextRunInfo,
                            UnicodeToTextFallbackUPP iFallback,
                            OptionBits iControlFlags, LogicalAddress iInfoPtr);
 
OSStatus
ResetTextToUnicodeInfo(TextToUnicodeInfo ioTextToUnicodeInfo);
 
OSStatus
ResetUnicodeToTextInfo(UnicodeToTextInfo ioUnicodeToTextInfo);
 
OSStatus
ResetUnicodeToTextRunInfo(UnicodeToTextRunInfo ioUnicodeToTextRunInfo);
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif