TweetFollow Us on Twitter

Toolbox Calls
Volume Number:1
Issue Number:3
Column Tag:Forth forum

Toolbox Calls

By Jörg Langowski

First of all let me apologize for two things. The first one is an error in my article on the floating point routines; you might already have noticed it. Page 14 of MacTech 1-1, column 2, sentence 2, last word should be ELEMS68K instead of FP68K.

Secondly, I omitted something that I promised to you, namely the words for toolbox trap calling from MacForth. Let's quickly make up for this: The word that defines an operating system call is OS.TRAP. The word defined by OS.TRAP will take the address of a parameter block from the stack and put it into register A0, then execute the trap given in the definition. OS traps returns their result in register D0, and the content of this register is saved in the predefined variable IO-RESULT before exiting. As an example you may define a call to the READ function as:

:  A002  OS.TRAP  READ  ;

Calling READ with the address of a file control block on the stack will then read the appropriate number of bytes from a file or volume.

All toolbox routines that are structured like a Pascal procedure expect their parameters on the stack in the order in which they appear in the Pascal definition in the Inside Mac manual. The Forth word MT assumes that all parameters on the stack are in their correct 32-bit format, and a toolbox call defined by MT will leave the stack unchanged before executing the trap. On execution, the parameters are cleared from the stack.

If the routine expects any 16-bit parameters (16 and 32 bits are the only possibilities), it would be a little difficult to push them on the stack correctly, since MacForth generally assumes stack items to be 32 bit long (in contrast to standard FORTH-79). Most toolbox traps, however, need at most two 16-bit items, and they are at the end of the parameter list. MacForth provides the two defining words W>MT and 2W>MT for calling traps that need one or two 16-bit parameters. These parameters can be pushed on the stack as 32-bit items and are automatically adjusted to 16 bits before the trap is executed.

Last type of toolbox calls are Pascal functions. The calling convention here is that one has to leave space on the stack for the result and then push the parameters. The function will clear the parameters from the stack upon execution and leave the result in the space provided. Four types of calls are provided through the defining words FUNC>W, FUNC>L, W>FUNC>L, L>FUNC>L,for functions (in that order) that use no parameters and return a 16-bit item, no parameters/32-bit result, 16-bit parameter/32-bit result, 32-bit parameter/32-bit result.

The line 1111 instruction

If you decompile and disassemble the code that is produced by the trap defining words, you will see that some of them contain instructions that start with a hex F. Here MacForth makes use of the other set of unimplemented instructions (line 1111 emulator) of the 68000!

Read this over again, it is important. The MacForth implementers have really made a fine use of the 68000 traps that are available. Not only are the 4E type traps used in making the threaded code fast (see my last article), here is the 1111 line trap, too. The Motorola 68000 Programmer's Reference Manual (you have it by now, haven't you) tells you where the trap vector is, it is hex 2C. At this location you find (in MacForth) the 32-bit number hex 5614. The code at $5614 looks like that shown in fig. 1.

Beautiful: A word that starts with hex F is a negative 16-bit number and can therefore be used as a negative offset into an address table that is below the base location that A4 points to. As an example, let's see how an OS trap defined through OS.TRAP is executed. Assume you defined READ like above. Then the word READ will generate the threaded code:

 FFEC [F line trap for OS.TRAP]
 A002 [READ OS call]

A4 points to $55C4 in Forth 1.1. $FFEC added to A4 gives $55B0, at which location we find the address $1850. Offset from A4, we find ourselves at $6E14. The code there is shown in figure 2.

As you see, the trap word is moved into the routine that sets up the parameter register and executes the OS call. You may try and disassemble the definitions of the Pascal function call defining words; they also work through the 1111 line trap.

'Exotic' procedure calls

Though I do not recommend to do so, you might have written your own assembly language routine that requires a 16-bit parameter on the stack somewhere in between the 32 bit parameters and therefore you cannot use one of the defining words to call it. Here is a little trick that does the job. Since MacForth does not provide a word that pushes a 16-bit value on the stack and decrements the stack pointer by only two, we define our own. The base of the stack can be accessed through the variable S0, SP@ fetches the current stack pointer and SP! stores the value of S0 in the stack pointer.

:  PUSHW  S0  @  >R  SP@  2-  S0  !
SP!  R>  S0  !  DROP  ;

is our 16-bit push. After this, of course, the stack will be screwed up for most practical Forth purposes, so be sure to use it only if you a. want to call a procedure that expects a 16-bit parameter at this position on the stack or b. if you use it twice to make a composite 32-bit item on the stack from two 16-bit items.

Windows and Controls in MacForth

The last topic that I want to deal with in this issue are some points about windowing on the Macintosh. Those of you who read David Smith's article on assembly language have probably already got a feeling how involved this can get. Even setting up a window takes quite some effort. Fortunately, the MacForth system takes most of the load off our shoulders.

The FINGER.PAINT example in the MacForth manual illustrates the ease with which basic windowing functions such as opening, closing, dragging, resizing and tracking the mouse are handled; the word DO.EVENTS takes care of many of these functions. However, the MacForth system support does not go beyond those basics. More complicated things like scrolling must be handled explicitly by you, the user. The reason for this is simply that opening, closing, dragging and sizing are functions that are handled by the Window Manager while a scroll bar is a control for which the Control Manager is responsible. Controls are supported by MacForth Level 2; Level 1 does not document controls, although some of the definitions that are used in control handling are already present in Level 1.

For example, you can add scroll bars to any window by adding the constants SCROLL.UP/DOWN or SCROLL.LEFT/RIGHT to the window attributes. Try this in the windowing example from the Level 1 manual and then click the mouse in one of the scroll bars.

Of course, the bars don't scroll anything since DO.EVENTS does not support them. In order to be able to use these and other controls, we have to go through the Control Manager. Level 1 owners, you don't have to quit here, controls are a standard concept of the Macintosh that is supported by the Mac system and may be used from anywhere, FORTH, machine language, Pascal, C, even BASIC. It is only a little simpler in Level 2 because some of the things that we have to define for ourselves are already there.

In the next issue we'll look at the Control Manager and how to use it from Forth.

FIG 1
$5614 ADDQ.L#2,SP  discard status  register
 MOVE.L (SP),A0  saved PC -> A0
 MOVE   (A0)+,D0 F-trap word ->D0
 MOVE.L A0,(SP)  updated PC ->     stack
 MOVE.L 0(A4,D0.W),D1get address of  trap routine              rel. to 
A4 -> D1
 JMP  0(A4,D1.L) jump to this routine relative                 to A4

FIG 2
$6E14 MOVE.L(SP)+,A1 put PC into A1  (points to OS             
 trap word to be executed)

 MOVE  (A1),$1858(A4)get trap word & 
 put into $1858(A4) =     $6E1C

 MOVE.L (SP)+,A0 OS parameter pointer -> A0

$6E1C AXXXTrap goes into  here. Yuck!  Self-                   modifying 
code!

 MOVE D0,A0 result code
 MOVE.L A0,38(A0,D7.L)  save in    IO-RESULT

 JMP  (A4)get next Forth  token and  ...                 execute

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Live Home 3D Pro 3.6.2 - $49.99
Live Home 3D Pro is powerful yet intuitive home design software that lets you build the house of your dreams right on your Mac, iPhone or iPad. It has every feature of Live Home 3D, plus some... Read more
RapidWeaver 8.2 - Create template-based...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Opera 60.0.3255.109 - High-performance W...
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
DEVONthink Pro 3.0beta2 - Knowledge base...
DEVONthink Pro is your essential assistant for today's world, where almost everything is digital. From shopping receipts to important research papers, your life often fills your hard drive in the... Read more
Tunnelblick 3.7.9 - GUI for OpenVPN.
Tunnelblick is a free, open source graphic user interface for OpenVPN on OS X. It provides easy control of OpenVPN client and/or server connections. It comes as a ready-to-use application with all... Read more
Carbon Copy Cloner 5.1.9 - 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
Dropbox 73.4.118 - Cloud backup and sync...
Dropbox is an application that creates a special Finder folder that automatically syncs online and between your computers. It allows you to both backup files and keeps them up-to-date between systems... Read more
Postbox 6.1.18 - Powerful and flexible e...
Postbox is a new email application that helps you organize your work life and get stuff done. It has all the elegance and simplicity of Apple Mail, but with more power and flexibility to manage even... Read more
Wireshark 3.0.2 - Network protocol analy...
Wireshark is one of the world's foremost network protocol analyzers, and is the standard in many parts of the industry. It is the continuation of a project that started in 1998. Hundreds of... Read more
BetterTouchTool 2.856 - Customize multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more

AFK Arena guide - Everything you need to...
Ok, so if you're like me, you've been playing (and sometimes waiting) your way through AFK Arena, only to learn there's a lot more to it than there appears on the surface. There's guilds, a PvP arena, and all sorts of other systems and game modes... | Read more »
Explore an epic fantasy world in MMORPG...
Webzen have just announced the official launch date for its stunning MMORPG ‘MU Origin 2’ which will arrive for iOS and Android on May 28th. It will be the second spinoff from the classic PC-based MU Online, and it looks to further refine the... | Read more »
Solar Explorer: New Dawn guide - Tips an...
Solar Explorer: New Dawn is a lunar lander game that really ratchets the intensity up to 11. With all of the asteroids flying around as you fly around at seemingly breakneck speeds, it can be easy to feel overwhelmed bythe whole thing. | Read more »
The Dalaran Heist - How Hearthstone...
I am someone who wrote Hearthstone off a while ago. It was hard not to try and stick with it. The game has incredible production values and a core of really great talent working on the game continuously to keep it feeling fresh and fun (full... | Read more »
Steam Link App - Everything You Need to...
Steam Link has finally released for iOS! That’s right, you can play your epic backlog of PC games on the go now. Well… sort of. While the Steam Link app was announced seemingly ages ago, it only got actual approval for release last night. Check out... | Read more »
Pre-register now for endless superhero r...
Talking Tom Hero Dash is set to take the ever-popular Talking Tom and Friends franchise in a brand new direction as it opens pre-registration to players worldwide. Not only does it promise to be a beautifully rendered, fast-paced, action-packed... | Read more »
AFK Arena - Guild Wars guide
Ok, so if you're like me, you've been playing (and sometimes waiting) your way through AFK Arena, only to learn there's a lot more to it than there appears on the surface. There's guilds, a PvP arena, and all sorts of other systems and game modes... | Read more »
Superhero-themed Talking Tom Hero Dash i...
One of the exciting releases that we’re looking forward to is Talking Tom Hero Dash, an upcoming superhero-themed runner created by Outfit7. This new game is an action-packed endless runner that takes you on an epic adventure to assemble the... | Read more »
Kingdom Rush Vengeance Update Guide 2 -...
Kingdom Rush: Vengeance just got updated once again to add more content to the game. This addition, called The Frozen Nightmare, adds three new levels, five new enemies, two new heroes, and some new achievements. | Read more »
Save the world with SCIENCE in the upcom...
Previous versions of space colonization game TerraGenesis encouraged you to explore the galaxy and settle its planets. The eagerly-awaited 5.0 update will try to smash them to bits. Yep, with a new "world killers" setting, you can unleash... | Read more »

Price Scanner via MacPrices.net

12″ 1.2GHz MacBooks on sale for $999, $300 of...
Amazon has current-generation 12″ 1.2GHz Retina MacBooks on sale for $300 off Apple’s MSRP. Shipping is free: 12″ 1.2GHz Space Gray MacBook: $999.99 $300 off MSRP 12″ 1.2GHz Silver MacBook: $999.99 $... Read more
Here’s how to save $200 on Apple’s new 8-Core...
Apple has released details of their Education discount associated with the new 2019 15″ 6-Core and 8-Core MacBook Pros. Take $200 off the price of the new 8-Core model (now $2599) and $150 off the 15... Read more
Price drops! 2018 15″ 2.2GHz 6-Core MacBook P...
Amazon has dropped prices on clearance 2018 15″ 2.2GHz 6-Core Touch Bar MacBook Pros by $300 with models now available for $2099. These are the same models sold by Apple in their retail and online... Read more
Apple drops prices on 2018 13″ 2.3GHz Quad-Co...
Apple has dropped prices on Certified Refurbished 2018 13″ 2.3GHz 4-Core Touch Bar MacBook Pros with prices now starting at $1489. Apple’s one-year warranty is included, shipping is free, and each... Read more
Apple drops prices on 2018 Certified Refurbis...
Apple has dropped prices on clearance 2018 15″ 6-Core Touch Bar MacBook Pro, Certified Refurbished, with models available starting at only $1999. Each model features a new outer case, shipping is... Read more
Price drops! Clearance 2018 13″ Quad Core Mac...
Amazon has dropped prices on 2018 13″ Apple Quad-Core MacBook Pros with models now available for $250 off original MSRP. Shipping is free. Select Amazon as the seller, rather than a third-party, to... Read more
How Much Is ‘Solace’ Of Mind Worth When Buyin...
COMMENTARY: 05.22.19- Smartphone cases give us peace of mind by providing ample protection for such a fragile gadget and the sky’s the limit as far as choices go with a plethora of brands, styles,... Read more
Get a 13″ Touch Bar MacBook Pro for the lowes...
Apple has Certified Refurbished 2017 13″ 3.1GHz Dual-Core i5 Touch Bar MacBook Pros available starting at $1439, ranging up to $390 off original MSRP. Each MacBook features a new outer case, shipping... Read more
Apple adds new 15″ 8-Core MacBook Pro to line...
Apple has added a new 15″ MacBook Pro to its lineup featuring a 9th generation 2.3GHz 8-Core Intel i9 processor, 16GB of RAM, a 512GB SSD, and a Radeon Pro 560X with 4GB of GDDR5 memory for $2799.... Read more
21″ 2.3GHz iMac available for $999 at B&H...
B&H Photo has the 2018 21″ 2.3GHz Apple iMac on sale for $100 off MSRP. This is the same model offering by Apple in their retail and online stores. Shipping is free: – 21″ 2.3GHz iMac (MMQA2LL/A... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**690427BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000860-Charlottesville-Store **Job Description:** **What Read more
*Apple* Mobile Master - Best Buy (United Sta...
**696430BR** **Job Title:** Apple Mobile Master **Job Category:** Store Associates **Location Number:** 001012-Bismarck-Store **Job Description:** **What does a Best Read more
Manager - *Apple* Team - SHI International...
…opportunity available in the Hardware & Advanced Solutions Department as the Manager of the Apple Team The Manager must be familiar with all aspects of Apple Read more
Best Buy *Apple* Computing Master - Best Bu...
**696375BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000203-North Austin-Store **Job Description:** **What does a Read more
Geek Squad *Apple* Master Consultation Agen...
**696286BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Job Category:** Services/Installation/Repair **Location Number:** 000172-Rivergate-Store Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.