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

Viber 11.9.1 - Send messages and make fr...
Viber lets you send free messages and make free calls to other Viber users, on any device and network, in any country! Viber syncs your contacts, messages and call history with your mobile device, so... Read more
Vallum 3.3.2 - $15.00
Vallum is a little tool that helps you monitor and block apps connections and throttle apps bandwidth. It is able to intercept connections at the application layer, and hold them while you decide... Read more
Microsoft OneNote 16.31 - Free digital n...
OneNote is your very own digital notebook. With OneNote, you can capture that flash of genius, that moment of inspiration, or that list of errands that's too important to forget. Whether you're at... Read more
Apple Pages 8.2.1 - Apple's word pr...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices, and... Read more
Numbers 6.2.1 - Apple's spreadsheet...
With Apple Numbers, sophisticated spreadsheets are just the start. The whole sheet is your canvas. Just add dramatic interactive charts, tables, and images that paint a revealing picture of your data... Read more
f.lux 39.9873 - Adjusts the color of you...
f.lux makes the color of your computer's display adapt to the time of day, warm at night and like sunlight during the day. Ever notice how people texting at night have that eerie blue glow? Or wake... Read more
Deeper 2.5.0 - Enable hidden features in...
Deeper is a personalization utility for macOS which allows you to enable and disable the hidden functions of the Finder, Dock, QuickTime, Safari, iTunes, login window, Spotlight, and many of Apple's... Read more
NTFS 15.5.71 - Provides full read and wr...
NTFS breaks down the barriers between Windows and macOS. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS. Write, edit, copy, move, delete files on NTFS... Read more
MTR 5.3.0.0 - The Mac's oldest and...
MTR (was MacTheRipper)--the Mac's oldest and smartest DVD-backup app. MTR - the complete toolbox, not a one-trick, point-and-click extractor. MTR is intended for making fair-use, backup copies of... Read more
Keynote 9.2.1 - Apple's presentatio...
Easily create gorgeous presentations with the all-new Keynote, featuring powerful yet easy-to-use tools and dazzling effects that will make you a very hard act to follow. The Theme Chooser lets you... Read more

Latest Forum Discussions

See All

Black Desert Mobile gets an official rel...
Pearl Abyss has just announced that its highly-anticipated MMO, Black Desert Mobile, will launch globally for iOS and Android on December 11th. [Read more] | Read more »
Another Eden receives new a episode, cha...
Another Eden, WFS' popular RPG, has received another update that brings new story content to the game alongside a few new heroes to discover. [Read more] | Read more »
Overdox guide - Tips and tricks for begi...
Overdox is a clever battle royale that changes things up by adding MOBA mechanics and melee combat to the mix. This new hybrid game can be quite a bit to take in at first, so we’ve put together a list of tips to help you get a leg up on the... | Read more »
Roterra Extreme - Great Escape is a pers...
Roterra Extreme – Great Escape has been described by developers Dig-It Games as a mini-sequel to their acclaimed title Roterra: Flip the Fairytale. It continues that game's tradition of messing with which way is up, tasking you with solving... | Read more »
Hearthstone: Battlegrounds open beta lau...
Remember earlier this year when auto battlers were the latest hotness? We had Auto Chess, DOTA Underlords, Chess Rush, and more all gunning for our attention. They all had their own reasons to play, but, at least from where I'm standing, most... | Read more »
The House of Da Vinci 2 gets a new gamep...
The House of Da Vinci launched all the way back in 2017. Now, developer Blue Brain Games is gearing up to deliver a second dose of The Room-inspired puzzling. Some fresh details have now emerged, alongside the game's first official trailer. [Read... | Read more »
Shoot 'em up action awaits in Battl...
BattleBrew Productions has just introduced another entry into its award winning, barrelpunk inspired, BattleSky Brigade series. Whilst its previous title BattleSky Brigade TapTap provided fans with idle town building gameplay, this time the... | Read more »
Arcade classic R-Type Dimensions EX blas...
If you're a long time fan of shmups and have been looking for something to play lately, Tozai Games may have just released an ideal game for you on iOS. R-Type Dimensions EX brings the first R-Type and its sequel to iOS devices. [Read more] | Read more »
Intense VR first-person shooter Colonicl...
Our latest VR obsession is Colonicle, an intense VR FPS, recently released on Oculus and Google Play, courtesy of From Fake Eyes and Goboogie Games. It's a pulse-pounding multiplayer shooter which should appeal to genre fanatics and newcomers alike... | Read more »
PUBG Mobile's incoming update bring...
PUGB Mobile's newest Royale Pass season they're calling Fury of the Wasteland arrives tomorrow and with it comes a fair chunk of new content to the game. We'll be seeing a new map, weapon and even a companion system. [Read more] | Read more »

Price Scanner via MacPrices.net

Weekend Sale: Apple AirPods Pro for $234.98 a...
Abt Electronics has Apple’s new AirPods Pro in stock and on sale today for $234.98 including free shipping and free returns. Their price is $15 off Apple’s MSRP for these AirPods and tie Amazon... Read more
New 2019 16″ MacBook Pros on sale for $100 of...
Apple Authorized Reseller Adorama has new 2019 16″ MacBook Pros on sale today for $100 off Apple’s MSRP, each including free shipping. In addition, Adorama charges sales tax for NY & NJ residents... Read more
Apple Watch Series 3 GPS models on sale for l...
Amazon has Apple Watch Series 3 GPS models on sale starting at only $179. There prices are the lowest we’ve ever seen for these models from any Apple reseller. Choose Amazon as the seller rather than... Read more
iOS Bug In Facebook News Feed Lets Device Ca...
NEWS: 11.15.19- Users of the Facebook social media platform’s mobile app running on iOS devices won’t, like, this piece of news one bit in where a bug in the News Feed gave access to the camera... Read more
16″ MacBook Pros on sale! Preorder at Amazon...
Apple’s new 16″ MacBook Pros were only introduced yesterday, but Amazon is already offering a $100 discount on preorders. Prices for the base 6-Core 16″ MacBook Pros start at $2299: – 2019 16″ 2.6GHz... Read more
Use our exclusive MacBook Price Trackers to f...
Our Apple award-winning MacBook price trackers are the best place to look for the best sales & lowest prices on new and clearance MacBook Airs and MacBook Pros–including Apple’s new 16″ MacBook... Read more
New November Verizon iPhone deal: Get an iPho...
Verizon has the 64GB iPhone Xr on sale for 50% off for a limited time, plus they will include a free $200 prepaid MasterCard and a free Amazon Echo Dot. That reduces their price for the 64GB iPhone... Read more
Apple cuts prices on clearance, refurbished 2...
Apple has clearance 2018 15″ 6-Core Touch Bar MacBook Pros, Certified Refurbished, now available starting at only $1829. Each model features a new outer case, shipping is free, and an Apple 1-year... Read more
Up to $450 price drop on clearance 15″ MacBoo...
B&H Photo has dropped prices Apple’s 2019 15″ 6-Core and 8-Core MacBook Pros by $400-$450 off original MSRP, starting at $1999, with free overnight shipping available to many addresses in the US... Read more
Here’s how to save $200 on Apple’s new 16″ Ma...
Apple has released details of their Education discount associated with the new 2019 16″ 6-Core and 8-Core MacBook Pros. Take $200 off the price of the new 8-Core model (now $2599) and $200 off the 16... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**746887BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Store NUmber or Department:** 001512-Ankeny-Store **Job Read more
Best Buy *Apple* Computing Master - Best Bu...
**746836BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Store NUmber or Department:** 000341-Scranton-Store **Job Description:** **What Read more
QA Manager, *Apple* - CBS Corporation (Unit...
# QA Manager, Apple **REF#:** 35331 **CBS BUSINESS UNIT:** CBS Interactive **JOB TYPE:** Full-Time Staff **JOB SCHEDULE:** **JOB LOCATION:** Burbank, CA **ABOUT Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**744315BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Store NUmber or Department:** 000662-Auburn AL-Store **Job Description:** At Best Read more
Nurse Practitioner - Field Based (San Bernard...
Nurse Practitioner - Field Based (San Bernardino, CA, Apple Valley, Hesperia) **Location:** **United States** **New** **Requisition #:** PS30312 **Post Date:** 4 Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.