{ File: CarbonCore/Resources.h Contains: Resource Manager Interfaces. Version: CarbonCore-859.2~1 Copyright: © 1985-2008 by Apple Computer, Inc., all rights reserved Bugs?: For bug reports, consult the following page on the World Wide Web: http://www.freepascal.org/bugs.html } { Pascal Translation Updated: Jonas Maebe, , October 2009 } { Modified for use with Free Pascal Version 308 Please report any bugs to } {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE} {$mode macpas} {$packenum 1} {$macro on} {$inline on} {$calling mwpascal} unit Resources; interface {$setc UNIVERSAL_INTERFACES_VERSION := $0400} {$setc GAP_INTERFACES_VERSION := $0308} {$ifc not defined USE_CFSTR_CONSTANT_MACROS} {$setc USE_CFSTR_CONSTANT_MACROS := TRUE} {$endc} {$ifc defined CPUPOWERPC and defined CPUI386} {$error Conflicting initial definitions for CPUPOWERPC and CPUI386} {$endc} {$ifc defined FPC_BIG_ENDIAN and defined FPC_LITTLE_ENDIAN} {$error Conflicting initial definitions for FPC_BIG_ENDIAN and FPC_LITTLE_ENDIAN} {$endc} {$ifc not defined __ppc__ and defined CPUPOWERPC32} {$setc __ppc__ := 1} {$elsec} {$setc __ppc__ := 0} {$endc} {$ifc not defined __ppc64__ and defined CPUPOWERPC64} {$setc __ppc64__ := 1} {$elsec} {$setc __ppc64__ := 0} {$endc} {$ifc not defined __i386__ and defined CPUI386} {$setc __i386__ := 1} {$elsec} {$setc __i386__ := 0} {$endc} {$ifc not defined __x86_64__ and defined CPUX86_64} {$setc __x86_64__ := 1} {$elsec} {$setc __x86_64__ := 0} {$endc} {$ifc not defined __arm__ and defined CPUARM} {$setc __arm__ := 1} {$elsec} {$setc __arm__ := 0} {$endc} {$ifc defined cpu64} {$setc __LP64__ := 1} {$elsec} {$setc __LP64__ := 0} {$endc} {$ifc defined __ppc__ and __ppc__ and defined __i386__ and __i386__} {$error Conflicting definitions for __ppc__ and __i386__} {$endc} {$ifc defined __ppc__ and __ppc__} {$setc TARGET_CPU_PPC := TRUE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := FALSE} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elifc defined __ppc64__ and __ppc64__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := TRUE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := FALSE} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elifc defined __i386__ and __i386__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := TRUE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := FALSE} {$ifc defined(iphonesim)} {$setc TARGET_OS_MAC := FALSE} {$setc TARGET_OS_IPHONE := TRUE} {$setc TARGET_IPHONE_SIMULATOR := TRUE} {$elsec} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$endc} {$elifc defined __x86_64__ and __x86_64__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := TRUE} {$setc TARGET_CPU_ARM := FALSE} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elifc defined __arm__ and __arm__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := TRUE} { will require compiler define when/if other Apple devices with ARM cpus ship } {$setc TARGET_OS_MAC := FALSE} {$setc TARGET_OS_IPHONE := TRUE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elsec} {$error __ppc__ nor __ppc64__ nor __i386__ nor __x86_64__ nor __arm__ is defined.} {$endc} {$ifc defined __LP64__ and __LP64__ } {$setc TARGET_CPU_64 := TRUE} {$elsec} {$setc TARGET_CPU_64 := FALSE} {$endc} {$ifc defined FPC_BIG_ENDIAN} {$setc TARGET_RT_BIG_ENDIAN := TRUE} {$setc TARGET_RT_LITTLE_ENDIAN := FALSE} {$elifc defined FPC_LITTLE_ENDIAN} {$setc TARGET_RT_BIG_ENDIAN := FALSE} {$setc TARGET_RT_LITTLE_ENDIAN := TRUE} {$elsec} {$error Neither FPC_BIG_ENDIAN nor FPC_LITTLE_ENDIAN are defined.} {$endc} {$setc ACCESSOR_CALLS_ARE_FUNCTIONS := TRUE} {$setc CALL_NOT_IN_CARBON := FALSE} {$setc OLDROUTINENAMES := FALSE} {$setc OPAQUE_TOOLBOX_STRUCTS := TRUE} {$setc OPAQUE_UPP_TYPES := TRUE} {$setc OTCARBONAPPLICATION := TRUE} {$setc OTKERNEL := FALSE} {$setc PM_USE_SESSION_APIS := TRUE} {$setc TARGET_API_MAC_CARBON := TRUE} {$setc TARGET_API_MAC_OS8 := FALSE} {$setc TARGET_API_MAC_OSX := TRUE} {$setc TARGET_CARBON := TRUE} {$setc TARGET_CPU_68K := FALSE} {$setc TARGET_CPU_MIPS := FALSE} {$setc TARGET_CPU_SPARC := FALSE} {$setc TARGET_OS_UNIX := FALSE} {$setc TARGET_OS_WIN32 := FALSE} {$setc TARGET_RT_MAC_68881 := FALSE} {$setc TARGET_RT_MAC_CFM := FALSE} {$setc TARGET_RT_MAC_MACHO := TRUE} {$setc TYPED_FUNCTION_POINTERS := TRUE} {$setc TYPE_BOOL := FALSE} {$setc TYPE_EXTENDED := FALSE} {$setc TYPE_LONGLONG := TRUE} uses MacTypes,Files; {$endc} {not MACOSALLINCLUDE} {$ifc TARGET_OS_MAC} {$ALIGN POWER} { These typedefs were originally created for the Copland Resource Mangager } type ResID = SInt16; ResAttributes = SInt16; ResFileAttributes = SInt16; ResourceCount = SInt16; ResourceIndex = SInt16; ResFileRefNum = FSIORefNum; { Resource Attribute Bits } const 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} { Resource Attribute Masks} const 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?} { Resource Fork Attribute Bits} const mapReadOnlyBit = 7; {is this file read-only?} mapCompactBit = 6; {Is a compact necessary?} mapChangedBit = 5; {Is it necessary to write map?} { Resource Fork Attribute Masks} const mapReadOnly = 128; {Resource file read-only} mapCompact = 64; {Compact resource file} mapChanged = 32; {Write map out at update} { Resource File Ref Num constants} const kResFileNotOpened = -1; {ref num return as error when opening a resource file} kSystemResFile = 0; {this is the default ref num to the system file} type ResErrProcPtr = procedure( thErr: OSErr ); ResErrUPP = ResErrProcPtr; { * NewResErrUPP() * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: available as macro/inline } function NewResErrUPP( userRoutine: ResErrProcPtr ): ResErrUPP; external name '_NewResErrUPP'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * DisposeResErrUPP() * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: available as macro/inline } procedure DisposeResErrUPP( userUPP: ResErrUPP ); external name '_DisposeResErrUPP'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * InvokeResErrUPP() * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: available as macro/inline } procedure InvokeResErrUPP( thErr: OSErr; userUPP: ResErrUPP ); external name '_InvokeResErrUPP'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { QuickTime 3.0} type ResourceEndianFilterPtr = function( theResource: Handle; currentlyNativeEndian: Boolean ): OSErr; { * CloseResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure CloseResFile( refNum: ResFileRefNum ); external name '_CloseResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * ResError() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function ResError: OSErr; external name '_ResError'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * CurResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function CurResFile: ResFileRefNum; external name '_CurResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * HomeResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function HomeResFile( theResource: Handle ): ResFileRefNum; external name '_HomeResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * UseResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure UseResFile( refNum: ResFileRefNum ); external name '_UseResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * CountTypes() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function CountTypes: ResourceCount; external name '_CountTypes'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * Count1Types() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function Count1Types: ResourceCount; external name '_Count1Types'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetIndType() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure GetIndType( var theType: ResType; itemIndex: ResourceIndex ); external name '_GetIndType'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * Get1IndType() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure Get1IndType( var theType: ResType; itemIndex: ResourceIndex ); external name '_Get1IndType'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * SetResLoad() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure SetResLoad( load: Boolean ); external name '_SetResLoad'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * CountResources() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function CountResources( theType: ResType ): ResourceCount; external name '_CountResources'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * Count1Resources() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function Count1Resources( theType: ResType ): ResourceCount; external name '_Count1Resources'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetIndResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetIndResource( theType: ResType; itemIndex: ResourceIndex ): Handle; external name '_GetIndResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * Get1IndResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function Get1IndResource( theType: ResType; itemIndex: ResourceIndex ): Handle; external name '_Get1IndResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetResource( theType: ResType; theID: ResID ): Handle; external name '_GetResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * Get1Resource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function Get1Resource( theType: ResType; theID: ResID ): Handle; external name '_Get1Resource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetNamedResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetNamedResource( theType: ResType; const (*var*) name: Str255 ): Handle; external name '_GetNamedResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * Get1NamedResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function Get1NamedResource( theType: ResType; const (*var*) name: Str255 ): Handle; external name '_Get1NamedResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * [Mac]LoadResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure MacLoadResource( theResource: Handle ); external name '_MacLoadResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * ReleaseResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure ReleaseResource( theResource: Handle ); external name '_ReleaseResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * DetachResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure DetachResource( theResource: Handle ); external name '_DetachResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * UniqueID() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function UniqueID( theType: ResType ): ResID; external name '_UniqueID'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * Unique1ID() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function Unique1ID( theType: ResType ): ResID; external name '_Unique1ID'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetResAttrs() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetResAttrs( theResource: Handle ): ResAttributes; external name '_GetResAttrs'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetResInfo() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure GetResInfo( theResource: Handle; var theID: ResID; var theType: ResType; var name: Str255 ); external name '_GetResInfo'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * SetResInfo() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure SetResInfo( theResource: Handle; theID: ResID; const (*var*) name: Str255 ); external name '_SetResInfo'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * AddResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure AddResource( theData: Handle; theType: ResType; theID: ResID; const (*var*) name: Str255 ); external name '_AddResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetResourceSizeOnDisk() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetResourceSizeOnDisk( theResource: Handle ): SIGNEDLONG; external name '_GetResourceSizeOnDisk'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetMaxResourceSize() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetMaxResourceSize( theResource: Handle ): SIGNEDLONG; external name '_GetMaxResourceSize'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * SetResAttrs() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure SetResAttrs( theResource: Handle; attrs: ResAttributes ); external name '_SetResAttrs'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * ChangedResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure ChangedResource( theResource: Handle ); external name '_ChangedResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * RemoveResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure RemoveResource( theResource: Handle ); external name '_RemoveResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * UpdateResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure UpdateResFile( refNum: ResFileRefNum ); external name '_UpdateResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * WriteResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure WriteResource( theResource: Handle ); external name '_WriteResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * SetResPurge() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure SetResPurge( install: Boolean ); external name '_SetResPurge'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetResFileAttrs() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetResFileAttrs( refNum: ResFileRefNum ): ResFileAttributes; external name '_GetResFileAttrs'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * SetResFileAttrs() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure SetResFileAttrs( refNum: ResFileRefNum; attrs: ResFileAttributes ); external name '_SetResFileAttrs'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * ReadPartialResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure ReadPartialResource( theResource: Handle; offset: SIGNEDLONG; buffer: UnivPtr; count: SIGNEDLONG ); external name '_ReadPartialResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * WritePartialResource() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure WritePartialResource( theResource: Handle; offset: SIGNEDLONG; buffer: {const} UnivPtr; count: SIGNEDLONG ); external name '_WritePartialResource'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * SetResourceSize() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure SetResourceSize( theResource: Handle; newSize: SIGNEDLONG ); external name '_SetResourceSize'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * GetNextFOND() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function GetNextFOND( fondHandle: Handle ): Handle; external name '_GetNextFOND'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { QuickTime 3.0} { * RegisterResourceEndianFilter() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: not available } { _________________________________________________________________________________________________________ ¥ RESOURCE CHAIN LOCATION - for use with the Resource Manager chain manipulation routines under Carbon. _________________________________________________________________________________________________________ } type RsrcChainLocation = SInt16; const 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} { If the file is already in the resource chain, it is removed and re-inserted at the specified location If the file has been detached, it is added to the resource chain at the specified location Returns resFNotFound if it's not currently open. } { * InsertResourceFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function InsertResourceFile( refNum: ResFileRefNum; where: RsrcChainLocation ): OSErr; external name '_InsertResourceFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { If the file is not currently in the resource chain, this returns resNotFound Otherwise, the resource file is removed from the resource chain. } { * DetachResourceFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function DetachResourceFile( refNum: ResFileRefNum ): OSErr; external name '_DetachResourceFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { GetTopResourceFile returns the refNum of the top most resource map in the current resource chain. If the resource chain is empty it returns resFNotFound. } { * GetTopResourceFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0.2 and later * Non-Carbon CFM: not available } function GetTopResourceFile( var refNum: ResFileRefNum ): OSErr; external name '_GetTopResourceFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { GetNextResourceFile can be used to iterate over resource files in the resource chain. By passing a valid refNum in curRefNum it will return in nextRefNum the refNum of the next file in the chain. If curRefNum is not found in the resource chain, GetNextResourceFile returns resFNotFound. When the end of the chain is reached GetNextResourceFile will return noErr and nextRefNum will be NIL. } { * GetNextResourceFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.0.2 and later * Non-Carbon CFM: not available } function GetNextResourceFile( curRefNum: ResFileRefNum; var nextRefNum: ResFileRefNum ): OSErr; external name '_GetNextResourceFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * FSOpenResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.1 and later * Non-Carbon CFM: in InterfaceLib 9.1 and later } function FSOpenResFile( const (*var*) ref: FSRef; permission: SInt8 ): ResFileRefNum; external name '_FSOpenResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * FSCreateResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.1 and later * Non-Carbon CFM: in InterfaceLib 9.1 and later } procedure FSCreateResFile( const (*var*) parentRef: FSRef; nameLength: UniCharCount; name: UniCharPtr; whichInfo: FSCatalogInfoBitmap; {const} catalogInfo: FSCatalogInfoPtr { can be NULL }; newRef: FSRefPtr { can be NULL }; newSpec: FSSpecPtr { can be NULL } ); external name '_FSCreateResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { Returns true if the resource file is already open and known by the Resource Manager (i.e., it is either in the current resource chain or it's a detached resource file.) If it's in the resource chain, the inChain Boolean is set to true on exit and true is returned. If it's an open file, but the file is currently detached, inChain is set to false and true is returned. If the file is open, the refNum to the file is returned. } { * FSResourceFileAlreadyOpen() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.1 and later * Non-Carbon CFM: in InterfaceLib 9.1 and later } function FSResourceFileAlreadyOpen( const (*var*) resourceFileRef: FSRef; var inChain: Boolean; var refNum: ResFileRefNum ): Boolean; external name '_FSResourceFileAlreadyOpen'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { FSOpenOrphanResFile should be used to open a resource file that is persistent across all contexts, because using OpenResFile normally loads a map and all preloaded resources into the application context. FSOpenOrphanResFile loads everything into the system context and detaches the file from the context in which it was opened. If the file is already in the resource chain and a new instance is not opened, FSOpenOrphanResFile will return a paramErr. Use with care, as can and will fail if the map is very large or a lot of preload resources exist. } { * FSOpenOrphanResFile() * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.5 and later in CoreServices.framework * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.5 and later * Non-Carbon CFM: not available } function FSOpenOrphanResFile( const (*var*) ref: FSRef; permission: SignedByte; var refNum: ResFileRefNum ): OSErr; external name '_FSOpenOrphanResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER *) { * FSCreateResourceFile() * * Summary: * Creates a new resource file. * * Discussion: * This function creates a new file and initializes the specified * named fork as an empty resource fork. This function allows for * the creation of data fork only files which can be used for * storing resources. Passing in a null name defaults to using the * data fork. * * Mac OS X threading: * Not thread safe * * Parameters: * * parentRef: * The directory where the file is to be created * * nameLength: * Number of Unicode characters in the file's name * * name: * A pointer to the Unicode name * * whichInfo: * Which catalog info fields to set * * catalogInfo: * The values for catalog info fields to set; may be NULL * * forkNameLength: * The length of the fork name (in Unicode characters) * * forkName: * The name of the fork to initialize (in Unicode); may be NULL * * newRef: * A pointer to the FSRef for the new file; may be NULL * * newSpec: * A pointer to the FSSpec for the new directory; may be NULL. * Ignored on 64 bit. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.3 and later * Non-Carbon CFM: not available } function FSCreateResourceFile( const (*var*) parentRef: FSRef; nameLength: UniCharCount; name: UniCharPtr; whichInfo: FSCatalogInfoBitmap; {const} catalogInfo: FSCatalogInfoPtr { can be NULL }; forkNameLength: UniCharCount; {const} forkName: UniCharPtr { can be NULL }; newRef: FSRefPtr { can be NULL }; newSpec: FSSpecPtr { can be NULL } ): OSErr; external name '_FSCreateResourceFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { * FSCreateResourceFork() * * Summary: * Creates the named forked and initializes it as an empty resource * fork. * * Discussion: * This function allows a resource fork to be added to an existing * file. Passing in a null forkname will result in the data fork * being used. If the named fork already exists this function does * nothing and returns errFSForkExists. * * Mac OS X threading: * Not thread safe * * Parameters: * * ref: * The file to add the fork to * * forkNameLength: * The length of the fork name (in Unicode characters) * * forkName: * The name of the fork to open (in Unicode); may be NULL * * flags: * Pass in zero * * Availability: * Mac OS X: in version 10.2 and later in CoreServices.framework * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later * Non-Carbon CFM: not available } function FSCreateResourceFork( const (*var*) ref: FSRef; forkNameLength: UniCharCount; {const} forkName: UniCharPtr { can be NULL }; flags: UInt32 ): OSErr; external name '_FSCreateResourceFork'; (* AVAILABLE_MAC_OS_X_VERSION_10_2_AND_LATER *) { * FSOpenResourceFile() * * Summary: * Opens the specified named fork as a resource fork. * * Discussion: * This function allows any named fork of a file to be used for * storing resources. Passing in a null forkname will result in the * data fork being used. * * Mac OS X threading: * Not thread safe * * Parameters: * * ref: * The file containing the fork to open * * forkNameLength: * The length of the fork name (in Unicode characters) * * forkName: * The name of the fork to open (in Unicode); may be NULL * * permissions: * The access (read and/or write) you want * * refNum: * On exit the reference number for accessing the open fork * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework * CarbonLib: in CarbonLib 1.3 and later * Non-Carbon CFM: not available } function FSOpenResourceFile( const (*var*) ref: FSRef; forkNameLength: UniCharCount; {const} forkName: UniCharPtr { can be NULL }; permissions: SInt8; var refNum: ResFileRefNum ): OSErr; external name '_FSOpenResourceFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *) { Deprecated Functions -------------------------------------------------------} { use FSOpenResourceFile instead} {$ifc not TARGET_CPU_64} { * OpenRFPerm() *** DEPRECATED *** * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function OpenRFPerm( const (*var*) fileName: Str255; vRefNum: FSVolumeRefNum; permission: SInt8 ): ResFileRefNum; external name '_OpenRFPerm'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *) { use FSOpenResourceFile instead} { * HOpenResFile() *** DEPRECATED *** * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function HOpenResFile( vRefNum: FSVolumeRefNum; dirID: SIGNEDLONG; const (*var*) fileName: Str255; permission: SInt8 ): ResFileRefNum; external name '_HOpenResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *) { use FSCreateResourceFile instead} { * HCreateResFile() *** DEPRECATED *** * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure HCreateResFile( vRefNum: FSVolumeRefNum; dirID: SIGNEDLONG; const (*var*) fileName: Str255 ); external name '_HCreateResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *) { use FSOpenResourceFile instead} { * FSpOpenResFile() *** DEPRECATED *** * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function FSpOpenResFile( const (*var*) spec: FSSpec; permission: SignedByte ): ResFileRefNum; external name '_FSpOpenResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *) { use FSCreateResourceFile instead} { * FSpCreateResFile() *** DEPRECATED *** * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } procedure FSpCreateResFile( const (*var*) spec: FSSpec; creator: OSType; fileType: OSType; scriptTag: ScriptCode ); external name '_FSpCreateResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *) { use FSResourceFileAlreadyOpen instead} { * FSpResourceFileAlreadyOpen() *** DEPRECATED *** * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 9.0 and later } function FSpResourceFileAlreadyOpen( const (*var*) resourceFile: FSSpec; var inChain: Boolean; var refNum: ResFileRefNum ): Boolean; external name '_FSpResourceFileAlreadyOpen'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *) { use FSOpenOrphanResFile instead} { * FSpOpenOrphanResFile() *** DEPRECATED *** * * Mac OS X threading: * Not thread safe * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function FSpOpenOrphanResFile( const (*var*) spec: FSSpec; permission: SignedByte; var refNum: ResFileRefNum ): OSErr; external name '_FSpOpenOrphanResFile'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *) {$endc} {not TARGET_CPU_64} {$endc} {TARGET_OS_MAC} {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE} end. {$endc} {not MACOSALLINCLUDE}