ATSFont.h

Go to the documentation of this file.

 
#ifndef __ATSFONT__
#define __ATSFONT__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __ATSTYPES__
#include <ATSTypes.h>
#endif
 
#ifndef __CFSTRING__
#include <CFString.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __TEXTCOMMON__
#include <TextCommon.h>
#endif
 
#ifndef __SFNTTYPES__
#include <SFNTTypes.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
 
#if PRAGMA_ENUM_ALWAYSINT
#if defined(__fourbyteints__) && !__fourbyteints__
#define __ATSFONT__RESTORE_TWOBYTEINTS
#pragma fourbyteints on
#endif
#pragma enumsalwaysint on
#elif PRAGMA_ENUM_OPTIONS
#pragma option enum =int
#elif PRAGMA_ENUM_PACK
#if __option(pack_enums)
#define __ATSFONT__RESTORE_PACKED_ENUMS
#pragma options(!pack_enums)
#endif
#endif
 
  enum
  {
    kATSOptionFlagsDefault = kNilOptions,
    kATSOptionFlagsComposeFontPostScriptName =
        1 << 0, /* ATSFontGetPostScriptName */
    kATSOptionFlagsUseDataForkAsResourceFork =
        1 << 8, /* ATSFontActivateFromFileSpecification */
    kATSOptionFlagsUseResourceFork = 2 << 8,
    kATSOptionFlagsUseDataFork = 3 << 8
  };
 
  enum
  {
    kATSIterationCompleted = -980L,
    kATSInvalidFontFamilyAccess = -981L,
    kATSInvalidFontAccess = -982L,
    kATSIterationScopeModified = -983L,
    kATSInvalidFontTableAccess = -984L,
    kATSInvalidFontContainerAccess = -985L
  };
 
  typedef UInt32 ATSFontContext;
  enum
  {
    kATSFontContextUnspecified = 0,
    kATSFontContextGlobal = 1
  };
 
  typedef UInt32 ATSFontFormat;
  enum
  {
    kATSFontFormatUnspecified = 0
  };
 
  typedef CALLBACK_API_C(OSStatus,
                         ATSFontFamilyApplierFunction)(ATSFontFamilyRef iFamily,
                                                       void *iRefCon);
  typedef CALLBACK_API_C(OSStatus, ATSFontApplierFunction)(ATSFontRef iFont,
                                                           void *iRefCon);
  typedef struct ATSFontFamilyIterator_ *ATSFontFamilyIterator;
  typedef struct ATSFontIterator_ *ATSFontIterator;
  enum
  {
    kATSFontFilterCurrentVersion = 0
  };
 
  enum ATSFontFilterSelector
  {
    kATSFontFilterSelectorUnspecified = 0,
    kATSFontFilterSelectorGeneration = 3,
    kATSFontFilterSelectorFontFamily = 7,
    kATSFontFilterSelectorFontFamilyApplierFunction = 8,
    kATSFontFilterSelectorFontApplierFunction = 9
  };
  typedef enum ATSFontFilterSelector ATSFontFilterSelector;
 
  struct ATSFontFilter
  {
    UInt32 version;
    ATSFontFilterSelector filterSelector;
    union
    {
      ATSGeneration generationFilter;
      ATSFontFamilyRef fontFamilyFilter;
      ATSFontFamilyApplierFunction fontFamilyApplierFunctionFilter;
      ATSFontApplierFunction fontApplierFunctionFilter;
    } filter;
  };
  typedef struct ATSFontFilter ATSFontFilter;
  /* -----------------------------------------------------------------------------------------
   */
  /* Font container */
  /* -----------------------------------------------------------------------------------------
   */
  ATSGeneration
  ATSGetGeneration(void);
 
  OSStatus
  ATSFontActivateFromFileSpecification(const FSSpec *iFile,
                                       ATSFontContext iContext,
                                       ATSFontFormat iFormat, void *iReserved,
                                       ATSOptionFlags iOptions,
                                       ATSFontContainerRef *oContainer);
 
  OSStatus
  ATSFontActivateFromMemory(LogicalAddress iData, ByteCount iLength,
                            ATSFontContext iContext, ATSFontFormat iFormat,
                            void *iReserved, ATSOptionFlags iOptions,
                            ATSFontContainerRef *oContainer);
 
  OSStatus
  ATSFontDeactivate(ATSFontContainerRef iContainer, void *iRefCon,
                    ATSOptionFlags iOptions);
 
  /* -----------------------------------------------------------------------------------------
   */
  /* Font family */
  /* -----------------------------------------------------------------------------------------
   */
  OSStatus
  ATSFontFamilyApplyFunction(ATSFontFamilyApplierFunction iFunction,
                             void *iRefCon);
 
  OSStatus
  ATSFontFamilyIteratorCreate(ATSFontContext iContext,
                              const ATSFontFilter *iFilter, /* can be NULL */
                              void *iRefCon, ATSOptionFlags iOptions,
                              ATSFontFamilyIterator *ioIterator);
 
  OSStatus
  ATSFontFamilyIteratorRelease(ATSFontFamilyIterator *ioIterator);
 
  OSStatus
  ATSFontFamilyIteratorReset(ATSFontContext iContext,
                             const ATSFontFilter *iFilter, /* can be NULL */
                             void *iRefCon, ATSOptionFlags iOptions,
                             ATSFontFamilyIterator *ioIterator);
 
  OSStatus
  ATSFontFamilyIteratorNext(ATSFontFamilyIterator iIterator,
                            ATSFontFamilyRef *oFamily);
 
  ATSFontFamilyRef
  ATSFontFamilyFindFromName(CFStringRef iName, ATSOptionFlags iOptions);
 
  ATSGeneration
  ATSFontFamilyGetGeneration(ATSFontFamilyRef iFamily);
 
  OSStatus
  ATSFontFamilyGetName(ATSFontFamilyRef iFamily, ATSOptionFlags iOptions,
                       CFStringRef *oName);
 
  TextEncoding
  ATSFontFamilyGetEncoding(ATSFontFamilyRef iFamily);
 
  /* -----------------------------------------------------------------------------------------
   */
  /* Font */
  /* -----------------------------------------------------------------------------------------
   */
  OSStatus
  ATSFontApplyFunction(ATSFontApplierFunction iFunction, void *iRefCon);
 
  OSStatus
  ATSFontIteratorCreate(ATSFontContext iContext,
                        const ATSFontFilter *iFilter, /* can be NULL */
                        void *iRefCon, ATSOptionFlags iOptions,
                        ATSFontIterator *ioIterator);
 
  OSStatus
  ATSFontIteratorRelease(ATSFontIterator *ioIterator);
 
  OSStatus
  ATSFontIteratorReset(ATSFontContext iContext,
                       const ATSFontFilter *iFilter, /* can be NULL */
                       void *iRefCon, ATSOptionFlags iOptions,
                       ATSFontIterator *ioIterator);
 
  OSStatus
  ATSFontIteratorNext(ATSFontIterator iIterator, ATSFontRef *oFont);
 
  ATSFontRef
  ATSFontFindFromName(CFStringRef iName, ATSOptionFlags iOptions);
 
  ATSFontRef
  ATSFontFindFromPostScriptName(CFStringRef iName, ATSOptionFlags iOptions);
 
  OSStatus
  ATSFontFindFromContainer(ATSFontContainerRef iContainer,
                           ATSOptionFlags iOptions, ItemCount iCount,
                           ATSFontRef ioArray[], ItemCount *oCount);
 
  ATSGeneration
  ATSFontGetGeneration(ATSFontRef iFont);
 
  OSStatus
  ATSFontGetName(ATSFontRef iFont, ATSOptionFlags iOptions, CFStringRef *oName);
 
  OSStatus
  ATSFontGetPostScriptName(ATSFontRef iFont, ATSOptionFlags iOptions,
                           CFStringRef *oName);
 
  OSStatus
  ATSFontGetTableDirectory(ATSFontRef iFont, ByteCount iBufferSize,
                           void *ioBuffer, ByteCount *oSize); /* can be NULL */
 
  OSStatus
  ATSFontGetTable(ATSFontRef iFont, FourCharCode iTag, ByteOffset iOffset,
                  ByteCount iBufferSize, void *ioBuffer,
                  ByteCount *oSize); /* can be NULL */
 
  OSStatus
  ATSFontGetHorizontalMetrics(ATSFontRef iFont, ATSOptionFlags iOptions,
                              ATSFontMetrics *oMetrics);
 
  OSStatus
  ATSFontGetVerticalMetrics(ATSFontRef iFont, ATSOptionFlags iOptions,
                            ATSFontMetrics *oMetrics);
 
  /* -----------------------------------------------------------------------------------------
   */
  /* Compatibiity */
  /* -----------------------------------------------------------------------------------------
   */
  ATSFontFamilyRef
  ATSFontFamilyFindFromQuickDrawName(ConstStr255Param iName);
 
  OSStatus
  ATSFontFamilyGetQuickDrawName(ATSFontFamilyRef iFamily, Str255 oName);
 
  OSStatus
  ATSFontGetFileSpecification(ATSFontRef iFont, FSSpec *oFile);
 
  OSStatus
  ATSFontGetFontFamilyResource(ATSFontRef iFont, ByteCount iBufferSize,
                               void *ioBuffer,
                               ByteCount *oSize); /* can be NULL */
 
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#ifdef __ATSFONT__RESTORE_TWOBYTEINTS
#pragma fourbyteints off
#endif
#elif PRAGMA_ENUM_OPTIONS
#pragma option enum =reset
#elif defined(__ATSFONT__RESTORE_PACKED_ENUMS)
#pragma options(pack_enums)
#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 /* __ATSFONT__ */