TweetFollow Us on Twitter

Filter Procs
Volume Number:1
Issue Number:10
Column Tag:Programmer's Forum

"C Glue Routines for Filter Procs"

By Van Kichline, John Pence, MacMan, Inc.

The Macintosh ROM is divided into two sections, the operating system and the programmer's toolbox. The programmer's toolbox comprises about two thirds of the ROM and is there to make it easier for the programmer to adhere to Apple's stringent but cohesive user interface guidelines. It provides easy to use routines for creating windows and text edit records, dealing with resources, conducting modal dialogs and alerts, and many, many more functions. Used with a little care, it makes your program look and perform like a commercial Macintosh product, and makes it easy and intuitive for users to use your program.

The toolbox helps the programmer do it right, but what if you want to do it just a little differently? Not many individuals would care to rewrite and debug the routines provided by the toolbox, but in many cases there are alternatives built in. Many toolbox routines include parameters for optional filter or action procedures, which can be used with a default value (usually NIL) or with a pointer to a procedure you supply. Some examples are filterProcs for SFGetFile and ModalDialog, and actionProcs for controls.

A dialog filterProc is invoked by calling ModalDialog with a procPtr to your filter procedure. It changes the way ModalDialog responds to events that take place within its domain. The object of one filter we wrote was to capture keystrokes that occurred while the command key was down, format them, and display them in a rectangle in the ModalDialog box. The filter looked at keyDown events, checked the modifiers field, changed the itemHit to 0 so that a TextEdit box in the same dialog wouldn't know about the keystroke, and then did a little string fiddling. It didn't take long to write, but it took a while to get running!

The Programmer's Toolbox expects you to be a Pascal programmer, not a C programmer, and C passes arguments quite differently than Pascal. This means that the ROM will call your function, but the way it presents its data is incompatible with Mac C. Pascal passes its parameters on the stack, and Mac C passes its parameters in registers.

Can non-Pascal programmers use filters and actionProcs at all? Is there any solution? Is this the end?

There are two solutions, actually. Assembly language routines can be used for all procedures that are called by the ROM. Assembly language is easy to mix with C programs, and allows the programmer the flexibility to deal with data in any format in which it may be presented. There is nothing at all wrong with this solution, and Inside Mac provides much valuable information for the assembly programmer. Assembly code is tight, fast, and efficient. Assembly programming, however, requires a firm grasp of the instruction set of the processor, and is more difficult and time consuming than programming in a medium level language like C.

Functions called by the ROM can be written in C with a little care, a little effort, and a little glue. The term "glue" refers to a few assembly language instructions that fasten your code and the ROM code together. A glue routine is a labeled set of instructions that interface a particular function to another, "incompatible" function. Glue routines are easy to implement , and once a glue routine for a particular case is developed, it can be readily copied to other routines of the same type with only the most trivial modifications. This allows the programmer to rapidly write the filter and action routines in C. Once debugged and tuned, the routines can be converted to assembly if required, but I haven't found a need to convert any yet.

Pascal calls FUNCTIONS and PROCEDUREs by pushing its arguments onto the stack. If the routine being called is a FUNCTION (a Pascal routine that returns a result) a place for the result is cleared on the stack, which may be two or four bytes wide. Then the parameters for the routine, which may also be two or four bytes each, are pushed on the stack in the order which they are declared in the Pascal procedure's definition. In other words, if the procedure Meza is being called, and it's defined:

PROCEDURE Meza(Homos : food ; Gyros: food ; Pita : bread) ;

Then the arguments would be pushed in the order Homos, Gyros, and Pita. When they're retrieved, they'll be popped in the order Pita, Gyros, Homos. Be careful. Think backwards. Finally, the JSR instruction that calls the procedure places the four byte return address on top of the stack, covering the parameters.

Mac C functions pass the values of the first seven arguments, assuming there are more, in the data registers D0 through D6. Excess arguments are stored on the stack, but we won't deal with the complexities of excess arguments here. The prologue code for each function defined in Mac C actually takes the arguments out of the registers and stores them on the stack in a "stack frame," but we are free to ignore what takes place once the C function is invoked. What's of importance to the writer of a glue routine is taking the Pascal parameters off the stack and placing them in the appropriate registers while preserving the return address. For Pascal FUNCTIONS, the result must also be placed in the appropriate location on the stack.

Assembling the Solution

There are several ways to construct glue routines. The way I've presented here is applicable for routines requiring up to three parameters. Another way would be to "seal" the parameters in a stack frame and extract each parameter relative to A6. (See Robert Denny's column in MT 1, 7) I've selected the more direct approach because it's easier to describe, and is sufficient for all routines I've encountered except window and menu definition procedures, which are extremely complex. Our goal is to present enough information for the reader to construct his/her own glue routines without further aid, so we've selected the direct, or "brute force" method for presentation.

Assembly language may be included in Mac C source code by bracketing the lines with the terms #asm and #endasm. What goes in between is assembly source code that's exactly like MDS assembly source. Here's the skeleton of a Pascal to Mac C glue routine:

#asm
routineName:; what you call the function 
MOVE.L  (SP)+, A0; pop return address to A0
MOVE.X  (SP)+, DX; save up to 3 params, of 2             ; or 4 bytes.
MOVEM.L A0, -(SP); return address on top of        ; stack
MOVEM.L A3-A4/D3-D7, -(SP); save the registers
JSR myFunctionInC; execute the C code
MOVEM.L (SP)+,  A3-A4/D3-D7 ; Restore registers.
MOVE.X  X0, 4(SP); if it's a function, return a          ; value
RTS
#endasm

The first line of the glue routine is the label, "routineName." This would be replaced with a unique function name in your application. The toolbox routine calls this label, not myFunctionInC. If the C function is called by the ROM instead of the glue routine, the system will crash. The label is declared as a C function at the beginning of the file. For example, if this where to be a ModalDialog filterProc, I would declare it in advance:

short routineName() ;   /* type short : returns Pascal BOOLEAN */

Thereafter, the term "routineName" represents a pointer to the function. To use it as a function for a particular modal filter, you'd use:

do{
 ModalDialog(routineName, &itemHit) ;
 switch(itemHit)
 {
 case QUIT:         (code) break 
 case CANCEL:  (code) break ;
 case CRASH:     (code) break ;
 default:                SysBeep(8) ;
 }
} while TRUE ;

Thus, the label of the glue routine is treated exactly as if it where the name of the C function it calls. The actual C function is referenced by nobody but the glue routine.

The second item in the glue routine skeleton pops the top four bytes off the stack and puts them in A0 for temporary storage. This is the return address of the routine calling our filter, pushed on the stack by a JSR in the ROM. In this case, it is ModalDialog who called, and the return address is the only way back to it.

Next is the part that does the actual gluing, and varies for different usages. Parameters, being two or four bytes in length, are popped off the stack and stored in data registers. (See the illustration "Data Configurations.") This data, remember, was pushed there by the toolbox routine before calling us and comprises the parameters our C function needs in its registers. If the data is two bytes in length MOVE.W is used, and if the data is four bytes long MOVE.L is used in place of MOVE.X. See the illustration of the stack at entry to the glue routine.

After the parameters are moved into the registers the return address, which we'd stored in A0, is placed back on top of the stack.

Next, the register set is saved. The MoveMultiple instruction saves all the registers desired in a single line. Then, the JSR instruction to the private name myFunctionInC executes the real code.

After the last parameter is moved to the appropriate data register, the stack pointer (A7) points at the place holder for the FUNCTION result if there is one, or else to "unknown territory," or other essential data that remains on the stack and must be preserved. Next, the return address is placed back on top of the stack (four bytes) followed by the registers (28 bytes.) When the JSR myFunctionInC instruction is executed, it pushes a return address to the instruction following the JSR onto the stack and puts the address of myFunctionInC in the program counter. The data the C code needs is in the registers. The C function doesn't disturb anything on the stack except the return address on the very top, which it uses to return to the glue routine with an RTS.

Once the C function returns to the glue routine that called it, the registers that the glue routine saved are restored, popping them from the stack. Directly under those registers is the return address of the caller that we were so careful to preserve earlier. If our C code was emulating a Pascal FUNCTION, the place holder for the result is directly under the return address. We must place the result of our function in this location. Mac C returns results that are values in D0, and results that are pointers in A0. So a BOOLEAN result would be in D0, and two bytes long. In this case, the last instruction before the RTS would be MOVE.W DO, 4(SP). It's always 4(SP), because the return address always four bytes long, but the instruction may move a word or a long word from D0, or a long word from A0, depending on the data type of the result. Don't put a result there if it's not required! You'll mash irreplaceable data and crash. Now a simple JSR propels us back into the ROM and the inner sanctums of ModalDialog.

Concrete Glue

Here's a concrete example. The toolbox routine TrackControl can use a pointer to an actionProc as a parameter. This actionProc represents a continuous action to be performed while the control is being tracked. Scroll bars require an actionProc in order to make the arrows and paging parts work. First, the label is declared globally.

void trackScroll() ;

The function's declared as void because it's used as a Pascal PROCEDURE, and returns no result. Then, when a mousedown occurs in a scroll bar, the application finds the controls handle and calls:

if(TestControl(controlHand, &theEvent->where) == inThumb)
 TrackControl(controlHand, &theEvent->where, NIL) ;
else
 TrackControl(controlHand, &theEvent->where, trackScroll) ;

Note that TrackControl doesn't need an actionProc for the thumb (the moving box part of the scroller), so why rewrite one?

If the else branch is taken, our glue routine is called by the ROM. An action proc for an indicator like a scroll bar receives two parameters; a ControlHandle and a short representing the partCode of the control that was activated. No result is returned. Thus the glue routine goes:

#asm
trackSrcoll:
MOVE.L  (SP)+, A0; temp storage for return addr
MOVE.W  (SP)+, D1; partCode goes in D1, 2 bytes
MOVE.L  (SP)+, D0; controlHandle goes in D0, 4 bytes
MOVE.L  A0, -(SP); push return address
MOVEM.L A3-A4/D3-D7, -(SP)       ; save regs
JSR   Cscroll  ; do the function written in C
MOVEM.L (SP)+, A3-A4/D3-D7      ; restore regs
RTS; no result. go back to TrackControl
#endasm

The labels trackScroll and Csrcoll are specific to an implementation, while the rest is constant from one actionProc to another. The size of the parameters determines which MOVE instructions to use. D1 is loaded first, then D0, because they where pushed onto the stack in order, and are popped off in reverse.

The glue routine may be contained entirely within the function called by it. This makes cutting and pasting the routine to another application easier. A complete, albeit simple example of a scrolling actionProc in C might be:

void deadCscrolls (theControl, partCode)
 ControlHandle   theControl ;
 short  partCode ;
{
 short  amount, startVal, up ;
 
 if(!partCode)
 return ;
 startVal = GetCtlValue(theControl) ;
 up = (partCode == inUpButton || 
 partCode == inPageUp) ? TRUE : FALSE;
 
 if ((up && (startVal > GetCtlMin(theControl))) ||
 (!up && (startVal<GetCtlMax(theControl))))
 {
 amount = (up) ? -1 :  1 ;
 SetCtlValue(theControl, startVal + amount) ;
 }
 return ;
 
 /* the Glue routine */
 
#asm
trackScroll:; TrackControl calls trackScroll, not        ; deadCscrolls!
 MOVE.L (SP)+, A0; save the return address
 MOVE.W (SP)+, D1; partCode to D1
 MOVE.L (SP)+, D0; theControl to D0
 MOVE.L A0, -(SP); return address goes here
 MOVEM.L  A3-A4/D3-D7, -(SP); save the registers   JSR   deadCscrolls
 ; the scroll actionproc - C
 MOVEM.L  (SP)+, A3-A4/D3-D7; restore the registers      RTS   
 ; there's nothing to return
#endasm
}

Note that every actionProc of this type uses the exact same glue routine. It may take a little while to work out the first time, but the effort doesn't need to be repeated. A small collection is all you need.

Glue routines can be used to rapidly implement toolbox modifying procedures and functions in C. Such implementation allows the programmer to write filters and actionProcs readily, and simplifies debugging and maintaining them. Such routines can be converted entirely to assembly after testing for greater efficiency, or may be left as is with little or no difference in performance.

Authors note: The techniques described here may or may not apply to other C compilers. We'd be interested in hearing.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Six fantastic ways to spend National Vid...
As if anyone needed an excuse to play games today, I am about to give you one: it is National Video Games Day. A day for us to play games, like we no doubt do every day. Let’s not look a gift horse in the mouth. Instead, feast your eyes on this... | Read more »
Old School RuneScape players turn out in...
The sheer leap in technological advancements in our lifetime has been mind-blowing. We went from Commodore 64s to VR glasses in what feels like a heartbeat, but more importantly, the internet. It can be a dark mess, but it also brought hundreds of... | Read more »
Today's Best Mobile Game Discounts...
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links below... | Read more »
Nintendo and The Pokémon Company's...
Unless you have been living under a rock, you know that Nintendo has been locked in an epic battle with Pocketpair, creator of the obvious Pokémon rip-off Palworld. Nintendo often resorts to legal retaliation at the drop of a hat, but it seems this... | Read more »
Apple exclusive mobile games don’t make...
If you are a gamer on phones, no doubt you have been as distressed as I am on one huge sticking point: exclusivity. For years, Xbox and PlayStation have done battle, and before this was the Sega Genesis and the Nintendo NES. On console, it makes... | Read more »
Regionally exclusive events make no sens...
Last week, over on our sister site AppSpy, I babbled excitedly about the Pokémon GO Safari Days event. You can get nine Eevees with an explorer hat per day. Or, can you? Specifically, you, reader. Do you have the time or funds to possibly fly for... | Read more »
As Jon Bellamy defends his choice to can...
Back in March, Jagex announced the appointment of a new CEO, Jon Bellamy. Mr Bellamy then decided to almost immediately paint a huge target on his back by cancelling the Runescapes Pride event. This led to widespread condemnation about his perceived... | Read more »
Marvel Contest of Champions adds two mor...
When I saw the latest two Marvel Contest of Champions characters, I scoffed. Mr Knight and Silver Samurai, thought I, they are running out of good choices. Then I realised no, I was being far too cynical. This is one of the things that games do best... | Read more »
Grass is green, and water is wet: Pokémo...
It must be a day that ends in Y, because Pokémon Trading Card Game Pocket has kicked off its Zoroark Drop Event. Here you can get a promo version of another card, and look forward to the next Wonder Pick Event and the next Mass Outbreak that will be... | Read more »
Enter the Gungeon review
It took me a minute to get around to reviewing this game for a couple of very good reasons. The first is that Enter the Gungeon's style of roguelike bullet-hell action is teetering on the edge of being straight-up malicious, which made getting... | Read more »

Price Scanner via MacPrices.net

Take $150 off every Apple 11-inch M3 iPad Air
Amazon is offering a $150 discount on 11-inch M3 WiFi iPad Airs right now. Shipping is free: – 11″ 128GB M3 WiFi iPad Air: $449, $150 off – 11″ 256GB M3 WiFi iPad Air: $549, $150 off – 11″ 512GB M3... Read more
Apple iPad minis back on sale for $100 off MS...
Amazon is offering $100 discounts (up to 20% off) on Apple’s newest 2024 WiFi iPad minis, each with free shipping. These are the lowest prices available for new minis among the Apple retailers we... Read more
Apple’s 16-inch M4 Max MacBook Pros are on sa...
Amazon has 16-inch M4 Max MacBook Pros (Silver and Black colors) on sale for up to $410 off Apple’s MSRP right now. Shipping is free. Be sure to select Amazon as the seller, rather than a third-party... Read more
Red Pocket Mobile is offering a $150 rebate o...
Red Pocket Mobile has new Apple iPhone 17’s on sale for $150 off MSRP when you switch and open up a new line of service. Red Pocket Mobile is a nationwide MVNO using all the major wireless carrier... Read more
Switch to Verizon, and get any iPhone 16 for...
With yesterday’s introduction of the new iPhone 17 models, Verizon responded by running “on us” promos across much of the iPhone 16 lineup: iPhone 16 and 16 Plus show as $0/mo for 36 months with bill... Read more
Here is a summary of the new features in Appl...
Apple’s September 2025 event introduced major updates across its most popular product lines, focusing on health, performance, and design breakthroughs. The AirPods Pro 3 now feature best-in-class... Read more
Apple’s Smartphone Lineup Could Use A Touch o...
COMMENTARY – Whatever happened to the old adage, “less is more”? Apple’s smartphone lineup. — which is due for its annual refresh either this month or next (possibly at an Apple Event on September 9... Read more
Take $50 off every 11th-generation A16 WiFi i...
Amazon has Apple’s 11th-generation A16 WiFi iPads in stock on sale for $50 off MSRP right now. Shipping is free: – 11″ 11th-generation 128GB WiFi iPads: $299 $50 off MSRP – 11″ 11th-generation 256GB... Read more
Sunday Sale: 14-inch M4 MacBook Pros for up t...
Don’t pay full price! Amazon has Apple’s 14-inch M4 MacBook Pros (Silver and Black colors) on sale for up to $220 off MSRP right now. Shipping is free. Be sure to select Amazon as the seller, rather... Read more
Mac mini with M4 Pro CPU back on sale for $12...
B&H Photo has Apple’s Mac mini with the M4 Pro CPU back on sale for $1259, $140 off MSRP. B&H offers free 1-2 day shipping to most US addresses: – Mac mini M4 Pro CPU (24GB/512GB): $1259, $... Read more

Jobs Board

All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.