TweetFollow Us on Twitter

Gestaltstorage
Volume Number:9
Issue Number:3
Column Tag:Pascal/Assembly

Related Info: Gestalt Manager

Gestaltstorage

A ‘Global’ storage technique, using _Gestalt

By Alain Danteny, France

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

This article is merely a re-writing and translation of a previous article I submitted to Apple France’s DTS, which was published in the November 91-issue of ‘La Lettre des Développeurs Apple’. It’s based on an idea by Franck Lefebvre (Hi, Frank): How to use Gestalt to store “global” informations, mainly in non-A5 worlds. Frank did it in C, while I propose it in MPW Pascal and Asm

1. Gestalt Was ist das?

System 6.0.4 introduced a new Trap, _Gestalt, that lets you read specific hardware or software configurations and settings: system version, QuickDraw version, etc.

You can use the Gestalt Manager through a single call to:

FUNCTION Gestalt(selector: OSType; VAR response: Longint): OSErr;

Error codes are sometimes returned:

gestaltUnknownErr = -5550;
{ value returned if Gestalt doesn't know the answer }
gestaltUndefSelectorErr = -5551;        
{ undefined selector was passed to Gestalt }
gestaltDupSelectorErr = -5552;          
{ tried to add an entry that already existed }
gestaltLocationErr = -5553;             
{ gestalt function ptr wasn't in sysheap }

They are a lot of predefined read-only selectors available

More interesting, you can define your own private selector through the use of:

FUNCTION NewGestalt(selector: OSType; selectorFunction: ProcPtr): OSErr;

The heart of this routine is the selectorFunction parameter: you have to supply your own mechanism to retrieve your information. This routine is called by the Gestalt Manager using the following interface:

FUNCTION selectorFunction(selector:OSType; VAR response:Longint):OSErr;

You will probably write it using assembly, although this is not necessary.

For the purpose of GestaltStorage, we write the following routine :

;1

 FUNC 
 EXPORT (__SelectorFunc,__EndSelectorFunc):CODE

;FUNCTION __SelectorFunc(selector:OSType;
;VAR response:Longint):OSErr;
__SelectorFunc 
result  EQU $10
selectorEQU $C
responseEQU $8


 BRA.S  Skip
Address DC.L0    
;place holder for our address of storage structure
;could be anything else, provided a 4-byte length
Skip    LINKA6,#0
 CLR.W  result(A6) ;init no error
 MOVEA.Lresponse(A6),A0
 MOVE.L Address(PC),D0
 BNE.S  GFExit
;if Address is $0 (meaning we already used and released 
;this selector) then we return the address of the 
;selectorFunction itself to re-use it properly
 LEA    __SelectorFunc,A1
 MOVE.L A1,D0
;we return #$0100 as error code to let user know that the 
;address of the selectorFunction is returned instead
 MOVE.W #$0100,result(A6) 
GFExit  MOVE.L   D0,(A0)
;otherwise, return ‘global’ address 
 UNLK   A6
 MOVEA.L(A7)+,A0
 ADDQ.W #$8,A7
 JMP    (A0)
__EndSelectorFunc;marker to end of routine
 ENDFUNC


As you know by now, check out the Gestalt Manager chapter of Inside Mac Volume VI, or your interface files.

2. GestaltStorage

The idea behind the GestaltStorage project is to provide simple routines to create, set, get and dispose of ‘private’ Gestalt selectors in your application.

Whenever you need to keep data ‘global’ (for example, between two calls of an XCMD, a MDEF, a WDEF etc.), just create a new selector, fill it, use it and release it when the job is done (actually, when quitting).

There’s one thing you have to remember: Gestalt ‘lives’ in the system heap, therefore everything you create there stays until the next boot.

The ‘public’ routines of GestaltStorage are:

FUNCTION GSFreeStorage(selector:OSType):Boolean;

This function tests whether your private Gestalt selector already exists or not.

FUNCTION GSNew(selector:OSType;storageSize:Size; globalData:Ptr):OSErr;

This function allocate a new ‘global’ storage structure in the System heap of type selector, stuffs the ‘raw’ data pointed by globalData in it, for storageSize bytes long, and returns an error code (either Gestalt or Memory Manager).

There are three possibilities:

• selector doesn’t exist yet: we simply create it.

• selector already exists, but doesn’t point to data any longer: we reuse it and store new data, being aware of the previous storageSize field of the internal structure.

• selector already exists and points to data: we overwrite those data for storageSize bytes long (no dynamic re-allocation!)

FUNCTION GSGet(selector:OSType;bucketPtr:Ptr):OSErr;

This function collects the data stored in the selector structure and stuffs them in bucketPtr. This pointer must be an already existing and valid pointer, or any structure pointed to with the @ operator (in Pascal).

FUNCTION GSRead(selector:OSType;offset,length:LongInt;

bucketPtr:Ptr):OSErr;

This is merely the same as GSGet, except that you can get ‘partial’ data, provided you supply an offset from the beginning of your own structure and a length of bytes to read from.

FUNCTION GSSet(selector:OSType;globalData:Ptr):OSErr;

This routine lets you reset or modify your previously stored ‘global’ data (through GSNew). globalData points to the new ‘raw’ data. Only storageSize bytes will be copied

FUNCTION GSWrite(selector:OSType;offset,length:LongInt;
 globalData:Ptr):OSErr;

Merely the same as GSSet, except that you can write ‘partial’ new data, providing an offset and a length to write to.

FUNCTION GSDispose(selector:OSType):OSErr;

When you’re done with the use of your own selector, this routine de-allocates any memory used in the System heap and set the ‘global’ address to $0 (a longint).

(Notice that the selector is still alive, until next boot: there’s no [official] way to unregister a Gestalt selector )

3. Optimizing GestaltStorage?

This mechanism is very simple, yet efficient for any data of constant size.

One could consider re-writting GestaltStorage to handle dynamic allocations, linked structures, etc. or implement such routines:

FUNCTION GSAppend(selector:OSType;moreSize:Size;
 moreGlobalData:Ptr):OSErr;
FUNCTION GSInsert(selector:OSType;offset:LongInt;
 moreSize:Size;moreGlobalData:Ptr):OSErr;
FUNCTION GSRemove(selector:OSType;offset:LongInt;
 lessSize:Size):OSErr;

For the OOP folks, there’s probably a good class to code here!

4. Tidbits

While sleuthing the MPW libraries, I discovered that the Gestalt Manager routines are embedded in a 500+-byte ‘glue’, for compatibility purpose: if you really know what your doing, you can use those ‘un-glued’ routines:

;2

;FUNCTION __ReplaceGestalt(selector: OSType;
;gestaltFunction: ProcPtr;
;VAR oldGestaltFunction: ProcPtr): OSErr;
;smaller version without MPW glue : we assume _Gestalt is 
;implemented <Juil 92> remove extra LINK and UNLK 
;instructions refer to A7
__ReplaceGestalt FUNC EXPORT
error   EQU $10
selectorEQU $C
newGF   EQU $8
oldGF   EQU $4
 MOVE.L selector(A7),D0
 MOVEA.LnewGF(A7),A0
 _Gestalt ,Sys
 MOVE.W D0,error(A7)
 MOVEA.LoldGF(A7),A1
 MOVE.L A0,(A1)
 MOVEA.L(A7)+,A0
 ADDA.W #$C,A7
 JMP    (A0)
 ENDFUNC

;===========================================================
;FUNCTION __NewGestalt(selector: OSType;
;gestaltFunction: ProcPtr): OSErr;
;smaller version without MPW glue : we assume _Gestalt is ;implemented 
<Juil 92> remove extra LINK and UNLK ;instructions refer to A7
__NewGestaltFUNC EXPORT
error   EQU $C
selectorEQU $8
funct   EQU $4
 MOVE.L selector(A7),D0
 MOVEA.Lfunct(A7),A0
 _Gestalt ,Immed
 MOVE.W D0,error(A7)
 MOVEA.L(A7)+,A0
 ADDQ.L #$8,A7
 JMP    (A0)
 ENDFUNC

;===========================================================
;FUNCTION __Gestalt(selector: OSType;
;VAR response: LONGINT): OSErr;
;smaller version without MPW glue : we assume _Gestalt is ;implemented 
<Juil 92> remove extra LINK and UNLK 
;instructions refer to A7
__Gestalt FUNC EXPORT
error   EQU $C
selectorEQU $8
responseEQU $4
 MOVE.L selector(A7),D0
 _Gestalt
 MOVEA.Lresponse(A7),A1
 MOVE.L A0,(A1)
 MOVE.W D0,error(A7)
 MOVEA.L(A7)+,A0
 ADDQ.L #$8,A7
 JMP    (A0)
 ENDFUNC

5. Comments

I’ll be glad to hear your comments on AppleLink at DANTENY.

{3}
Listing GestaltStorage.p
UNIT GestaltStorage;

INTERFACE

USES Memtypes,QuickDraw,OSIntf,ToolIntf,GestaltEqu,
 GestaltStorage_glue;

CONST 
 gsFromStart=0;
 gsStorageSize=8;
TYPE  
 (* Key concept: through the use of Gestalt and our *)
 (* private selector we store an address to a pointer *)
 (* in system heap, and thus access it later, even *)
 (* during interrupts tasks   We could have stored the *)
 (* address of the 'raw' pointer to data but we decided *)
 (* to use the following structure for our data: *)
 
 gsStoragePtr=^gsStorageData;
 gsStorageData=RECORD
 {kind of 'private' fields }
 gsSize:Size;    {size of the 'raw' data     }
 {address of the GestaltFunction}
 gsFuncAddr:LongInt; 
 {kind of 'public' field }
 {raw data goes here for gsSize bytes long}
   END;
   
 (* For Pascal uses,we defined that structure to mimic *)
 (* the asm structure of the GestaltFunction. Forget *)
 (* it otherwise *)
 gsFuncPtr=^gsFuncData;
 gsFuncData=RECORD
 {entrypoint of asm routine}
 BRAinstruction:integer;  
 gsStorageAddr:LongInt; {our DC.L storage}
 {func code goes here as defined in the .a code}
 END;
 

FUNCTION GSNew(selector:OSType;storageSize:Size;
 globalData:Ptr):OSErr;
FUNCTION GSGet(selector:OSType;bucketPtr:Ptr):OSErr;
FUNCTION GSRead(selector:OSType;offset,length:LongInt;
 bucketPtr:Ptr):OSErr;
FUNCTION GSSet(selector:OSType;globalData:Ptr):OSErr;
FUNCTION GSWrite(selector:OSType;offset,length:LongInt;
 globalData:Ptr):OSErr;
FUNCTION GSDispose(selector:OSType):OSErr;

IMPLEMENTATION


FUNCTION GSNew(selector:OSType;storageSize:Size;
 globalData:Ptr):OSErr;
VAR
 theErr:OSErr;
 globalDataAddr:LongInt;
 theStorage:Ptr;
 theGestaltFunc:Ptr;
 theGestaltFuncAddr:LongInt;
 oldStorageSize:Size;
BEGIN
 theErr:=__Gestalt(selector,globalDataAddr);
 IF theErr=gestaltUndefSelectorErr THEN 
 { An undefined selector was passed to Gestalt : it's OK }
 { for us to allocate a brand new storage component. }
 BEGIN
 theGestaltFunc:=GSNewFunction;
 IF theGestaltFunc<>NIL THEN
 BEGIN
 theStorage:=GSNewStorage(storageSize,globalData);
 IF theStorage<>NIL THEN
 BEGIN
 gsFuncPtr(theGestaltFunc)^.gsStorageAddr:=
 ORD(theStorage);
 gsStoragePtr(theStorage)^.gsFuncAddr:=
 ORD(theGestaltFunc);
 theErr:=__NewGestalt(selector,
 ProcPtr(theGestaltFunc));
 END
 ELSE
 BEGIN
 gsStoragePtr(theStorage)^.gsFuncAddr:=0;
 theErr:=memFullErr;
 END;
 END
 ELSE theErr:=memFullErr;
 END
 ELSE IF theErr=$0100 THEN 
 { value returned by the _Gestalt function if storage }
 { address is NIL (header) the selector is still valid, }
 { so we can re-use it in this case, the globalDataAddr }
 { longint holds the address of the gestalt function. }
 BEGIN
 theGestaltFuncAddr:=globalDataAddr; 
 IF theGestaltFuncAddr<>0 THEN 
 {probably paranoid }
 BEGIN
 theGestaltFunc:=Ptr(theGestaltFuncAddr);
 IF gsFuncPtr(theGestaltFunc)^.BRAinstruction=$6004 THEN
 BEGIN
 theStorage:=GSNewStorage(storageSize,globalData);
 IF theStorage<>NIL THEN
 BEGIN
 gsFuncPtr(theGestaltFunc)^.gsStorageAddr:=
 ORD(theStorage);
 gsStoragePtr(theStorage)^.gsFuncAddr:=
 theGestaltFuncAddr;
 theErr:=noErr;
 END
 ELSE theErr:=memFullErr;
 END
 ELSE theErr:=gestaltDupSelectorErr; 
 {really paranoid }
 END
 ELSE theErr:=gestaltDupSelectorErr;
 END
 ELSE IF theErr=noErr THEN 
 {an entry already exist: we OVERWRITE it with same Size}
 BEGIN
 oldStorageSize:=
 gsStoragePtr(Ptr(globalDataAddr))^.gsSize;
 BlockMove(globalData,Ptr(globalDataAddr+
 SizeOf(gsStorageData)),oldStorageSize);
 END
 ELSE theErr:=gestaltDupSelectorErr;
 {an unexpected error occurs: we safetely do nothing}
 GSNew:=theErr;
END;


FUNCTION GSGet(selector:OSType;bucketPtr:Ptr):OSErr;
VAR
 theErr:OSErr;
 globalDataAddr:LongInt;
BEGIN
 theErr:=__Gestalt(selector,globalDataAddr);
 IF theErr=noErr THEN
 WITH gsStoragePtr(Ptr(globalDataAddr))^ DO
 BlockMove(Ptr(globalDataAddr+
 SizeOf(gsStorageData)),bucketPtr,gsSize);
 GSGet:=theErr;
END;


FUNCTION GSRead(selector:OSType;offset,length:LongInt;
 bucketPtr:Ptr):OSErr;
VAR
 theErr:OSErr;
 globalDataAddr:LongInt;
BEGIN
 theErr:=__Gestalt(selector,globalDataAddr);
 IF theErr=noErr THEN
 BlockMove(Ptr(globalDataAddr+
 SizeOf(gsStorageData)+offSet),bucketPtr,length);
 GSRead:=theErr;
END;


FUNCTION GSSet(selector:OSType;globalData:Ptr):OSErr;
VAR
 theErr:OSErr;
 globalDataAddr:LongInt;
BEGIN
 theErr:=__Gestalt(selector,globalDataAddr);
 IF theErr=noErr THEN
 WITH gsStoragePtr(Ptr(globalDataAddr))^ DO
 BlockMove(globalData,Ptr(globalDataAddr+
 SizeOf(gsStorageData)),gsSize);
 GSSet:=theErr;
END;

FUNCTION GSWrite(selector:OSType;offset,length:LongInt;
 globalData:Ptr):OSErr;
VAR
 theErr:OSErr;
 globalDataAddr:LongInt;
BEGIN
 theErr:=__Gestalt(selector,globalDataAddr);
 IF theErr=noErr THEN
 BlockMove(globalData,Ptr(globalDataAddr+
 SizeOf(gsStorageData)+offSet),length);
 GSWrite:=theErr;
END;


FUNCTION GSDispose(selector:OSType):OSErr;
VAR
 theErr:OSErr;
 globalDataAddr:LongInt;
 globalData:Ptr;
BEGIN
 theErr:=__Gestalt(selector,globalDataAddr);
 IF theErr=noErr THEN
 BEGIN
 globalData:=Ptr(globalDataAddr);
 IF globalData<>NIL THEN
 BEGIN
 gsFuncPtr(Ptr(gsStoragePtr(globalData)^.
 gsFuncAddr))^.gsStorageAddr:=0;
 DisposPtr(globalData);
 globalData:=NIL;
 END
 ELSE theErr:=nilHandleErr;
 END;
 GSDispose:=theErr;
END;

END.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

VisualRuler - turns your iPhone into rul...
VisualRuler - turns your iPhone into ruler 1.0 Device: iOS iPhone Category: Utilities Price: $2.99, Version: 1.0 (iTunes) Description: Need to measure the size of the object but do not have a ruler? VisualRuler calculates the size of... | Read more »
Blyss (Games)
Blyss 2.0 Device: iOS Universal Category: Games Price: $1.99, Version: 2.0 (iTunes) Description: Travel through Beautiful mountains, serene valleys and harsh deserts solving Blyss' unique and self-evolving puzzles. The endless... | Read more »
Road Not Taken (Games)
Road Not Taken 1.0 Device: iOS iPhone Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: "It looks like a cute fairy tale, but this is a turn-based game that's thorny with challenge and packed with an incredible number... | Read more »
What is PokéVision -- and why doesn...
The biggest thing that Pokemon GO players want to know is where to find the Pokemon they don't already have. The crux of the game is catching 'em all, so tracking down elusive pocket monsters is generally task number one any time someone fires up... | Read more »
Win every gym battle in Pokemon GO
Let me know if this scenario sounds familiar. You've got a Pokemon GO gym battle within easy walking distance, and you've visited it many times. Maybe you've even dropped one of your Pokemon there to help defend the place and reap the benefits. [... | Read more »
Can PokeMatch help you find love with Po...
The unofficial Pokemon GO companion app space has exploded almost as fast as the game itself over the last few weeks. Aspiring app developers, many of them working solo, have given us apps that locate Pokemon, keep track of the server status, and... | Read more »
How to get started with Prisma
If there's one thing people like to do more than taking pictures with their smartphones, it's tinkering with those photos in some way. Numerous apps have sprung up over the last several years that allow you to use filters and special effects to... | Read more »
6 Pokemon GO updates you can expect, acc...
Pokemon GO had a scheduled appearance at this year's San Diego Comic-Con for a while, but it was only relatively close to the show that it was upgraded to a spot in Hall H. That's the biggest venue at SDCC, one usually reserved for the largest... | Read more »
How to evolve Eevee in Pokemon GO
By now, almost everyone should be hip to how to evolve Pokemon in Pokemon GO (and if not, there's a guide for that). Just gather enough candy of the appropriate type, feed them all to the Pokemon, and evolution happens. It's a miracle that would... | Read more »
CSR Racing 2: Guide to all game modes
It might not seem like there are all that many ways to go fast in a straight line, but CSR Racing 2 begs to differ. [Read more] | Read more »

Price Scanner via MacPrices.net

Bare Bones Software Releases Free TextWrangle...
Bare Bones Software has announced the release and immediate availability of TextWrangler 5.5, a significant update to its powerful, free, general purpose text editor for Mac OS X. TextWrangler is a... Read more
Apple’s 2016 Back to School promotion: Free B...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free, and... Read more
Apple refurbished iPad Air 2s available start...
Apple has Certified Refurbished iPad Air 2 available starting at $339. Apple’s one-year warranty is included with each model, and shipping is free: - 128GB Wi-Fi iPad Air 2: $499 - 64GB Wi-Fi iPad... Read more
13-inch 2.5GHz MacBook Pro available for $964...
Overstock has the 13″ 2.5GHz MacBook Pro available for $964.21 including free shipping. Their price is $135 off MSRP. Read more
External Keyboard Innovations For iPad Pro (1...
I’m an input device aficionado. With non-touchscreen computers, which includes all Macs, the keyboard and mouse or trackpad are the tactile points of interface between user and machine, and the... Read more
GSK Rheumatoid Arthritis Study Leverages iPho...
Global healthcare products company GlaxoSmithKline (GSK) says that since 2014 they have begun transforming the way they conduct research, by leveraging state-of-the-art digital technologies — a... Read more
Clearance 12-inch Retina MacBooks, Apple refu...
Apple has Certified Refurbished 2015 12″ Retina MacBooks available starting at $929. Apple will include a standard one-year warranty with each MacBook, and shipping is free. The following... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1199 $100 off MSRP - 13″ 2.7GHz/... Read more
13-inch 1.6GHz/128GB MacBook Air on sale for...
Amazon has the 13″ 1.6GHz/128GB MacBook Air on sale for $200 off MSRP for a limited time. Shipping is free: - 13″ 1.6GHz/128GB MacBook Air (sku MMGF2LL/A): $799.99 $200 off MSRP Their price is the... Read more
13-inch 1.6GHz/256GB MacBook Air on sale for...
Amazon has the 13″ 1.6GHz/256GB MacBook Air on sale for $200 off MSRP for a limited time. Shipping is free: - 13″ 1.6GHz/256GB MacBook Air (sku MMGG2LL/A): $999.99 $200 off MSRP Their price is the... Read more

Jobs Board

*Apple* Retail - Multiple Positions, Willow...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Evangelist - JAMF Software (United S...
The Apple Evangelist is responsible for building and cultivating strategic relationships with Apple 's small and mid-market business development field teams. This Read more
*Apple* Solutions Consultant - APPLE (United...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
*Apple* Professional Learning Specialist - A...
Job Summary The Apple Professional Learning Specialist is a full-time position for one year with Apple in the Phoenix, AZ area. This position requires a high Read more
*Apple* Picker - Apple Hill Orchard (United...
Apple Hill Orchard, Co. Rte. 21,Whitehall, NY 9/7/16-10/228/16. Pick fresh market or processing apples Productivity of 60 boxes and 80 boxes processing fruit per Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.