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

Trend Micro 11.0.2062 - An essential sec...
Trend Micro Antivirus provides essential security for macOS with real-time malware detection and mitigation in an affordable solution with a simple, intuitive interface. However, be aware that more... Read more
Backblaze 7.0.2.490 - Online backup serv...
Backblaze is an online backup service designed from the ground-up for the Mac. With unlimited storage available for $6 per month, as well as a free 15-day trial, peace of mind is within reach with... Read more
Pro Video Formats 2.2.1 - Updates for pr...
Pro Video Formats includes support for the following professional video codecs: Apple Intermediate Codec Apple ProRes AVC-Intra 50 / 100 / 200 / 4:4:4 / LT AVC-LongG XAVC XF-AVC DVCPRO HD HDV XDCAM... Read more
Boom 3D 1.3.11 - $19.99
Boom 3D is a revolutionary app with 3D Surround Sound and phenomenally rich and intense audio that is realistic and works on any headphones. Features 3D surround sound Built-in audio player... Read more
Final Cut Pro 10.5.2 - Professional vide...
Redesigned from the ground up, Final Cut Pro combines revolutionary video editing with a powerful media organization and incredible performance to let you create at the speed of thought.... Read more
Chromium 89.0.4389.72 - 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 89.0.4389.72: Complete list of changes can... Read more
iMovie 10.2.3 - Edit personal videos and...
With a streamlined design and intuitive editing features, iMovie lets you create Hollywood-style trailers and beautiful movies like never before. Browse your video library, share favorite moments,... Read more
OmniPlan 4.2.5 - Professional-grade proj...
With OmniPlan, you can create logical, manageable project plans with Gantt charts, schedules, summaries, milestones, and critical paths. Break down the tasks needed to make your project a success,... Read more
Compressor 4.5.2 - Adds power and flexib...
Compressor adds power and flexibility to Final Cut Pro X export. Customize output settings, work faster with distributed encoding, and tap into a comprehensive set of delivery features. Features:... Read more
Motion 5.5.1 - Create and customize Fina...
Motion is designed for video editors, Motion 5 lets you customize Final Cut Pro titles, transitions, and effects. Or create your own dazzling animations in 2D or 3D space, with real-time feedback as... Read more

Latest Forum Discussions

See All

Frogger in Toy Town's latest update...
Konami Digital Entertainment has announced today that their Apple Arcade title Frogger in Toy Town has been updated to introduce a new ranked Endurance Mode. This new game variant's arrival is also accompanied by a few other changes. [Read more] | Read more »
Mitoza is surreal adventure toy you can...
The folks behind the Rusty Lake games have just put a new title onto the App Store. Second Maze, Rusty Lake's collaborative publishing brand, has just brought this 10 year old adventure game from Gal Mamalya to mobile. The best part about all of... | Read more »
Pocket Gamer Awards 2021: You have five...
Three weeks ago our sister site, Pocket Gamer, entered the voting stage for the upcoming Pocket Gamer Awards 2021 and is now in the final stretch. You only have a few hours left to vote for the games you’ve enjoyed on mobile in the past year, as... | Read more »
Patty Stack is a casual arcade game, ava...
Patty Stack is a casual arcade title that's available now for iOS and Android. It's the debut game from developer Feeka Games tasks players with making an increasingly giant burger tower. Think of it as Tower Bloxx but more edible. [Read more] | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
Genshin Impact Guide - Gacha Strategy: W...
This is part 2 of our Genshin Impact gacha strategy guides. See part 1 here. You can check out more guides for Genshin Impact here. | Read more »
Slashy Camp is a new endless runner insp...
Blue Wizard Digital has released Slashy Camp onto iOS and Android after it spent a short amount of time in early access. [Read more] | Read more »
Kinder World is a relaxing game about lo...
Lumi Interactive is releasing a game called Kinder World later this year on iOS and Android, which is all about looking after houseplants. [Read more] | Read more »
Steam Link Spotlight - Fights in Tight S...
Steam Link Spotlight is a feature where we look at PC games that play exceptionally well using the Steam Link app. Our last entry was on Hades. Read about how it plays using Steam Link over here. | Read more »
Lyxo, the light-based puzzler for mobile...
Vienna-based independent game studio Emoak has just released its unique light-based puzzler for iOS and Android. Founded in 2014 by Tobias Sturn, the company is also the creative force behind the infinite climbing game Paper Climb, as well as the... | Read more »

Price Scanner via MacPrices.net

Weekend Sale: $100 off Apple iPad Magic Keybo...
Amazon has Apple iPad Magic Keyboards on sale for $100 off MSRP for a limited time. Amazon’s prices are the lowest available for iPad Magic Keyboard from any Apple reseller this weekend: – Magic... Read more
Gazelle now offering a full line of refurbish...
Gazelle is now offering a full range of discounted, refurbished, unlocked Apple iPhone 12 models starting at $649. iPhones are offered in Fair, Good, and Excellent conditions, and multiple colors are... Read more
These are the latest discounted iPhones Apple...
Apple has a range of Certified Refurbished iPhones available right now starting at only $339. Apple includes a standard one-year warranty, new outer shell, and shipping is free. According to Apple, “... Read more
Save up to $64 on new M1 MacBook Airs at Expe...
Apple reseller Expercom has 2020 13″ M1 MacBook Airs on sale for $51-$64 off Apple’s MSRP with prices starting at $947.96. In addition to their MacBook Air sale prices, take $50 off AppleCare+ when... Read more
Discounts available on 16″ MacBook Pros with...
Upgrade a 16″ 6-Core or 8-Core MacBook Pro from 16GB of standard RAM to 32GB at Adorama, and save $100-$210 over Apple’s price for this custom option: – 16″ 6-Core MacBook Pro/32GB RAM: $2699, save $... Read more
10.9″ iPad Airs on sale for $50-$70 off Apple...
Amazon has new 2020 10.9″ Apple WiFi iPad Airs in stock and on sale today for up to $70 off MSRP with prices starting at $549. Note that Amazon’s sale price might be restricted to certain colors (see... Read more
Apple restocks 2020 27″ 5K iMacs for up to $3...
After an initial offering in January, Apple has restocked a full line of Certified Refurbished 2020 27″ 5K iMacs starting at $1529 and up to $350 off original MSRP. Apple’s one-year warranty is... Read more
Sale! 16″ 8-Core MacBook Pro for $2449, $350...
Apple reseller Adorama has the 16″ 2.3GHz 8-Core Space Gray MacBook Pro in stock and on sale today for $2449 including free shipping. Their price is $350 off Apple’s MSRP for this model, and it’s the... Read more
Roundup of 13″ Multi-Core Intel MacBook Pro s...
Apple resellers are offering significant sales & deals this week on 2020 13″ MacBook Pros with 10th generation Intel CPUs. Take up to $250 off Apple’s MSRP, get free fast shipping, and/or pay no... Read more
64GB iPhone 8 Plus available for $379 at Appl...
Apple has the 64GB iPhone 8 Plus in Space Gray & Gold colors available for $379 today, Certified Refurbished. Each phone is unlocked and comes with Apple’s standard 1-year warranty and free... Read more

Jobs Board

Geek Squad Advanced Repair *Apple* Professi...
**795178BR** **Job Title:** Geek Squad Advanced Repair Apple Professional **Job Category:** Store Associates **Store Number or Department:** 001406-Allen Park-Store Read more
Geek Squad *Apple* Consultation Professiona...
**796549BR** **Job Title:** Geek Squad Apple Consultation Professional **Job Category:** Store Associates **Store Number or Department:** 001800-Hot Springs-Store Read more
*Apple* Mobility Specialist - Best Buy (Unit...
**796014BR** **Job Title:** Apple Mobility Specialist **Job Category:** Store Associates **Store Number or Department:** 001776-Woodmore Towne Centre-Store **Job Read more
Systems Architect, *Apple* Production Engin...
…package beginning on your first day? If so, we hope you'll keep reading! The Apple Sales Engineering and account team is looking for a stellar presales engineer with Read more
Systems Engineer, Webscale, *Apple* Retail,...
…beginning on your first day? If so, we hope you'll keep reading! The Apple Sales Engineering team is looking for a pre-sales engineer with Enterprise engineering Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.