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

Chromium 45.0.2454.85 - 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 45.0.2454.85: Note: Does not contain the "... Read more
OmniFocus 2.2.5 - GTD task manager with...
OmniFocus helps you manage your tasks the way that you want, freeing you to focus your attention on the things that matter to you most. Capturing tasks and ideas is always a keyboard shortcut away in... Read more
iFFmpeg 5.7.1 - Convert multimedia files...
iFFmpeg is a graphical front-end for FFmpeg, a command-line tool used to convert multimedia files between formats. The command line instructions can be very hard to master/understand, so iFFmpeg does... Read more
VOX 2.6 - Music player that supports man...
VOX is a beautiful music player that supports many filetypes. The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all... Read more
Box Sync 4.0.6567 - Online synchronizati...
Box Sync gives you a hard-drive in the Cloud for online storage. Note: You must first sign up to use Box. What if the files you need are on your laptop -- but you're on the road with your iPhone? No... Read more
Carbon Copy Cloner 4.1.4 - Easy-to-use b...
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
OmniGraffle Pro 6.3.1 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
Monosnap 3.1.2 - Versatile screenshot ut...
Monosnap lets you capture screenshots, share files, and record video and .gifs! Capture: Capture full screen, just part of the screen, or a selected window Make your crop area pixel perfect with... Read more
Alfred 2.7.2 - Quick launcher for apps a...
Alfred is an award-winning productivity application for OS X. Alfred saves you time when you search for files online or on your Mac. Be more productive with hotkeys, keywords, and file actions at... Read more
Microsoft Remote Desktop 8.0.19 - Connec...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more

We're Sorry to Report that Moonrise...
Moonrise is a very promising-looking, Pokemon-esque monster collecting and battling game that we were really looking forward to reviewing, but unfortunately it looks like that's never going to happen. [Read more] | Read more »
The Latest Update for The Sims FreePlay...
Commerce has gotten a little more active with the newest update for The Sims FreePlay, making Sunset Mall more of a hangout than ever before. [Read more] | Read more »
This Week at 148Apps: August 24-28, 2015
The Apps of August 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, standing out... | Read more »
NASCAR in Real Racing 3? Sure, Why Not?
I have to give Firemonkeys credit - it's very cool of them to add NASCAR to Real Racing 3 via an update rather than making a separate game for it. But that's a different discussion for another time; for now let's sit back and enjoy driving in... | Read more »
The nuyu is an Inexpensive Activity Moni...
Today, Health o Meter nuyu has announced a series of health and fitness-related products, including the aforementioned activity monitor along with a wireless scale. All at a decent pricepoint, no less. [Read more] | Read more »
The Makers of Overkill are Trying Someth...
Craneballs, the studio responsible for the Overkill series, is taking a little break from all that violence (a little break) to bring us Cube Worm - a 3D take on one of the most classic PC/calculator games in existence. [Read more] | Read more »
The Sandbox Welcomes Cutethulu in its La...
Another month, another update to Pixowl's The Sandbox. This time players can say hello to "Cutethulu" - an adorable little rendition of perhaps the most well known (and infamous) of the Elder Gods. [Read more] | Read more »
ReBoard: Revolutionary Keyboard (Utilit...
ReBoard: Revolutionary Keyboard 1.0 Device: iOS Universal Category: Utilities Price: $1.99, Version: 1.0 (iTunes) Description: Do everything within the keyboard without switching apps! If you are in WhatsApp, how do you schedule a... | Read more »
Tiny Empire (Games)
Tiny Empire 1.1.3 Device: iOS Universal Category: Games Price: $2.99, Version: 1.1.3 (iTunes) Description: Launch cannonballs and blow tiny orcs into thousands of pieces in this intuitive fantasy-themed puzzle shooter! Embark on an... | Read more »
Astropad Mini (Productivity)
Astropad Mini 1.0 Device: iOS iPhone Category: Productivity Price: $4.99, Version: 1.0 (iTunes) Description: *** 50% off introductory price! ​*** Get the high-end experience of a Wacom tablet at a fraction of the price with Astropad... | Read more »

Price Scanner via MacPrices.net

eFileCabinet Announces SMB Document Managemen...
Electronic document management (EDM) eFileCabinet, Inc., a hosted solutions provider for small to medium businesses, has announced that its SecureDrawer and eFileCabinet Online services will be... Read more
WaterField Designs Unveils American-Made, All...
San Francisco’s WaterField Designs today unveiled their all-leather Cozmo 2.0 — an elegant attach laptop bag with carefully-designed features to suit any business environment. The Cozmo 2.0 is... Read more
Apple’s 2015 Back to School promotion: Free B...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
128GB MacBook Airs on sale for $100 off MSRP,...
B&H Photo has 11″ & 13″ MacBook Airs with 128GB SSDs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.6GHz/128GB MacBook Air: $799.99, $100 off MSRP... Read more
13-inch 2.5GHz MacBook Pro (refurbished) avai...
The Apple Store has Apple Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.... 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
Apple and Cisco Partner to Deliver Fast-Lane...
Apple and Cisco have announced a partnership to create a “fast lane” for iOS business users by optimizing Cisco networks for iOS devices and apps. The alliance integrates iPhone with Cisco enterprise... Read more
Apple offering refurbished 2015 13-inch Retin...
The Apple Store is offering Apple Certified Refurbished 2015 13″ Retina MacBook Pros for up to $270 (15%) off the cost of new models. An Apple one-year warranty is included with each model, and... Read more
Apple refurbished 2015 MacBook Airs available...
The Apple Store has Apple Certified Refurbished 2015 11″ and 13″ MacBook Airs (the latest models), available for up to $180 off the cost of new models. An Apple one-year warranty is included with... Read more
21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $120 off MSRP including free shipping plus NY sales tax only: - 21″ 1.4GHz iMac: $999.99 $100 off - 21″ 2.7GHz iMac: $1199.99 $100 off - 21″ 2.9GHz iMac... Read more

Jobs Board

*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
Simply Mac- *Apple* Specialist- Store Manag...
Simply Mac is the largest premier retailer for Apple products and solutions. We're looking for dedicated individuals with a passion to simplify and enhance the 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* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.