TweetFollow Us on Twitter

DA Prototype
Volume Number:2
Issue Number:1
Column Tag:Pascal Procedures

Prototyping Desk Accessories

By Alan Wootton, President, Top-Notch Productions, MacTutor Contributing Editor

This month I will try to provide an interesting explanation of how to program Desk Accessories. Rather than simply attempting to explain the purpose and function of each of the three main procedures used by DA's (which has, after all, been done), we will try an entirely different approach. We will start with a simple DA, and take for granted the fact that it works. We will then type this DA's code into MacPascal and attempt to get it to run. In the process we will learn a lot about DA's, and when it is all done we will have a useful tool for prototyping Desk Accessories.

Perhaps at this point you are wondering "What do you mean, type it in and get it to run?" We can't make the system call a MacPascal procedure the same way it calls compiled 68000 procedures, so we will write a program that attempts to duplicate the actions of the system and its relationship with DA's. [ A desk accessory simulator! -Ed.]

To start with let's take a look at the DA we will be using as a subject. Its' code is listed below. Look at it briefly and then continue reading the text that follows.

The Simple DA We Will Be Using

 procedure UpdateSelf (var device : deviceControlRec);
    with device do
 MoveTo(10, 30);
 DrawString('This is a test DA');
 end;{ of with }
 end;{ of UpdateSelf }

 procedure Open (var device : deviceControlRec;
                                           var block : ParamBlockRec);
  R : Rect;
  wP : windowPeek;
     with device do
      setrect(R, 128, 128, 256, 256);
      dctlWindow := 
                  NewWindow(nil, R, 'Test DA', true, 0, nil, true, 0);
      wP := pointer(ord(dctlWindow));
      wP^.windowKind := dctlRefNum;
  end;{ of with }
 end;{ of open }

procedure  Close (var device : deviceControlRec;
                                            var block : ParamBlockRec);
     with device do
      dctlWindow := nil;
  end;{ of with }
 end;{ of close }

 procedure Event (var device : deviceControlRec;
                                        var block : ParamBlockRec);
         EventP : ^EventRecord;
    {  csParam holds a pointer to the event record }
    {  copy it to EventP }
     BlockMove(@block.csParam[0], @EventP, 4);
     with EventP^ do{ eventRecord    }
      case what of
  1 :           { mdown event }
  6 :            { update event }
      ;       { ignore all other events }
      end;{ case of what }
  end;{ with }
 end;{ procedure event }

 procedure Ctl (var device : deviceControlRec;
                                      var block : ParamBlockRec);
  poi : point;
     with block do
      case csCode of
  64 :        { accEvent }
      Event(device, block);
     {        other codes (accRun, accCursor, accMenu,  
                          accCut, etc.) }
     {        are not used by this DA          }
      end;{ case of code }
  end;{ of with block }
 end;{ of Ctl  }

The first thing to notice about this DA is that it does practically nothing. The Open procedure creates a window, the Ctl procedure only handles calls of type accEvent (which are passed to the procedure event). The only events handled are Update, which draws a string, and MouseDown which merely beeps. Finally, the Close procedure Disposes the window. That's all it does. The next thing to notice is that there are some data types referenced that MacPascal does not recognize. Scanning through the code we encounter a DeviceControlRec, and then the ParamBlockRec. Further examination reveals the type WindowPeek which is used once in the Open procedure. We will deal with these three types in a moment. The final thing is the toolbox calls used by the DA. We will declare equivalent procedures to these and use "inline" to make the actual calls. It will be very straightforward with one minor twist.

Now let's get back to the type declarations. DeviceControlRec is not found anywhere in Inside Macintosh! As it turns out, if you read the portion of the Desk Manager on "writing your own Desk Accessories" it will mention the three driver routines used and then refer you to the Device Manager for further details. In the Device Manager chapter they mention that all driver routines recieve a pointer to the calls parameter block in A0 (there's the ParamBlockRec), and a pointer to the "Device Control Entry" in A1. On page 21, titled "A Device Control Entry" we find the description of what must be the DeviceControlRec. The description is not a Pascal type declaration but we can easily convert it into one. The only fields accessed by the simple DA are the dctlRefNum, and dctlWindow. DctlRefNum is the reference number of the driver (related to the number of the DA), and dctlWindow is a place to put a pointer to the window the DA uses. Once you become familiar with DA's the use of the other fields is easily found.

The declaration of a ParamBlockRec is found in that same chapter. If we read the DA carefully we see that csCode and csParam are the only parts referenced, so we won't type all four of the variant parts, only what is needed. CsParam is declared as array[0..0] of Byte which seems real stupid and dangerous to me so I changed it to array[0..3] of Byte. In the DA csParam is used only as a pointer to an event record. It would be convenient to change the definition of csParam to ^EventRecord, but let's stay with the standard form. IM assumes that all DA's (and all drivers) are written in assembly language. In assembly you can use csParam any way you wish. In Pascal the type checking gets in the way, so I have adopted the habit of useing BlockMove to copy things into an out of csParam.

To find the definition of WindowPeek we look, naturally, in the Window Manager chapter of IM. To use this definition we must also provide declarations for a Handle, and for a StringHandle. As I mentioned in previous articles, MacPascal allocates 2 bytes for boolean types while Lisa Pascal allocates 1 byte (1 is correct). We take this into account in the declaration.

We are now ready to do the Type declarations, so here they are:

Type Declarations for the Sample DA

    Lptr = ^longint;
    ptr = ^integer;
    Handle = ^ptr;
    Byte = 0..255;
    str255P = ^str255;
    stringHandle = ^str255;

  ParamBlockRec = record
      qLink : Ptr;
      qType : integer;
      ioTrap : integer;
      ioCmdAddr : ptr;
      ioCompletion : ptr;
      ioResult : integer;
      ioNamePtr : ^str255;
      ioVrefNum : integer;
      { Usually there are three variant parts here also. }
      { DA's use only csCode and csParam. }
      csCode : integer;
      csParam : array[0..3] of Byte;

  ParamBlkPtr = ^ParamBlockRec;

  WindowPtr = GrafPtr;
  WindowPeek = ^WindowRecord;

  WindowRecord = record
       port : GrafPort;
       windowKind : Integer;
       visible : Boolean;
       {hilited : Boolean; }
       goAwayFlag : Boolean;
       {spareFlag : Boolean; }
       strucRgn : RgnHandle;
       contRgn : RgnHandle;
       updateRgn : RgnHandle;
       windowDefProc : Handle;
       dataHandle : Handle;
       titleHandle : StringHandle;
       titleWidth : Integer;
       ControlList : Handle;
       nextWindow : WindowPeek;
       windowPic : PicHandle;
       refCon : LongInt;

  DeviceControlRec = record
       dCltDriver : Handle;
       DcltFlags : integer;
       dctlQueue : integer;
       DctlQHead : Lptr;
       DctlQtail : Lptr;
       DctlPosition : longint;
       DctlStorage : Handle;
       dCtlRefNum : integer;
       dCtlCurTicks : longint;
       dCtlWindow : GrafPtr;
       dCtlDelay : integer;
       dCtlEmask : integer;
       dCtlMenu : integer;

Now let's attack the issue of the toolbox calls. We will make procedure declarations for the needed routines, and use inline in those declarations. This method is clearer than using inline directly in the code. In the main procedure we will use inline directly (for brevity). The NewWindow function is going to allocate a window record on the heap, and MacPascal reacts very poorly to this (you get an out of memory error). To alleviate this problem we pass a pointer to a window record to NewWindow. We must remember later, when we are constructing the main procedure of our program, to declare a variable named GlobalWindow as a WindowRecord. The ToolBox interface is therefore:

ToolBox Interface routines

{--- Toolbox routines used by  DA -----------------------}
{ NewWindow used by Open. }
{ Uses GlobalWindow variable for WindowRecord instead of  }
{ letting the system allocate the memory automatically. }

 function NewWindow (wStorage : ptr;
       boundsRect : Rect;
                        title : str255;
      visible : boolean;
                  procID : integer;
      behind : windowPtr;
       goAwayFlag : boolean;
                   refcon : longint) : WindowPtr;
    NewWindow := pointer(LinlineF($A913, @GlobalWindow,
                                 @boundsRect, @title, visible, procID,
   behind, goAwayFlag, refcon));
 procedure BeginUpdate (TheWindow : WindowPtr);
      inlineP($A922, TheWindow);
 procedure EndUpdate (TheWindow : WindowPtr);
      inlineP($A923, TheWindow);
 procedure DisposeWindow (TheWindow : WindowPtr);
      inlineP($A914, TheWindow);

At this point all we have is enough declarations to survive a command-K check without getting a bug box. We still don't have the DA doing anything. The routines to operate the DA will all be contained in the main procedure, and all their variables will be declared as global. You will find the program at the end of this article. Now we will step-step through the system simulation that will run the sample DA.

If you follow along in the code you'll see that the first command is to remove the menu hilite created by the Go command. We then set the dctlRefNum as if the system were opening the DA and that were its driver reference number. What the DA will do is set the WindowKind field of the DA's window to this number. Actually, if the WindowKind of any window is negative the Window Manager will not treat it normally. It therefore becomes necessary to cheat a little and use a positive number for dctlRefNum. Note that the same applies to the Menu Manager. Our sample DA does not use a menu, but if it did we would have to make that menu's id number positive or it would not be treated normally (Normally for an application menu that is. In a real DA we want the system to treat the menu differently.)

We then call Open, passing along the two records. Block is still not set to any values, but Open does not look for any so it doesn't matter. Open sets dctlWindow to the WindowPtr of the newly created window. Note that Open makes the new window in the back, and that immediately after the Open call the system calls SelectWindow and then ShowWindow. I know this is right because I have traced the code of the trap _OpenDeskAcc.

Now that the DA is Open, it can respond to Ctl (control) calls. When the system actually makes these calls they are of the form err:=PBControl(@Block,false), in other words, a normal device manager driver call. In a Pascal DA there is a header that converts the register based call into a procedure call. We will simply call Ctl directly. One type of control call that all DA's should respond to is those to cut and paste. Our sample DA doesn't, but we will include this in the simulation. To do this we will need a menu, like the Edit menu in an application, to generate the cut and paste commands. This is the purpose of the NewMenu call after Open.

At this point we enter an event loop. The variable "quit" is set to false and we will loop until it is true. The first thing the larger event loop does is enter a smaller loop that waits for an event to occur. There are two types of control call that DA's can receive that are not connected with an event. These are to set the cursor and perform a periodic action. We will not concern ourselves with the timing of the periodic action, or when the DA should set the cursor. Instead we will just make Ctl calls of these two types until an event occurs. Seehow easy it is to make a Ctl call: simply set the csCode and call Ctl.

Once an event occurs it is the system's job to decide if the event should go to a DA or somewhere else. We will go ahead and set up Block for an accEvent call and change it later if needed. In general a DA receives only update events unless it is the front window, in which case it gets almost all of the events. Rather than checking that now, we'll case out the event and check each event on an indivual basis to see which window should receive it. A good example is the first case, KeyDown. If the DA is in front then we make a Ctl call (already set up as type accEvent). Otherwise we do nothing, as the dormant MacPascal windows won't receive events.

The next case is that of a MouseDown. For a mouse click we'll need another case statement to handle the various places the click could have landed. FindWindow will return a code that indicates where, and in which windoow, the click occured. No matter where the click was, if it was in a window, then that window should be in front. So, we call SelectWindow. The variable "fnd'' is an integer that holds the code returned by FindWindow. We will handle the possibilities one at a time, and in numerical order. To understand the action of FindWindow better, consult the Window Manager chapter of Inside Mac.

If the MouseDown was in the menu bar then we should call the Menu Manager function MenuSelect to find which menu item the user wants to choose. MenuSelect returns a Longint with different information in the upper and lower words. If the HiWord is equal to dctlMenu then the user has chosen the DA's menu; csCode is set to accMenu, and csParam is set to the MenuSelect result. Note that the application handles the menu events, not the DA. By the time the DA finds out about it the menu has already been clicked, dragged, and released (MenuSelect does this). The DA uses the Longint MenuSelect result to determine what happened. If the HiWord from MenuSelect is not dctlMenu then it could be the Edit menu (a DA is not concerned with the others). I have arranged the menu put up earlier so that if we add 67 to the number of the menu item chosen it conveniently becomes the correct csCode for editing. We make a Ctl call accordingly.

If the MouseDown was not in the menu bar, but was in a window, then several possibilities remain. If the click was in the content portion of the window then it is that window's responsibility to handle it. Normally these clicks are returned to the application. But, if the WindowKind is negative, then the Window Manager will assume that that window belongs to a DA and make a control call. We do similarly. I found out about this the hard way. If the DA forgets to set WindowKind in Open then the window shows up but is strangely dead - this is most perplexing until you figure it out.

If the click is in the drag bar of a DA window the system will drag the window. The DA never even knows what has happened. Also, if the click is in the close box then the system calls TrackGoAway and then Close. The DA finds out this has happened whne it gets a Close call, it must then close itself. In the simulation we set "quit" and then call Close after exiting the main event loop.

We are done covering the MouseDown possibilities. All that remains are the rest of the event cases. For Update and Activate events a pointer to the window involved is in the message field of the event record. We check it, and make a Ctl call, if necessary. I am not sure how the system handles all the other event possibilities, so I pass them to the DA just in case.

This covers all the functions of the DA Prototyping Program. I have used this program, or one of its cousins, to develop several different DA's, including the one presented in this column in November '85. I think that it is a very useful tool, and I hope you find it useful, too.

DA Prototyping Program
program Run_A_DA;

{ Put type declarations here }

 var { Variables for main simulation of system. }
     {  NOT for use by the DA }
     device : DeviceControlRec;{ passed to DA }
     block : ParamBlockRec;{ passed to DA }
     sysEv : eventRecord;
     sysMenu : MenuHandle;
     poi : point;
     wPeek : WindowPeek;
     r : rect;
     fnd : integer;
     quit : boolean;
     lll : longint;
     GlobalWindow : WindowRecord;
{ Put ToolBox interface routines here }

{ Put sample DA code here }

{** Everything below this line is the simulation of the ****}
{** system running the DA and should not be changed **}
begin { of main simulation of system handling desk acc. }
  { Desk Accessory simulation by Alan Wootton 11/11/85 }
   inlineP($A938, 0);{ HiliteMenu(0); remove Run hilite }
   device.dctlRefNum := -1 * (16 + 1);{ make this DA #16  }
  { Actually there is a problem with using negative numbers }
  { like a real DA would, so we change it to a positive number. }
   device.dctlRefNum := -device.dctlRefNum;
  { If the DA has owned Resources it may have trouble finding
     them. }
   Open(device, block);{ Open the DA }
   inlineP($A91F, device.dctlWindow);{ SelectWindow }
   inlineP($A915, device.dctlWindow);{ ShowWindow }
  { Make a menu to simulate the applications Edit menu. }
   sysMenu := Pointer(LinlineF($A931, 13, 'sysEDIT'));
   inlineP($A933, sysMenu, 'undo');{AppendMenu}
   inlineP($A933, sysMenu, '??');{AppendMenu}
   inlineP($A933, sysMenu, 'cut');{AppendMenu}
   inlineP($A933, sysMenu, 'copy');{AppendMenu}
   inlineP($A933, sysMenu, 'paste');{AppendMenu}
   inlineP($A933, sysMenu, 'clear');{AppendMenu}
   inlineP($A935, sysMenu, 0);{ InsertMenu }
   quit := false;

   repeat { until quit }
 repeat { accRun and accCursor until an event occurs  }
            { actually these shouldn't happen all the time like 
                         they do here }
 block.cscode := 65; { accRun }
 Ctl(device, block);{ Device Manager Control call }
 block.cscode := 66; { accCursor }
 Ctl(device, block);{ Device Manager Control call }
 until getnextevent(-1, SysEv);
     { set up block to make a control call of type accEvent }
 block.cscode := 64;
 lll := ord(@SysEv);
 BlockMove(@lll, @Block.csParam[0], 4);
 case SysEv.what of
     3, 5 :       {  key, or key repeat event  }
           if (LinlineF($A924)=ord(device.dctlWindow)) then
         {   if  FrontWindow = device.dctlWindow then }
      Ctl(device, block);
     1 :      { if mousedown event }
  poi := SysEv.where;
  fnd := winlineF($A92C, poi, @wPeek);
  { Findwindow( poi, wPeek) }
  if fnd > 0 then { if not on desktop }
 if fnd > 1 then
      inlineP($A91F, wPeek);{ SelectWindow }
 case fnd of
     1 :      {  mouse down is in MenuBar }
  lll := LinlineF($A93D, poi);
 {  lll:=MenuSelect(poi) }
  if hiword(lll) = device.dctlMenu then
 { if dctlMenu selected then make accMenu call }
  block.csCode := 67;
                { 67 is accMenu }
                  @Block.csParam[0], 4);
  Ctl(device, block);
  if Hiword(lll) = 13 then
 { Applications Edit menu? }
          {  if mouse down in app.'s Edit}
          { then make accUndo..accClear} 
          { call }
              Block.csCode := 
 loword(lll) + 67;
  Ctl(device, block);
        inlineP($A938, 0);{ HiliteMenu(0 }
     3, 5 : { if in content or grow part of window}
 if (wPeek^.windowKind = 
 device.dctlRefNum) then
       Ctl(device, block);
     4 :{ if in drag bar then drag window, }
          { no control call }

   setrect(r, -999, -999, 999, 999);
   inlineP($A925, wPeek, poi, r);
 { DragWindow }
     6 :  
 { if in GoAway box of DA window then make close call }

        if winlineF($A91E, wPeek, poi) > 0 then 
 { if TrackGoAway  then }
    if (wPeek^.windowKind = 
           device.dctlRefNum) then
        quit := true;
    { make close call later and end simulation }
 end{ case of  fnd }
     end;{ of if fnd>0 }
      end;{ case  mousedown }
     6, 8 :    {  if  update, or activate event then make      accEvent 
control call  }
  if sysev.message = 
                         ord(device.dctlWindow) then
       Ctl(device, block);
           Ctl(device, block);{ send other events to acc ??? }
    end;{ of case of event.what }
       end{ of repeat }
   until quit;
   Close(device, block);
    { Application ( or system ) calls CloseDeskAcc }
end.{  of program, and of article, see 'ya next month}

Only MacTutor brings you quality programming information month after month. Subscribe now!


Community Search:
MacTech Search:

Software Updates via MacUpdate

The best GIF making apps
Animated GIFs have exploded in popularity recently which is likely thanks to a combination of Tumblr, our shorter attention spans, and the simple fact they’re a lot of fun. [Read more] | Read more »
The best remote desktop apps for iOS
We've been sifting through the App Store to find the best ways to do computer tasks on a tablet. That gave us a thought - what if we could just do computer tasks from our tablets? Here's a list of the best remote desktop apps to help you use your... | Read more »
Warhammer 40,000: Freeblade guide - How...
Warhammer 40,000: Freebladejust launched in the App Store and it lets you live your childhood dream of blowing up and slashing a bunch of enemies as a massive, hulking Space Marine. It's not easy being a Space Marine though - and particularly if... | Read more »
Gopogo guide - How to bounce like the be...
Nitrome just launched a new game and, as to be expected, it's a lot of addictive fun. It's called Gopogo, and it challenges you to hoparound a bunch of platforms, avoiding enemies and picking up shiny stuff. It's not easy though - just like the... | Read more »
Sago Mini Superhero (Education)
Sago Mini Superhero 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: KAPOW! Jack the rabbit bursts into the sky as the Sago Mini Superhero! Fly with Jack as he lifts impossible weights,... | Read more »
Star Wars: Galaxy of Heroes guide - How...
Star Wars: Galaxy of Heroes is all about collecting heroes, powering them up, and using them together to defeat your foes. It's pretty straightforward stuff for the most part, but increasing your characters' stats can be a bit confusing because it... | Read more »
The best cooking apps (just in time for...
It’s that time of year again, where you’ll be gathering around the dinner table with your family and a huge feast in front of you. [Read more] | Read more »
Square Rave guide - How to grab those te...
Square Rave is an awesome little music-oriented puzzle game that smacks of games like Lumines, but with its own unique sense of gameplay. To help wrap your head around the game, keep the following tips and tricks in mind. [Read more] | Read more »
Snowboard Party 2 (Games)
Snowboard Party 2 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Crowned the best snowboarding game available on the market, Snowboard Party is back to fulfill all your adrenaline needs in... | Read more »
One Button Travel (Games)
One Button Travel 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: “To cut a long story short, If you like interactive fiction, just go buy this one.” - “Oozes the polish that... | Read more »

Price Scanner via

Holiday weekend Mac sales roundup: B&H Ph...
B&H Photo continues to have all new Macs on sale for up to $500 off MSRP as part of their Black Friday/Holiday weekend sale. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina... Read more
iMobie Releases its Ace iOS Cleaner PhoneClea...
iMobie Inc. has announced the new update of PhoneClean 4, its iOS cleaner designed to reclaim wasted space on iPhone/iPad for use and keep the device fast. Alongside, iMobie hosts a 3-day giveaway of... Read more
U.S. Cellular Offering iPad Pro
U.S. Cellular today announced that it is offering the new iPad Pro with Wi-Fi + Cellular, featuring a 12.9-inch Retina display with 5.6 million pixels — the most ever in an iOS device. U.S. Cellular... Read more
Newegg Canada Unveils Black Friday Deals for...
Newegg Canada is offering more than 1,000 deep discounts to Canadian customers this Black Friday, available now through Cyber Monday, with new deals posted throughout the week. “Black Friday is... Read more
Black Friday: Macs on sale for up to $500 off...
BLACK FRIDAY B&H Photo has all new Macs on sale for up to $500 off MSRP as part of their early Black Friday sale including free shipping plus NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $... Read more
Black Friday: Up to $125 off iPad Air 2s at B...
BLACK FRIDAY Walmart has the 16GB iPad Air 2 WiFi on sale for $100 off MSRP on their online store. Choose free shipping or free local store pickup (if available): - 16GB iPad Air 2 WiFi: $399, save $... Read more
Black Friday: iPad mini 4s on sale for $100 o...
BLACK FRIDAY Best Buy has iPad mini 4s on sale for $100 off MSRP on their online store for Black Friday. Choose free shipping or free local store pickup (if available): - 16GB iPad mini 4 WiFi: $299.... Read more
Black Friday: Apple Watch for up to $100 off...
BLACK FRIDAY Apple resellers are offering discounts and bundles with the purchase of an Apple Watch this Black Friday. Below is a roundup of the deals being offered by authorized Watch resellers:... Read more
Black Friday: Target offers 6th Generation iP...
BLACK FRIDAY Save $40 to $60 on a 6th generation iPod touch at Target with free shipping or free local store pickup (if available). Sale prices for online orders only, in-store prices may vary: -... Read more
Black Friday: Walmart and Target offer iPod n...
BLACK FRIDAY Walmart has the 16GB iPod nano (various colors) on sale for $119.20 on their online store for a limited time. That’s $30 off MSRP. Choose free shipping or free local store pickup (if... Read more

Jobs Board

*Apple* Site Security Manager - Apple (Unite...
# Apple Site Security Manager Job Number: 42975010 Culver City, Califo ia, United States Posted: Oct. 2, 2015 Weekly Hours: 40.00 **Job Summary** The Apple Site Read more
WiSE *Apple* Pay Quality Engineer - Apple (...
# WiSE Apple Pay Quality Engineer Job Number: 44313381 Santa Clara Valley, Califo ia, United States Posted: Nov. 13, 2015 Weekly Hours: 40.00 **Job Summary** Join our Read more
Holiday Retail Associate with *Apple* Knowl...
…and assertive.Someone who can troubleshoot iOS devices (iPhone and iPad) and Apple Mail issues.Someone who can offer solutions.Someone who can work weekends.Someone with Read more
*Apple* Systems Engineer (Mclean, VA and NYC...
Summary:Assist in providing strategic direction and technical leadership within the Apple portfolio, including desktops, laptops, and printing environment. This person Read more
Simply Mac *Apple* Specialist- Service Repa...
Simply Mac is the largest premier retailer of Apple products in the nation. In order to support our growing customer base, we are currently looking for a driven Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.