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

Day One 2.3 - Maintain a daily journal.
Day One is the easiest and best-looking way to use a journal / diary / text-logging application for the Mac. Day One is well designed and extremely focused to encourage you to write more through... Read more
Carbon Copy Cloner 4.1.16 - Easy-to-use...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
Sketch 45 - Design app for UX/UI for iOS...
Sketch is an innovative and fresh look at vector drawing. Its intentionally minimalist design is based upon a drawing space of unlimited size and layers, free of palettes, panels, menus, windows, and... Read more
NeoFinder 7.1 - Catalog your external me...
NeoFinder (formerly CDFinder) rapidly organizes your data, either on external or internal disks, or any other volumes. It catalogs all your data, so you stay in control of your data archive or disk... Read more
TunnelBear 3.0.15 - Subscription-based p...
TunnelBear is a subscription-based virtual private network (VPN) service and companion app, enabling you to browse the internet privately and securely. Features Browse privately - Secure your data... Read more
Hopper Disassembler 4.2.5- - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32-bit and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about... Read more
BetterTouchTool 2.261 - Customize Multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
Sketch 44.1 - Design app for UX/UI for i...
Sketch is an innovative and fresh look at vector drawing. Its intentionally minimalist design is based upon a drawing space of unlimited size and layers, free of palettes, panels, menus, windows, and... Read more
BetterTouchTool 2.260 - Customize Multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
Chromium 59.0.3071.115 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 59.0.3071.115: This update has no Flash plug... Read more

Latest Forum Discussions

See All

Dive into epic summer adventure with Oce...
Summer may be the best time to enjoy ocean adventures, and now you don’t even have to leave the comfort of your own home, thanks to the folks at Joycity, creators of Oceans & Empires. The old-timey naval MMO is getting a sizable new June Grand... | Read more »
Missile Cards (Games)
Missile Cards 1.0.9 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.9 (iTunes) Description: "Missile Command meets Solitaire...only with more doomlasers, death, and explosions." | Read more »
Collect mini assassins in 'Assassin...
Assassin's Creed is traveling back in time to the Spanish Inquisition for its latest mobile entry, Assassin's Creed Rebellion. The game is giving the series a look that's a huge departure from its past design, recreating classic characters in a... | Read more »
Animal Crossing is still coming to mobil...
Animal Crossing is still coming to mobile in 2017, according to aWaypointinterview with Nintendo. Announced in 2016, the game was delayed without a defined release window. However, fans of Nintendo's fantasy slice of life game won't have to wait... | Read more »
Ravenscroft 275 Piano (Music)
Ravenscroft 275 Piano 1.0.0 Device: iOS Universal Category: Music Price: $35.99, Version: 1.0.0 (iTunes) Description: Experience the splendor of a Ravenscroft Grand with the most realistic sounding piano ever created for iOS. Launch... | Read more »
This War of Mine gets a new ending and m...
This War of Mine just got a big new update, featuring free DLC that adds a new ending to the game, among other exciting changes. The update is celebrating the game's two-year release anniversary. Apart from the new ending, which will be quite... | Read more »
Summon eight new heroes in Fire Emblem H...
Nintendo keeps coming at us with Fire Emblem Heroes updates, and it doesn't look like that trend is stopping anytime soon. The folks behind the game have just announced the new War of the Clerics Voting Gauntlet, expected to start next Tuesday. [... | Read more »
The best deals on the App Store this wee...
iOS publishers are pulling out all the stops this week -- there's a huge number of seriously great games at discounted prices this week. Let's not waste any time and get right down to business. [Read more] | Read more »
The House of da Vinci (Games)
The House of da Vinci 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Enter The House of Da Vinci, a new must-try 3D puzzle adventure game. Solve mechanical puzzles, discover hidden... | Read more »
Solve the disappearance of history’s gre...
Blue Brain Games invites you to indulge in an immersive hands-on 3D puzzle adventure in similar vein to The Room series, with its debut release The House of Da Vinci. Set during the historic period of the Italian Renaissance (when Leonardo himself... | Read more »

Price Scanner via MacPrices.net

Will iPad Running iOS 11 Be The ‘Ute’ Of The...
Steve Jobs’ analogy comparing iPads and PCs to cars and trucks respectively is seven years old but still stimulates discussion and debate. Appearing on an All Things D panel in 2010 shortly after the... Read more
Free CarePassport App gives Patients control...
Boston based CarePassport is on a mission to enable patients to take control of their medical records by allowing patients to aggregate, store, share and manage all their medical data including... Read more
Western Digital Launches New My Passport Ultr...
Western Digital Corporation has expanded its WD brand My Passport portable drive line with the redesigned My Passport Ultra drive. In addition to a new metallic look, the drive offers intuitive WD... Read more
Clearance 2016 13-inch MacBook Pros available...
B&H Photo has clearance 2016 13″ MacBook Pros in stock today for up to $210 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 13″ 2.9GHz/512GB Touch Bar... Read more
Apple Releases iOS 11 Public Beta; How To Get...
The official release of Apple’s latest mobile operating system iOS 11 is vaguely slated for the fall, but as of June 26, ordinary users can download an iOS 11 public beta. To download the iOS 11... Read more
Extend Life of MacBook Pro Retina 2.0TB With...
MacSales.com/Other World Computing has announced availability of the new OWC 2.0TB Aura Pro Solid State Drive for mid-2012 to early 2013 Apple MacBook Pro with Retina display. One of the fastest... Read more
BBEdit SummerFest 2017 Discount Ends Friday,...
You can get 20% off BBEdit for a limited time in Bare Bones Software’s http://www.eastgate.com/Tinderbox/Specials/SummerFest.html?mc_cid=f2101ca260&mc_eid=[UNIQID]SummerFest 2017 sale and... Read more
Use Apple’s Education discount to save up to...
Purchase a new Mac using Apple’s Education discount, and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: - 15″ 2... Read more
Clearance 27-inch 3.3GHz 5K iMac available fo...
Amazon clearance 27″ 3.3GHz 5K iMacs (MK482LL/A) available for $1799.90 including free shipping. Their price is $500 off original MSRP, and it’s the lowest price available for this model from any... Read more
13-inch 1.8GHz/256GB MacBook Air on sale for...
B&H Photo has the updated 2017 13″ 1.8GHz/256GB MacBook Air (MQD42LL/A) in stock and on sale for $1129 including free shipping plus NY & NJ tax only. Their price is $70 off MSRP. Read more

Jobs Board

*Apple* News Product Marketing Mgr., Publish...
…organizational consensus on strategy and vision for publisher tools, authoring, and Apple News Format.Carries this strategy and vision across the organization to Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Security Data Analyst - *Apple* Information...
…data sources need to be collected to allow Information Security to better protect Apple employees and customers from a wide range of threats.Act as the subject matter Read more
Lead *Apple* Solutions Consultant - Apple I...
…integrity, and trust.Success Metrics/Key Performance Indicators:Quantitative* Year over Year growth in Apple Product and Beyond the Box sales in the assigned Point of Read more
*Apple* Solutions Consultant till v%u00E5r...
…ethics, integrity, and trust.Success Metrics/Key Performance Indicators:QuantitativeYear over Year growth in Apple Product and Beyond the Box sales in the assigned Point Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.