TweetFollow Us on Twitter

Forth Structures
Volume Number:2
Issue Number:9
Column Tag:Threaded Code

Adding Record Structures to Forth

By Jörg Langowski, EMBL, c/o I.L.L., Grenoble, Cedex, France, MacTutor Editorial Board

Records with local field names

Data representation is a field that is neglected by many Forth dialects. Basic Forth-83 doesn't even provide for simple one and two dimensional matrices, neither are more complex types of data supported, such as Pascal records or C structs. These latter forms of data representation play a most important role in Toolbox programming, since very many traps expect pointers to records as parameters.

A letter received through BITNET from a reader who was wondering how to install a way to handle such data structures in Forth got me started on this month's column:

"I posted the following article to the USENET, but got little in the way of a response. Any help you can give will be much appreciated. By the way, I know that the rectangle definitions given below are inaccurate for the Mac, but I was trying to be machine independent in posting to the Forth language newsgroup.

From postnews Thu Jun 12 15:23:34 1986

Subject: Defining a structure in FORTH?

Newsgroups: net.lang.forth

Distribution: net

I am very much a novice FORTH programmer, and I don't even have a good textbook to go by. I recently purchased a FORTH for my Macintosh at home (MACH1, distributed by the Palo Alto Shipping Co.), and would like some advice. Professionally I do a lot of work with LISP, and I would like to implement something similar to a `DEFSTRUCT' package in FORTH. In other words, I'd like to be able to do something like:

    DEFSTRUCT[ RECTANGLE
           TOP    2
           LEFT   2
           BOTTOM 2
           RIGHT  2 ]ENDSTRUCT

Which would automatically define the following:

    8 CONSTANT RECTANGLE-SIZE
    : RECTANGLE-TOP@ ( a - n ) @ ;
    : RECTANGLE-TOP! ( n a - ) ! ;
    : RECTANGLE-LEFT@ ( a - n ) 2 + @ ;
    : RECTANGLE-LEFT! ( n a - ) 2 + ! ;
    : RECTANGLE-BOTTOM@ ( a - n ) 4 + @ ;
    : RECTANGLE-BOTTOM! ( n a - ) 4 + ! ;
    : RECTANGLE-RIGHT@ ( a - n ) 6 + @ ;
    : RECTANGLE-RIGHT! ( n a - ) 6 + ! ;
    : MAKE-RECTANGLE ( whatever code
 necessary to allocate 8 bytes of variable storage and assign a dictionary 
entry to the word which follows.This I guess would be implementation 
specific. ) ;

While I'm sure that this could be done by defining 'DEFSTRUCT[' so that it constructs all of the necessary dictionary headers etc. at the bit and byte level, this would doubtless be complicated and not very portable. I wonder then, if there is a higher level method of defining such a beast? Any help (even "no that can't be done") would be appreciated."

--Bruce Florman florman@rand-unix.ARPA

Since I think the question put forward by Bruce Florman is of very general interest to Macintosh Forth programmers, I'll try to show a way how such data structures may be implemented in MacForth or Mach2.

Structures in MacForth (CSI method)

MacForth (Kernel 2.4) provides a simple and effective way to implement structure definitions. A structure definition is a way to assemble information about a data structure (the lengths of the various fields and the total length of the structure). Example:

structure testrec
 long: ^date
 long: ^time
 byte: ^flag
   20 string: ^description
structure.end 

defines the data structure testrec with four fields, date, time, flag, and description. testrec is not a defining word. When executed, it merely leaves on the stack the length of the structure that is going to be defined; this number can then be used to allot an appropriate number of bytes in the dictionary. So, creation of a testrec would be done like:

create myrec testrec allot

The words that are used to access the field, ^date, ^time, ^flag, and ^description, simply add an offset to the number on top of stack. If this number is the address of a valid structure, like myrec,

myrec  ^flag

would indeed yield the address of the flag field in myrec. [Note that the circumflex in front of the field names is purely a MacForth convention, you could name the fields as you like].

This solution is beautifully simple and helps very much improving the readability of your program text if you are working with lots of structured data types. There is one drawback, however, that the field name definitions are global to the program and therefore violate the conventional definition of a Pascal record, in which field names are always local to the structure.

This means you have to exercise a lot of discipline when you work with structures defined in this way. On executing a field operator, it is not checked whether the address on top of stack is really the address of a structure, so bugs that leave unexpected values on the stack would be harder to detect. Furthermore, since all the field names are global, they may not occur in several different structure definitions in different contexts.

Therefore, I'd like to present an alternative to CSI's implementation of structures which uses local field names. This is slower during compilation, since every structure definition will have its own local dictionary that has to be searched, but in most cases has the same speed during execution. It offers the additional advantage that by a very simple modification, a rudimentary NEON-like class behavior may be built in.

Record definition with local field names

From now on, we'll call the type of data structure dealt with a record, to emphasize the similarity with Pascal records. A record definition will be a template from which an arbitrary number of instances of this record can be built (note that this already strongly resembles NEON's terminology). Each instance will consist of a reference to its template and the data fields as defined in the template (Fig. 1).

A record definition (Listing 1) then consists of:

- the word :record, which sets up a defining word for the instances and initializes the stack for the field name definitions following;

- field name definitions (>long, >word, etc.), which add names to the record template and store (after the name) the length of the data field and its position within the record;

- ;record, which closes the definition, stores a 16-bit zero and the total length of the record at the end of the template, and checks for completeness of the definition.

An example definition is given at the end of Listing 1.

Run-time behavior of records

The run-time behavior of a record template defined through :record is given by the word do.record. This word scans the list of field names in the record template and creates a new instance of the record with a pointer to the template in its first four bytes and space for the data fields following it.

The run-time behavior of the record instance is just to place its base address (the pointer to the template) on the stack. Access to the record fields is provided through ^field, which expects an address of a record instance and a string address on the stack. ^field will search the record template for the field name and leave the (absolute) field address on the stack or abort with an error message if the string does not match any field name in that particular record.

The operator ^ is provided for readability; executing

r1 ^ date

will give the same result as executing

r1 " date" ^field.

So far, we have only talked about execution time behavior of records. However, most of the times one would want to compile references to record fields into Forth definitions rather than execute them directly. For inclusion into Forth definitions, one way is to write

: test1 [ r1 ^ date ] literal ....... ;

which compiles the address of the date field of r1 into the definition as a literal. If a run-time reference to an arbitrary record is to be made, one can either write

: test2 ( record addr -- addr of date field )
  " date" ^field ;

which also checks at runtime for the validity of the date reference (something like 'late binding'), or, for faster execution, one writes

: test3 (record addr -- addr of date field )
  [ r1 dup ^ date - ] literal + ;

which assumes that the record address passed at run time refers to a record of the same type as r1. But in that case, CSI's structure definition is, of course, equivalent and easier to read.

From record to class definitions - using record fields as vectors

A simple, again very rudimentary, implementation of a NEON class like structure can be obtained using the record definition given here. If the data contained in a >long field (lets say with the field name print) is the cfa of a Forth word, writing

r1 ^ print @ execute (Mach2) or

r1 ^ print @ make.token execute
  (MacForth)

will execute the word that the print field of r1 points to. (In MacForth, one might also reserve a >word field and store a token there, then say r1 ^ print @ execute).

Vectors within records are very similar to methods associated with objects. Of course, method inheritance from superclasses has not been implemented here, so the resemblance to 'real' object oriented languages is not very strong.

Some extensions to Mach2 for MacForth compatibility

At the beginning of Listing 1 I have included some definitions for MacForth words that are not included in Mach2. Those are the words =cells, needed, and -string. The latter, a string comparison operator, has been implemented in two different ways; in both cases, the top two stack items are string addresses, and the flag returned is 0 if the strings are equal and 1 if not. =string uses the IUMagIDString routine from the international utilities package, which does a better job in comparing name strings that contain umlauts, diacritical marks etc., but is slower. -string uses the _Cmpstring trap, which is much faster and the recommended one to use for applications like this one.

MacForth Plus - no more Level 1,2,3

Readers of the CSI newsletter might have received an announcement of their latest update to MacForth by the time this is in print. Anyway, I'll tell you a few things about it that I was told in a letter at the time I wrote this (June).

• MacForth Plus, to be released at the end of August, will supersede all previous versions and levels of MacForth. Its version of the kernel will "...execute considerably faster than K2.4 It will execute faster than Mach1."

• Normal text file editing will be supported, as well as block file editing.

• Multitasking, which was undocumented, but in principle possible with MacForth, will be fully supported in MacForth Plus.

• The documentation will contain in one single manual the Level 1,2 and 3 informations, as well as the new features.

• Stand-alone applications can be produced by a built-in turnkey mechanism.

• The upgrade from Level 2 will be available for (scheduled) $49 upgrade fee, which includes the manual. Level 3 users will receive a free upgrade.

This sounds very interesting. I hope I'll soon have a test copy to write about.

Listing 1: record structures in Forth
( Structures, Mach-2 version                  
----------
Adding a structure compiler to Forth. JL 26.6.86.
This file defines a Pascal-like 'record' structure;
a record is a template for instances of the structure.
Example
:record a
    >long field1
    >word field2
;record

myrec r1 \this creates an instance r1 of myrec whose fields
          may be accessed through myrec ^ field1 etc..

for 'late binding' usage, the word ^field is provided)

only forth also assembler
decimal
( some MacForth definitions that Mach1 is missing )
: =cells dup 2 mod + ;
: needed depth 1- > abort" NEEDED- not enough stack items" ;

CODE =string 
      count rot count rot swap  
      MOVE.W    #0,-(A7)
      MOVE.L    $C(A6),-(A7)
      MOVE.L    $8(A6),-(A7)
      MOVE.W    $6(A6),-(A7)
      MOVE.W    $2(A6),-(A7)
      MOVE.W    #12,-(A7)
      _pack6 
      ADDQ.L    #8,A6
      ADDQ.L    #8,A6
      MOVE.W    (A7)+,-(A6)
      MOVE.W    #0,-(A6)
      RTS
END-CODE

CODE -string 
      count rot count swap  
      MOVE.L    (A6)+,A0
      MOVE.L    (A6)+,D0
      SWAP.W    D0
      MOVE.L    (A6)+,D1
      MOVE.W    D1,D0   
      MOVE.L    (A6)+,A1
      _cmpstring
      MOVE.L    D0,-(A6)
      RTS
END-CODE

( do.record, creating one instance of a record )  ( 062686 jl )
: do.record  ( addr of master | -- )
    create  dup ,
        begin dup c@ dup while ( not zero, i.e. end)
            1+ =cells 4 + + ( next field in template )
        repeat
    drop 2+ w@ ( length stored here ) allot
    does>  ( nothing special )
;

( :record ;record and friends)                    ( 062686 jl )

:  :record  create 13579 4 does> do.record ;

:  ;record  2 needed
    0 w, ( end of list) w, ( total length )
    13579 = 0= abort" ;record without :record"
;

:  put.fieldname
    32 word here over c@ 1+ dup =cells allot cmove ;


( field defining words )                          ( 062686 jl )
: >long ( addr | addr+4)
        put.fieldname dup w, 4 w, 4 + ;
: >word ( addr | addr+2)
        put.fieldname dup w, 2 w, 2+ ;
: >byte ( addr | addr+1)
        put.fieldname dup w, 1 w, 1+ ;
: >bytes ( addr \ n | addr+n )
        put.fieldname over w, dup w, + ;
 
( ^field, addressing a field within a record )    ( 062686 jl )
: ^field ( addr name | address of field )
    over @ ( addr name master )
        begin 2dup -string while ( no match )
            dup c@ 6 + =cells +
            dup c@ 0= ( end of list )
                abort" RECORD- specified field does not exist"
        repeat
    ( match found )
    dup c@ 1+ =cells + w@ ( start within record )
    swap drop   +  ( address of field )
;

( ^ )                                   ( 062686 jl )

: ^   32 word ^field ;

( example of a record structure )                 ( 062686 jl )
:record testrec
    >long date
    >long time
    >byte flag
    >word counts
 30 >bytes description
;record

testrec r1
testrec r2
 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Google Chrome 75.0.3770.142 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Notability 4.0.4 - Note-taking and annot...
Notability is a powerful note-taker to annotate documents, sketch ideas, record lectures, take notes and more. It combines, typing, handwriting, audio recording, and photos so you can create notes... Read more
ffWorks 1.3.1 - Convert multimedia files...
ffWorks, focused on simplicity, brings a fresh approach to the use of FFmpeg, allowing you to create ultra-high-quality movies without the need to write a single line of code on the command-line.... Read more
EtreCheck Pro 6.0.2 - For troubleshootin...
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
Adobe Premiere Pro CC 2019 13.1.3 - Digi...
Premiere Pro CC 2019 is available as part of Adobe Creative Cloud for as little as $52.99/month. The price on display is a price for annual by-monthly plan for Adobe Premiere Pro only Adobe Premiere... Read more
BitTorrent 7.4.3 - Official client of th...
BitTorrent is a protocol for distributing files. It identifies content by URL and is designed to integrate seamlessly with the web. Its advantage over plain HTTP is that when multiple downloads of... Read more
BetterTouchTool 3.134 - Customize multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom)... Read more
EtreCheck Pro 6.0.2 - For troubleshootin...
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
BitTorrent 7.4.3 - Official client of th...
BitTorrent is a protocol for distributing files. It identifies content by URL and is designed to integrate seamlessly with the web. Its advantage over plain HTTP is that when multiple downloads of... Read more
Adobe Premiere Pro CC 2019 13.1.3 - Digi...
Premiere Pro CC 2019 is available as part of Adobe Creative Cloud for as little as $52.99/month. The price on display is a price for annual by-monthly plan for Adobe Premiere Pro only Adobe Premiere... Read more

Latest Forum Discussions

See All

TEPPEN guide - Tips and tricks for new p...
TEPPEN is a wild game that nobody asked for, but I’m sure glad it exists. Who would’ve thought that a CCG featuring Capcom characters could be so cool and weird? In case you’re not completely sure what TEPPEN is, make sure to check out our review... | Read more »
Dr. Mario World guide - Other games that...
We now live in a post-Dr. Mario World world, and I gotta say, things don’t feel too different. Nintendo continues to squirt out bad games on phones, causing all but the most stalwart fans of mobile games to question why they even bother... | Read more »
Strategy RPG Brown Dust introduces its b...
Epic turn-based RPG Brown Dust is set to turn 500 days old next week, and to celebrate, Neowiz has just unveiled its biggest and most exciting update yet, offering a host of new rewards, increased gacha rates, and a brand new feature that will... | Read more »
Dr. Mario World is yet another disappoin...
As soon as I booted up Dr. Mario World, I knew I wasn’t going to have fun with it. Nintendo’s record on phones thus far has been pretty spotty, with things trending downward as of late. [Read more] | Read more »
Retro Space Shooter P.3 is now available...
Shoot-em-ups tend to be a dime a dozen on the App Store, but every so often you come across one gem that aims to shake up the genre in a unique way. Developer Devjgame’s P.3 is the latest game seeking to do so this, working as a love letter to the... | Read more »
Void Tyrant guide - Guildins guide
I’ve still been putting a lot of time into Void Tyrant since it officially released last week, and it’s surprising how much stuff there is to uncover in such a simple-looking game. Just toray, I finished spending my Guildins on all available... | Read more »
Tactical RPG Brown Dust celebrates the s...
Neowiz is set to celebrate the summer by launching a 2-month long festival in its smash-hit RPG Brown Dust. The event kicks off today, and it’s divided into 4 parts, each of which will last two weeks. Brown Dust is all about collecting, upgrading,... | Read more »
Flappy Royale is an incredibly clever ta...
I spent the better part of my weekend playing Flappy Royale. I didn’t necessarily want to. I just felt like I had to. It’s a hypnotic experience that’s way too easy to just keep playing. | Read more »
Void Tyrant guide - General tips and tri...
Void Tyrant is a card-based dungeon-crawler that doesn’t fit in the mold of other games in the genre. Between the Blackjack-style combat and strange gear system alone, you’re left to your own devices to figure out how best to use everything to your... | Read more »
Webzen’s latest RPG First Hero is offici...
You might be busy sending your hulking Dark Knight into the midst of battle in Webzen’s other recent release: the long-anticipated MU Origin 2. But for something a little different, the South Korean publisher has launched First Hero. Released today... | Read more »

Price Scanner via MacPrices.net

Price drop! Clearance 12″ 1.2GHz Silver MacBo...
Amazon has dropped their price on the recently-discontinued 12″ 1.2GHz Silver MacBook to $849.99 shipped. That’s $450 off Apple’s original MSRP for this model, and it’s the cheapest price available... Read more
Apple’s 21″ 3.0GHz 4K iMac drops to only $936...
Abt Electronics has dropped their price on clearance, previous-generation 21″ 3.0GHz 4K iMacs to only $936 shipped. That’s $363 off Apple’s original MSRP, and it’s the cheapest price we’ve seen so... Read more
Amazon’s Prime Day savings on Apple 11″ iPad...
Amazon has new 2018 Apple 11″ iPad Pros in stock today and on sale for up to $250 off Apple’s MSRP as part of their Prime Day sale (but Prime membership is NOT required for these savings). These are... Read more
Prime Day Apple iPhone deal: $100 off all iPh...
Boost Mobile is offering Apple’s new 2018 iPhone Xr, iPhone Xs, and Xs Max for $100 off MSRP. Their discount reduces the cost of an Xs to $899 for the 64GB models and $999 for the 64GB Xs Max. Price... Read more
Clearance 13″ 2.3GHz Dual-Core MacBook Pros a...
Focus Camera has clearance 2017 13″ 2.3GHz/128GB non-Touch Bar Dual-Core MacBook Pros on sale for $169 off Apple’s original MSRP. Shipping is free. Focus charges sales tax for NY & NJ residents... Read more
Amazon Prime Day deal: 9.7″ Apple iPads for $...
Amazon is offering new 9.7″ WiFi iPads with Apple Pencil support for $80-$100 off MSRP as part of their Prime Day sale, starting at only $249. These are the same iPads found in Apple’s retail and... Read more
Amazon Prime Day deal: 10% (up to $20) off Ap...
Amazon is offering discounts on new 2019 Apple AirPods ranging up to $20 (10%) off MSRP as part of their Prime Day sales. Shipping is free: – AirPods with Charging Case: $144.99 $15 off MSRP –... Read more
Amazon Prime Day deal: $50-$80 off Apple Watc...
Amazon has Apple Watch Series 4 and Series 3 models on sale for $50-$80 off Apple’s MSRP as part of their Prime Day deals with prices starting at only $199. Choose Amazon as the seller rather than a... Read more
Amazon Prime Day deal: 50% discount on Apple...
Amazon has Apple Smart Keyboards for current-generation 10″ iPad Airs and previous-generation 10″ iPad Pros on sale today for $79.50 shipped as part of their early Prime Day deals. That’s a 50%... Read more
Abt drops prices on clearance 2018 MacBook Ai...
Abt Electronics has dropped prices on clearance 2018 13″ MacBook Airs by $201 with models now available starting at only $998. Shipping is free: – 13″ 1.6GHz/128GB MacBook Air (Space Gray, Silver, or... Read more

Jobs Board

*Apple* Graders/Inspectors (Seasonal/Hourly/...
…requirements. #COVAentryleveljobs ## Minimum Qualifications Some knowledge of agricultural and/or the apple industry is helpful as well as the ability to comprehend, Read more
Best Buy *Apple* Computing Master - Best Bu...
**710003BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Location Number:** 000171-Winchester Road-Store **Job Description:** Read more
Best Buy *Apple* Computing Master - Best Bu...
**709786BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000430-Orange Park-Store **Job Description:** **What does a Read more
Geek Squad *Apple* Master Consultation Agen...
**709918BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Job Category:** Services/Installation/Repair **Location Number:** 000106-Palmdale-Store Read more
*Apple* Systems Architect/Engineer, Vice Pre...
…its vision to be the world's most trusted financial group. **Summary:** Apple Systems Architect/Engineer with strong knowledge of products and services related to Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.