TweetFollow Us on Twitter

Anchored Variables
Volume Number:1
Issue Number:8
Column Tag:Programmer's Forum

"Modula-2 and Anchored Variables"

By Tom Taylor, Software Engineer, Modula-2 Corp., Provo, Ut.

"Modula-2 and Anchored Variables"

The programming language Modula-2 supports a little known but extremely powerful feature called "anchored variables." Anchored variables allow one to specify in the variable's declaration the absolute address of the variable and override the compiler's allocation method. This feature was intended to allow access to device registers on computers with memory mapped I/O (like on a PDP-11 where the original Modula-2 compiler was developed). It also allows the Modula-2 programmer on the Macintosh to access the Mac's operating system global variables very conveniently and cleanly.

In this article, we will look at two examples of anchored variable usage. In the first, we will try a small example to show that anchored variables really do work. In the second example, we'll actually develop a useful module based on anchored variables. These examples have been programed using MacModula-2 by Modula Corporation. However, with minor changes to the programs (probably the import statements), these programs should run using any Modula-2 system.

Anchored variables are "anchored" to a specific address by specifying that address in brackets immediately following the variable name in a variable declaration and before specifying the variable's type. For example:

VAR
     FinderName [2E0h]
     : ARRAY [0..16] OF CHAR;

This statement tells the compiler to allocate the variable FinderName starting at hex location 2E0h. Location 2E0h just happens to contain a Mac style string with the name of the current finder. The following program, will print out the name of the currently installed finder:

MODULE PrintFinder;
    FROM Terminal IMPORT
             ClearScreen, Write,
             Read, WriteLn, WriteString;

VAR
    FinderName [2e0h] :
             ARRAY [0..16] OF CHAR;
    i : CARDINAL;
    ch : CHAR;

BEGIN
    ClearScreen;
    WriteString("Current finder is: ");
    FOR i := 1 TO ORD(FinderName[0]) DO
          Write(FinderName[i]);
    END;
    WriteLn;
    Read(ch);
END PrintFinder.

Volume Control Block Queue

This next example is slightly more useful. It demonstrates the use of anchored variables in traversing the Volume Control Block queue and returning information about any disk (or volume) visible on the desktop (inserted in a drive or ejected) at the time your program was launched. This technique is used, for example, in the MacModula-2 compiler and linker when they search for imported files. This feature allows users of single drive Macs to build programs that are spred out over a number of disks by having those disks visible on the desktop at the time the compiler or linker is launched. The compiler or linker will search each disk found on the desktop by traversing the VCB queue until the desired import file is found or the end of the queue is reached.

The following example actually consists of three modules:

1) a Definition Module that defines the records, types, global variables, and procedures that are available for use by any program.

2) An Implementation Module that contains the code for the procedures defined in the Definition Module.

3) A simple Program Module that uses the procedures we have written and demonstrates some of the information available from the Volume Control Blocks.


DEFINITION MODULE VolumeTracer;

FROM MacSystemTypes IMPORT LongCard, Ptr;

EXPORT QUALIFIED VCB, VolumesOnLine,                                 
                                               GetVolumeInfo;

TYPE
        QElemPtr = POINTER TO VCB;

     VCB = RECORD
                          qLink: QElemPtr;
                                         (* next queue entry *)
                         qType:  INTEGER;
                                         (* not used *)
                        vcbFlags: INTEGER;
                                        (* bit 15=1 if dirty *)
                        vcbSigWord: INTEGER;
                                       (* always $D2D7 *)
                       vcbCrDate: LongCard;
                                      (* date volume initialized *)
                       vcbLsBkUp: LongCard;
                                     (* date of last backup *)
                      vcbAtrb: INTEGER;
                                    (* volume attributes *)
                      vcbNmFls: INTEGER;
                                    (* # of files in directory *)
                      vcbDirSt: INTEGER;
                                   (* directory's first block *)
                      vcbBlLn: INTEGER;
                                  (* length of file directory *)
                     vcbNmBlks: INTEGER;
                                  (* # of allocation blocks *)
                    vcbAlBlkSiz: LongCard;
                                  (* size of allocation blocks *)
                    vcbClpSiz: LongCard;
                                 (* # of bytes to allocate *)
                   vcbAlBlSt: INTEGER;
                                (* first block in block map *)
                   vcbNxtFNum: LongCard;
                                (* next unused file number *)
                   vcbFreeBks: INTEGER;
                                (* number of unused blocks *)
                   vcbVN: ARRAY [0..27] OF CHAR;
                               (* vol name Str255 format *)
                   vcbDrvNum: INTEGER;
                               (* drive number *)
                   vcbDRefNum: INTEGER;
                              (* driver reference number *)
                  vcbFSID: INTEGER;
                              (* file system identifier *)
                  vcbVRefNum: INTEGER;
                             (* volume reference number *)
                 vcbMAdr: Ptr;
                            (* location of block map *)
                 vcbBufAdr: Ptr;
                           (* location of volume buffer *)
                vcbMLen: INTEGER;
                           (* # of bytes in block map *)
               vcbDirIndex: INTEGER;
                          (* used internally *)
              vcbDirBlk: INTEGER;
                          (* used internally *)
END;

PROCEDURE VolumesOnLine(): CARDINAL;
                     (* Returns the maximum number of
                         volumes currently recognized by the
                         Mac operating system. *)

PROCEDURE GetVolumeInfo(VAR volume :
                  VCB; whichVol : CARDINAL);
                              (* Returns the current VCB block for
                                 volume "whichVol"  The variable
                               "whichVol" must be between 1 and
                                 the result of the procedure of
                                "VolumesOnLine()".  Otherwise,
                                  the "volume" info is undefined. *)

END VolumeTracer.
IMPLEMENTATION MODULE VolumeTracer;

TYPE
        QHdrPtr   = POINTER TO QHdr;
        QHdr        = RECORD
        qFlags : INTEGER;
                          (* queue flags *)
        qHead  : QElemPtr;
                          (* first queue entry *)
        qTail   : QElemPtr;
                          (* last  queue entry *)
END;

VAR
        VCBQHdr  [0356h] : QHdr;
                                           (* VCB queue header *)

PROCEDURE VolumesOnLine(): CARDINAL;
VAR
       ptr : QElemPtr;
       count : CARDINAL;
BEGIN
       ptr := VCBQHdr.qHead;
       count := 0;
       WHILE ptr # NIL DO
               INC(count);
               ptr := ptr^.qLink;
       END;
       RETURN count;
END VolumesOnLine;

PROCEDURE GetVolumeInfo(VAR volume :
           VCB; whichVol : CARDINAL);
VAR
        ptr : QElemPtr;
        count : CARDINAL;
BEGIN
        ptr := VCBQHdr.qHead;
        count := 0;
        WHILE (ptr # NIL) AND
               (count # whichVol) DO
        INC(count);
        IF count = whichVol THEN
                  volume := ptr^;
                  END;
        ptr := ptr^.qLink;
        END;
END GetVolumeInfo;

END VolumeTracer.

MODULE ListVolumes;
FROM VolumeTracer IMPORT
           VCB, VolumesOnLine, GetVolumeInfo;
FROM InOut IMPORT WriteString, ClearScreen,  WriteLn, WriteCard, WriteInt, 
Write, Read;
  
VAR
        i, maxVols : CARDINAL;
       vcb : VCB;
       ch : CHAR;
  
PROCEDURE PrintVolName;
VAR
       i : CARDINAL;
BEGIN
       FOR i := 1 TO ORD(vcb.vcbVN[0]) DO
              Write(vcb.vcbVN[i]);
              END;
       WriteLn;
END PrintVolName;

BEGIN
        ClearScreen;
       WriteString
                     ("Number of volumes on-line: ");
       maxVols := VolumesOnLine();
       WriteCard(maxVols,0);
       WriteLn; WriteLn;
       FOR i := 1 TO maxVols DO
              GetVolumeInfo(vcb,i);
              WriteString('Volume Name: ');
              PrintVolName;
             WriteString
                        ('Number of files in volume: ');
             WriteInt(vcb.vcbNmFls,0);
             WriteLn;
             WriteString('Drive Number: ');
             WriteInt(vcb.vcbDrvNum,0);
            WriteLn;
            WriteLn;
     END;
Read(ch);
END ListVolumes.

Figure 1. Typical VCB Queue

This is only one simple example of a typical use of anchored variables. Many times, Inside Macintosh will mention some variable that can be accessed from assembly language. The Window Manager, for example, mentions that putting a WindowPtr in the variable GhostWindow, will cause that window to never be the front window. In order to find the addresses of such variables, such as GhostWindow, one need simply paw through ToolEqu.TXT or SysEqu.TXT. Both of these source files are included with the MDS system by Apple. Not only have I used GhostWindow as an anchored variable in my applications, I have also used anchored variables to access the information set by the Finder when a program is launched.

By taking advantage of the power of anchored variables, you will be able to create very readable programs that use some of the Mac's low-level features.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Ellipsis - Touch. Explore. Survive. (...
Ellipsis - Touch. Explore. Survive. 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Ys Chronicles II (Games)
Ys Chronicles II 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: After a hard fight to recover the six sacred books in Ys Chronicles I, Adol is back for a sequel! | Read more »
FINAL FANTASY Ⅸ (Games)
FINAL FANTASY Ⅸ 1.0.4 Device: iOS Universal Category: Games Price: $16.99, Version: 1.0.4 (iTunes) Description: ==========●Special sale price for the FINAL FANTASY IX release! ●20% off from February 10 to February 21, 2016... | Read more »
Tennis Club Story (Games)
Tennis Club Story 1.03 Device: iOS Universal Category: Games Price: $4.99, Version: 1.03 (iTunes) Description: Aim for the ace position of tennis club prestige in this simulation! Your leadership decides if players make it to the big... | Read more »
Juggernaut Wars guide - How to use skill...
Juggernaut Warsis a brand new auto-RPG on iOS and Android that challenges you to build a team of heroes, send them out into various different missions to defeat waves of heroes, and level them up to increase their power. The actual combat itself... | Read more »
Check out the new Pirate Attack update i...
Love pirates and board games? Well, you'll love the new Pirate Attack themed update that just launched in Game of Dice. It adds a bunch of new content themed around pirates, like an all new event map based on a pirate ship which revamps the toll... | Read more »
Splash Cars guide - How to paint the tow...
Splash Cars is an arcade driving game that feels like a hybrid between Dawn of the Plow and Splatoon. In it, you'll need to drive a car around to repaint areas of a town that have lost all of their color. Check out these tips to help you perform... | Read more »
The best video player on mobile
We all know the stock video player on iOS is not particularly convenient, primarily because it asks us to hook a device up to iTunes to sync video in a world that has things like Netflix. [Read more] | Read more »
Four apps to help improve your Super Bow...
Super Bowl Sunday is upon us, and whether you’re a Panthers or a Broncos fan you’re no doubt gearing up for it. [Read more] | Read more »
LooperSonic (Music)
LooperSonic 1.0 Device: iOS Universal Category: Music Price: $4.99, Version: 1.0 (iTunes) Description: LooperSonic is a multi-track audio looper and recorder that will take your loops to the next level. Use it like a loop pedal to... | Read more »

Price Scanner via MacPrices.net

App Annie Reveals Future of the App Economy:...
App Annie, a San Francisco based mobile app data and insights platform, has launched its first comprehensive app economy forecast. This new offering will provide brands, agencies, investors and app... Read more
Apple restocks Certified Refurbished Mac mini...
Apple has restocked 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 Mac mini: $419 $... Read more
What iPad Pro Still Needs To Make It Truly Pr...
I love my iPad Air 2. So much that I’m grudgingly willing to put up with its compromises and limitations as a production tool in order to take advantage of its virtues. However, since a computer for... Read more
21-inch 3.1GHz 4K on sale for $1399, $100 off...
B&H Photo has the 21″ 3.1GHz 4K iMac on sale $1399 for a limited time. Shipping is free, and B&H charges NY sales tax only. Their price is $100 off MSRP: - 21″ 3.1GHz 4K iMac (MK452LL/A): $... Read more
Apple price trackers, updated continuously
Scan our Apple Price Trackers for the latest information on sales, bundles, and availability on systems from Apple’s authorized internet/catalog resellers. We update the trackers continuously: - 15″... Read more
Save up to $240 with Apple Certified Refurbis...
Apple is now offering Certified Refurbished 12″ Retina MacBooks for up to $240 off the cost of new models. Apple will include a standard one-year warranty with each MacBook, and shipping is free. The... Read more
Apple refurbished 13-inch Retina MacBook Pros...
Apple has Certified Refurbished 13″ Retina MacBook Pros available for up to $270 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.7GHz... Read more
Apple refurbished Time Capsules available for...
Apple has certified refurbished Time Capsules available for $120 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $179, $120 off - 3TB... Read more
13-inch 2.5GHz MacBook Pro (refurbished) avai...
Apple has Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more

Jobs Board

Lead Engineer - *Apple* OSX & Hardware...
Lead Engineer - Apple OSX & Hardware **Job ID:** 3125919 **Full/Part\-Time:** Full\-time **Regular/Temporary:** Regular **Listed:** 2016\-02\-10 **Location:** Cary, 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
Infrastructure Engineer - *Apple* /Mac - Rem...
…part of a team Requires proven problem solving skills Preferred Additional: Apple Certified System Administrator (ACSA) Apple Certified Technical Coordinator (ACTC) Read more
Lead Engineer - *Apple* OSX & Hardware...
Lead Engineer - Apple OSX & Hardware **Job ID:** 3125919 **Full/Part\-Time:** Full\-time **Regular/Temporary:** Regular **Listed:** 2016\-02\-10 **Location:** Cary, Read more
*Apple* System Analyst - ATOS IT Services...
Apple System AnalystReference no.198783CountryUSARegionUS - CALIFORNIACityUS - CALIFORNIA - BURBANKPosition TypeProfessionalJob AreaIT SupportJob TypeFull Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.