PictUtils.h

Go to the documentation of this file.

 
#ifndef __PICTUTILS__
#define __PICTUTILS__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __PALETTES__
#include <Palettes.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
 
  enum
  {
    returnColorTable = 0x0001,
    returnPalette = 0x0002,
    recordComments = 0x0004,
    recordFontInfo = 0x0008,
    suppressBlackAndWhite = 0x0010
  };
 
  enum
  {
    systemMethod = 0,  
    popularMethod = 1, 
    medianMethod = 2   
  };
 
  enum
  {
    ColorBankIsCustom = -1,
    ColorBankIsExactAnd555 = 0,
    ColorBankIs555 = 1
  };
 
  typedef long PictInfoID;
  struct CommentSpec
  {
    short count; 
    short ID;    
  };
  typedef struct CommentSpec CommentSpec;
  typedef CommentSpec *CommentSpecPtr;
  typedef CommentSpecPtr *CommentSpecHandle;
  struct FontSpec
  {
    short pictFontID; 
    short sysFontID;  
    long size[4];     
    short style;      
    long
        nameOffset; 
  };
  typedef struct FontSpec FontSpec;
  typedef FontSpec *FontSpecPtr;
  typedef FontSpecPtr *FontSpecHandle;
  struct PictInfo
  {
    short version;                   
    long uniqueColors;               
    PaletteHandle thePalette;        
    CTabHandle theColorTable;        
    Fixed hRes;                      
    Fixed vRes;                      
    short depth;                     
    Rect sourceRect;                 
    long textCount;                  
    long lineCount;                  
    long rectCount;                  
    long rRectCount;                 
    long ovalCount;                  
    long arcCount;                   
    long polyCount;                  
    long regionCount;                
    long bitMapCount;                
    long pixMapCount;                
    long commentCount;               
    long uniqueComments;             
    CommentSpecHandle commentHandle; 
    long uniqueFonts;                
    FontSpecHandle fontHandle;       
    Handle fontNamesHandle;          
    long reserved1;
    long reserved2;
  };
  typedef struct PictInfo PictInfo;
  typedef PictInfo *PictInfoPtr;
  typedef PictInfoPtr *PictInfoHandle;
  typedef CALLBACK_API(OSErr, InitPickMethodProcPtr)(SInt16 colorsRequested,
                                                     UInt32 *dataRef,
                                                     SInt16 *colorBankType);
  typedef CALLBACK_API(OSErr, RecordColorsProcPtr)(UInt32 dataRef,
                                                   RGBColor *colorsArray,
                                                   SInt32 colorCount,
                                                   SInt32 *uniqueColors);
  typedef CALLBACK_API(OSErr, CalcColorTableProcPtr)(UInt32 dataRef,
                                                     SInt16 colorsRequested,
                                                     void *colorBankPtr,
                                                     CSpecArray resultPtr);
  typedef CALLBACK_API(OSErr, DisposeColorPickMethodProcPtr)(UInt32 dataRef);
  typedef STACK_UPP_TYPE(InitPickMethodProcPtr) InitPickMethodUPP;
  typedef STACK_UPP_TYPE(RecordColorsProcPtr) RecordColorsUPP;
  typedef STACK_UPP_TYPE(CalcColorTableProcPtr) CalcColorTableUPP;
  typedef STACK_UPP_TYPE(DisposeColorPickMethodProcPtr) DisposeColorPickMethodUPP;
  InitPickMethodUPP
  NewInitPickMethodUPP(InitPickMethodProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppInitPickMethodProcInfo = 0x00000FA0
  }; 
#ifdef __cplusplus
  inline InitPickMethodUPP
  NewInitPickMethodUPP(InitPickMethodProcPtr userRoutine)
  {
    return (InitPickMethodUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                   uppInitPickMethodProcInfo,
                                                   GetCurrentArchitecture());
  }
#else
#define NewInitPickMethodUPP(userRoutine)                                     \
  (InitPickMethodUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppInitPickMethodProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  RecordColorsUPP
  NewRecordColorsUPP(RecordColorsProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppRecordColorsProcInfo = 0x00003FE0
  }; 
#ifdef __cplusplus
  inline RecordColorsUPP NewRecordColorsUPP(RecordColorsProcPtr userRoutine)
  {
    return (RecordColorsUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                 uppRecordColorsProcInfo,
                                                 GetCurrentArchitecture());
  }
#else
#define NewRecordColorsUPP(userRoutine)                                     \
  (RecordColorsUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppRecordColorsProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  CalcColorTableUPP
  NewCalcColorTableUPP(CalcColorTableProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppCalcColorTableProcInfo = 0x00003EE0
  }; 
#ifdef __cplusplus
  inline CalcColorTableUPP
  NewCalcColorTableUPP(CalcColorTableProcPtr userRoutine)
  {
    return (CalcColorTableUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                   uppCalcColorTableProcInfo,
                                                   GetCurrentArchitecture());
  }
#else
#define NewCalcColorTableUPP(userRoutine)                                     \
  (CalcColorTableUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppCalcColorTableProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  DisposeColorPickMethodUPP
  NewDisposeColorPickMethodUPP(DisposeColorPickMethodProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppDisposeColorPickMethodProcInfo = 0x000000E0
  }; 
#ifdef __cplusplus
  inline DisposeColorPickMethodUPP
  NewDisposeColorPickMethodUPP(DisposeColorPickMethodProcPtr userRoutine)
  {
    return (DisposeColorPickMethodUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppDisposeColorPickMethodProcInfo,
        GetCurrentArchitecture());
  }
#else
#define NewDisposeColorPickMethodUPP(userRoutine)                \
  (DisposeColorPickMethodUPP) NewRoutineDescriptor(              \
      (ProcPtr)(userRoutine), uppDisposeColorPickMethodProcInfo, \
      GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeInitPickMethodUPP(InitPickMethodUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeInitPickMethodUPP(InitPickMethodUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeInitPickMethodUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeRecordColorsUPP(RecordColorsUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeRecordColorsUPP(RecordColorsUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeRecordColorsUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeCalcColorTableUPP(CalcColorTableUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeCalcColorTableUPP(CalcColorTableUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeCalcColorTableUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeDisposeColorPickMethodUPP(DisposeColorPickMethodUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void
  DisposeDisposeColorPickMethodUPP(DisposeColorPickMethodUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeDisposeColorPickMethodUPP(userUPP) \
  DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  OSErr
  InvokeInitPickMethodUPP(SInt16 colorsRequested, UInt32 *dataRef,
                          SInt16 *colorBankType, InitPickMethodUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSErr InvokeInitPickMethodUPP(SInt16 colorsRequested, UInt32 *dataRef,
                                       SInt16 *colorBankType,
                                       InitPickMethodUPP userUPP)
  {
    return (OSErr)CALL_THREE_PARAMETER_UPP(userUPP, uppInitPickMethodProcInfo,
                                           colorsRequested, dataRef,
                                           colorBankType);
  }
#else
#define InvokeInitPickMethodUPP(colorsRequested, dataRef, colorBankType, \
                                userUPP)                                 \
  (OSErr)                                                                \
      CALL_THREE_PARAMETER_UPP((userUPP), uppInitPickMethodProcInfo,     \
                               (colorsRequested), (dataRef), (colorBankType))
#endif
#endif
 
  OSErr
  InvokeRecordColorsUPP(UInt32 dataRef, RGBColor *colorsArray, SInt32 colorCount,
                        SInt32 *uniqueColors, RecordColorsUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSErr InvokeRecordColorsUPP(UInt32 dataRef, RGBColor *colorsArray,
                                     SInt32 colorCount, SInt32 *uniqueColors,
                                     RecordColorsUPP userUPP)
  {
    return (OSErr)CALL_FOUR_PARAMETER_UPP(userUPP, uppRecordColorsProcInfo,
                                          dataRef, colorsArray, colorCount,
                                          uniqueColors);
  }
#else
#define InvokeRecordColorsUPP(dataRef, colorsArray, colorCount, uniqueColors, \
                              userUPP)                                        \
  (OSErr)                                                                     \
      CALL_FOUR_PARAMETER_UPP((userUPP), uppRecordColorsProcInfo, (dataRef),  \
                              (colorsArray), (colorCount), (uniqueColors))
#endif
#endif
 
  OSErr
  InvokeCalcColorTableUPP(UInt32 dataRef, SInt16 colorsRequested,
                          void *colorBankPtr, CSpecArray resultPtr,
                          CalcColorTableUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSErr InvokeCalcColorTableUPP(UInt32 dataRef, SInt16 colorsRequested,
                                       void *colorBankPtr, CSpecArray resultPtr,
                                       CalcColorTableUPP userUPP)
  {
    return (OSErr)CALL_FOUR_PARAMETER_UPP(userUPP, uppCalcColorTableProcInfo,
                                          dataRef, colorsRequested, colorBankPtr,
                                          resultPtr);
  }
#else
#define InvokeCalcColorTableUPP(dataRef, colorsRequested, colorBankPtr,        \
                                resultPtr, userUPP)                            \
  (OSErr)                                                                      \
      CALL_FOUR_PARAMETER_UPP((userUPP), uppCalcColorTableProcInfo, (dataRef), \
                              (colorsRequested), (colorBankPtr), (resultPtr))
#endif
#endif
 
  OSErr
  InvokeDisposeColorPickMethodUPP(UInt32 dataRef,
                                  DisposeColorPickMethodUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSErr
  InvokeDisposeColorPickMethodUPP(UInt32 dataRef,
                                  DisposeColorPickMethodUPP userUPP)
  {
    return (OSErr)CALL_ONE_PARAMETER_UPP(
        userUPP, uppDisposeColorPickMethodProcInfo, dataRef);
  }
#else
#define InvokeDisposeColorPickMethodUPP(dataRef, userUPP)                      \
  (OSErr) CALL_ONE_PARAMETER_UPP((userUPP), uppDisposeColorPickMethodProcInfo, \
                                 (dataRef))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewInitPickMethodProc(userRoutine) NewInitPickMethodUPP(userRoutine)
#define NewRecordColorsProc(userRoutine) NewRecordColorsUPP(userRoutine)
#define NewCalcColorTableProc(userRoutine) NewCalcColorTableUPP(userRoutine)
#define NewDisposeColorPickMethodProc(userRoutine) \
  NewDisposeColorPickMethodUPP(userRoutine)
#define CallInitPickMethodProc(userRoutine, colorsRequested, dataRef, \
                               colorBankType)                         \
  InvokeInitPickMethodUPP(colorsRequested, dataRef, colorBankType, userRoutine)
#define CallRecordColorsProc(userRoutine, dataRef, colorsArray, colorCount, \
                             uniqueColors)                                  \
  InvokeRecordColorsUPP(dataRef, colorsArray, colorCount, uniqueColors,     \
                        userRoutine)
#define CallCalcColorTableProc(userRoutine, dataRef, colorsRequested,        \
                               colorBankPtr, resultPtr)                      \
  InvokeCalcColorTableUPP(dataRef, colorsRequested, colorBankPtr, resultPtr, \
                          userRoutine)
#define CallDisposeColorPickMethodProc(userRoutine, dataRef) \
  InvokeDisposeColorPickMethodUPP(dataRef, userRoutine)
#endif 
  OSErr
  GetPictInfo(PicHandle thePictHandle, PictInfo *thePictInfo, short verb,
              short colorsRequested, short colorPickMethod, short version);
 
  OSErr
  GetPixMapInfo(PixMapHandle thePixMapHandle, PictInfo *thePictInfo, short verb,
                short colorsRequested, short colorPickMethod, short version);
 
  OSErr
  NewPictInfo(PictInfoID *thePictInfoID, short verb, short colorsRequested,
              short colorPickMethod, short version);
 
  OSErr
  RecordPictInfo(PictInfoID thePictInfoID, PicHandle thePictHandle);
 
  OSErr
  RecordPixMapInfo(PictInfoID thePictInfoID, PixMapHandle thePixMapHandle);
 
  OSErr
  RetrievePictInfo(PictInfoID thePictInfoID, PictInfo *thePictInfo,
                   short colorsRequested);
 
  OSErr
  DisposePictInfo(PictInfoID thePictInfoID);
 
#if OLDROUTINENAMES
#define DisposPictInfo(thePictInfoID) DisposePictInfo(thePictInfoID)
#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