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

OmniGraffle 7.2.2 - Create diagrams, flo...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more
OmniGraffle Pro 7.2.2 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
OmniGraffle Pro 7.2.2 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
OmniGraffle 7.2.2 - Create diagrams, flo...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more
Spotify 1.0.44.100. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
Microsoft OneNote 15.29 - Free digital n...
OneNote is your very own digital notebook. With OneNote, you can capture that flash of genius, that moment of inspiration, or that list of errands that's too important to forget. Whether you're at... Read more
WALTR 2 2.0.8 - $39.95
WALTR 2 helps you wirelessly drag-and-drop any music, ringtones, videos, PDF, and ePub files onto your iPhone, iPad, or iPod without iTunes. It is the second major version of Softorino's critically-... Read more
Dropbox 16.3.27 - Cloud backup and synch...
Dropbox is an application that creates a special Finder folder that automatically syncs online and between your computers. It allows you to both backup files and keep them up-to-date between systems... Read more
EtreCheck 3.1.5 - 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
Carbon Copy Cloner 4.1.12 - Easy-to-use...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more

Latest Forum Discussions

See All

Track Santa with these three festive app...
Christmas is fast approaching and that means it's time to prepare for Santa's yearly pilgrimage around the globe. Christmas Eve is an exciting time as parents help their kids get ready to welcome Santa. You've got the cookies and milk all planned... | Read more »
Galaxy on Fire 3 and four other fantasti...
Galaxy on Fire 3 - Manticore brings the series back for another round of daring space battles. It's familiar territory for folks who are familiar with the franchise. If you've beaten the game and are looking to broaden your horizons, might we... | Read more »
The best apps for your holiday gift exch...
What's that, you say? You still haven't started your holiday shopping? Don't beat yourself up over it -- a lot of people have been putting it off, too. It's become easier and easier to procrastinate gift shopping thanks to a number of apps that... | Read more »
Toca Hair Salon 3 (Education)
Toca Hair Salon 3 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Winter comes to Darkwood as Seekers Note...
MyTona, based in the chilly Siberian city of Yakutsk, has brought a little festive fun to its hidden object game Seekers Notes: Hidden Mystery. The Christmas update introduces some new inhabitants to players, and with them a chance to win plenty of... | Read more »
Bully: Anniversary Edition (Games)
Bully: Anniversary Edition 1.03.1 Device: iOS Universal Category: Games Price: $6.99, Version: 1.03.1 (iTunes) Description: *** PLEASE NOTE: This game is officially supported on the following devices: iPhone 5 and newer, iPod Touch... | Read more »
PINE GROVE (Games)
PINE GROVE 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: A pine grove where there are no footsteps of people due to continuous missing cases. The case is still unsolved and nothing has... | Read more »
Niantic teases new Pokémon announcement...
After rumors started swirling yesterday, it turns out there is an official Pokémon GO update on its way. We’ll find out what’s in store for us and our growing Pokémon collections tomorrow during the Starbucks event, but Niantic will be revealing... | Read more »
3 reasons why Nicki Minaj: The Empire is...
Nicki Minaj is as business-savvy as she is musically talented and she’s proved that by launching her own game. Designed by Glu, purveyors of other fine celebrity games like cult favorite Kim Kardashian: Hollywood, Nicki Minaj: The Empire launched... | Read more »
Clash of Clans is getting its own animat...
Riding on its unending wave of fame and success, Clash of Clans is getting an animated web series based on its Clash-A-Rama animated shorts.As opposed to the current shorts' 60 second run time, the new and improved Clash-A-Rama will be comprised of... | Read more »

Price Scanner via MacPrices.net

New 2016 13-inch Touch Bar MacBook Pros on sa...
B&H Photo the new 2016 Apple 13″ 2.9GHz/256GB Touch Bar MacBook Pros on sale for $50 off MSRP, each including free shipping plus NY sales tax only: - 13″ 2.9GHz/256GB Touch Bar MacBook Pro Space... Read more
12-inch 1.2GHz Space Gray Retina MacBook on s...
B&H Photo has dropped their price on the 2016 Apple 12″ 1.2GHz Space Gray Retina MacBook (MLH82LL/A) to $1399 including free shipping plus NY sales tax only. Their price is $200 off MSRP, and it’... Read more
Never Settle for Low Performing Wifi With iOS...
AppYogi Software has announced the release of WiFi Signal Strength Status App 1.0, the company’s new utility developed exclusively for macOS. WiFi Signal Strength Status App features a unique, single... Read more
New 2016 13-inch Touch Bar MacBook Pros in st...
B&H Photo has stock of new 2016 Apple 13″ Touch Bar MacBook Pro models, each including free shipping plus NY sales tax only: - 13″ 2.9GHz/512GB Touch Bar MacBook Pro Space Gray: $1999 - 13″ 2.... Read more
New 2016 15″ Touch Bar MacBook Pros in stock...
B&H Photo has new 2016 Apple 15″ Touch Bar MacBook Pro models in stock today including free shipping plus NY sales tax only: - 15″ 2.7GHz Touch Bar MacBook Pro Space Gray: $2799 - 15″ 2.7GHz... Read more
DietSensor App Targeting Diabetes and Obesity...
DietSensor, Inc., a developer of smart food and nutrition applications designed to fight diabetes and obesity and help improve overall fitness, has announced the launch of its DietSensor app for... Read more
Holiday 2016 13-inch 2.0GHz MacBook Pro sales...
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
Holiday sale: Apple TVs for $51-$40 off MSRP,...
Best Buy has dropped their price on the 64GB Apple TV to $159.99 including free shipping. That’s $40 off MSRP. 32GB Apple TVs are on sale right now for $98 on Sams Club’s online store. That’s $51 off... Read more
12-inch Retina MacBooks, Apple refurbished, n...
Apple has restocked a full line of Certified Refurbished 2016 12″ Retina MacBooks, now available for $200-$260 off MSRP. Refurbished 2015 models are available starting at $929. Apple will include a... Read more
Holiday sale: 12-inch Retina MacBook for $100...
B&H has 12″ Retina MacBooks on sale for $100 off MSRP as part of their Holiday sale. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.1GHz Space Gray Retina MacBook: $1199 $100... Read more

Jobs Board

Integration Technician, *Apple* - Zones, In...
…at Zones and for our customers each day. Position Overview The Apple Integration Technician will be responsible for performing customer specific configuration Read more
*Apple* Brand Ambassador (Macy's) - The...
…(T-ROC), is proud of its unprecedented relationship with our partner and client, APPLE ,in bringing amazing" APPLE ADVOCATES"to "non" Apple store locations. Read more
*Apple* Retail - Multiple Positions- Trumbul...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
US- *Apple* Store Leader Program - Apple (Un...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.