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

Apple Security Update 2015-001 - For OS...
Apple Security Update 2015-001 is recommended for all users and improves the security of OS X. For detailed information about the security content of this update, please visit: http://support.apple.... Read more
Drive Genius 4.0.1 - Powerful system uti...
Drive Genius 4 gives you faster performance from your Mac while also protecting it. The award-winning and improved DrivePulse feature alerts you to hard drive issues before they become major problems... Read more
OS X Yosemite 10.10.2 - Apple's lat...
OS X Yosemite is Apple's newest operating system for Mac. An elegant design that feels entirely fresh, yet inherently familiar. The apps you use every day, enhanced with new features. And a... Read more
Apple iOS 8.1.3 - The latest version of...
The latest version of iOS can be downloaded through iTunes. Apple iOS 8 comes with big updates to apps you use every day, like Messages and Photos. A whole new way to share content with your family.... Read more
SpamSieve 2.9.19 - Robust spam filter fo...
SpamSieve is a robust spam filter for major email clients that uses powerful Bayesian spam filtering. SpamSieve understands what your spam looks like in order to block it all, but also learns what... Read more
RapidWeaver 6.0.5 - Create template-base...
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
Duet 1.2.2 - Use your iPad as an externa...
Duet is the first app that allows you to use your iDevice as an extra display for your Mac using the Lightning or 30-pin cable. Note: This app requires a $14.99 iOS companion app. Version 1.2.2:... Read more
Alfred 2.6 - Quick launcher for apps and...
Alfred is an award-winning productivity application for OS X. Alfred saves you time when you search for files online or on your Mac. Be more productive with hotkeys, keywords, and file actions at... Read more
1Password 5.1 - Powerful password manage...
1Password is a password manager that uniquely brings you both security and convenience. It is the only program that provides anti-phishing protection and goes beyond password management by adding Web... Read more
GarageSale 6.9.2 - Create outstanding eB...
GarageSale is a slick, full-featured client application for the eBay online auction system. Create and manage your auctions with ease. With GarageSale, you can create, edit, track, and manage... Read more

Storm & Skye – Magical Adventure Sto...
Storm & Skye – Magical Adventure Story For Kids Review By Amy Solomon on January 28th, 2015 Our Rating: iPhone App - Designed for the iPhone, compatible with the iPad The first book in the Storm & Skye series includes... | Read more »
New WOTA: U-Boat Compass ‘Wets’ Your App...
New WOTA: U-Boat Compass ‘Wets’ Your Appetite for WOTA: Wolves of the Atlantic. Posted by Jessica Fisher on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Warship Solitaire Review
Warship Solitaire Review By Nadia Oxford on January 27th, 2015 Our Rating: :: A WAR OF NUMBERSUniversal App - Designed for iPhone and iPad Warship Solitaire might lack frills and looks, but it offers some thought provoking... | Read more »
Keep Track of Your Hectic Work Schedule...
Keep Track of Your Hectic Work Schedule With Shifts Posted by Jessica Fisher on January 27th, 2015 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
All Star Quarterback Review
All Star Quarterback Review By Campbell Bird on January 27th, 2015 Our Rating: :: PLAY YOUR PARTUniversal App - Designed for iPhone and iPad Train your way to the Super Bowl in this free-to-play sports management game.   | Read more »
Sentinel 4: Dark Star Adds New Campaign...
Sentinel 4: Dark Star Adds New Campaign and More Posted by Ellis Spice on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Wheel & Deal Review
Wheel & Deal Review By Tre Lawrence on January 27th, 2015 Our Rating: :: SIMPLE FUNUniversal App - Designed for iPhone and iPad A simple arcade shooter that has a retro feel.   | Read more »
Join the NAVY in a Big New Update for WW...
Join the NAVY in a Big New Update for WW2: Sandbox. Strategy & Tactics Posted by Jessica Fisher on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Earthworm Alchemy Review
Earthworm Alchemy Review By Campbell Bird on January 27th, 2015 Our Rating: :: FEED THE WORMUniversal App - Designed for iPhone and iPad Feed this funny looking worm and dodge bombs in this charming, free-to-play arcade game.   | Read more »
Graphic Novel App netwars – The Butterfl...
Graphic Novel App netwars – The Butterfly Attack has Received Some New Episodes Posted by Jessica Fisher on January 27th, 2015 [ permalink ] | Read more »

Price Scanner via MacPrices.net

iPad Turns Five – The ”Book Mystique
Five years ago this week, the late Steve Jobs took the stage at an Apple special press event to unveil the first Apple iPad — a slab-shaped, hand-holdable device that was to shake the personal... Read more
Sale! 15-inch Retina MacBook Pros for up to $...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for $150 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1889.99... Read more
Apple refurbished Mac minis for up to $150 of...
The Apple Store has restocked Apple Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz... Read more
Apple Releases New Tranche Of OS Updates For...
Apple has released incremental bugfix and security updates for its most recent Mac and iOS versions. OS X Yosemite 10.10.2 Update Apple says this update includes the following improvements: Resolves... Read more
Samsung To Be Main Supplier Of A9 Chips For i...
Korea’s Maeil Business Newspaper reports that Samsung has beat out its chipmaking rivals, Taiwan’s Qualcomm and TSMC, as supplier of chipsets for the next generations of both its own Galaxy S6 and... Read more
Save up to $340 on iMacs with Apple Certified...
The Apple Store has Apple Certified Refurbished iMacs available for up to $340 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
AppleCare Protection Plans on sale for up to...
B&H Photo has 3-Year AppleCare Warranties on sale for up to $105 off MSRP including free shipping plus NY sales tax only: - Mac Laptops 15″ and Above: $244 $105 off MSRP - Mac Laptops 13″ and... Read more
Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
3TB AirPort Time Capsule on sale for $349, $5...
B&H Photo has 3TB AirPort Time Capsules on sale for $349 including free shipping plus NY sales tax only. Their price is $50 off MSRP, and it’s the lowest price available for this model (except... Read more
16GB iPad Air 2 on sale for $446, save $53
Walmart has 16GB WiFi iPad Air 2s on sale for $53 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Sale prices available for online orders only, in-... Read more

Jobs Board

*Apple* Solutions Consultant - Retail Sales...
As an ambassador of the Apple brand, the ASC is accountable for driving sales performance by: Connecting with customers. Discovering customers' needs and values. Showing Read more
*Apple* Tree Children's Center is hirin...
Apple Tree Learning Center is Hiring Preschool Teachers! Phoenix Childrens Academy is a national leader in the early childhood education industry and we are currently Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Solutions Consultant - Retail Sales...
As an ambassador of the Apple brand, the ASC is accountable for driving sales performance by: Connecting with customers. Discovering customers' needs and values. Showing Read more
*Apple* Solutions Consultant- Retail Sales -...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Resellers store. The ASCs role is to grow Apple product Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.