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

BusyCal 3.7.2 - Powerful calendar app wi...
BusyCal is the powerful, flexible, reliable calendar app for macOS. It's packed with time-saving features and compatible with all leading cloud services including iCloud, Google, Exchange and more.... Read more
BusyContacts 1.4.2 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
iShowU Instant 1.3.0 - Full-featured scr...
iShowU Instant gives you real-time screen recording like you've never seen before! It is the fastest, most feature-filled real-time screen capture tool from shinywhitebox yet. All of the features you... Read more
Capo 3.8 - Slow down and learn to play y...
Capo lets you slow down your favorite songs so you can hear the notes and learn how they are played. With Capo, you can quickly tab out your songs atop a highly-detailed OpenCL-powered spectrogram... Read more
Viber 11.7.0 - 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
Drive Genius 5.3.1 - $79.00
Drive Genius features a comprehensive Malware Scan. Automate your malware protection. Protect your investment from any threat. The Malware Scan is part of the automated DrivePulse utility. DrivePulse... Read more
CorelDRAW 21.2.0.708 - Graphic design so...
CorelDRAW - professional graphic design software for vector illustration, layout, and so much more. Get started quickly and easily with a wealth of intuitive tools, built-in learning materials,... Read more
Navicat Premium Essentials 12.1.27 - Pro...
Navicat Premium Essentials is a compact version of Navicat which provides basic and necessary features you will need to perform simple administration on a database. It supports the latest features... Read more
OmniFocus 3.4.3 - GTD task manager with...
OmniFocus is an organizer app. It uses projects to organize tasks naturally, and then add tags to organize across projects. Easily enter tasks when you’re on the go, and process them when you have... Read more
Microsoft OneNote 16.30 - 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

Latest Forum Discussions

See All

Upcoming mobile MMO TeeTINY Online’s sec...
TeeTINY Online is an upcoming anime-themed MMO which boasts striking visuals and an ambitious open world to explore. Following a successful CBT (closed beta test) on Android, developer TEENY.studio has now released a follow-up test which adds an... | Read more »
Breakout: Dark Prison is a fast-paced ac...
Breakout: Dark Prison is an action RPG from LaterSoft. Set in the aftermath of a deadly virus outbreak your daughter has been taken from you because she has an immunity to the illness in her DNA. Not being a fan of experimentation on children –... | Read more »
Apple Arcade in review
This weekend, Apple Arcade will officially be one month old. That means anyone who signed up for the free trial on day one has a decision to make: Stick with the service and shell out $5 a month, or cancel and go about your merry way. | Read more »
Alluris is a choose-your-own adventure g...
Alluris is an RPG that the developer's are calling a swipe-your-own adventure game. This is because the game incorporates a Reigns-style - swiping left or right - selection mechanic to make all the decisions you'd usually expect to make across... | Read more »
Hello Hero All Stars receives update wit...
The first Hello Hero game hit global platforms in 2013 and proved a huge success, with developer Fincon adding two more entries to this popular series of casual RPG games since. Released in June this year, Hello Hero All Stars brings many of the... | Read more »
Zombieland: Double Tapper, a cartoon idl...
Zombieland: Double Tapper is the idle RPG tie-in to the upcoming Zombieland: Double Tap. Oddly, it's one of two different Zombieland games launching today, with the other being the Switch title Zombieland: Double Tap - Road Trip. [Read more] | Read more »
Rusty Lake's The White Door launche...
Rusty Lake and Second Maze's intriguing point-and-click adventure game, The White Door, is now up for pre-order on the App Store. This one sees you playing as Robert Hill, a mental health patient who is suffering from severe memory loss. The game... | Read more »
Hellrule is an auto-runner inspired by G...
Hellrule is an upcoming auto-runner game from independent developer Pedrocorp where players will take control of a dapperly dressed gentlemen who comes equipped with a razor-sharp umbrella for slicing up his foes. The game will be available for... | Read more »
Grobo is a gravity bending puzzle platfo...
Grobo is a 2D puzzle platformer that marks the first release from developers Hot Chocolate Games. You'll find yourself manipulating gravity as you make your through this title that's available now for iOS and Android. [Read more] | Read more »
Adrenaline, Compulsive Entertainment’s h...
Compulsive Entertainment’s high-octane arcade racer, Adrenaline, has now made its way to the App Store following a successful launch on Google Play. It’s a ton of challenging, fast-paced fun, boasting easy-to-learn controls and a varied selection... | Read more »

Price Scanner via MacPrices.net

11″ WiFi iPad Pros on sale today for up to $2...
Amazon has new 2018 Apple 11″ WiFi iPad Pros in stock today and on sale for up to $250 off Apple’s MSRP. These are the same iPad Pros sold by Apple in its retail and online stores. Be sure to select... Read more
Apple offers clearance 2018 15″ 6-Core MacBoo...
Apple has clearance 2018 15″ 6-Core Touch Bar MacBook Pros, Certified Refurbished, available starting at only $1999. Each model features a new outer case, shipping is free, and an Apple 1-year... Read more
Apple continues to offer refurbished 2019 21″...
Apple has Certified Refurbished 2019 21″ & 27″ iMacs available starting at $929 and up to $350 off the cost of new models. Apple’s one-year warranty is standard, shipping is free, and each iMac... Read more
Verizon offers free iPhone 7 for customers wh...
Verizon is offering a free 32GB iPhone 7 for new or existing customers who open a new line of service, no trade-in required. Cost of the phone is credited to your account monthly for 24 months. The... Read more
13″ 2.4GHz 4-Core MacBook Pros remain availab...
Apple has a full line of Certified Refurbished 2019 13″ 2.4GHz 4-Core Touch Bar MacBook Pros available starting at $1529 and up to $300 off MSRP. Apple’s one-year warranty is included, shipping is... Read more
Lease one iPhone Xs, Xr, or X at Sprint and g...
Purchase an Apple iPhone X, Xr, Xs, or Xs Max at Sprint, and get a 64GB iPhone Xr for free. Requires 2 new lines or 1 upgrade-eligible line and 1 new line. The fine print: “iPhone Xs (64 GB) $37.50/... Read more
How to use your Apple Education discount to s...
Purchase a new MacBook Pro or MacBook Air using Apple’s Education discount, and take up to $200 off MSRP. All teachers, students, and staff of any educational institution with a .edu email address... Read more
Base 2019 13″ 1.4GHz 4-Core MacBook Pro on sa...
Amazon has the new 2019 13″ 1.4GHz/128GB 4-Core Space Gray Touch Bar MacBook Pro on sale for $100 off Apple’s MSRP. This is the same MacBook Pro sold by Apple in its retail and online stores: – 2019... Read more
Save up to $30 on Apple’s AirPods at these re...
Amazon is offering discounts on new 2019 Apple AirPods ranging up to $30 off MSRP. Shipping is free: – AirPods with Charging Case: $144 $15 off MSRP – AirPods with Wireless Charging Case: $169 $30... Read more
Save $15 on Apple Watch Series 5 models on Wa...
Walmart has new Apple Watch Series 5 models on sale for $15 off Apple’s MSRP on their online store. Choose free shipping or free local store pickup (if available). Sale prices for online orders only... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**734688BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Location Number:** 000297-Reston-Store **Job Description:** The Core Read more
Best Buy *Apple* Computing Master - Best Bu...
**738529BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000258-Lewisville-Store **Job Description:** **What does a Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**741888BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Location Number:** 000870-N Scottsdale-Store **Job Description:** At Best Buy, Read more
*Apple* Mobile App Developer - eiWorkflow So...
…eiWorkflow Solutions, LLC is currently looking for a consultant for the following role. Apple Mobile App Developer Tasks the role will be performing: ? Mobile App Read more
Essbase Developer - *Apple* - Theorem, LLC...
Job Summary Apple is seeking an experienced, detail-minded Essbase developer to join our worldwide business development and strategy team. If you are someone who Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.