Resources.h

Go to the documentation of this file.

 
#ifndef __RESOURCES__
#define __RESOURCES__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
#ifndef __FILES__
#include <Files.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
  {
    resSysHeap = 64,   /*System or application heap?*/
    resPurgeable = 32, /*Purgeable resource?*/
    resLocked = 16,    /*Load it in locked?*/
    resProtected = 8,  /*Protected?*/
    resPreload = 4,    /*Load in on OpenResFile?*/
    resChanged = 2,    /*Resource changed?*/
    mapReadOnly = 128, /*Resource file read-only*/
    mapCompact = 64,   /*Compact resource file*/
    mapChanged = 32    /*Write map out at update*/
  };
 
  enum
  {
    resSysRefBit = 7,    /*reference to system/local reference*/
    resSysHeapBit = 6,   /*In system/in application heap*/
    resPurgeableBit = 5, /*Purgeable/not purgeable*/
    resLockedBit = 4,    /*Locked/not locked*/
    resProtectedBit = 3, /*Protected/not protected*/
    resPreloadBit = 2,   /*Read in at OpenResource?*/
    resChangedBit = 1,   /*Existing resource changed since last update*/
    mapReadOnlyBit = 7,  /*is this file read-only?*/
    mapCompactBit = 6,   /*Is a compact necessary?*/
    mapChangedBit = 5    /*Is it necessary to write map?*/
  };
 
  enum
  {
    kResFileNotOpened =
        -1,            /*ref num return as error when opening a resource file*/
    kSystemResFile = 0 /*this is the default ref num to the system file*/
  };
 
  typedef CALLBACK_API_REGISTER68K(void, ResErrProcPtr, (OSErr thErr));
  typedef REGISTER_UPP_TYPE(ResErrProcPtr) ResErrUPP;
  ResErrUPP
  NewResErrUPP(ResErrProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppResErrProcInfo = 0x00001002
  }; /* register no_return_value Func(2_bytes:D0) */
#ifdef __cplusplus
  inline ResErrUPP NewResErrUPP(ResErrProcPtr userRoutine)
  {
    return (ResErrUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppResErrProcInfo, GetCurrentArchitecture());
  }
#else
#define NewResErrUPP(userRoutine)                                             \
  (ResErrUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppResErrProcInfo, \
                                   GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeResErrUPP(ResErrUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeResErrUPP(ResErrUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeResErrUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter InvokeResErrUPP(__D0, __A0)
#endif
  void
  InvokeResErrUPP(OSErr thErr, ResErrUPP userUPP);
#if !OPAQUE_UPP_TYPES && \
    (!TARGET_OS_MAC || !TARGET_CPU_68K || TARGET_RT_MAC_CFM)
#ifdef __cplusplus
  inline void InvokeResErrUPP(OSErr thErr, ResErrUPP userUPP)
  {
    CALL_ONE_PARAMETER_UPP(userUPP, uppResErrProcInfo, thErr);
  }
#else
#define InvokeResErrUPP(thErr, userUPP) \
  CALL_ONE_PARAMETER_UPP((userUPP), uppResErrProcInfo, (thErr))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
/* support for pre-Carbon UPP routines: New...Proc and Call...Proc */
#define NewResErrProc(userRoutine) NewResErrUPP(userRoutine)
#define CallResErrProc(userRoutine, thErr) InvokeResErrUPP(thErr, userRoutine)
#endif /* CALL_NOT_IN_CARBON */
 
  /* QuickTime 3.0*/
  typedef CALLBACK_API(OSErr,
                       ResourceEndianFilterPtr)(Handle theResource,
                                                Boolean currentlyNativeEndian);
#if CALL_NOT_IN_CARBON
  short
  InitResources(void);
 
  void
  RsrcZoneInit(void);
 
#endif /* CALL_NOT_IN_CARBON */
 
  void
  CloseResFile(short refNum);
 
  OSErr
  ResError(void);
 
  short
  CurResFile(void);
 
  short
  HomeResFile(Handle theResource);
 
#if CALL_NOT_IN_CARBON
  void
  CreateResFile(ConstStr255Param fileName);
 
  short
  OpenResFile(ConstStr255Param fileName);
 
#endif /* CALL_NOT_IN_CARBON */
 
  void
  UseResFile(short refNum);
 
  short rTotal, j;
  ResType rt;
  char *rtp;
  rTotal = CountTypes();
  for (j = 1; j <= rTotal; j++)
  {
    GetIndType(&rt, j);
    rtp = &rt;
    printf("Type '%c%c%c%c' has %d resources\n",
           rtp[0], rtp[1], rtp[2], rtp[3], CountResources(rt));
  }
  </ pre>
              * \copyright THINK Reference © 1991 - 1992 Symantec Corporation
                                                        *    \non_carbon_cfm in InterfaceLib 7.1 and
      later
          *    \carbon_lib in CarbonLib 1.0 and
      later
          *    \mac_os_x in version 10.0 and
      later
              * /
          short
          CountTypes(void);
 
  short
  Count1Types(void);
 
  void
  GetIndType(ResType *theType, short index);
 
  void
  Get1IndType(ResType *theType, short index);
 
  void
  SetResLoad(Boolean load);
 
  /* before calling SetResLoad */
  rCount = CountResources('DRVR');
  SetResLoad(FALSE); /* do not need resource, just info */
  for (j = 1; j <= rCount; j++)
  {
    rHandle = GetIndResource('DRVR', j);
    GetResInfo(rHandle, &rID, &rType, rName);
    printf(" 'DRVR' Rsrc ID: %6d, Name: %s\n", rID, PtoCstr(rName) + 1);
  }
  SetResLoad(TRUE); /* better do this! */
  </ pre>
              * \copyright THINK Reference © 1991 - 1992 Symantec Corporation
                                                        *    \non_carbon_cfm in InterfaceLib 7.1 and
      later
          *    \carbon_lib in CarbonLib 1.0 and
      later
          *    \mac_os_x in version 10.0 and
      later
              * /
          short
          CountResources(ResType theType);
 
  short
  Count1Resources(ResType theType);
 
  Handle
  GetIndResource(ResType theType, short index);
 
  Handle
  Get1IndResource(ResType theType, short index);
 
  Handle
  GetResource(ResType theType, short theID);
 
  Handle
  Get1Resource(ResType theType, short theID);
 
  Handle
  GetNamedResource(ResType theType, ConstStr255Param name);
 
  Handle
  Get1NamedResource(ResType theType, ConstStr255Param name);
 
#if TARGET_OS_MAC
#define MacLoadResource LoadResource
#endif
  void
  MacLoadResource(Handle theResource);
 
  void
  ReleaseResource(Handle theResource);
 
  void
  DetachResource(Handle theResource);
 
  short
  UniqueID(ResType theType);
 
  short
  Unique1ID(ResType theType);
 
  short
  GetResAttrs(Handle theResource);
 
  void
  GetResInfo(Handle theResource, short *theID, ResType *theType, Str255 name);
 
  void
  SetResInfo(Handle theResource, short theID, ConstStr255Param name);
 
  void
  AddResource(Handle theData, ResType theType, short theID, ConstStr255Param name);
 
  long
  GetResourceSizeOnDisk(Handle theResource);
 
  long
  GetMaxResourceSize(Handle theResource);
 
#if CALL_NOT_IN_CARBON
 
  long
  RsrcMapEntry(Handle theResource);
 
#endif /* CALL_NOT_IN_CARBON */
 
  void
  SetResAttrs(Handle theResource, short attrs);
 
  void
  ChangedResource(Handle theResource);
 
  void
  RemoveResource(Handle theResource);
 
  void
  UpdateResFile(short refNum);
 
  /*... modify the handle data... */
  ChangedResource(rHandle); /* tag as changed */
  if (ResError() == noErr)
  {                         /* always check this! */
    WriteResource(rHandle); /* record changes to disk */
  }
  HPurge(rHandle); /* allow purge */
  Make sure you check ResError after calling ChangedResource(or
                                                             AddResource) and
      before calling WriteResource.</ pre>
              * \copyright THINK Reference © 1991 -
          1992 Symantec Corporation
              *    \non_carbon_cfm in InterfaceLib 7.1 and
      later
          *    \carbon_lib in CarbonLib 1.0 and
      later
          *    \mac_os_x in version 10.0 and
      later
              * /
          void WriteResource(Handle theResource);
 
  void
  SetResPurge(Boolean install);
 
  short
  GetResFileAttrs(short refNum);
 
  void
  SetResFileAttrs(short refNum, short attrs);
 
  short
  OpenRFPerm(ConstStr255Param fileName, short vRefNum, SInt8 permission);
 
#if CALL_NOT_IN_CARBON
  Handle
  RGetResource(ResType theType, short theID);
 
#endif /* CALL_NOT_IN_CARBON */
 
  short
  HOpenResFile(short vRefNum, long dirID, ConstStr255Param fileName,
               SInt8 permission);
 
  void
  HCreateResFile(short vRefNum, long dirID, ConstStr255Param fileName);
 
  short
  FSpOpenResFile(const FSSpec *spec, SignedByte permission);
 
  void
  FSpCreateResFile(const FSSpec *spec, OSType creator, OSType fileType,
                   ScriptCode scriptTag);
 
  void
  ReadPartialResource(Handle theResource, long offset, void *buffer, long count);
 
  void
  WritePartialResource(Handle theResource, long offset, const void *buffer,
                       long count);
 
  void
  SetResourceSize(Handle theResource, long newSize);
 
  Handle
  GetNextFOND(Handle fondHandle);
 
/* QuickTime 3.0*/
#if CALL_NOT_IN_CARBON
  OSErr
  RegisterResourceEndianFilter(ResType theType,
                               ResourceEndianFilterPtr theFilterProc);
 
  /* Use TempInsertROMMap to force the ROM resource map to be
     inserted into the chain in front of the system. Note that
     this call is only temporary - the modified resource chain
     is only used for the next call to the resource manager.
     See IM IV 19 for more information.
  */
  void
  TempInsertROMMap(Boolean tempResLoad);
 
#endif /* CALL_NOT_IN_CARBON */
 
  typedef SInt16 RsrcChainLocation;
  enum
  {
    kRsrcChainBelowSystemMap = 0,      /* Below the system's resource map*/
    kRsrcChainBelowApplicationMap = 1, /* Below the application's resource map*/
    kRsrcChainAboveApplicationMap = 2, /* Above the application's resource map*/
    kRsrcChainAboveAllMaps = 4         /* Above all resource maps*/
  };
 
  OSErr
  InsertResourceFile(SInt16 refNum, RsrcChainLocation where);
 
  OSErr
  DetachResourceFile(SInt16 refNum);
 
  Boolean
  FSpResourceFileAlreadyOpen(const FSSpec *resourceFile, Boolean *inChain,
                             SInt16 *refNum);
 
  OSErr
  FSpOpenOrphanResFile(const FSSpec *spec, SignedByte permission, SInt16 *refNum);
 
  OSErr
  GetTopResourceFile(SInt16 *refNum);
 
  OSErr
  GetNextResourceFile(SInt16 curRefNum, SInt16 *nextRefNum);
 
#if CALL_NOT_IN_CARBON
  Handle
  getnamedresource(ResType theType, const char *name);
 
  Handle
  get1namedresource(ResType theType, const char *name);
 
  short
  openrfperm(const char *fileName, short vRefNum, char permission);
 
  short
  openresfile(const char *fileName);
 
  void
  createresfile(const char *fileName);
 
  void
  getresinfo(Handle theResource, short *theID, ResType *theType, char *name);
 
  void
  setresinfo(Handle theResource, short theID, const char *name);
 
  void
  addresource(Handle theResource, ResType theType, short theID, const char *name);
 
#endif /* CALL_NOT_IN_CARBON */
 
#if OLDROUTINENAMES
#define SizeResource(theResource) GetResourceSizeOnDisk(theResource)
#define MaxSizeRsrc(theResource) GetMaxResourceSize(theResource)
#define RmveResource(theResource) RemoveResource(theResource)
#endif /* OLDROUTINENAMES */
 
  short
  FSOpenResFile(const FSRef *ref, SInt8 permission);
 
  void
  FSCreateResFile(const FSRef *parentRef, UniCharCount nameLength,
                  const UniChar *name, FSCatalogInfoBitmap whichInfo,
                  const FSCatalogInfo *catalogInfo, FSRef *newRef,
                  FSSpec *newSpec);
 
  Boolean
  FSResourceFileAlreadyOpen(const FSRef *resourceFileRef, Boolean *inChain,
                            SInt16 *refNum);
 
  OSErr
  FSCreateResourceFile(const FSRef *parentRef, UniCharCount nameLength,
                       const UniChar *name, FSCatalogInfoBitmap whichInfo,
                       const FSCatalogInfo *catalogInfo, /* can be NULL */
                       UniCharCount forkNameLength,
                       const UniChar *forkName, /* can be NULL */
                       FSRef *newRef,           /* can be NULL */
                       FSSpec *newSpec);        /* can be NULL */
 
  OSErr
  FSOpenResourceFile(const FSRef *ref, UniCharCount forkNameLength,
                     const UniChar *forkName, /* can be NULL */
                     SInt8 permissions, SInt16 *refNum);
 
  typedef short ResFileRefNum;
  typedef short ResID;
  typedef short ResAttributes;
  typedef short ResFileAttributes;
 
#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 /* __RESOURCES__ */
* / FileAttributes;
 
#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 /* __RESOURCES__ */
* /*/*/ * /*/*/ * /*/*/ * /*/*/ * /*/*/ * /*/*/ * /*/*/ * /