TextEncodingConverter.h

Go to the documentation of this file.

 
#ifndef __TEXTENCODINGCONVERTER__
#define __TEXTENCODINGCONVERTER__
 
#ifndef __MACTYPES__
#include <MacTypes.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 OSType TECPluginSignature;
  typedef UInt32 TECPluginVersion;
  enum
  {
    kTECSignature = FOUR_CHAR_CODE('encv'),
    kTECUnicodePluginSignature = FOUR_CHAR_CODE('puni'),
    kTECJapanesePluginSignature = FOUR_CHAR_CODE('pjpn'),
    kTECChinesePluginSignature = FOUR_CHAR_CODE('pzho'),
    kTECKoreanPluginSignature = FOUR_CHAR_CODE('pkor')
  };
 
  typedef struct OpaqueTECObjectRef *TECObjectRef;
  typedef struct OpaqueTECSnifferObjectRef *TECSnifferObjectRef;
  typedef OSType TECPluginSig;
  struct TECConversionInfo
  {
    TextEncoding sourceEncoding;
    TextEncoding destinationEncoding;
    UInt16 reserved1;
    UInt16 reserved2;
  };
  typedef struct TECConversionInfo TECConversionInfo;
  OSStatus
  TECCountAvailableTextEncodings(ItemCount *numberEncodings);
 
  OSStatus
  TECGetAvailableTextEncodings(TextEncoding availableEncodings[],
                               ItemCount maxAvailableEncodings,
                               ItemCount *actualAvailableEncodings);
 
  OSStatus
  TECCountDirectTextEncodingConversions(ItemCount *numberOfEncodings);
 
  OSStatus
  TECGetDirectTextEncodingConversions(TECConversionInfo availableConversions[],
                                      ItemCount maxAvailableConversions,
                                      ItemCount *actualAvailableConversions);
 
  OSStatus
  TECCountDestinationTextEncodings(TextEncoding inputEncoding,
                                   ItemCount *numberOfEncodings);
 
  OSStatus
  TECGetDestinationTextEncodings(TextEncoding inputEncoding,
                                 TextEncoding destinationEncodings[],
                                 ItemCount maxDestinationEncodings,
                                 ItemCount *actualDestinationEncodings);
 
  OSStatus
  TECGetTextEncodingInternetName(TextEncoding textEncoding, Str255 encodingName);
 
  OSStatus
  TECGetTextEncodingFromInternetName(TextEncoding *textEncoding,
                                     ConstStr255Param encodingName);
 
  OSStatus
  TECCreateConverter(TECObjectRef *newEncodingConverter,
                     TextEncoding inputEncoding, TextEncoding outputEncoding);
 
  OSStatus
  TECCreateConverterFromPath(TECObjectRef *newEncodingConverter,
                             const TextEncoding inPath[], ItemCount inEncodings);
 
  OSStatus
  TECDisposeConverter(TECObjectRef newEncodingConverter);
 
  OSStatus
  TECClearConverterContextInfo(TECObjectRef encodingConverter);
 
  OSStatus
  TECConvertText(TECObjectRef encodingConverter, ConstTextPtr inputBuffer,
                 ByteCount inputBufferLength, ByteCount *actualInputLength,
                 TextPtr outputBuffer, ByteCount outputBufferLength,
                 ByteCount *actualOutputLength);
 
  OSStatus
  TECFlushText(TECObjectRef encodingConverter, TextPtr outputBuffer,
               ByteCount outputBufferLength, ByteCount *actualOutputLength);
 
  OSStatus
  TECCountSubTextEncodings(TextEncoding inputEncoding,
                           ItemCount *numberOfEncodings);
 
  OSStatus
  TECGetSubTextEncodings(TextEncoding inputEncoding, TextEncoding subEncodings[],
                         ItemCount maxSubEncodings,
                         ItemCount *actualSubEncodings);
 
  OSStatus
  TECGetEncodingList(TECObjectRef encodingConverter, ItemCount *numEncodings,
                     Handle *encodingList);
 
  OSStatus
  TECCreateOneToManyConverter(TECObjectRef *newEncodingConverter,
                              TextEncoding inputEncoding,
                              ItemCount numOutputEncodings,
                              const TextEncoding outputEncodings[]);
 
  OSStatus
  TECConvertTextToMultipleEncodings(
      TECObjectRef encodingConverter, ConstTextPtr inputBuffer,
      ByteCount inputBufferLength, ByteCount *actualInputLength,
      TextPtr outputBuffer, ByteCount outputBufferLength,
      ByteCount *actualOutputLength, TextEncodingRun outEncodingsBuffer[],
      ItemCount maxOutEncodingRuns, ItemCount *actualOutEncodingRuns);
 
  OSStatus
  TECFlushMultipleEncodings(TECObjectRef encodingConverter, TextPtr outputBuffer,
                            ByteCount outputBufferLength,
                            ByteCount *actualOutputLength,
                            TextEncodingRun outEncodingsBuffer[],
                            ItemCount maxOutEncodingRuns,
                            ItemCount *actualOutEncodingRuns);
 
  OSStatus
  TECCountWebTextEncodings(RegionCode locale, ItemCount *numberEncodings);
 
  OSStatus
  TECGetWebTextEncodings(RegionCode locale, TextEncoding availableEncodings[],
                         ItemCount maxAvailableEncodings,
                         ItemCount *actualAvailableEncodings);
 
  OSStatus
  TECCountMailTextEncodings(RegionCode locale, ItemCount *numberEncodings);
 
  OSStatus
  TECGetMailTextEncodings(RegionCode locale, TextEncoding availableEncodings[],
                          ItemCount maxAvailableEncodings,
                          ItemCount *actualAvailableEncodings);
 
  OSStatus
  TECCountAvailableSniffers(ItemCount *numberOfEncodings);
 
  OSStatus
  TECGetAvailableSniffers(TextEncoding availableSniffers[],
                          ItemCount maxAvailableSniffers,
                          ItemCount *actualAvailableSniffers);
 
  OSStatus
  TECCreateSniffer(TECSnifferObjectRef *encodingSniffer,
                   TextEncoding testEncodings[], ItemCount numTextEncodings);
 
  OSStatus
  TECSniffTextEncoding(TECSnifferObjectRef encodingSniffer, TextPtr inputBuffer,
                       ByteCount inputBufferLength, TextEncoding testEncodings[],
                       ItemCount numTextEncodings, ItemCount numErrsArray[],
                       ItemCount maxErrs, ItemCount numFeaturesArray[],
                       ItemCount maxFeatures);
 
  OSStatus
  TECDisposeSniffer(TECSnifferObjectRef encodingSniffer);
 
  OSStatus
  TECClearSnifferContextInfo(TECSnifferObjectRef encodingSniffer);
 
#if CALL_NOT_IN_CARBON
  OSStatus
  TECSetBasicOptions(TECObjectRef encodingConverter, OptionBits controlFlags);
 
#endif 
#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