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

Paragraphs 1.0.1 - Writing tool just for...
Paragraphs is an app just for writers. It was built for one thing and one thing only: writing. It gives you everything you need to create brilliant prose and does away with the rest. Everything in... Read more
BlueStacks App Player 0.9.21 - Run Andro...
BlueStacks App Player lets you run your Android apps fast and fullscreen on your Mac. Version 0.9.21: Note: Now requires OS X 10.8 or later running on a 64-bit Intel processor. Initial stable... Read more
Apple iTunes 12.2 - Play Apple Music...
Apple iTunes lets you organize and stream Apple Music, download and watch video and listen to Podcasts. It can automatically download new music, app, and book purchases across all your devices and... Read more
Apple Security Update 2015-005 - For OS...
Apple Security Update 2015-005 is recommended for all users and improves the security of OS X. For detailed information about the security content of this update, please visit: http://support.apple.... Read more
Apple HP Printer Drivers 3.1 - For OS X...
Apple HP Printer Drivers includes the latest HP printing and scanning software for OS X Lion or later. For information about supported printer models, see this page. Version 3.1: The latest printing... Read more
Epson Printer Drivers 3.1 - For OS X 10....
Epson Printer Drivers installs the latest software for your EPSON printer or scanner for OS X Yosemite, OS X Mavericks, OS X Mountain Lion, and OS X Lion. For more information about printing and... Read more
Xcode 6.4 - Integrated development envir...
Xcode provides everything developers need to create great applications for Mac, iPhone, and iPad. Xcode brings user interface design, coding, testing, and debugging into a united workflow. The Xcode... Read more
OS X Yosemite 10.10.4 - Apple's lat...
OS X Yosemite is Apple's newest operating system for Mac. An elegant design that feels entirely fresh, yet inherently familiar. The apps you use every day, enhanced with new features. And a... Read more
Dash 3.0.2 - Instant search and offline...
Dash is an API Documentation Browser and Code Snippet Manager. Dash helps you store snippets of code, as well as instantly search and browse documentation for almost any API you might use (for a full... Read more
FontExplorer X Pro 5.0 - Font management...
FontExplorer X Pro is optimized for professional use; it's the solution that gives you the power you need to manage all your fonts. Now you can more easily manage, activate and organize your... Read more

Heroki (Games)
Heroki 1.0 Device: iOS Universal Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: CLEAR THE SKIES FOR A NEW HERO!The peaceful sky village of Levantia is in danger! The dastardly Dr. N. Forchin and his accomplice,... | Read more »
Hands-On With Raceline CC
Set for release soon, Rebellion’s motorbike racing game, Raceline CC certainly looks stylish. But how does it play? I got my hands on a preview build to answer exactly that. | Read more »
Siegefall - Tips, Tricks, and Strategies...
So, you fancy establishing a base and ruling the world again. Siegefall is a convenient place to do that, but how about some great tips and tricks on how best to go about it? Here are a few ideas on how to get ahead as a beginner to this medieval... | Read more »
The WWE Comes to Racing Rivals - Because...
Racing Rivals is a racing game that's all about, well, rivalry. And who knows rivalry better than WWE superstars (shhhh, that was rhetorical)? [Read more] | Read more »
Hey, Who Put Apple Music in My SoundHoun...
One of the App Store's popular music discovery sources - SoundHound - has already been updated to include Apple's own music discovery source - Apple Music. That was fast! [Read more] | Read more »
Arcane Legends has a New Expansion Calle...
Arcane Legends has been going strong since it debuted at the tail end of 2012. So well, in fact, that it's already up to its sixth expansion. [Read more] | Read more »
Vector 2 is Officially a Thing and it...
Vector is a pretty cool parkour-driven runner that's gotten a pretty decent following since it first came out - although personally I think more people could stand to show it some love. Anyway, Nekki has announced that a sequel isofficially on its... | Read more »
Get Ready to Trucksform and Roll Out (an...
It looks like NuOxygen is bringing the truck-transforming racer Trucksform (get it?) to iOS in a couple of weeks. Although really it's more of an auto-driver than a racer. But still, transforming trucks! [Read more] | Read more »
This Week at 148Apps:June 22-26, 2015
June's Summer Journey Continues With 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice,... | Read more »
LEGO® Minifigures Online (Games)
LEGO® Minifigures Online 1.0.1 Device: iOS iPhone Category: Games Price: $4.99, Version: 1.0.1 (iTunes) Description: | Read more »

Price Scanner via MacPrices.net

Logo Pop Free Vector Logo Design App For OS X...
128bit Technologies has released of Logo Pop Free 1.2 for Mac OS X, a vector based, full-fledged, logo design app available exclusively on the Mac App Store for the agreeable price of absolutely free... Read more
21-inch 1.4GHz iMac on sale for $999, save $1...
B&H Photo has new 21″ 1.4GHz iMac on sale for $999 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Best Buy has the 21″ 1.4GHz iMac on sale for $999.99 on their... Read more
16GB iPad mini 3 on sale for $339, save $60
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $339 including free shipping plus NY tax only. Their price is $60 off MSRP. Read more
Save up to $40 on iPad Air 2, NY tax only, fr...
B&H Photo has iPad Air 2s on sale for up to $40 off MSRP including free shipping plus NY sales tax only: - 16GB iPad Air 2 WiFi: $489 $10 off - 64GB iPad Air 2 WiFi: $559 $40 off - 128GB iPad Air... Read more
Apple Releases OS X 10.10.4 With WIFi Fix, iO...
On Tuesday, Apple released final versions of OS X 10.10.4 and iOS 8.4, as well as updates for the Safari browser for OS X Yosemite, Mavericks, and Mountain Lion. The OS X 10.10.4 update focuses on... Read more
Dual-Band High-Gain Antennas for Home Wi-Fi N...
Linksys has announced what it claims are the first dual-band, omni-directional high-gain antennas for the consumer market. The new Linksys high-gain antennas available in a 2- and 4-pack (WRT004ANT... Read more
Apple refurbished 2014 15-inch Retina MacBook...
The Apple Store has Apple Certified Refurbished 2014 15″ 2.2GHz Retina MacBook Pros available for $1609, $390 off original MSRP. Apple’s one-year warranty is included, and shipping is free. They have... Read more
Clearance 2014 MacBook Airs available for up...
Adorama has 2014 MacBook Airs on sale for up to $301 off original MSRP including NY + NJ sales tax and free shipping: - 11″ 256GB MacBook Air: $798 $301 off original MSRP - 13″ 128GB MacBook Air: $... Read more
5K iMacs on sale for $100 off MSRP, free ship...
B&H Photo has the new 27″ 3.3GHz 5K iMac on sale for $1899.99 including free shipping plus NY tax only. Their price is $100 off MSRP. They have the 27″ 3.5GHz 5K iMac on sale for $2199, also $100... Read more
27-inch 3.2GHz iMac on sale for $1679, save $...
B&H Photo has the 27″ 3.2GHz iMac on sale for $1679.99 including free shipping plus NY sales tax only. Their price is $120 off MSRP. Read more

Jobs Board

*Apple* TV Live Streaming Frameworks Test En...
**Job Summary** Work and contribute towards the engineering of Apple 's state-of-the-art products involving video, audio, and graphics in Interactive Media Group (IMG) at Read more
Project Manager, WW *Apple* Fulfillment Ope...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
Senior Data Scientist, *Apple* Retail - Onl...
**Job Summary** Apple Retail - Online sells Apple products to customers around the world. In addition to selling Apple products with unique services such as iPad Read more
*Apple* Music Producer - Apple (United State...
**Job Summary** Apple Music seeks a Producer to help shepherd some of the most important content and editorial initiatives within the music app, with a particular focus Read more
Sr. Technical Services Consultant, *Apple*...
**Job Summary** Apple Professional Services (APS) has an opening for a senior technical position that contributes to Apple 's efforts for strategic and transactional Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.