TweetFollow Us on Twitter

Chain Events
Volume Number:9
Issue Number:12
Column Tag:Jörg's Folder

Related Info: Event Manager Apple Event Mgr

Apple Event Handlers in MacForth

Changing the main event loop with executable chains

By Jörg Langowski, MacTech Magazine Regular Contributing Author

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Which Macintosh programming environment - other than Forth - do you know where you can change the main event loop on the fly, plug in new routines or change them while you’re trying them out, or even while your application is running? Maybe Lisp, but certainly none of the development systems (C and C++ of various flavors, Pascal, maybe Fortran and Basic) that account for the majority of all applications on the market. You can solve some of these problems through runtime binding in C++, but for developing a program you still face that edit/compile/link/crash cycle. When I did the example for this column, implementing high-level event support in MacForth, I had plenty of opportunity to appreciate the incremental compiling that Forth offers, together with a good low-level debugger like TMON.

So after having seen how to use Apple events in Fortran and C++, you knew that a Forth example on that subject was just unavoidable. MacForth 4.0, the version that I am still using, does not offer built-in support for high level events. I’m not sure whether the latest 4.2 update does, but I’ll keep you informed as soon as I receive it. Anyway, for the sake of example it is better to use a version that does not support Apple events, because then you can see how to do it.

You remember that an application that supports Apple events has to tell this to the system. There is a bit in the SIZE resource reserved for this purpose. So the first step to make our MacForth kernel high-level event aware is to use ResEdit and set this bit to 1. Now the application’s name will, e.g., be visible in the PPC browser dialog when you select an application to interact with. Now comes the actual work, implementing an Apple event handler in MacForth.

Hooking into the main event loop

Apple events have an event code of 23. Older applications that did not handle Apple events did not check for this code. So how do you persuade the MacForth runtime system to react to high-level events, that is, how does one change the main event loop? (Let’s assume we don’t have access to the source). Easy. MacForth solves this and related problems - like how do you change its behavior on startup and during quit - through the concept of executable chains. These are lists of Forth words that are executed in sequence on various occasions; for instance, the Eventer chain is executed on each pass through the main event loop. There is a standard mechanism to add new Forth words to this chain. If you would add a word to the Eventer chain, all you do is to write Eventer linked followed by your word’s definition (see near the end of the example listing). This word is then automatically linked into the main event loop.

Words linked into the Eventer chain take an event code as a parameter and leave an event code (which may be different from the original one) plus a flag on the stack. The flag tells the system whether the event has been processed (true) or not (false). Thus, we’ll define a word that looks for event code 23 and if it finds it, calls ProcessAppleEvent, the routine that finds the handler corresponding to the Apple event received.

Event handlers

The handlers themselves are installed in a dispatch table through the Forth word Install.Event.Handler (see listing). The parameters to the trap are, from bottom to top of stack:

• the event class specifier (32 bit);

• the event ID (32 bit);

• a pointer to the handler routine (32 bit);

• a reference constant (32 bit);

• a boolean (16 bit) which is true if the handler is installed in the system event dispatch table, false otherwise.

The event class for the required Apple events is ‘aevt’, and the event IDs are ‘oapp’, ‘odoc’, ‘pdoc’, and ‘quit’. We will define handlers for all these events except ‘oapp’.

The address of the handler that is passed to the AEInstallEventHander trap must be a pointer to a routine that follows Pascal calling conventions. Of course, a standard MacForth word doesn’t do that, and you have to define the handler routines in a particular way. MacForth offers two ‘filter routine’ definition words, filter: and ;filter that can be used for that purpose. If you use them instead of : and ; at the start and end of a Forth definition, the resulting word will be callable as a subroutine from machine language. All the word does on execution is to put the entry address of the routine on the stack, which can then be passed as a parameter to a toolbox trap.

The first handler that we’ll write is for the ‘quit’ event. It seems pretty simple; just call ExitToShell and you’re done. But wait we can’t pull the rug from underneath other things that may be going on in the run time system; e.g. open files that have been edited and are not saved, etc. There is a Forth word, bye, that quits the MacForth system gracefully and will for instance present you with the ‘Save Changes ’ dialog box when there are unsaved files. So why not call bye from within the handler? I’ve tried that, with spectacular crashes as a result. This approach does not work because the handler routine would never return correctly, and I guess this leaves things hanging in the air that should be safely fixed on the ground. A safe way to quit is to install a token for a word that quits in the event.filter variable. If this variable is nonzero, MacForth assumes that it contains the pointer to a routine that is called on every pass through the main event loop. We now define a word ciao which resets event.filter to zero and then calls bye, and the quit handler will install the token for this word in event.filter. This way we make sure that ciao is called only once when the ‘quit’ event is received.

You can try out the ‘quit’ handler by using any of the tools to send an Apple event to other applications (there is a Hypercard stack and an Apple event test application available on the Apple ETO CD-ROM, and I’m sure there are public domain programs floating around in cyberspace). You’ll see that MacForth quits, and if there is any open file with unsaved changes, opens the dialog that asks you whether you want to save the changes. I had some problems with the quit handler when I used it in connection with the extended editor (see my last Forth column), and don’t know the reason for sure, but with the standard Sibley editor it works alright.

The other two handlers are for opening and printing documents from the finder. They are very similar, and one could easily modify this so that only one handler is called for both purposes, the switch between open and print behavior being done through the reference constant that is passed when the handler is installed.

These handlers are direct translations from the proposed ‘odoc’ and ‘pdoc’ handlers in Inside Mac vol. 6. First, we get the parameter descriptor out of the Apple event that corresponds to a list of files to be opened or printed. The keyword for this descriptor is ‘list’. The descriptor returned consists of two 32-bit words, the first one containing the parameter type (‘list’), the second one a handle to this parameter. The address of the descriptor is then passed to a routine that counts the number of items in the list (CountItems), and then a loop is executed that steps an index starting at 1 to the number of items, and opens - or prints - each item. The information about the file to be opened is obtained through the routine Get.Nth.Ptr which gets the data corresponding to the n-th item out of a descriptor list. The parameters taken by the trap, AEGetNthPtr, used in this routine are the following:

• a pointer to the descriptor list (32 bits);

• the number of the desired item (32 bits);

• the type of the desired item (32 bits);

• a keyword if one is associated with the descriptor record (32 bits);

• the descriptor type of the item returned (32 bits);

• a pointer to the data buffer (32 bits);

• the maximum size of the data to be returned (32 bits);

• the address of a variable that contains the actual size of the data returned (32 bits).

We call this trap with our descriptor list as a parameter, and specifying that we want the data to be returned in the format of a file system specifier (‘fss ’). Actually, the information about the files to be processed in the ‘odoc’ and ‘pdoc’ Apple events is in the format of alias records, which allows file aliases to be processed transparently. If we specify as the desired type ‘fss ’, the Apple Event manager will automatically ‘coerce’ the alias data to the FSS format, thus resolve the alias. You don’t have to worry about this, all that’s important is that the buffer myFSS contains the volume reference number (16 bits), the directory ID (32 bits), and the file name (63 byte string), in that order. After the successful call to GetNthPtr, this information is extracted from the buffer and used to call either of two routines: se.open$ for opening a file in a new editor window, or (paper) for printing it.

After all these preliminaries, try and load the Forth code, and then drag a few files from the finder to the MacForth item, or select the print command. You’ll see how it works. If it doesn’t, make sure that you have modified your SIZE resource with ResEdit so that the high-level events bit is set.

Things to be resolved

There remain quite a few things that could still be done, for instance, I haven’t told you how to install Apple event handlers in a stand-alone MacForth application, or how to handle other types of Apple events. In fact, I have a very nice project: to install a ‘dosc’ handler in MacForth that interprets Forth code that is sent from other applications, and send back the result in text form. Sort of a Forth tool server. But this is something that you may find in a later column. Until then, happy threading.

Example: Implementing the required Apple events in MacForth 4.0
anew testAE


\ generic interface word to the AE manager

<code AEPack
 popd0, \ pop selector into d0
 MAC Pack8 w,
 next,


\ some AE routines that we need in this example
\ the Pack8 routines all return a 16-bit result,
\ so we have to leave space below the parameters
\ on the stack. Here, we push a 32-bit 0 and later shift the 
\ result code by 16 bit ( hex 10000 / )

hex
: Process.Apple.Event
 0 event.record 021b AEPack 10000 /
;

: Install.Event.Handler  ( AEclass AEID AEproc -- OSErr )      
 0 3 bury ( space for result)
 0 ( refcon ) 0 0 wbury ( false ) 091f ( selector )
 AEPack 10000 /
;

: Get.Param.Desc 
 ( theEvent AEKey DescType AEDesc -- OSErr )
 0 4 bury ( space for result)
 0812 AEPack 10000 /
;

: Count.Items ( DescList theCount -- OSErr )
 0 2 bury ( space for result)
 0407 AEPack 10000 /
;

: Get.Nth.Ptr ( DescList index desiredType theAEKey
 typeCode dataPtr maximumSize actualSize -- OSErr )
 0 8 bury ( space for result )
 100A AEPack 10000 /
;
 
: Dispose.Desc ( AEDesc -- OSErr )
 0 swap 0204 AEPack 10000 /
;
decimal


\ global variables

create myFSS 70 allot
create docList 8 allot


\ the ‘quit’ handler does not call bye directly (this leads to
\ crashes), but just puts a token to a ‘bye’ routine into 
\ EVENT.FILTER. The ‘bye’ routine then sets the filter
\ back to ‘off’ again, so that it won’t be called all over 
\ again in case the user cancels the bye process.

\ our ‘bye’ routine. 

: ciao 
 event.filter off
 bye
;


\ the quit handler itself

filter: AEquit
 locals| refcon reply theEvent |
 token.for ciao event.filter !
;filter


\ ‘odoc’ handler, uses routines from the Sibley editor

filter: AEodoc
 0 0 0 0 
 locals| actualSize descType myKey #items 
 refcon reply theEvent |
 
 theEvent  ascii ---- ( DirectObject )
 ascii list ( AEList ) docList
 Get.Param.Desc 
 if ." GetParamDesc error" cr then
 
 docList addr.of #items  
 Count.Items
 if ." CountItems error" cr then
 
 #items 1+ 1 do
 docList i ascii fss_ addr.of myKey 
 addr.of descType myFSS 70 addr.of actualSize  
 Get.Nth.Ptr
 if ." Get.Nth.Ptr error" cr then
 myFSS 6+ myFSS w@ myFSS 2+ @ se.open$ 
 loop
 
 docList Dispose.Desc
 if ." Dispose.Desc error" cr then
;filter


\ ‘pdoc’ handler, very similar to the ‘odoc’ handler (some
\ code could be factored out here). Uses the printing 
\ routine from ‘Paper’

filter: AEpdoc
 0 0 0 0 
 locals| actualSize descType myKey #items 
 refcon reply theEvent |
 
 theEvent  ascii ---- ( DirectObject )
 ascii list ( AEList ) docList
 Get.Param.Desc 
 if ." GetParamDesc error" cr then
 
 docList addr.of #items  
 Count.Items
 if ." CountItems error" cr then
 
 #items 1+ 1 do
 docList i ascii fss_ addr.of myKey addr.of descType
 myFSS 70 addr.of actualSize  
 Get.Nth.Ptr
 if ." Get.Nth.Ptr error" cr then
 myFSS w@ volref# !
 myFSS 2+ @ ioDir !
 myFSS 6+ (paper) 
 loop
 
 docList Dispose.Desc
 if ." Dispose.Desc error" cr then
;filter

\ space for filter routine return stack
256 allot here 64 - FilterRP !


\ word to install the handlers. We have not provided the 
\ ‘oapp’ handler, but put in there anything you like

: install.req.handlers
   ascii aevt ascii quit AEquit Install.Event.Handler drop
\ ascii aevt ascii oapp AEoapp Install.Event.Handler drop
   ascii aevt ascii odoc AEodoc Install.Event.Handler drop
   ascii aevt ascii pdoc AEpdoc Install.Event.Handler drop
;

\ we need to catch the high level event. MacForth allows to 
\ easily hook new event handlers into the main event loop, 
\ through the Eventer executable chain.
 
Eventer Linked
: AEDispatch
 dup
 23 = if
 Process.Apple.Event drop
 drop 0 true
 else
 false
 then
;

\ finally, install the handlers
install.req.handlers

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Tor Browser 11.5.8 - Anonymize Web brows...
Using Tor Browser you can protect yourself against tracking, surveillance, and censorship. Tor was originally designed, implemented, and deployed as a third-generation onion-routing project of the U.... Read more
Alarm Clock Pro 15.0 - $19.95 (91% off)
Alarm Clock Pro isn't just an ordinary alarm clock. Use it to wake you up in the morning, send and compose e-mails, remind you of appointments, randomize the iTunes selection, control an internet... Read more
Google Chrome 107.0.5304.121 - Modern an...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
calibre 6.9.0 - Complete e-book library...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital librarian... Read more
Safari Technology Preview 16.4 - The new...
Safari Technology Preview contains the most recent additions and improvements to WebKit and the latest advances in Safari web technologies. And once installed, you will receive notifications of... Read more
FileZilla 3.62.2 - Fast and reliable FTP...
FileZilla (ported from Windows) is a fast and reliable FTP client and server with lots of useful features and an intuitive interface. The FileZilla Client not only supports FTP, but also FTP over TLS... Read more
djay Pro 4.0.13 - Transform your Mac int...
djay Pro provides a complete toolkit for performing DJs. Its unique modern interface is built around a sophisticated integration with iTunes and Spotify, giving you instant access to millions of... Read more
Opera 93.0.4585.21 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
AppCleaner 3.6.6 - Uninstall your apps e...
AppCleaner allows you to uninstall your apps easily. It searches the files created by the applications and you can delete them quickly. Supports macOS Ventura. Fixed an issue causing failed updates... Read more
QuickBooks 21.0.7.1248 - Financial manag...
QuickBooks helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save. Built for... Read more

Latest Forum Discussions

See All

‘Top Hunter Roddy & Cathy’ Review –...
The NEOGEO is generally characterized by, with only a few notable exceptions, fighting games and Metal Slug. Within a couple of years of its launch, the vast majority of the output on the console seemed to be mining (quite successfully) a few... | Read more »
SwitchArcade Round-Up: Reviews Featuring...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for November 28th, 2022. In today’s article, we’ve got a pair of reviews to check out. Full reviews of Pokemon Scarlet and Violet and The Oregon Trail are waiting for you to read. There’... | Read more »
‘OPUS: Echo of Starsong’ Interview: Port...
With OPUS: Echo of Starsong ($8.99) having finally launched on iOS after hitting PC and consoles, I had a chance to talk to Scott Chen who is the co-founder and executive producer of Sigono. In our chat, I touched on topics like game subscription... | Read more »
Best iPhone Game Updates: ‘Rush Rally 3’...
Hello everyone, and welcome to the week! It’s time once again for our look back at the noteworthy updates of the last seven days. As November breaths its last, the holiday season is right around the corner. That means we should start seeing more... | Read more »
‘Total Football’ is an Arcade-Style Socc...
GALA SPORTS recently launched its brand new soccer title, Total Football, and, true to its name, it is a pure arcade-style soccer game in the same vein as FIFA Mobile and PES Mobile. It also features official licensing from FIFPro and Manchester... | Read more »
Genshin Impact will recieve two new char...
HoYoverse has announced that Genshin Impacts version 3.3 will be arriving on December 7th. Titled All Senses Clear, All Existence Void, the update will bring two powerful new characters and a brand new card-based minigame. [Read more] | Read more »
‘Wreckfest’ Mobile Compared With Console...
HandyGames’ mobile version of Bugbear’s demolition derby-style racer Wreckfest ($9.99) released on iOS and Android recently, and we featured it as our Game of the Week. | Read more »
Black Friday Deals Here – The TouchArcad...
After taking a couple of weeks off we return on this glorious Black Friday with another episode of The TouchArcade Show. We get into a big discussion about virtual assistants like Alexa, Siri, and Google, and their place in the greater smarthome... | Read more »
TouchArcade Game of the Week: ‘Station 1...
I’m a big fan of Glitch Games and their unique brand of point-and-click adventure/escape room/puzzle games, and while they’re a tiny outfit and there’d typically be a couple years gap in-between their new releases, they were always worth the wait.... | Read more »
SwitchArcade Round-Up: ‘Super Lone Survi...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for November 25th, 2022. Today we look at the remaining releases for the week, and I’ll be honest with you: it’s not a great assortment. Still, there are at least a couple of things... | Read more »

Price Scanner via MacPrices.net

Cyber Monday: 24″ Apple M1 iMacs for $150 off...
Amazon has Apple’s 24″ M1 iMacs on Black Friday sale for $150 off MSRP. Their prices are currently the lowest available for new iMacs among the Apple retailers we track: – 24″ M1 iMacs (8-Core CPU/7-... Read more
Cyber Monday Sale: 25% off Apple MagSafe acce...
Apple retailers are offering MagSafe accessories for up to 25% off MSRP for Cyber Monday. Here are the best deals available, currently from Verizon and Amazon: (1) Verizon has Apple MagSafe Chargers... Read more
Cyber Monday Sale: Apple AirPods for up to $1...
Looking for Apple AirPods, AirPods Pro, or AirPods Max this Cyber Monday? Look no further than our Apple AirPods Price Tracker. We track prices from 20+ Apple retailers and update the tracker... Read more
Final day for Apple’s Black Friday/Cyber Mond...
CYBER MONDAY Apple’s four day Black Friday/Cyber Monday 2022 event is now live and will run from November 25, 2022 to November 28, 2022 (ends today!). Receive a free $100-$250 Apple Gift Card with... Read more
Cyber Monday: Apple 13″ M2 MacBook Airs for $...
Apple retailers have posted their Cyber Monday prices on 13″ MacBook Airs. Take up to $200 off MSRP on M2-powered Airs with these sales with prices starting at only $1049. Free shipping is available... Read more
The best Cyber Monday iPhone sale? This $500...
If you switch to Xfinity Mobile and open a new line of service, they will take $500 off the price of a new iPhone, no trade-in required. This is the best no trade-in Cyber Monday Apple iPhone 14 deal... Read more
Cyber Monday Sale: Apple 16″ MacBook Pros for...
Amazon is offering $500 off MSRP discounts on Apple 16″ MacBook Pros with M1 Pro CPUs as part of their Cyber Monday sale. Their prices are the lowest available for these models from any Apple... Read more
Cyber Monday Sale: Apple 14″ MacBook Pros for...
Amazon is offering $300-$500 off MSRP discounts on Apple 14-inch MacBook Pros with M1 Pro CPUs as part of their Cyber Monday sale. Their prices are the lowest available for these models from any... Read more
Cyber Monday Sale: Apple Watch Ultra for $60...
Amazon has Apple Watch Ultra models (Alpine Loop, Trail Loop, and Opean Bans) on sale for $60 off MSRP as part of their Cyber Monday sale, each including free shipping, reducing the price for an... Read more
Cyber Monday MacBook Sale: 13″ M1 Apple MacBo...
Amazon has Apple 13″ M1 MacBook Airs back on sale for $200 off MSRP, starting at only $799, for Cyber Monday 2022. Their prices are the lowest available for new MacBooks this Cyber Monday. Stock may... Read more

Jobs Board

*Apple* Electronic Repair Technician - PlanI...
…a highly motivated individual to join our Production Department as an Apple Electronic Repair Technician. The computer repair technician will diagnose, assemble, Read more
Product Manager II - *Apple* - DISH (United...
…you will be doing We seek an ambitious, data-driven thinker to assist the Apple Product Development team as our new Retail Wireless division continues to grow and Read more
Staff Engineer 5G Protocol, *Apple* - DISH...
…metrics. Essential Functions and Responsibilities for a Staff Engineer 5G protocol( Apple ) Knowledge of 5G and 4G/LTE protocols and system architectures Experience Read more
Cashier - *Apple* Blossom Mall - JCPenney (...
Cashier - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Blossom Mall Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.