home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 January: Mac OS SDK / Dev.CD Jan 99 SDK1.toast / Development Kits / Interfaces&Libraries / Universal / Interfaces / CIncludes / UnicodeConverter.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-17  |  13.3 KB  |  400 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        UnicodeConverter.h
  3.  
  4.      Contains:    Types, constants, and prototypes for Unicode Converter
  5.  
  6.      Version:    Technology:    Mac OS 8
  7.                  Release:    Universal Interfaces 3.2
  8.  
  9.      Copyright:    © 1994-1998 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __UNICODECONVERTER__
  18. #define __UNICODECONVERTER__
  19.  
  20. #ifndef __MACTYPES__
  21. #include <MacTypes.h>
  22. #endif
  23. #ifndef __TEXTCOMMON__
  24. #include <TextCommon.h>
  25. #endif
  26. #ifndef __MIXEDMODE__
  27. #include <MixedMode.h>
  28. #endif
  29.  
  30.  
  31.  
  32. #if PRAGMA_ONCE
  33. #pragma once
  34. #endif
  35.  
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  39.  
  40. #if PRAGMA_IMPORT
  41. #pragma import on
  42. #endif
  43.  
  44. #if PRAGMA_STRUCT_ALIGN
  45.     #pragma options align=mac68k
  46. #elif PRAGMA_STRUCT_PACKPUSH
  47.     #pragma pack(push, 2)
  48. #elif PRAGMA_STRUCT_PACK
  49.     #pragma pack(2)
  50. #endif
  51.  
  52. /* Unicode conversion contexts: */
  53. typedef struct OpaqueTextToUnicodeInfo*  TextToUnicodeInfo;
  54. typedef struct OpaqueUnicodeToTextInfo*  UnicodeToTextInfo;
  55. typedef struct OpaqueUnicodeToTextRunInfo*  UnicodeToTextRunInfo;
  56. typedef const TextToUnicodeInfo         ConstTextToUnicodeInfo;
  57. typedef const UnicodeToTextInfo         ConstUnicodeToTextInfo;
  58. /* UnicodeMapVersion type & values */
  59. typedef SInt32                             UnicodeMapVersion;
  60.  
  61. enum {
  62.     kUnicodeUseLatestMapping    = -1,
  63.     kUnicodeUseHFSPlusMapping    = 4
  64. };
  65.  
  66. /* Types used in conversion */
  67.  
  68. struct UnicodeMapping {
  69.     TextEncoding                     unicodeEncoding;
  70.     TextEncoding                     otherEncoding;
  71.     UnicodeMapVersion                 mappingVersion;
  72. };
  73. typedef struct UnicodeMapping            UnicodeMapping;
  74. typedef UnicodeMapping *                UnicodeMappingPtr;
  75.  
  76. typedef const UnicodeMapping *            ConstUnicodeMappingPtr;
  77. /* Control flags for ConvertFromUnicodeToText and ConvertFromTextToUnicode */
  78.  
  79. enum {
  80.     kUnicodeUseFallbacksBit        = 0,
  81.     kUnicodeKeepInfoBit            = 1,
  82.     kUnicodeDirectionalityBits    = 2,
  83.     kUnicodeVerticalFormBit        = 4,
  84.     kUnicodeLooseMappingsBit    = 5,
  85.     kUnicodeStringUnterminatedBit = 6,
  86.     kUnicodeTextRunBit            = 7,
  87.     kUnicodeKeepSameEncodingBit    = 8,
  88.     kUnicodeForceASCIIRangeBit    = 9,
  89.     kUnicodeNoHalfwidthCharsBit    = 10
  90. };
  91.  
  92.  
  93. enum {
  94.     kUnicodeUseFallbacksMask    = 1L << kUnicodeUseFallbacksBit,
  95.     kUnicodeKeepInfoMask        = 1L << kUnicodeKeepInfoBit,
  96.     kUnicodeDirectionalityMask    = 3L << kUnicodeDirectionalityBits,
  97.     kUnicodeVerticalFormMask    = 1L << kUnicodeVerticalFormBit,
  98.     kUnicodeLooseMappingsMask    = 1L << kUnicodeLooseMappingsBit,
  99.     kUnicodeStringUnterminatedMask = 1L << kUnicodeStringUnterminatedBit,
  100.     kUnicodeTextRunMask            = 1L << kUnicodeTextRunBit,
  101.     kUnicodeKeepSameEncodingMask = 1L << kUnicodeKeepSameEncodingBit,
  102.     kUnicodeForceASCIIRangeMask    = 1L << kUnicodeForceASCIIRangeBit,
  103.     kUnicodeNoHalfwidthCharsMask = 1L << kUnicodeNoHalfwidthCharsBit
  104. };
  105.  
  106. /* Values for kUnicodeDirectionality field */
  107.  
  108. enum {
  109.     kUnicodeDefaultDirection    = 0,
  110.     kUnicodeLeftToRight            = 1,
  111.     kUnicodeRightToLeft            = 2
  112. };
  113.  
  114. /* Directionality masks for control flags */
  115.  
  116. enum {
  117.     kUnicodeDefaultDirectionMask = kUnicodeDefaultDirection << kUnicodeDirectionalityBits,
  118.     kUnicodeLeftToRightMask        = kUnicodeLeftToRight << kUnicodeDirectionalityBits,
  119.     kUnicodeRightToLeftMask        = kUnicodeRightToLeft << kUnicodeDirectionalityBits
  120. };
  121.  
  122. /* Control flags for TruncateForUnicodeToText: */
  123. /*
  124.    Now TruncateForUnicodeToText uses control flags from the same set as used by
  125.    ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc., but only
  126.    kUnicodeStringUnterminatedMask is meaningful for TruncateForUnicodeToText.
  127.    
  128.    Previously two special control flags were defined for TruncateForUnicodeToText:
  129.           kUnicodeTextElementSafeBit = 0
  130.           kUnicodeRestartSafeBit = 1
  131.    However, neither of these was implemented.
  132.    Instead of implementing kUnicodeTextElementSafeBit, we now use
  133.    kUnicodeStringUnterminatedMask since it accomplishes the same thing and avoids
  134.    having special flags just for TruncateForUnicodeToText
  135.    Also, kUnicodeRestartSafeBit is unnecessary, since restart-safeness is handled by
  136.    setting kUnicodeKeepInfoBit with ConvertFromUnicodeToText.
  137.    If TruncateForUnicodeToText is called with one or both of the old special control
  138.    flags set (bits 0 or 1), it will not generate a paramErr, but the old bits have no
  139.    effect on its operation.
  140. */
  141.  
  142. /* Filter bits for filter field in QueryUnicodeMappings and CountUnicodeMappings: */
  143.  
  144. enum {
  145.     kUnicodeMatchUnicodeBaseBit    = 0,
  146.     kUnicodeMatchUnicodeVariantBit = 1,
  147.     kUnicodeMatchUnicodeFormatBit = 2,
  148.     kUnicodeMatchOtherBaseBit    = 3,
  149.     kUnicodeMatchOtherVariantBit = 4,
  150.     kUnicodeMatchOtherFormatBit    = 5
  151. };
  152.  
  153.  
  154. enum {
  155.     kUnicodeMatchUnicodeBaseMask = 1L << kUnicodeMatchUnicodeBaseBit,
  156.     kUnicodeMatchUnicodeVariantMask = 1L << kUnicodeMatchUnicodeVariantBit,
  157.     kUnicodeMatchUnicodeFormatMask = 1L << kUnicodeMatchUnicodeFormatBit,
  158.     kUnicodeMatchOtherBaseMask    = 1L << kUnicodeMatchOtherBaseBit,
  159.     kUnicodeMatchOtherVariantMask = 1L << kUnicodeMatchOtherVariantBit,
  160.     kUnicodeMatchOtherFormatMask = 1L << kUnicodeMatchOtherFormatBit
  161. };
  162.  
  163. /* Control flags for SetFallbackUnicodeToText */
  164.  
  165. enum {
  166.     kUnicodeFallbackSequencingBits = 0
  167. };
  168.  
  169.  
  170. enum {
  171.     kUnicodeFallbackSequencingMask = 3L << kUnicodeFallbackSequencingBits
  172. };
  173.  
  174. /* values for kUnicodeFallbackSequencing field */
  175.  
  176. enum {
  177.     kUnicodeFallbackDefaultOnly    = 0L,
  178.     kUnicodeFallbackCustomOnly    = 1L,
  179.     kUnicodeFallbackDefaultFirst = 2L,
  180.     kUnicodeFallbackCustomFirst    = 3L
  181. };
  182.  
  183.  
  184. /* Caller-supplied entry point to a fallback handler */
  185. typedef CALLBACK_API( OSStatus , UnicodeToTextFallbackProcPtr )(UniChar *iSrcUniStr, ByteCount iSrcUniStrLen, ByteCount *oSrcConvLen, TextPtr oDestStr, ByteCount iDestStrLen, ByteCount *oDestConvLen, LogicalAddress iInfoPtr, ConstUnicodeMappingPtr iUnicodeMappingPtr);
  186. typedef STACK_UPP_TYPE(UnicodeToTextFallbackProcPtr)             UnicodeToTextFallbackUPP;
  187. enum { uppUnicodeToTextFallbackProcInfo = 0x003FFFF0 };         /* pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes) */
  188. #define NewUnicodeToTextFallbackProc(userRoutine)                 (UnicodeToTextFallbackUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppUnicodeToTextFallbackProcInfo, GetCurrentArchitecture())
  189. #define CallUnicodeToTextFallbackProc(userRoutine, iSrcUniStr, iSrcUniStrLen, oSrcConvLen, oDestStr, iDestStrLen, oDestConvLen, iInfoPtr, iUnicodeMappingPtr)  CALL_EIGHT_PARAMETER_UPP((userRoutine), uppUnicodeToTextFallbackProcInfo, (iSrcUniStr), (iSrcUniStrLen), (oSrcConvLen), (oDestStr), (iDestStrLen), (oDestConvLen), (iInfoPtr), (iUnicodeMappingPtr))
  190. /* Function prototypes */
  191. #if GENERATING68K && !GENERATINGCFM
  192. /*
  193.       Routine to Initialize the Unicode Converter and cleanup once done with it. 
  194.       These routines must be called from Static Library clients.
  195. */
  196. EXTERN_API( OSStatus )
  197. InitializeUnicodeConverter        (StringPtr                 TECFileName);
  198.  
  199. EXTERN_API( void )
  200. TerminateUnicodeConverter        (void);
  201.  
  202. /* Note: the old names (InitializeUnicode, TerminateUnicode) for the above are still exported.*/
  203. #endif  /* GENERATING68K && !GENERATINGCFM */
  204.  
  205. EXTERN_API( OSStatus )
  206. CreateTextToUnicodeInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  207.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  208.  
  209. EXTERN_API( OSStatus )
  210. CreateTextToUnicodeInfoByEncoding (TextEncoding         iEncoding,
  211.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  212.  
  213. EXTERN_API( OSStatus )
  214. CreateUnicodeToTextInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  215.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  216.  
  217. EXTERN_API( OSStatus )
  218. CreateUnicodeToTextInfoByEncoding (TextEncoding         iEncoding,
  219.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  220.  
  221. EXTERN_API( OSStatus )
  222. CreateUnicodeToTextRunInfo        (ItemCount                 iNumberOfMappings,
  223.                                  const UnicodeMapping     iUnicodeMappings[],
  224.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  225.  
  226. EXTERN_API( OSStatus )
  227. CreateUnicodeToTextRunInfoByEncoding (ItemCount         iNumberOfEncodings,
  228.                                  const TextEncoding     iEncodings[],
  229.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  230.  
  231. EXTERN_API( OSStatus )
  232. CreateUnicodeToTextRunInfoByScriptCode (ItemCount         iNumberOfScriptCodes,
  233.                                  const ScriptCode         iScripts[],
  234.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  235.  
  236. /* Change the TextToUnicodeInfo to another mapping. */
  237. EXTERN_API( OSStatus )
  238. ChangeTextToUnicodeInfo            (TextToUnicodeInfo         ioTextToUnicodeInfo,
  239.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  240.  
  241. /* Change the UnicodeToTextInfo to another mapping. */
  242. EXTERN_API( OSStatus )
  243. ChangeUnicodeToTextInfo            (UnicodeToTextInfo         ioUnicodeToTextInfo,
  244.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  245.  
  246.  
  247. EXTERN_API( OSStatus )
  248. DisposeTextToUnicodeInfo        (TextToUnicodeInfo *    ioTextToUnicodeInfo);
  249.  
  250. EXTERN_API( OSStatus )
  251. DisposeUnicodeToTextInfo        (UnicodeToTextInfo *    ioUnicodeToTextInfo);
  252.  
  253. EXTERN_API( OSStatus )
  254. DisposeUnicodeToTextRunInfo        (UnicodeToTextRunInfo *    ioUnicodeToTextRunInfo);
  255.  
  256. EXTERN_API( OSStatus )
  257. ConvertFromTextToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  258.                                  ByteCount                 iSourceLen,
  259.                                  ConstLogicalAddress     iSourceStr,
  260.                                  OptionBits             iControlFlags,
  261.                                  ItemCount                 iOffsetCount,
  262.                                  ByteOffset             iOffsetArray[],
  263.                                  ItemCount *            oOffsetCount,
  264.                                  ByteOffset             oOffsetArray[],
  265.                                  ByteCount                 iOutputBufLen,
  266.                                  ByteCount *            oSourceRead,
  267.                                  ByteCount *            oUnicodeLen,
  268.                                  UniCharArrayPtr         oUnicodeStr);
  269.  
  270. EXTERN_API( OSStatus )
  271. ConvertFromUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  272.                                  ByteCount                 iUnicodeLen,
  273.                                  ConstUniCharArrayPtr     iUnicodeStr,
  274.                                  OptionBits             iControlFlags,
  275.                                  ItemCount                 iOffsetCount,
  276.                                  ByteOffset             iOffsetArray[],
  277.                                  ItemCount *            oOffsetCount,
  278.                                  ByteOffset             oOffsetArray[],
  279.                                  ByteCount                 iOutputBufLen,
  280.                                  ByteCount *            oInputRead,
  281.                                  ByteCount *            oOutputLen,
  282.                                  LogicalAddress         oOutputStr);
  283.  
  284. EXTERN_API( OSStatus )
  285. ConvertFromUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextInfo,
  286.                                  ByteCount                 iUnicodeLen,
  287.                                  ConstUniCharArrayPtr     iUnicodeStr,
  288.                                  OptionBits             iControlFlags,
  289.                                  ItemCount                 iOffsetCount,
  290.                                  ByteOffset             iOffsetArray[],
  291.                                  ItemCount *            oOffsetCount,
  292.                                  ByteOffset             oOffsetArray[],
  293.                                  ByteCount                 iOutputBufLen,
  294.                                  ByteCount *            oInputRead,
  295.                                  ByteCount *            oOutputLen,
  296.                                  LogicalAddress         oOutputStr,
  297.                                  ItemCount                 iEncodingRunBufLen,
  298.                                  ItemCount *            oEncodingRunOutLen,
  299.                                  TextEncodingRun         oEncodingRuns[]);
  300.  
  301. EXTERN_API( OSStatus )
  302. ConvertFromUnicodeToScriptCodeRun (UnicodeToTextRunInfo  iUnicodeToTextInfo,
  303.                                  ByteCount                 iUnicodeLen,
  304.                                  ConstUniCharArrayPtr     iUnicodeStr,
  305.                                  OptionBits             iControlFlags,
  306.                                  ItemCount                 iOffsetCount,
  307.                                  ByteOffset             iOffsetArray[],
  308.                                  ItemCount *            oOffsetCount,
  309.                                  ByteOffset             oOffsetArray[],
  310.                                  ByteCount                 iOutputBufLen,
  311.                                  ByteCount *            oInputRead,
  312.                                  ByteCount *            oOutputLen,
  313.                                  LogicalAddress         oOutputStr,
  314.                                  ItemCount                 iScriptRunBufLen,
  315.                                  ItemCount *            oScriptRunOutLen,
  316.                                  ScriptCodeRun             oScriptCodeRuns[]);
  317.  
  318. /* Truncate a multibyte string at a safe place. */
  319. EXTERN_API( OSStatus )
  320. TruncateForTextToUnicode        (ConstTextToUnicodeInfo  iTextToUnicodeInfo,
  321.                                  ByteCount                 iSourceLen,
  322.                                  ConstLogicalAddress     iSourceStr,
  323.                                  ByteCount                 iMaxLen,
  324.                                  ByteCount *            oTruncatedLen);
  325.  
  326. /* Truncate a Unicode string at a safe place. */
  327. EXTERN_API( OSStatus )
  328. TruncateForUnicodeToText        (ConstUnicodeToTextInfo  iUnicodeToTextInfo,
  329.                                  ByteCount                 iSourceLen,
  330.                                  ConstUniCharArrayPtr     iSourceStr,
  331.                                  OptionBits             iControlFlags,
  332.                                  ByteCount                 iMaxLen,
  333.                                  ByteCount *            oTruncatedLen);
  334.  
  335. /* Convert a Pascal string to Unicode string. */
  336. EXTERN_API( OSStatus )
  337. ConvertFromPStringToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  338.                                  ConstStr255Param         iPascalStr,
  339.                                  ByteCount                 iOutputBufLen,
  340.                                  ByteCount *            oUnicodeLen,
  341.                                  UniCharArrayPtr         oUnicodeStr);
  342.  
  343. /* Convert a Unicode string to Pascal string. */
  344. EXTERN_API( OSStatus )
  345. ConvertFromUnicodeToPString        (UnicodeToTextInfo         iUnicodeToTextInfo,
  346.                                  ByteCount                 iUnicodeLen,
  347.                                  ConstUniCharArrayPtr     iUnicodeStr,
  348.                                  Str255                 oPascalStr);
  349.  
  350. /* Count the available conversion mappings. */
  351. EXTERN_API( OSStatus )
  352. CountUnicodeMappings            (OptionBits             iFilter,
  353.                                  ConstUnicodeMappingPtr  iFindMapping,
  354.                                  ItemCount *            oActualCount);
  355.  
  356. /* Get a list of the available conversion mappings. */
  357. EXTERN_API( OSStatus )
  358. QueryUnicodeMappings            (OptionBits             iFilter,
  359.                                  ConstUnicodeMappingPtr  iFindMapping,
  360.                                  ItemCount                 iMaxCount,
  361.                                  ItemCount *            oActualCount,
  362.                                  UnicodeMapping         oReturnedMappings[]);
  363.  
  364. /* Setup the fallback handler for converting Unicode To Text. */
  365. EXTERN_API( OSStatus )
  366. SetFallbackUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  367.                                  UnicodeToTextFallbackUPP  iFallback,
  368.                                  OptionBits             iControlFlags,
  369.                                  LogicalAddress         iInfoPtr);
  370.  
  371. /* Setup the fallback handler for converting Unicode To TextRuns. */
  372. EXTERN_API( OSStatus )
  373. SetFallbackUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextRunInfo,
  374.                                  UnicodeToTextFallbackUPP  iFallback,
  375.                                  OptionBits             iControlFlags,
  376.                                  LogicalAddress         iInfoPtr);
  377.  
  378.  
  379.  
  380. #if PRAGMA_STRUCT_ALIGN
  381.     #pragma options align=reset
  382. #elif PRAGMA_STRUCT_PACKPUSH
  383.     #pragma pack(pop)
  384. #elif PRAGMA_STRUCT_PACK
  385.     #pragma pack()
  386. #endif
  387.  
  388. #ifdef PRAGMA_IMPORT_OFF
  389. #pragma import off
  390. #elif PRAGMA_IMPORT
  391. #pragma import reset
  392. #endif
  393.  
  394. #ifdef __cplusplus
  395. }
  396. #endif
  397.  
  398. #endif /* __UNICODECONVERTER__ */
  399.  
  400.