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

Latest Forum Discussions

See All

Whitethorn Games combines two completely...
If you have ever gone fishing then you know that it is a lesson in patience, sitting around waiting for a bite that may never come. Well, that's because you have been doing it wrong, since as Whitehorn Games now demonstrates in new release Skate... | Read more »
Call of Duty Warzone is a Waiting Simula...
It's always fun when a splashy multiplayer game comes to mobile because they are few and far between, so I was excited to see the notification about Call of Duty: Warzone Mobile (finally) launching last week and wanted to try it out. As someone who... | Read more »
Albion Online introduces some massive ne...
Sandbox Interactive has announced an upcoming update to its flagship MMORPG Albion Online, containing massive updates to its existing guild Vs guild systems. Someone clearly rewatched the Helms Deep battle in Lord of the Rings and spent the next... | Read more »
Chucklefish announces launch date of the...
Chucklefish, the indie London-based team we probably all know from developing Terraria or their stint publishing Stardew Valley, has revealed the mobile release date for roguelike deck-builder Wildfrost. Developed by Gaziter and Deadpan Games, the... | Read more »
Netmarble opens pre-registration for act...
It has been close to three years since Netmarble announced they would be adapting the smash series Solo Leveling into a video game, and at last, they have announced the opening of pre-orders for Solo Leveling: Arise. [Read more] | Read more »
PUBG Mobile celebrates sixth anniversary...
For the past six years, PUBG Mobile has been one of the most popular shooters you can play in the palm of your hand, and Krafton is celebrating this milestone and many years of ups by teaming up with hit music man JVKE to create a special song for... | Read more »
ASTRA: Knights of Veda refuse to pump th...
In perhaps the most recent example of being incredibly eager, ASTRA: Knights of Veda has dropped its second collaboration with South Korean boyband Seventeen, named so as it consists of exactly thirteen members and a video collaboration with Lee... | Read more »
Collect all your cats and caterpillars a...
If you are growing tired of trying to build a town with your phone by using it as a tiny, ineffectual shover then fear no longer, as Independent Arts Software has announced the upcoming release of Construction Simulator 4, from the critically... | Read more »
Backbone complete its lineup of 2nd Gene...
With all the ports of big AAA games that have been coming to mobile, it is becoming more convenient than ever to own a good controller, and to help with this Backbone has announced the completion of their 2nd generation product lineup with their... | Read more »
Zenless Zone Zero opens entries for its...
miHoYo, aka HoYoverse, has become such a big name in mobile gaming that it's hard to believe that arguably their flagship title, Genshin Impact, is only three and a half years old. Now, they continue the road to the next title in their world, with... | Read more »

Price Scanner via MacPrices.net

Deal Alert! B&H Photo has Apple’s 14-inch...
B&H Photo has new Gray and Black 14″ M3, M3 Pro, and M3 Max MacBook Pros on sale for $200-$300 off MSRP, starting at only $1399. B&H offers free 1-2 day delivery to most US addresses: – 14″ 8... Read more
Department Of Justice Sets Sights On Apple In...
NEWS – The ball has finally dropped on the big Apple. The ball (metaphorically speaking) — an antitrust lawsuit filed in the U.S. on March 21 by the Department of Justice (DOJ) — came down following... Read more
New 13-inch M3 MacBook Air on sale for $999,...
Amazon has Apple’s new 13″ M3 MacBook Air on sale for $100 off MSRP for the first time, now just $999 shipped. Shipping is free: – 13″ MacBook Air (8GB RAM/256GB SSD/Space Gray): $999 $100 off MSRP... Read more
Amazon has Apple’s 9th-generation WiFi iPads...
Amazon has Apple’s 9th generation 10.2″ WiFi iPads on sale for $80-$100 off MSRP, starting only $249. Their prices are the lowest available for new iPads anywhere: – 10″ 64GB WiFi iPad (Space Gray or... Read more
Discounted 14-inch M3 MacBook Pros with 16GB...
Apple retailer Expercom has 14″ MacBook Pros with M3 CPUs and 16GB of standard memory discounted by up to $120 off Apple’s MSRP: – 14″ M3 MacBook Pro (16GB RAM/256GB SSD): $1691.06 $108 off MSRP – 14... Read more
Clearance 15-inch M2 MacBook Airs on sale for...
B&H Photo has Apple’s 15″ MacBook Airs with M2 CPUs (8GB RAM/256GB SSD) in stock today and on clearance sale for $999 in all four colors. Free 1-2 delivery is available to most US addresses.... Read more
Clearance 13-inch M1 MacBook Airs drop to onl...
B&H has Apple’s base 13″ M1 MacBook Air (Space Gray, Silver, & Gold) in stock and on clearance sale today for $300 off MSRP, only $699. Free 1-2 day shipping is available to most addresses in... Read more
New promo at Visible: Buy a new iPhone, get $...
Switch to Visible, and buy a new iPhone, and Visible will take $10 off their monthly Visible+ service for 24 months. Visible+ is normally $45 per month. With this promotion, the cost of Visible+ is... Read more
B&H has Apple’s 13-inch M2 MacBook Airs o...
B&H Photo has 13″ MacBook Airs with M2 CPUs and 256GB of storage in stock and on sale for $100 off Apple’s new MSRP, only $899. Free 1-2 day delivery is available to most US addresses. Their... Read more
Take advantage of Apple’s steep discounts on...
Apple has a full line of 16″ M3 Pro and M3 Max MacBook Pros available, Certified Refurbished, starting at $2119 and ranging up to $600 off MSRP. Each model features a new outer case, shipping is free... Read more

Jobs Board

Medical Assistant - Surgical Oncology- *Apple...
Medical Assistant - Surgical Oncology- Apple Hill Location: WellSpan Medical Group, York, PA Schedule: Full Time Sign-On Bonus Eligible Remote/Hybrid Regular Apply Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Cashier - *Apple* Blossom Mall - JCPenney (...
Cashier - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Blossom Mall Read more
Operations Associate - *Apple* Blossom Mall...
Operations Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Business Analyst | *Apple* Pay - Banco Popu...
Business Analyst | Apple PayApply now " Apply now + Apply Now + Start applying with LinkedIn Start + Please wait Date:Mar 19, 2024 Location: San Juan-Cupey, PR Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.