TweetFollow Us on Twitter

Call Register Routines
Volume Number:1
Issue Number:5
Column Tag:Undocumented procedure

Call register-based Toolbox/OS routines

By Steve Brecher

Macintosh Pascal provides a built-in procedure named Generic that is not documented. Generic permits you to call register-based Toolbox/OS routines. It can also be used to execute any machine language code that you have stored in a Pascal data structure. This article describes the use of the Generic procedure.

In effect, the following procedure is pre-declared:

procedure Generic(InstructionWord :integer;
                  VAR Registers : RegRcd);

“RegRcd” denotes a data structure consisting of 13 32-bit values -- five address register values (A0..A4), followed by eight data register values (D0..D7). The exact type of Registers is immaterial, i.e., you could declare:

var
 Registers : record
   A : array[0..4] of longint;
   D : array[0..7] of longint
  end;

Or in some cases you might prefer something like:

var
 Registers : record
   A0, A1, A2, A3, A4 : ^char;
   D0, D1, D2, D3, D4, D5, D6, D7 : longint
  end;

The register values that you pass to Generic are written to the MC68000 registers. Then the one-word instruction denoted by the InstructionWord argument is executed. Finally, your Registers structure is updated with the (possibly) new values of the MC68000 registers before Generic returns to your program.

Any registers that are not used by the machine language routine you’re invoking do not have to have their corresponding elements in the Registers data structure initialized. The machine language routine will have garbage in those registers (but, since it’s not using them, it won’t care).

Usually, Generic will be used to execute a register-based Toolbox/OS trap. In such cases the value you pass to Generic via the InstructionWord argument is the trap value. Here’s an example routine that resets the modem output port to establish new communications parameters:

type
  DataBitsT = (Five, Seven, Six, Eight);  
                               { ^--sic--^ }
  ParityT = (OddParity, NoParity, EvenParity);
  StopBitsT = (One, OnePointFive, Two);

 function ResetSer (Baud : longint;
         DataBits : DataBitsT;
         Parity : ParityT;
         StopBits : StopBitsT) : boolean;
{returns true if no error, false if modem}
{port hasn’t been opened yet}
{}
 const
   PBControl = $A004; {trap value}
   noErr = 0;
   ModemOutRefNum = -7;
   SerReset = 8;      {CScode}
{}
  var
   ParamBlockRec : record
     Filler : array[0..11] of integer;
     ioRefNum : integer;
     csCode : integer;
     csParam : integer
    end;
   Registers : record
     A : array[0..4] of longint;
     D : array[0..7] of longint
    end;
   serConfig : longint;
 begin {ResetSer}
  with ParamBlockRec do
   begin
    ioRefNum := ModemOutRefNum;
    csCode := SerReset;
    serConfig := trunc(114571.7 / baud -
                                              1.338395)
                 + 1024 * ord(DataBits)
                 + 4096 * (ord(Parity) + 1)
                 + 16384 * (ord(StopBits) + 1);
    csParam := loword(serConfig);
   end;
  Registers.A[0] := ord(@ParamBlockRec);
  Generic(PBControl, Registers);
  ResetSer := (Registers.D[0] = noErr)
 end; {ResetSer}

The InstructionWord argument to Generic does not have to be a trap value, however. It can be any 16-bit MC68000 instruction, as shown in the following example:

 procedure CallCode(VAR Result :integer);
{}
{This example assumes a global integer }
{array named Code which contains a       }
{machine language subroutine that takes}
{one VAR (address) argument on the       }
{stack.  CallCode calls the routine,        }
{passing it the address of the Result     }
{parameter. }
{}
 const
  JsrIndirectA0 = $4E90; { Jsr (A0) }
 var
  Registers : record
    A : array[0..4] of ^integer;
    D : array[0..7] of longint
   end;
  Glue : array[1..4] of integer;
 begin
{ MoveA.L (SP),A0 ;return addr }
  Glue[1] := $2057;
{ Move.L A2,(SP) ;ptr to Result }
  Glue[2] := $2E8A;
{ Move.L A0,-(SP) ;return addr }
  Glue[3] := $2F08;
{ Jmp (A1)        ;to subr in Code array }
  Glue[4] := $4ED1;
  with Registers do
   begin
    A[0] := @Glue[1];
    A[1] := @Code[1];
    A[2] := @Result;
   end;
  {Call Glue routine, which invokes Code}
  {routine...}
  Generic(JsrIndirectA0, Registers);
 end; {CallCode}

Scroll Rectangle Notes

(NOTE: did not appear with above article in MacTutor)

ScrollRect is a QuickDraw routine which scrolls a rectangle. Bits (pixels) scrolled out of the rectangle are lost, and the area near the side of the rectangle opposite to the scroll direction is filled with the current Grafport’s background pattern. [The rectangle defining the area to be scrolled must be larger than the screen object you wish to be moved by this procedure to allow room to be lost at the top.]

A Performance Note

ScrollRect will slow down by a factor of 3 or 4 if the scrolled rectangle includes one or more borders of the current Grafport’s portrect. For fast scrolling, assure that each side of the rectangle passed to ScrollRect is at least two pixels away from a border of the portrect.

A Usage Note

The UpdateRgn parameter (a region handle) passed to ScrollRect enables it to return to you the specification of the region that was vacated by scrolled bits and which ScrollRect filled with the background pattern. (Usually the vacated area will be a sub-rectangle of the scrolled rectangle; but it may be other than rectangular if an odd-shapped visRgn or clipRgn affects the ScrollRect.) The previous contents of the region (i.e., the data structure) are destroyed. If you don’t need to know the specification of the area filled with the background pattern (or if you already know), just allocate a dummy region (using NewRgn) and pass ScrollRect a handle to the dummy region. You can allocate the dummy region once at the beginning of your program; or you can allocate it before each call to ScrollRect and then use DisposRgn after each call to free the memory used by the region data structure.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Together 3.7 - Store and organize all of...
Together helps you organize your Mac, giving you the ability to store, edit and preview your files in a single clean, uncluttered interface. Features Smart storage. With simple drag-and-drop... Read more
EtreCheck 3.1.4 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
Postbox 5.0.9 - Powerful and flexible em...
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
DiskCatalogMaker 6.5.16 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast. Finder-like intuitive look and feel. Super-fast search algorithm. Can compress catalog data... Read more
TrailRunner 3.8.827 - Route planning for...
TrailRunner is the perfect companion for runners, bikers, hikers, and all people wandering under the sky. Plan routes on a geographical map. Import GPS or workout recordings and journalize your... Read more
VueScan 9.5.61 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Postbox 5.0.9 - Powerful and flexible em...
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
VueScan 9.5.61 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
DiskCatalogMaker 6.5.16 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast. Finder-like intuitive look and feel. Super-fast search algorithm. Can compress catalog data... Read more
TrailRunner 3.8.827 - Route planning for...
TrailRunner is the perfect companion for runners, bikers, hikers, and all people wandering under the sky. Plan routes on a geographical map. Import GPS or workout recordings and journalize your... Read more

Latest Forum Discussions

See All

Great zombie games in the spirit of Dead...
Dead Rising 4 arrives tomorrow, giving enthusiasts a fresh chance to take selfies with zombies and get up to other ridiculous end-of-the-world shenanigans. To really get into the spirit of things, we've gone and gathered the best zombie games that... | Read more »
Amateur Surgeon 4 Guide: Advanced tips a...
Amateur Surgeon 4 is still tackling the competition at the top of the App Store charts, so if you haven't tried it out yet, you should probably do that right away. If you've been at it for a while, though, perhaps you're ready to start expanding... | Read more »
Amateur Surgeon 4 Guide: Become the worl...
It's time to wield your trusty pizza cutter again, as Amateur Surgeon has returned with a whole fresh set of challenges (and some old, familiar ones, too). Starting anew isn't easy, especially when all you have at your disposal is a lighter, the... | Read more »
Le Parker: Sous Chef Extraordinaire (Ga...
Le Parker: Sous Chef Extraordinaire 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Telltale Games really is working on a Gu...
Telltale Games' next episodic adventure is indeed Guardians of the Galaxy. A document tied to the voice actors strike suggested that the project was in the work, but now we have direct confirmation following an announcement at the Game Awards that... | Read more »
Amateur Surgeon returns to iOS and Andro...
Amateur Surgeon and its two sequels disappeared from the App Store some time and it was sad days for all. But now, just in time for the holidays, the Adult Swim favorite makes its joyous return in the shape of Amateur Surgeon 4, a remake with... | Read more »
The best board games on mobile
Sometimes you need to ditch all of the high speed, high action games in favor of something a little more traditional. If you don't feel like parting ways from your mobile device, though, there are still plenty of ways to get that old-school fix.... | Read more »
The best Facebook Messenger Instant Game...
Facebook's new Instant Games is now here, meaning you can play games with your friends directly via Facebook. It's a fun new way to connect with friends, of course, but it's also proving to be a solid gaming experience in its own right, with a... | Read more »
You can now play game's on Facebook...
Facebook launched its new Instant Games platform in an exciting new attempt to engage its user base. As a result, you can now play a number of different games directly through Facebook Messenger. All of these games run with HTML5, meaning you play... | Read more »
Apollo Justice Ace Attorney (Games)
Apollo Justice Ace Attorney 1.00.00 Device: iOS Universal Category: Games Price: $.99, Version: 1.00.00 (iTunes) Description: Court Is Back In Session Star as rookie defense attorney, Apollo Justice, as he visits crime scenes,... | Read more »

Price Scanner via MacPrices.net

Monday roundup of Holiday Mac sales: Up to $3...
Take up to $300 off MSRP on the price of a new Apple Mac at B&H Photo today as part of their Holiday sale. Shipping is free, and B&H charges NY sales tax only. Touch Bar MacBook Pros are in... Read more
12-inch WiFi Apple iPad Pros on sale for up t...
B&H Photo has 12″ WiFi Apple iPad Pros on sale for up to $50 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 12″ Space Gray 32GB WiFi iPad Pro: $749 $50 off MSRP... Read more
9-inch Apple WiFi iPad Pros on sale for $20-$...
B&H Photo has 9.7″ Apple WiFi iPad Pros on sale for $20-$50 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 9″ Space Gray 256GB WiFi iPad Pro: $779.95 $20 off MSRP... Read more
Holiday sale: Apple MacBook Airs available fo...
B&H Photo has 13″ MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/128GB MacBook Air (MMGF2LL/A): $899 $100 off MSRP - 13″ 1.6GHz/... Read more
13-inch Silver Touch Bar MacBook Pro in stock...
Amazon has the new 2016 13″ 2.9GHz/256GB Silver Touch Bar MacBook Pro (MLVP2LL/A) in stock today and on sale for $1749 including free shipping. That’s $50 off MSRP, and it’s the lowest price... Read more
Parallels Toolbox 1.3 for Mac Offers 25 Singl...
Parallels has launched Parallels Toolbox 1.3 for Mac, an upgrade that adds five new utilities to the stand-alone application which was released in August and is available exclusively online at http... Read more
OWC Mercury Elite Pro Dual mini Ultra-Portabl...
OWC has introduced the new OWC Mercury Elite Pro Dual mini, a powerful yet ultra-portable dual-drive RAID solution. The new Mercury Elite Pro Dual mini packs phenomenal performance into a small... Read more
Clearance 13-inch Retina MacBook Pros availab...
B&H Photo has clearance 2015 13″ Retina Apple MacBook Pros available for up to $200 off original MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $... Read more
Roundup of 2016 13-inch 2.0GHz MacBook Pro sa...
B&H has the non-Touch Bar 13″ MacBook Pros in stock today for $50-$100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz MacBook Pro Space Gray (MLL42LL/A): $1449 $... Read more
New 13-inch 2.0GHz Space Gray MacBook Pro in...
Adorama has the new 13″ 2.0GHz Space Gray MacBook Pro (non-Touch Bar, MLL42LL/A) in stock for $1499 including a free 3-year AppleCare Protection Plan. Shipping is free, and Adorama charges sales tax... Read more

Jobs Board

Lead *Apple* Solutions Consultant - Apple (...
# Lead Apple Solutions Consultant Job Number: 53586123 Pittsburgh, Pennsylvania, United States Posted: Nov. 28, 2016 Weekly Hours: 40.00 **Job Summary** The Lead ASC Read more
*Apple* Retail - Multiple Positions- Plano,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions- Kansas...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions- Chicago...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Hardware Design Validation Engineer - *Apple...
The Apple Watch team is looking for a Hardware Design Validation Engineer. This person will be part of the Apple Watch hardware team with responsibilities for Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.