UnicodeUtilities.h

Go to the documentation of this file.

 
#ifndef __UNICODEUTILITIES__
#define __UNICODEUTILITIES__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __MACLOCALES__
#include <MacLocales.h>
#endif
 
#ifndef __TEXTCOMMON__
#include <TextCommon.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 UInt16 UCKeyOutput;
typedef UInt16 UCKeyCharSeq;
enum {
  kUCKeyOutputStateIndexMask = 0x4000,
  kUCKeyOutputSequenceIndexMask = 0x8000,
  kUCKeyOutputTestForIndexMask = 0xC000, 
  kUCKeyOutputGetIndexMask = 0x3FFF      
};
 
struct UCKeyStateRecord {
  UCKeyCharSeq stateZeroCharData;
  UInt16 stateZeroNextState;
  UInt16 stateEntryCount;
  UInt16 stateEntryFormat;
  UInt32 stateEntryData[1];
};
typedef struct UCKeyStateRecord UCKeyStateRecord;
enum {
  kUCKeyStateEntryTerminalFormat = 0x0001,
  kUCKeyStateEntryRangeFormat = 0x0002
};
 
struct UCKeyStateEntryTerminal {
  UInt16 curState;
  UCKeyCharSeq charData;
};
typedef struct UCKeyStateEntryTerminal UCKeyStateEntryTerminal;
struct UCKeyStateEntryRange {
  UInt16 curStateStart;
  UInt8 curStateRange;
  UInt8 deltaMultiplier;
  UCKeyCharSeq charData;
  UInt16 nextState;
};
typedef struct UCKeyStateEntryRange UCKeyStateEntryRange;
struct UCKeyboardTypeHeader {
  UInt32 keyboardTypeFirst; 
  UInt32 keyboardTypeLast;  
  ByteOffset keyModifiersToTableNumOffset; 
  ByteOffset keyToCharTableIndexOffset;    
  ByteOffset keyStateRecordsIndexOffset;   
  ByteOffset keyStateTerminatorsOffset;    
  ByteOffset keySequenceDataIndexOffset;   
};
typedef struct UCKeyboardTypeHeader UCKeyboardTypeHeader;
struct UCKeyboardLayout {
  UInt16 keyLayoutHeaderFormat;          
  UInt16 keyLayoutDataVersion;           
  ByteOffset keyLayoutFeatureInfoOffset; 
  ItemCount keyboardTypeCount; 
  UCKeyboardTypeHeader keyboardTypeList[1];
};
typedef struct UCKeyboardLayout UCKeyboardLayout;
struct UCKeyLayoutFeatureInfo {
  UInt16 keyLayoutFeatureInfoFormat; 
  UInt16 reserved;
  UniCharCount maxOutputStringLength; 
};
typedef struct UCKeyLayoutFeatureInfo UCKeyLayoutFeatureInfo;
struct UCKeyModifiersToTableNum {
  UInt16 keyModifiersToTableNumFormat; 
  UInt16 defaultTableNum;   
  ItemCount modifiersCount; 
  UInt8 tableNum[1];
 
};
typedef struct UCKeyModifiersToTableNum UCKeyModifiersToTableNum;
struct UCKeyToCharTableIndex {
  UInt16 keyToCharTableIndexFormat; 
  UInt16 keyToCharTableSize;        
  ItemCount keyToCharTableCount;    
  ByteOffset keyToCharTableOffsets[1];
 
};
typedef struct UCKeyToCharTableIndex UCKeyToCharTableIndex;
struct UCKeyStateRecordsIndex {
  UInt16 keyStateRecordsIndexFormat; 
  UInt16 keyStateRecordCount;        
  ByteOffset keyStateRecordOffsets[1];
 
};
typedef struct UCKeyStateRecordsIndex UCKeyStateRecordsIndex;
struct UCKeyStateTerminators {
  UInt16 keyStateTerminatorsFormat; 
  UInt16 keyStateTerminatorCount; 
  UCKeyCharSeq keyStateTerminators[1];
 
};
typedef struct UCKeyStateTerminators UCKeyStateTerminators;
struct UCKeySequenceDataIndex {
  UInt16 keySequenceDataIndexFormat; 
  UInt16 charSequenceCount;          
  UInt16 charSequenceOffsets[1];
 
};
typedef struct UCKeySequenceDataIndex UCKeySequenceDataIndex;
enum {
  kUCKeyLayoutHeaderFormat = 0x1002,
  kUCKeyLayoutFeatureInfoFormat = 0x2001,
  kUCKeyModifiersToTableNumFormat = 0x3001,
  kUCKeyToCharTableIndexFormat = 0x4001,
  kUCKeyStateRecordsIndexFormat = 0x5001,
  kUCKeyStateTerminatorsFormat = 0x6001,
  kUCKeySequenceDataIndexFormat = 0x7001
};
 
enum {
  kUCKeyActionDown = 0,    
  kUCKeyActionUp = 1,      
  kUCKeyActionAutoKey = 2, 
  kUCKeyActionDisplay =
      3 
};
 
enum {
  kUCKeyTranslateNoDeadKeysBit =
      0 
};
 
enum { kUCKeyTranslateNoDeadKeysMask = 1L << kUCKeyTranslateNoDeadKeysBit };
 
enum { kUnicodeCollationClass = FOUR_CHAR_CODE('ucol') };
 
typedef struct OpaqueCollatorRef *CollatorRef;
typedef UInt32 UCCollateOptions;
enum {
  kUCCollateComposeInsensitiveMask = 1L << 1,
  kUCCollateWidthInsensitiveMask = 1L << 2,
  kUCCollateCaseInsensitiveMask = 1L << 3,
  kUCCollateDiacritInsensitiveMask = 1L << 4, 
  kUCCollatePunctuationSignificantMask = 1L
                                         << 15, 
  kUCCollateDigitsOverrideMask = 1L << 16,
  kUCCollateDigitsAsNumberMask = 1L << 17
};
 
enum {
  kUCCollateStandardOptions =
      kUCCollateComposeInsensitiveMask | kUCCollateWidthInsensitiveMask
};
 
enum { kUCCollateTypeHFSExtended = 1 };
 
enum { kUCCollateTypeSourceMask = 0x000000FF, kUCCollateTypeShiftBits = 24 };
 
enum {
  kUCCollateTypeMask = kUCCollateTypeSourceMask << kUCCollateTypeShiftBits
};
 
typedef UInt32 UCCollationValue;
enum { kUnicodeTextBreakClass = FOUR_CHAR_CODE('ubrk') };
 
typedef struct OpaqueTextBreakLocatorRef *TextBreakLocatorRef;
typedef UInt32 UCTextBreakType;
enum {
  kUCTextBreakCharMask = 1L << 0,
  kUCTextBreakClusterMask = 1L << 2,
  kUCTextBreakWordMask = 1L << 4,
  kUCTextBreakLineMask = 1L << 6
};
 
typedef UInt32 UCTextBreakOptions;
enum {
  kUCTextBreakLeadingEdgeMask = 1L << 0,
  kUCTextBreakGoBackwardsMask = 1L << 1,
  kUCTextBreakIterateMask = 1L << 2
};
 
OSStatus
UCKeyTranslate(const UCKeyboardLayout *keyLayoutPtr, UInt16 virtualKeyCode,
               UInt16 keyAction, UInt32 modifierKeyState, UInt32 keyboardType,
               OptionBits keyTranslateOptions, UInt32 *deadKeyState,
               UniCharCount maxStringLength, UniCharCount *actualStringLength,
               UniChar unicodeString[]);
 
OSStatus
UCCreateCollator(LocaleRef locale, LocaleOperationVariant opVariant,
                 UCCollateOptions options, CollatorRef *collatorRef);
 
OSStatus
UCGetCollationKey(CollatorRef collatorRef, const UniChar *textPtr,
                  UniCharCount textLength, ItemCount maxKeySize,
                  ItemCount *actualKeySize, UCCollationValue collationKey[]);
 
OSStatus
UCCompareCollationKeys(const UCCollationValue *key1Ptr, ItemCount key1Length,
                       const UCCollationValue *key2Ptr, ItemCount key2Length,
                       Boolean *equivalent, SInt32 *order);
 
OSStatus
UCCompareText(CollatorRef collatorRef, const UniChar *text1Ptr,
              UniCharCount text1Length, const UniChar *text2Ptr,
              UniCharCount text2Length, Boolean *equivalent, SInt32 *order);
 
OSStatus
UCDisposeCollator(CollatorRef *collatorRef);
 
OSStatus
UCCompareTextDefault(UCCollateOptions options, const UniChar *text1Ptr,
                     UniCharCount text1Length, const UniChar *text2Ptr,
                     UniCharCount text2Length, Boolean *equivalent,
                     SInt32 *order);
 
OSStatus
UCCompareTextNoLocale(UCCollateOptions options, const UniChar *text1Ptr,
                      UniCharCount text1Length, const UniChar *text2Ptr,
                      UniCharCount text2Length, Boolean *equivalent,
                      SInt32 *order);
 
OSStatus
UCCreateTextBreakLocator(LocaleRef locale, LocaleOperationVariant opVariant,
                         UCTextBreakType breakTypes,
                         TextBreakLocatorRef *breakRef);
 
OSStatus
UCFindTextBreak(TextBreakLocatorRef breakRef, UCTextBreakType breakType,
                UCTextBreakOptions options, const UniChar *textPtr,
                UniCharCount textLength, UniCharArrayOffset startOffset,
                UniCharArrayOffset *breakOffset);
 
OSStatus
UCDisposeTextBreakLocator(TextBreakLocatorRef *breakRef);
 
#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