af3ea20a0915f26ed9614e5e2c3e851ccd5a4738
[jonesforth.git] / jonesforth.S
1 /*      A sometimes minimal FORTH compiler and tutorial for Linux / i386 systems. -*- asm -*-
2         By Richard W.M. Jones <rich@annexia.org> http://annexia.org/forth
3         This is PUBLIC DOMAIN (see public domain release statement below).
4         $Id: jonesforth.S,v 1.25 2007-09-23 22:10:04 rich Exp $
5
6         gcc -m32 -nostdlib -static -Wl,-Ttext,0 -o jonesforth jonesforth.S
7 */
8         .set JONES_VERSION,25
9 /*
10         INTRODUCTION ----------------------------------------------------------------------
11
12         FORTH is one of those alien languages which most working programmers regard in the same
13         way as Haskell, LISP, and so on.  Something so strange that they'd rather any thoughts
14         of it just go away so they can get on with writing this paying code.  But that's wrong
15         and if you care at all about programming then you should at least understand all these
16         languages, even if you will never use them.
17
18         LISP is the ultimate high-level language, and features from LISP are being added every
19         decade to the more common languages.  But FORTH is in some ways the ultimate in low level
20         programming.  Out of the box it lacks features like dynamic memory management and even
21         strings.  In fact, at its primitive level it lacks even basic concepts like IF-statements
22         and loops.
23
24         Why then would you want to learn FORTH?  There are several very good reasons.  First
25         and foremost, FORTH is minimal.  You really can write a complete FORTH in, say, 2000
26         lines of code.  I don't just mean a FORTH program, I mean a complete FORTH operating
27         system, environment and language.  You could boot such a FORTH on a bare PC and it would
28         come up with a prompt where you could start doing useful work.  The FORTH you have here
29         isn't minimal and uses a Linux process as its 'base PC' (both for the purposes of making
30         it a good tutorial). It's possible to completely understand the system.  Who can say they
31         completely understand how Linux works, or gcc?
32
33         Secondly FORTH has a peculiar bootstrapping property.  By that I mean that after writing
34         a little bit of assembly to talk to the hardware and implement a few primitives, all the
35         rest of the language and compiler is written in FORTH itself.  Remember I said before
36         that FORTH lacked IF-statements and loops?  Well of course it doesn't really because
37         such a lanuage would be useless, but my point was rather that IF-statements and loops are
38         written in FORTH itself.
39
40         Now of course this is common in other languages as well, and in those languages we call
41         them 'libraries'.  For example in C, 'printf' is a library function written in C.  But
42         in FORTH this goes way beyond mere libraries.  Can you imagine writing C's 'if' in C?
43         And that brings me to my third reason: If you can write 'if' in FORTH, then why restrict
44         yourself to the usual if/while/for/switch constructs?  You want a construct that iterates
45         over every other element in a list of numbers?  You can add it to the language.  What
46         about an operator which pulls in variables directly from a configuration file and makes
47         them available as FORTH variables?  Or how about adding Makefile-like dependencies to
48         the language?  No problem in FORTH.  This concept isn't common in programming languages,
49         but it has a name (in fact two names): "macros" (by which I mean LISP-style macros, not
50         the lame C preprocessor) and "domain specific languages" (DSLs).
51
52         This tutorial isn't about learning FORTH as the language.  I'll point you to some references
53         you should read if you're not familiar with using FORTH.  This tutorial is about how to
54         write FORTH.  In fact, until you understand how FORTH is written, you'll have only a very
55         superficial understanding of how to use it.
56
57         So if you're not familiar with FORTH or want to refresh your memory here are some online
58         references to read:
59
60         http://en.wikipedia.org/wiki/Forth_%28programming_language%29
61
62         http://galileo.phys.virginia.edu/classes/551.jvn.fall01/primer.htm
63
64         http://wiki.laptop.org/go/Forth_Lessons
65
66         http://www.albany.net/~hello/simple.htm
67
68         Here is another "Why FORTH?" essay: http://www.jwdt.com/~paysan/why-forth.html
69
70         Discussion and criticism of this FORTH here: http://lambda-the-ultimate.org/node/2452
71
72         ACKNOWLEDGEMENTS ----------------------------------------------------------------------
73
74         This code draws heavily on the design of LINA FORTH (http://home.hccnet.nl/a.w.m.van.der.horst/lina.html)
75         by Albert van der Horst.  Any similarities in the code are probably not accidental.
76
77         Also I used this document (http://ftp.funet.fi/pub/doc/IOCCC/1992/buzzard.2.design) which really
78         defies easy explanation.
79
80         PUBLIC DOMAIN ----------------------------------------------------------------------
81
82         I, the copyright holder of this work, hereby release it into the public domain. This applies worldwide.
83
84         In case this is not legally possible, I grant any entity the right to use this work for any purpose,
85         without any conditions, unless such conditions are required by law.
86
87         SETTING UP ----------------------------------------------------------------------
88
89         Let's get a few housekeeping things out of the way.  Firstly because I need to draw lots of
90         ASCII-art diagrams to explain concepts, the best way to look at this is using a window which
91         uses a fixed width font and is at least this wide:
92
93  <------------------------------------------------------------------------------------------------------------------------>
94
95         Secondly make sure TABS are set to 8 characters.  The following should be a vertical
96         line.  If not, sort out your tabs.
97
98         |
99         |
100         |
101
102         Thirdly I assume that your screen is at least 50 characters high.
103
104         ASSEMBLING ----------------------------------------------------------------------
105
106         If you want to actually run this FORTH, rather than just read it, you will need Linux on an
107         i386.  Linux because instead of programming directly to the hardware on a bare PC which I
108         could have done, I went for a simpler tutorial by assuming that the 'hardware' is a Linux
109         process with a few basic system calls (read, write and exit and that's about all).  i386
110         is needed because I had to write the assembly for a processor, and i386 is by far the most
111         common.  (Of course when I say 'i386', any 32- or 64-bit x86 processor will do.  I'm compiling
112         this on a 64 bit AMD Opteron).
113
114         Again, to assemble this you will need gcc and gas (the GNU assembler).  The commands to
115         assemble and run the code (save this file as 'jonesforth.S') are:
116
117         gcc -m32 -nostdlib -static -Wl,-Ttext,0 -o jonesforth jonesforth.S
118         ./jonesforth
119
120         You will see lots of 'Warning: unterminated string; newline inserted' messages from the
121         assembler.  That's just because the GNU assembler doesn't have a good syntax for multi-line
122         strings (or rather it used to, but the developers removed it!) so I've abused the syntax
123         slightly to make things readable.  Ignore these warnings.
124
125         If you want to run your own FORTH programs you can do:
126
127         ./jonesforth < myprog.f
128
129         If you want to load your own FORTH code and then continue reading user commands, you can do:
130
131         cat myfunctions.f - | ./jonesforth
132
133         ASSEMBLER ----------------------------------------------------------------------
134
135         (You can just skip to the next section -- you don't need to be able to read assembler to
136         follow this tutorial).
137
138         However if you do want to read the assembly code here are a few notes about gas (the GNU assembler):
139
140         (1) Register names are prefixed with '%', so %eax is the 32 bit i386 accumulator.  The registers
141             available on i386 are: %eax, %ebx, %ecx, %edx, %esi, %edi, %ebp and %esp, and most of them
142             have special purposes.
143
144         (2) Add, mov, etc. take arguments in the form SRC,DEST.  So mov %eax,%ecx moves %eax -> %ecx
145
146         (3) Constants are prefixed with '$', and you mustn't forget it!  If you forget it then it
147             causes a read from memory instead, so:
148             mov $2,%eax         moves number 2 into %eax
149             mov 2,%eax          reads the 32 bit word from address 2 into %eax (ie. most likely a mistake)
150
151         (4) gas has a funky syntax for local labels, where '1f' (etc.) means label '1:' "forwards"
152             and '1b' (etc.) means label '1:' "backwards".
153
154         (5) 'ja' is "jump if above", 'jb' for "jump if below", 'je' "jump if equal" etc.
155
156         (6) gas has a reasonably nice .macro syntax, and I use them a lot to make the code shorter and
157             less repetitive.
158
159         For more help reading the assembler, do "info gas" at the Linux prompt.
160
161         Now the tutorial starts in earnest.
162
163         THE DICTIONARY ----------------------------------------------------------------------
164
165         In FORTH as you will know, functions are called "words", and just as in other languages they
166         have a name and a definition.  Here are two FORTH words:
167
168         : DOUBLE DUP + ;                \ name is "DOUBLE", definition is "DUP +"
169         : QUADRUPLE DOUBLE DOUBLE ;     \ name is "QUADRUPLE", definition is "DOUBLE DOUBLE"
170
171         Words, both built-in ones and ones which the programmer defines later, are stored in a dictionary
172         which is just a linked list of dictionary entries.
173
174         <--- DICTIONARY ENTRY (HEADER) ----------------------->
175         +------------------------+--------+---------- - - - - +----------- - - - -
176         | LINK POINTER           | LENGTH/| NAME              | DEFINITION
177         |                        | FLAGS  |                   |
178         +--- (4 bytes) ----------+- byte -+- n bytes  - - - - +----------- - - - -
179
180         I'll come to the definition of the word later.  For now just look at the header.  The first
181         4 bytes are the link pointer.  This points back to the previous word in the dictionary, or, for
182         the first word in the dictionary it is just a NULL pointer.  Then comes a length/flags byte.
183         The length of the word can be up to 31 characters (5 bits used) and the top three bits are used
184         for various flags which I'll come to later.  This is followed by the name itself, and in this
185         implementation the name is rounded up to a multiple of 4 bytes by padding it with zero bytes.
186         That's just to ensure that the definition starts on a 32 bit boundary.
187
188         A FORTH variable called LATEST contains a pointer to the most recently defined word, in
189         other words, the head of this linked list.
190
191         DOUBLE and QUADRUPLE might look like this:
192
193           pointer to previous word
194            ^
195            |
196         +--|------+---+---+---+---+---+---+---+---+------------- - - - -
197         | LINK    | 6 | D | O | U | B | L | E | 0 | (definition ...)
198         +---------+---+---+---+---+---+---+---+---+------------- - - - -
199            ^       len                         padding
200            |
201         +--|------+---+---+---+---+---+---+---+---+---+---+---+---+------------- - - - -
202         | LINK    | 9 | Q | U | A | D | R | U | P | L | E | 0 | 0 | (definition ...)
203         +---------+---+---+---+---+---+---+---+---+---+---+---+---+------------- - - - -
204            ^       len                                     padding
205            |
206            |
207           LATEST
208
209         You should be able to see from this how you might implement functions to find a word in
210         the dictionary (just walk along the dictionary entries starting at LATEST and matching
211         the names until you either find a match or hit the NULL pointer at the end of the dictionary);
212         and add a word to the dictionary (create a new definition, set its LINK to LATEST, and set
213         LATEST to point to the new word).  We'll see precisely these functions implemented in
214         assembly code later on.
215
216         One interesting consequence of using a linked list is that you can redefine words, and
217         a newer definition of a word overrides an older one.  This is an important concept in
218         FORTH because it means that any word (even "built-in" or "standard" words) can be
219         overridden with a new definition, either to enhance it, to make it faster or even to
220         disable it.  However because of the way that FORTH words get compiled, which you'll
221         understand below, words defined using the old definition of a word continue to use
222         the old definition.  Only words defined after the new definition use the new definition.
223
224         DIRECT THREADED CODE ----------------------------------------------------------------------
225
226         Now we'll get to the really crucial bit in understanding FORTH, so go and get a cup of tea
227         or coffee and settle down.  It's fair to say that if you don't understand this section, then you
228         won't "get" how FORTH works, and that would be a failure on my part for not explaining it well.
229         So if after reading this section a few times you don't understand it, please email me
230         (rich@annexia.org).
231
232         Let's talk first about what "threaded code" means.  Imagine a peculiar version of C where
233         you are only allowed to call functions without arguments.  (Don't worry for now that such a
234         language would be completely useless!)  So in our peculiar C, code would look like this:
235
236         f ()
237         {
238           a ();
239           b ();
240           c ();
241         }
242
243         and so on.  How would a function, say 'f' above, be compiled by a standard C compiler?
244         Probably into assembly code like this.  On the right hand side I've written the actual
245         i386 machine code.
246
247         f:
248           CALL a                        E8 08 00 00 00
249           CALL b                        E8 1C 00 00 00
250           CALL c                        E8 2C 00 00 00
251           ; ignore the return from the function for now
252
253         "E8" is the x86 machine code to "CALL" a function.  In the first 20 years of computing
254         memory was hideously expensive and we might have worried about the wasted space being used
255         by the repeated "E8" bytes.  We can save 20% in code size (and therefore, in expensive memory)
256         by compressing this into just:
257
258         08 00 00 00             Just the function addresses, without
259         1C 00 00 00             the CALL prefix.
260         2C 00 00 00
261
262         On a 16-bit machine like the ones which originally ran FORTH the savings are even greater - 33%.
263
264         [Historical note: If the execution model that FORTH uses looks strange from the following
265         paragraphs, then it was motivated entirely by the need to save memory on early computers.
266         This code compression isn't so important now when our machines have more memory in their L1
267         caches than those early computers had in total, but the execution model still has some
268         useful properties].
269
270         Of course this code won't run directly any more.  Instead we need to write an interpreter
271         which takes each pair of bytes and calls it.
272
273         On an i386 machine it turns out that we can write this interpreter rather easily, in just
274         two assembly instructions which turn into just 3 bytes of machine code.  Let's store the
275         pointer to the next word to execute in the %esi register:
276
277                 08 00 00 00     <- We're executing this one now.  %esi is the _next_ one to execute.
278         %esi -> 1C 00 00 00
279                 2C 00 00 00
280
281         The all-important i386 instruction is called LODSL (or in Intel manuals, LODSW).  It does
282         two things.  Firstly it reads the memory at %esi into the accumulator (%eax).  Secondly it
283         increments %esi by 4 bytes.  So after LODSL, the situation now looks like this:
284
285                 08 00 00 00     <- We're still executing this one
286                 1C 00 00 00     <- %eax now contains this address (0x0000001C)
287         %esi -> 2C 00 00 00
288
289         Now we just need to jump to the address in %eax.  This is again just a single x86 instruction
290         written JMP *(%eax).  And after doing the jump, the situation looks like:
291
292                 08 00 00 00
293                 1C 00 00 00     <- Now we're executing this subroutine.
294         %esi -> 2C 00 00 00
295
296         To make this work, each subroutine is followed by the two instructions 'LODSL; JMP *(%eax)'
297         which literally make the jump to the next subroutine.
298
299         And that brings us to our first piece of actual code!  Well, it's a macro.
300 */
301
302 /* NEXT macro. */
303         .macro NEXT
304         lodsl
305         jmp *(%eax)
306         .endm
307
308 /*      The macro is called NEXT.  That's a FORTH-ism.  It expands to those two instructions.
309
310         Every FORTH primitive that we write has to be ended by NEXT.  Think of it kind of like
311         a return.
312
313         The above describes what is known as direct threaded code.
314
315         To sum up: We compress our function calls down to a list of addresses and use a somewhat
316         magical macro to act as a "jump to next function in the list".  We also use one register (%esi)
317         to act as a kind of instruction pointer, pointing to the next function in the list.
318
319         I'll just give you a hint of what is to come by saying that a FORTH definition such as:
320
321         : QUADRUPLE DOUBLE DOUBLE ;
322
323         actually compiles (almost, not precisely but we'll see why in a moment) to a list of
324         function addresses for DOUBLE, DOUBLE and a special function called EXIT to finish off.
325
326         At this point, REALLY EAGLE-EYED ASSEMBLY EXPERTS are saying "JONES, YOU'VE MADE A MISTAKE!".
327
328         I lied about JMP *(%eax).  
329
330         INDIRECT THREADED CODE ----------------------------------------------------------------------
331
332         It turns out that direct threaded code is interesting but only if you want to just execute
333         a list of functions written in assembly language.  So QUADRUPLE would work only if DOUBLE
334         was an assembly language function.  In the direct threaded code, QUADRUPLE would look like:
335
336                 +------------------+
337                 | addr of DOUBLE  --------------------> (assembly code to do the double)
338                 +------------------+                    NEXT
339         %esi -> | addr of DOUBLE   |
340                 +------------------+
341
342         We can add an extra indirection to allow us to run both words written in assembly language
343         (primitives written for speed) and words written in FORTH themselves as lists of addresses.
344
345         The extra indirection is the reason for the brackets in JMP *(%eax).
346
347         Let's have a look at how QUADRUPLE and DOUBLE really look in FORTH:
348
349                 : QUADRUPLE DOUBLE DOUBLE ;
350
351                 +------------------+
352                 | codeword         |               : DOUBLE DUP + ;
353                 +------------------+
354                 | addr of DOUBLE  ---------------> +------------------+
355                 +------------------+               | codeword         |
356                 | addr of DOUBLE   |               +------------------+
357                 +------------------+               | addr of DUP   --------------> +------------------+
358                 | addr of EXIT     |               +------------------+            | codeword      -------+
359                 +------------------+       %esi -> | addr of +     --------+       +------------------+   |
360                                                    +------------------+    |       | assembly to    <-----+
361                                                    | addr of EXIT     |    |       | implement DUP    |
362                                                    +------------------+    |       |    ..            |
363                                                                            |       |    ..            |
364                                                                            |       | NEXT             |
365                                                                            |       +------------------+
366                                                                            |
367                                                                            +-----> +------------------+
368                                                                                    | codeword      -------+
369                                                                                    +------------------+   |
370                                                                                    | assembly to   <------+
371                                                                                    | implement +      |
372                                                                                    |    ..            |
373                                                                                    |    ..            |
374                                                                                    | NEXT             |
375                                                                                    +------------------+
376
377         This is the part where you may need an extra cup of tea/coffee/favourite caffeinated
378         beverage.  What has changed is that I've added an extra pointer to the beginning of
379         the definitions.  In FORTH this is sometimes called the "codeword".  The codeword is
380         a pointer to the interpreter to run the function.  For primitives written in
381         assembly language, the "interpreter" just points to the actual assembly code itself.
382         They don't need interpreting, they just run.
383
384         In words written in FORTH (like QUADRUPLE and DOUBLE), the codeword points to an interpreter
385         function.
386
387         I'll show you the interpreter function shortly, but let's recall our indirect
388         JMP *(%eax) with the "extra" brackets.  Take the case where we're executing DOUBLE
389         as shown, and DUP has been called.  Note that %esi is pointing to the address of +
390
391         The assembly code for DUP eventually does a NEXT.  That:
392
393         (1) reads the address of + into %eax            %eax points to the codeword of +
394         (2) increments %esi by 4
395         (3) jumps to the indirect %eax                  jumps to the address in the codeword of +,
396                                                         ie. the assembly code to implement +
397
398                 +------------------+
399                 | codeword         |
400                 +------------------+
401                 | addr of DOUBLE  ---------------> +------------------+
402                 +------------------+               | codeword         |
403                 | addr of DOUBLE   |               +------------------+
404                 +------------------+               | addr of DUP   --------------> +------------------+
405                 | addr of EXIT     |               +------------------+            | codeword      -------+
406                 +------------------+               | addr of +     --------+       +------------------+   |
407                                                    +------------------+    |       | assembly to    <-----+
408                                            %esi -> | addr of EXIT     |    |       | implement DUP    |
409                                                    +------------------+    |       |    ..            |
410                                                                            |       |    ..            |
411                                                                            |       | NEXT             |
412                                                                            |       +------------------+
413                                                                            |
414                                                                            +-----> +------------------+
415                                                                                    | codeword      -------+
416                                                                                    +------------------+   |
417                                                                         now we're  | assembly to    <-----+
418                                                                         executing  | implement +      |
419                                                                         this       |    ..            |
420                                                                         function   |    ..            |
421                                                                                    | NEXT             |
422                                                                                    +------------------+
423
424         So I hope that I've convinced you that NEXT does roughly what you'd expect.  This is
425         indirect threaded code.
426
427         I've glossed over four things.  I wonder if you can guess without reading on what they are?
428
429         .
430         .
431         .
432
433         My list of four things are: (1) What does "EXIT" do?  (2) which is related to (1) is how do
434         you call into a function, ie. how does %esi start off pointing at part of QUADRUPLE, but
435         then point at part of DOUBLE.  (3) What goes in the codeword for the words which are written
436         in FORTH?  (4) How do you compile a function which does anything except call other functions
437         ie. a function which contains a number like : DOUBLE 2 * ; ?
438
439         THE INTERPRETER AND RETURN STACK ------------------------------------------------------------
440
441         Going at these in no particular order, let's talk about issues (3) and (2), the interpreter
442         and the return stack.
443
444         Words which are defined in FORTH need a codeword which points to a little bit of code to
445         give them a "helping hand" in life.  They don't need much, but they do need what is known
446         as an "interpreter", although it doesn't really "interpret" in the same way that, say,
447         Java bytecode used to be interpreted (ie. slowly).  This interpreter just sets up a few
448         machine registers so that the word can then execute at full speed using the indirect
449         threaded model above.
450
451         One of the things that needs to happen when QUADRUPLE calls DOUBLE is that we save the old
452         %esi ("instruction pointer") and create a new one pointing to the first word in DOUBLE.
453         Because we will need to restore the old %esi at the end of DOUBLE (this is, after all, like
454         a function call), we will need a stack to store these "return addresses" (old values of %esi).
455
456         As you will have read, when reading the background documentation, FORTH has two stacks,
457         an ordinary stack for parameters, and a return stack which is a bit more mysterious.  But
458         our return stack is just the stack I talked about in the previous paragraph, used to save
459         %esi when calling from a FORTH word into another FORTH word.
460
461         In this FORTH, we are using the normal stack pointer (%esp) for the parameter stack.
462         We will use the i386's "other" stack pointer (%ebp, usually called the "frame pointer")
463         for our return stack.
464
465         I've got two macros which just wrap up the details of using %ebp for the return stack.
466         You use them as for example "PUSHRSP %eax" (push %eax on the return stack) or "POPRSP %ebx"
467         (pop top of return stack into %ebx).
468 */
469
470 /* Macros to deal with the return stack. */
471         .macro PUSHRSP reg
472         lea -4(%ebp),%ebp       // push reg on to return stack
473         movl \reg,(%ebp)
474         .endm
475
476         .macro POPRSP reg
477         mov (%ebp),\reg         // pop top of return stack to reg
478         lea 4(%ebp),%ebp
479         .endm
480
481 /*
482         And with that we can now talk about the interpreter.
483
484         In FORTH the interpreter function is often called DOCOL (I think it means "DO COLON" because
485         all FORTH definitions start with a colon, as in : DOUBLE DUP + ;
486
487         The "interpreter" (it's not really "interpreting") just needs to push the old %esi on the
488         stack and set %esi to the first word in the definition.  Remember that we jumped to the
489         function using JMP *(%eax)?  Well a consequence of that is that conveniently %eax contains
490         the address of this codeword, so just by adding 4 to it we get the address of the first
491         data word.  Finally after setting up %esi, it just does NEXT which causes that first word
492         to run.
493 */
494
495 /* DOCOL - the interpreter! */
496         .text
497         .align 4
498 DOCOL:
499         PUSHRSP %esi            // push %esi on to the return stack
500         addl $4,%eax            // %eax points to codeword, so make
501         movl %eax,%esi          // %esi point to first data word
502         NEXT
503
504 /*
505         Just to make this absolutely clear, let's see how DOCOL works when jumping from QUADRUPLE
506         into DOUBLE:
507
508                 QUADRUPLE:
509                 +------------------+
510                 | codeword         |
511                 +------------------+               DOUBLE:
512                 | addr of DOUBLE  ---------------> +------------------+
513                 +------------------+       %eax -> | addr of DOCOL    |
514         %esi -> | addr of DOUBLE   |               +------------------+
515                 +------------------+               | addr of DUP      |
516                 | addr of EXIT     |               +------------------+
517                 +------------------+               | etc.             |
518
519         First, the call to DOUBLE calls DOCOL (the codeword of DOUBLE).  DOCOL does this:  It
520         pushes the old %esi on the return stack.  %eax points to the codeword of DOUBLE, so we
521         just add 4 on to it to get our new %esi:
522
523                 QUADRUPLE:
524                 +------------------+
525                 | codeword         |
526                 +------------------+               DOUBLE:
527                 | addr of DOUBLE  ---------------> +------------------+
528 top of return   +------------------+       %eax -> | addr of DOCOL    |
529 stack points -> | addr of DOUBLE   |       + 4 =   +------------------+
530                 +------------------+       %esi -> | addr of DUP      |
531                 | addr of EXIT     |               +------------------+
532                 +------------------+               | etc.             |
533
534         Then we do NEXT, and because of the magic of threaded code that increments %esi again
535         and calls DUP.
536
537         Well, it seems to work.
538
539         One minor point here.  Because DOCOL is the first bit of assembly actually to be defined
540         in this file (the others were just macros), and because I usually compile this code with the
541         text segment starting at address 0, DOCOL has address 0.  So if you are disassembling the
542         code and see a word with a codeword of 0, you will immediately know that the word is
543         written in FORTH (it's not an assembler primitive) and so uses DOCOL as the interpreter.
544
545         STARTING UP ----------------------------------------------------------------------
546
547         Now let's get down to nuts and bolts.  When we start the program we need to set up
548         a few things like the return stack.  But as soon as we can, we want to jump into FORTH
549         code (albeit much of the "early" FORTH code will still need to be written as
550         assembly language primitives).
551
552         This is what the set up code does.  Does a tiny bit of house-keeping, sets up the
553         separate return stack (NB: Linux gives us the ordinary parameter stack already), then
554         immediately jumps to a FORTH word called COLD.  COLD stands for cold-start.  In ISO
555         FORTH (but not in this FORTH), COLD can be called at any time to completely reset
556         the state of FORTH, and there is another word called WARM which does a partial reset.
557 */
558
559 /* ELF entry point. */
560         .text
561         .globl _start
562 _start:
563         cld
564         mov %esp,var_S0         // Store the initial data stack pointer.
565         mov $return_stack,%ebp  // Initialise the return stack.
566
567         mov $cold_start,%esi    // Initialise interpreter.
568         NEXT                    // Run interpreter!
569
570         .section .rodata
571 cold_start:                     // High-level code without a codeword.
572         .int COLD
573
574 /*
575         We also allocate some space for the return stack and some space to store user
576         definitions.  These are static memory allocations using fixed-size buffers, but it
577         wouldn't be a great deal of work to make them dynamic.
578 */
579
580         .bss
581 /* FORTH return stack. */
582         .set RETURN_STACK_SIZE,8192
583         .align 4096
584         .space RETURN_STACK_SIZE
585 return_stack:                   // Initial top of return stack.
586
587 /* The user definitions area: space for user-defined words and general memory allocations. */
588         .set USER_DEFS_SIZE,65536
589         .align 4096
590 user_defs_start:
591         .space USER_DEFS_SIZE
592
593 /*
594         BUILT-IN WORDS ----------------------------------------------------------------------
595
596         Remember our dictionary entries (headers).  Let's bring those together with the codeword
597         and data words to see how : DOUBLE DUP + ; really looks in memory.
598
599           pointer to previous word
600            ^
601            |
602         +--|------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
603         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        | +          | EXIT       |
604         +---------+---+---+---+---+---+---+---+---+------------+--|---------+------------+------------+
605            ^       len                         pad  codeword      |
606            |                                                      V
607           LINK in next word                             points to codeword of DUP
608         
609         Initially we can't just write ": DOUBLE DUP + ;" (ie. that literal string) here because we
610         don't yet have anything to read the string, break it up at spaces, parse each word, etc. etc.
611         So instead we will have to define built-in words using the GNU assembler data constructors
612         (like .int, .byte, .string, .ascii and so on -- look them up in the gas info page if you are
613         unsure of them).
614
615         The long way would be:
616         .int <link to previous word>
617         .byte 6                 // len
618         .ascii "DOUBLE"         // string
619         .byte 0                 // padding
620 DOUBLE: .int DOCOL              // codeword
621         .int DUP                // pointer to codeword of DUP
622         .int PLUS               // pointer to codeword of +
623         .int EXIT               // pointer to codeword of EXIT
624
625         That's going to get quite tedious rather quickly, so here I define an assembler macro
626         so that I can just write:
627
628         defword "DOUBLE",6,,DOUBLE
629         .int DUP,PLUS,EXIT
630
631         and I'll get exactly the same effect.
632
633         Don't worry too much about the exact implementation details of this macro - it's complicated!
634 */
635
636 /* Flags - these are discussed later. */
637         .set F_IMMED,0x80
638         .set F_HIDDEN,0x20
639         .set F_LENMASK,0x1f     // length mask
640
641         // Store the chain of links.
642         .set link,0
643
644         .macro defword name, namelen, flags=0, label
645         .section .rodata
646         .align 4
647         .globl name_\label
648 name_\label :
649         .int link               // link
650         .set link,name_\label
651         .byte \flags+\namelen   // flags + length byte
652         .ascii "\name"          // the name
653         .align 4
654         .globl \label
655 \label :
656         .int DOCOL              // codeword - the interpreter
657         // list of word pointers follow
658         .endm
659
660 /*
661         Similarly I want a way to write words written in assembly language.  There will quite a few
662         of these to start with because, well, everything has to start in assembly before there's
663         enough "infrastructure" to be able to start writing FORTH words, but also I want to define
664         some common FORTH words in assembly language for speed, even though I could write them in FORTH.
665
666         This is what DUP looks like in memory:
667
668           pointer to previous word
669            ^
670            |
671         +--|------+---+---+---+---+------------+
672         | LINK    | 3 | D | U | P | code_DUP ---------------------> points to the assembly
673         +---------+---+---+---+---+------------+                    code used to write DUP,
674            ^       len              codeword                        which ends with NEXT.
675            |
676           LINK in next word
677
678         Again, for brevity in writing the header I'm going to write an assembler macro called defcode.
679 */
680
681         .macro defcode name, namelen, flags=0, label
682         .section .rodata
683         .align 4
684         .globl name_\label
685 name_\label :
686         .int link               // link
687         .set link,name_\label
688         .byte \flags+\namelen   // flags + length byte
689         .ascii "\name"          // the name
690         .align 4
691         .globl \label
692 \label :
693         .int code_\label        // codeword
694         .text
695         .align 4
696         .globl code_\label
697 code_\label :                   // assembler code follows
698         .endm
699
700 /*
701         Now some easy FORTH primitives.  These are written in assembly for speed.  If you understand
702         i386 assembly language then it is worth reading these.  However if you don't understand assembly
703         you can skip the details.
704 */
705
706         defcode "DUP",3,,DUP
707         pop %eax                // duplicate top of stack
708         push %eax
709         push %eax
710         NEXT
711
712         defcode "DROP",4,,DROP
713         pop %eax                // drop top of stack
714         NEXT
715
716         defcode "SWAP",4,,SWAP
717         pop %eax                // swap top of stack
718         pop %ebx
719         push %eax
720         push %ebx
721         NEXT
722
723         defcode "OVER",4,,OVER
724         mov 4(%esp),%eax        // get the second element of stack
725         push %eax               // and push it on top
726         NEXT
727
728         defcode "ROT",3,,ROT
729         pop %eax
730         pop %ebx
731         pop %ecx
732         push %eax
733         push %ecx
734         push %ebx
735         NEXT
736
737         defcode "-ROT",4,,NROT
738         pop %eax
739         pop %ebx
740         pop %ecx
741         push %ebx
742         push %eax
743         push %ecx
744         NEXT
745
746         defcode "1+",2,,INCR
747         incl (%esp)             // increment top of stack
748         NEXT
749
750         defcode "1-",2,,DECR
751         decl (%esp)             // decrement top of stack
752         NEXT
753
754         defcode "4+",2,,INCR4
755         addl $4,(%esp)          // add 4 to top of stack
756         NEXT
757
758         defcode "4-",2,,DECR4
759         subl $4,(%esp)          // subtract 4 from top of stack
760         NEXT
761
762         defcode "+",1,,ADD
763         pop %eax                // get top of stack
764         addl %eax,(%esp)        // and add it to next word on stack
765         NEXT
766
767         defcode "-",1,,SUB
768         pop %eax                // get top of stack
769         subl %eax,(%esp)        // and subtract it from next word on stack
770         NEXT
771
772         defcode "*",1,,MUL
773         pop %eax
774         pop %ebx
775         imull %ebx,%eax
776         push %eax               // ignore overflow
777         NEXT
778
779         defcode "/",1,,DIV
780         xor %edx,%edx
781         pop %ebx
782         pop %eax
783         idivl %ebx
784         push %eax               // push quotient
785         NEXT
786
787         defcode "MOD",3,,MOD
788         xor %edx,%edx
789         pop %ebx
790         pop %eax
791         idivl %ebx
792         push %edx               // push remainder
793         NEXT
794
795         defcode "=",1,,EQU      // top two words are equal?
796         pop %eax
797         pop %ebx
798         cmp %ebx,%eax
799         je 1f
800         pushl $0
801         NEXT
802 1:      pushl $1
803         NEXT
804
805         defcode "<>",2,,NEQU    // top two words are not equal?
806         pop %eax
807         pop %ebx
808         cmp %ebx,%eax
809         je 1f
810         pushl $1
811         NEXT
812 1:      pushl $0
813         NEXT
814
815         defcode "<",1,,LT
816         pop %eax
817         pop %ebx
818         cmp %eax,%ebx
819         jl 1f
820         pushl $0
821         NEXT
822 1:      pushl $1
823         NEXT
824
825         defcode ">",1,,GT
826         pop %eax
827         pop %ebx
828         cmp %eax,%ebx
829         jg 1f
830         pushl $0
831         NEXT
832 1:      pushl $1
833         NEXT
834
835         defcode "<=",2,,LE
836         pop %eax
837         pop %ebx
838         cmp %eax,%ebx
839         jle 1f
840         pushl $0
841         NEXT
842 1:      pushl $1
843         NEXT
844
845         defcode ">=",2,,GE
846         pop %eax
847         pop %ebx
848         cmp %eax,%ebx
849         jge 1f
850         pushl $0
851         NEXT
852 1:      pushl $1
853         NEXT
854
855         defcode "0=",2,,ZEQU    // top of stack equals 0?
856         pop %eax
857         test %eax,%eax
858         jz 1f
859         pushl $0
860         NEXT
861 1:      pushl $1
862         NEXT
863
864         defcode "0<>",3,,ZNEQU  // top of stack not 0?
865         pop %eax
866         test %eax,%eax
867         jnz 1f
868         pushl $0
869         NEXT
870 1:      pushl $1
871         NEXT
872
873         defcode "0<",2,,ZLT
874         pop %eax
875         test %eax,%eax
876         jl 1f
877         pushl $0
878         NEXT
879 1:      pushl $1
880         NEXT
881
882         defcode "0>",2,,ZGT
883         pop %eax
884         test %eax,%eax
885         jg 1f
886         pushl $0
887         NEXT
888 1:      pushl $1
889         NEXT
890
891         defcode "0<=",3,,ZLE
892         pop %eax
893         test %eax,%eax
894         jle 1f
895         pushl $0
896         NEXT
897 1:      pushl $1
898         NEXT
899
900         defcode "0>=",3,,ZGE
901         pop %eax
902         test %eax,%eax
903         jge 1f
904         pushl $0
905         NEXT
906 1:      pushl $1
907         NEXT
908
909         defcode "AND",3,,AND
910         pop %eax
911         andl %eax,(%esp)
912         NEXT
913
914         defcode "OR",2,,OR
915         pop %eax
916         orl %eax,(%esp)
917         NEXT
918
919         defcode "XOR",3,,XOR
920         pop %eax
921         xorl %eax,(%esp)
922         NEXT
923
924         defcode "INVERT",6,,INVERT // this is the FORTH bitwise "NOT" function
925         notl (%esp)
926         NEXT
927
928 /*
929         RETURNING FROM FORTH WORDS ----------------------------------------------------------------------
930
931         Time to talk about what happens when we EXIT a function.  In this diagram QUADRUPLE has called
932         DOUBLE, and DOUBLE is about to exit (look at where %esi is pointing):
933
934                 QUADRUPLE
935                 +------------------+
936                 | codeword         |
937                 +------------------+               DOUBLE
938                 | addr of DOUBLE  ---------------> +------------------+
939                 +------------------+               | codeword         |
940                 | addr of DOUBLE   |               +------------------+
941                 +------------------+               | addr of DUP      |
942                 | addr of EXIT     |               +------------------+
943                 +------------------+               | addr of +        |
944                                                    +------------------+
945                                            %esi -> | addr of EXIT     |
946                                                    +------------------+
947
948         What happens when the + function does NEXT?  Well, the following code is executed.
949 */
950
951         defcode "EXIT",4,,EXIT
952         POPRSP %esi             // pop return stack into %esi
953         NEXT
954
955 /*
956         EXIT gets the old %esi which we saved from before on the return stack, and puts it in %esi.
957         So after this (but just before NEXT) we get:
958
959                 QUADRUPLE
960                 +------------------+
961                 | codeword         |
962                 +------------------+               DOUBLE
963                 | addr of DOUBLE  ---------------> +------------------+
964                 +------------------+               | codeword         |
965         %esi -> | addr of DOUBLE   |               +------------------+
966                 +------------------+               | addr of DUP      |
967                 | addr of EXIT     |               +------------------+
968                 +------------------+               | addr of +        |
969                                                    +------------------+
970                                                    | addr of EXIT     |
971                                                    +------------------+
972
973         And NEXT just completes the job by, well in this case just by calling DOUBLE again :-)
974
975         LITERALS ----------------------------------------------------------------------
976
977         The final point I "glossed over" before was how to deal with functions that do anything
978         apart from calling other functions.  For example, suppose that DOUBLE was defined like this:
979
980         : DOUBLE 2 * ;
981
982         It does the same thing, but how do we compile it since it contains the literal 2?  One way
983         would be to have a function called "2" (which you'd have to write in assembler), but you'd need
984         a function for every single literal that you wanted to use.
985
986         FORTH solves this by compiling the function using a special word called LIT:
987
988         +---------------------------+-------+-------+-------+-------+-------+
989         | (usual header of DOUBLE)  | DOCOL | LIT   | 2     | *     | EXIT  |
990         +---------------------------+-------+-------+-------+-------+-------+
991
992         LIT is executed in the normal way, but what it does next is definitely not normal.  It
993         looks at %esi (which now points to the literal 2), grabs it, pushes it on the stack, then
994         manipulates %esi in order to skip the literal as if it had never been there.
995
996         What's neat is that the whole grab/manipulate can be done using a single byte single
997         i386 instruction, our old friend LODSL.  Rather than me drawing more ASCII-art diagrams,
998         see if you can find out how LIT works:
999 */
1000
1001         defcode "LIT",3,,LIT
1002         // %esi points to the next command, but in this case it points to the next
1003         // literal 32 bit integer.  Get that literal into %eax and increment %esi.
1004         // On x86, it's a convenient single byte instruction!  (cf. NEXT macro)
1005         lodsl
1006         push %eax               // push the literal number on to stack
1007         NEXT
1008
1009 /*
1010         MEMORY ----------------------------------------------------------------------
1011
1012         As important point about FORTH is that it gives you direct access to the lowest levels
1013         of the machine.  Manipulating memory directly is done frequently in FORTH, and these are
1014         the primitive words for doing it.
1015 */
1016
1017         defcode "!",1,,STORE
1018         pop %ebx                // address to store at
1019         pop %eax                // data to store there
1020         mov %eax,(%ebx)         // store it
1021         NEXT
1022
1023         defcode "@",1,,FETCH
1024         pop %ebx                // address to fetch
1025         mov (%ebx),%eax         // fetch it
1026         push %eax               // push value onto stack
1027         NEXT
1028
1029         defcode "+!",2,,ADDSTORE
1030         pop %ebx                // address
1031         pop %eax                // the amount to add
1032         addl %eax,(%ebx)        // add it
1033         NEXT
1034
1035         defcode "-!",2,,SUBSTORE
1036         pop %ebx                // address
1037         pop %eax                // the amount to subtract
1038         subl %eax,(%ebx)        // add it
1039         NEXT
1040
1041 /* ! and @ (STORE and FETCH) store 32-bit words.  It's also useful to be able to read and write bytes.
1042  * I don't know whether FORTH has these words, so I invented my own, called !b and @b.
1043  * Byte-oriented operations only work on architectures which permit them (i386 is one of those).
1044  * UPDATE: writing a byte to the dictionary pointer is called C, in FORTH.
1045  */
1046         defcode "!b",2,,STOREBYTE
1047         pop %ebx                // address to store at
1048         pop %eax                // data to store there
1049         movb %al,(%ebx)         // store it
1050         NEXT
1051
1052         defcode "@b",2,,FETCHBYTE
1053         pop %ebx                // address to fetch
1054         xor %eax,%eax
1055         movb (%ebx),%al         // fetch it
1056         push %eax               // push value onto stack
1057         NEXT
1058
1059 /*
1060         BUILT-IN VARIABLES ----------------------------------------------------------------------
1061
1062         These are some built-in variables and related standard FORTH words.  Of these, the only one that we
1063         have discussed so far was LATEST, which points to the last (most recently defined) word in the
1064         FORTH dictionary.  LATEST is also a FORTH word which pushes the address of LATEST (the variable)
1065         on to the stack, so you can read or write it using @ and ! operators.  For example, to print
1066         the current value of LATEST (and this can apply to any FORTH variable) you would do:
1067
1068         LATEST @ . CR
1069
1070         To make defining variables shorter, I'm using a macro called defvar, similar to defword and
1071         defcode above.  (In fact the defvar macro uses defcode to do the dictionary header).
1072 */
1073
1074         .macro defvar name, namelen, flags=0, label, initial=0
1075         defcode \name,\namelen,\flags,\label
1076         push $var_\name
1077         NEXT
1078         .data
1079         .align 4
1080 var_\name :
1081         .int \initial
1082         .endm
1083
1084 /*
1085         The built-in variables are:
1086
1087         STATE           Is the interpreter executing code (0) or compiling a word (non-zero)?
1088         LATEST          Points to the latest (most recently defined) word in the dictionary.
1089         HERE            Points to the next free byte of memory.  When compiling, compiled words go here.
1090         _X              These are three scratch variables, used by some standard dictionary words.
1091         _Y
1092         _Z
1093         S0              Stores the address of the top of the parameter stack.
1094         BASE            The current base for printing and reading numbers.
1095
1096 */
1097         defvar "STATE",5,,STATE
1098         defvar "HERE",4,,HERE,user_defs_start
1099         defvar "LATEST",6,,LATEST,name_SYSEXIT // SYSEXIT must be last in built-in dictionary
1100         defvar "_X",2,,TX
1101         defvar "_Y",2,,TY
1102         defvar "_Z",2,,TZ
1103         defvar "S0",2,,SZ
1104         defvar "BASE",4,,BASE,10
1105
1106 /*
1107         BUILT-IN CONSTANTS ----------------------------------------------------------------------
1108
1109         It's also useful to expose a few constants to FORTH.  When the word is executed it pushes a
1110         constant value on the stack.
1111
1112         The built-in constants are:
1113
1114         VERSION         Is the current version of this FORTH.
1115         R0              The address of the top of the return stack.
1116         DOCOL           Pointer to DOCOL.
1117         F_IMMED         The IMMEDIATE flag's actual value.
1118         F_HIDDEN        The HIDDEN flag's actual value.
1119         F_LENMASK       The length mask.
1120 */
1121
1122         .macro defconst name, namelen, flags=0, label, value
1123         defcode \name,\namelen,\flags,\label
1124         push $\value
1125         NEXT
1126         .endm
1127
1128         defconst "VERSION",7,,VERSION,JONES_VERSION
1129         defconst "R0",2,,RZ,return_stack
1130         defconst "DOCOL",5,,__DOCOL,DOCOL
1131         defconst "F_IMMED",7,,__F_IMMED,F_IMMED
1132         defconst "F_HIDDEN",8,,__F_HIDDEN,F_HIDDEN
1133         defconst "F_LENMASK",9,,__F_LENMASK,F_LENMASK
1134
1135 /*
1136         RETURN STACK ----------------------------------------------------------------------
1137
1138         These words allow you to access the return stack.  Recall that the register %ebp always points to
1139         the top of the return stack.
1140 */
1141
1142         defcode ">R",2,,TOR
1143         pop %eax                // pop parameter stack into %eax
1144         PUSHRSP %eax            // push it on to the return stack
1145         NEXT
1146
1147         defcode "R>",2,,FROMR
1148         POPRSP %eax             // pop return stack on to %eax
1149         push %eax               // and push on to parameter stack
1150         NEXT
1151
1152         defcode "RSP@",4,,RSPFETCH
1153         push %ebp
1154         NEXT
1155
1156         defcode "RSP!",4,,RSPSTORE
1157         pop %ebp
1158         NEXT
1159
1160         defcode "RDROP",5,,RDROP
1161         lea 4(%ebp),%ebp        // pop return stack and throw away
1162         NEXT
1163
1164 /*
1165         PARAMETER (DATA) STACK ----------------------------------------------------------------------
1166
1167         These functions allow you to manipulate the parameter stack.  Recall that Linux sets up the parameter
1168         stack for us, and it is accessed through %esp.
1169 */
1170
1171         defcode "DSP@",4,,DSPFETCH
1172         mov %esp,%eax
1173         push %eax
1174         NEXT
1175
1176         defcode "DSP!",4,,DSPSTORE
1177         pop %esp
1178         NEXT
1179
1180 /*
1181         INPUT AND OUTPUT ----------------------------------------------------------------------
1182
1183         These are our first really meaty/complicated FORTH primitives.  I have chosen to write them in
1184         assembler, but surprisingly in "real" FORTH implementations these are often written in terms
1185         of more fundamental FORTH primitives.  I chose to avoid that because I think that just obscures
1186         the implementation.  After all, you may not understand assembler but you can just think of it
1187         as an opaque block of code that does what it says.
1188
1189         Let's discuss input first.
1190
1191         The FORTH word KEY reads the next byte from stdin (and pushes it on the parameter stack).
1192         So if KEY is called and someone hits the space key, then the number 32 (ASCII code of space)
1193         is pushed on the stack.
1194
1195         In FORTH there is no distinction between reading code and reading input.  We might be reading
1196         and compiling code, we might be reading words to execute, we might be asking for the user
1197         to type their name -- ultimately it all comes in through KEY.
1198
1199         The implementation of KEY uses an input buffer of a certain size (defined at the end of the
1200         program).  It calls the Linux read(2) system call to fill this buffer and tracks its position
1201         in the buffer using a couple of variables, and if it runs out of input buffer then it refills
1202         it automatically.  The other thing that KEY does is if it detects that stdin has closed, it
1203         exits the program, which is why when you hit ^D the FORTH system cleanly exits.
1204 */
1205
1206 #include <asm-i386/unistd.h>
1207
1208         defcode "KEY",3,,KEY
1209         call _KEY
1210         push %eax               // push return value on stack
1211         NEXT
1212 _KEY:
1213         mov (currkey),%ebx
1214         cmp (bufftop),%ebx
1215         jge 1f
1216         xor %eax,%eax
1217         mov (%ebx),%al
1218         inc %ebx
1219         mov %ebx,(currkey)
1220         ret
1221
1222 1:      // out of input; use read(2) to fetch more input from stdin
1223         xor %ebx,%ebx           // 1st param: stdin
1224         mov $buffer,%ecx        // 2nd param: buffer
1225         mov %ecx,currkey
1226         mov $buffend-buffer,%edx // 3rd param: max length
1227         mov $__NR_read,%eax     // syscall: read
1228         int $0x80
1229         test %eax,%eax          // If %eax <= 0, then exit.
1230         jbe 2f
1231         addl %eax,%ecx          // buffer+%eax = bufftop
1232         mov %ecx,bufftop
1233         jmp _KEY
1234
1235 2:      // error or out of input: exit
1236         xor %ebx,%ebx
1237         mov $__NR_exit,%eax     // syscall: exit
1238         int $0x80
1239
1240 /*
1241         By contrast, output is much simpler.  The FORTH word EMIT writes out a single byte to stdout.
1242         This implementation just uses the write system call.  No attempt is made to buffer output, but
1243         it would be a good exercise to add it.
1244 */
1245
1246         defcode "EMIT",4,,EMIT
1247         pop %eax
1248         call _EMIT
1249         NEXT
1250 _EMIT:
1251         mov $1,%ebx             // 1st param: stdout
1252
1253         // write needs the address of the byte to write
1254         mov %al,(2f)
1255         mov $2f,%ecx            // 2nd param: address
1256
1257         mov $1,%edx             // 3rd param: nbytes = 1
1258
1259         mov $__NR_write,%eax    // write syscall
1260         int $0x80
1261         ret
1262
1263         .bss
1264 2:      .space 1                // scratch used by EMIT
1265
1266 /*
1267         Back to input, WORD is a FORTH word which reads the next full word of input.
1268
1269         What it does in detail is that it first skips any blanks (spaces, tabs, newlines and so on).
1270         Then it calls KEY to read characters into an internal buffer until it hits a blank.  Then it
1271         calculates the length of the word it read and returns the address and the length as
1272         two words on the stack (with address at the top).
1273
1274         Notice that WORD has a single internal buffer which it overwrites each time (rather like
1275         a static C string).  Also notice that WORD's internal buffer is just 32 bytes long and
1276         there is NO checking for overflow.  31 bytes happens to be the maximum length of a
1277         FORTH word that we support, and that is what WORD is used for: to read FORTH words when
1278         we are compiling and executing code.  The returned strings are not NUL-terminated, so
1279         in some crazy-world you could define FORTH words containing ASCII NULs, although why
1280         you'd want to is a bit beyond me.
1281
1282         WORD is not suitable for just reading strings (eg. user input) because of all the above
1283         peculiarities and limitations.
1284
1285         Note that when executing, you'll see:
1286         WORD FOO
1287         which puts "FOO" and length 3 on the stack, but when compiling:
1288         : BAR WORD FOO ;
1289         is an error (or at least it doesn't do what you might expect).  Later we'll talk about compiling
1290         and immediate mode, and you'll understand why.
1291 */
1292
1293         defcode "WORD",4,,WORD
1294         call _WORD
1295         push %ecx               // push length
1296         push %edi               // push base address
1297         NEXT
1298
1299 _WORD:
1300         /* Search for first non-blank character.  Also skip \ comments. */
1301 1:
1302         call _KEY               // get next key, returned in %eax
1303         cmpb $'\\',%al          // start of a comment?
1304         je 3f                   // if so, skip the comment
1305         cmpb $' ',%al
1306         jbe 1b                  // if so, keep looking
1307
1308         /* Search for the end of the word, storing chars as we go. */
1309         mov $5f,%edi            // pointer to return buffer
1310 2:
1311         stosb                   // add character to return buffer
1312         call _KEY               // get next key, returned in %al
1313         cmpb $' ',%al           // is blank?
1314         ja 2b                   // if not, keep looping
1315
1316         /* Return the word (well, the static buffer) and length. */
1317         sub $5f,%edi
1318         mov %edi,%ecx           // return length of the word
1319         mov $5f,%edi            // return address of the word
1320         ret
1321
1322         /* Code to skip \ comments to end of the current line. */
1323 3:
1324         call _KEY
1325         cmpb $'\n',%al          // end of line yet?
1326         jne 3b
1327         jmp 1b
1328
1329         .bss
1330         // A static buffer where WORD returns.  Subsequent calls
1331         // overwrite this buffer.  Maximum word length is 32 chars.
1332 5:      .space 32
1333
1334 /*
1335         . (also called DOT) prints the top of the stack as an integer in the current BASE.
1336 */
1337
1338         defcode ".",1,,DOT
1339         pop %eax                // Get the number to print into %eax
1340         call _DOT               // Easier to do this recursively ...
1341         NEXT
1342 _DOT:
1343         mov var_BASE,%ecx       // Get current BASE
1344 1:
1345         cmp %ecx,%eax           // %eax < BASE?  If so jump to print immediately.
1346         jb 2f
1347         xor %edx,%edx           // %edx:%eax / %ecx -> quotient %eax, remainder %edx
1348         idivl %ecx
1349         pushl %edx              // Print quotient (top half) first ...
1350         call _DOT
1351         popl %eax               // ... then loop to print remainder
1352         jmp 1b
1353 2:                              // %eax < BASE so print immediately.
1354         movl $digits,%edx
1355         addl %eax,%edx
1356         movb (%edx),%al         // Note top bits are already zero.
1357         call _EMIT
1358         ret
1359         .section .rodata
1360 digits: .ascii "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1361
1362 /*
1363         Almost the opposite of DOT (but not quite), SNUMBER parses a numeric string such as one returned
1364         by WORD and pushes the number on the parameter stack.
1365
1366         This function does absolutely no error checking, and in particular the length of the string
1367         must be >= 1 bytes, and should contain only digits 0-9.  If it doesn't you'll get random results.
1368
1369         This function is only used when reading literal numbers in code, and shouldn't really be used
1370         in user code at all.
1371 */
1372         defcode "SNUMBER",7,,SNUMBER
1373         pop %edi
1374         pop %ecx
1375         call _SNUMBER
1376         push %eax
1377         NEXT
1378 _SNUMBER:
1379         xor %eax,%eax
1380         xor %ebx,%ebx
1381 1:
1382         imull $10,%eax          // %eax *= 10
1383         movb (%edi),%bl
1384         inc %edi
1385         subb $'0',%bl           // ASCII -> digit
1386         add %ebx,%eax
1387         dec %ecx
1388         jnz 1b
1389         ret
1390
1391 /*
1392         DICTIONARY LOOK UPS ----------------------------------------------------------------------
1393
1394         We're building up to our prelude on how FORTH code is compiled, but first we need yet more infrastructure.
1395
1396         The FORTH word FIND takes a string (a word as parsed by WORD -- see above) and looks it up in the
1397         dictionary.  What it actually returns is the address of the dictionary header, if it finds it,
1398         or 0 if it didn't.
1399
1400         So if DOUBLE is defined in the dictionary, then WORD DOUBLE FIND returns the following pointer:
1401
1402     pointer to this
1403         |
1404         |
1405         V
1406         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1407         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        | +          | EXIT       |
1408         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1409
1410         See also >CFA and >DFA.
1411
1412         FIND doesn't find dictionary entries which are flagged as HIDDEN.  See below for why.
1413 */
1414
1415         defcode "FIND",4,,FIND
1416         pop %edi                // %edi = address
1417         pop %ecx                // %ecx = length
1418         call _FIND
1419         push %eax
1420         NEXT
1421
1422 _FIND:
1423         push %esi               // Save %esi so we can use it in string comparison.
1424
1425         // Now we start searching backwards through the dictionary for this word.
1426         mov var_LATEST,%edx     // LATEST points to name header of the latest word in the dictionary
1427 1:
1428         test %edx,%edx          // NULL pointer?  (end of the linked list)
1429         je 4f
1430
1431         // Compare the length expected and the length of the word.
1432         // Note that if the F_HIDDEN flag is set on the word, then by a bit of trickery
1433         // this won't pick the word (the length will appear to be wrong).
1434         xor %eax,%eax
1435         movb 4(%edx),%al        // %al = flags+length field
1436         andb $(F_HIDDEN|F_LENMASK),%al // %al = name length
1437         cmpb %cl,%al            // Length is the same?
1438         jne 2f
1439
1440         // Compare the strings in detail.
1441         push %ecx               // Save the length
1442         push %edi               // Save the address (repe cmpsb will move this pointer)
1443         lea 5(%edx),%esi        // Dictionary string we are checking against.
1444         repe cmpsb              // Compare the strings.
1445         pop %edi
1446         pop %ecx
1447         jne 2f                  // Not the same.
1448
1449         // The strings are the same - return the header pointer in %eax
1450         pop %esi
1451         mov %edx,%eax
1452         ret
1453
1454 2:
1455         mov (%edx),%edx         // Move back through the link field to the previous word
1456         jmp 1b                  // .. and loop.
1457
1458 4:      // Not found.
1459         pop %esi
1460         xor %eax,%eax           // Return zero to indicate not found.
1461         ret
1462
1463 /*
1464         FIND returns the dictionary pointer, but when compiling we need the codeword pointer (recall
1465         that FORTH definitions are compiled into lists of codeword pointers).  The standard FORTH
1466         word >CFA turns a dictionary pointer into a codeword pointer.
1467
1468         The example below shows the result of:
1469
1470                 WORD DOUBLE FIND >CFA
1471
1472         FIND returns a pointer to this
1473         |                               >CFA converts it to a pointer to this
1474         |                                          |
1475         V                                          V
1476         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1477         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        | +          | EXIT       |
1478         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1479
1480         Notes:
1481
1482         Because names vary in length, this isn't just a simple increment.
1483
1484         In this FORTH you cannot easily turn a codeword pointer back into a dictionary entry pointer, but
1485         that is not true in most FORTH implementations where they store a back pointer in the definition
1486         (with an obvious memory/complexity cost).  The reason they do this is that it is useful to be
1487         able to go backwards (codeword -> dictionary entry) in order to decompile FORTH definitions.
1488
1489         What does CFA stand for?  My best guess is "Code Field Address".
1490 */
1491
1492         defcode ">CFA",4,,TCFA
1493         pop %edi
1494         call _TCFA
1495         push %edi
1496         NEXT
1497 _TCFA:
1498         xor %eax,%eax
1499         add $4,%edi             // Skip link pointer.
1500         movb (%edi),%al         // Load flags+len into %al.
1501         inc %edi                // Skip flags+len byte.
1502         andb $F_LENMASK,%al     // Just the length, not the flags.
1503         add %eax,%edi           // Skip the name.
1504         addl $3,%edi            // The codeword is 4-byte aligned.
1505         andl $~3,%edi
1506         ret
1507
1508 /*
1509         Related to >CFA is >DFA which takes a dictionary entry address as returned by FIND and
1510         returns a pointer to the first data field.
1511
1512         FIND returns a pointer to this
1513         |                               >CFA converts it to a pointer to this
1514         |                                          |
1515         |                                          |    >DFA converts it to a pointer to this
1516         |                                          |             |
1517         V                                          V             V
1518         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1519         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        | +          | EXIT       |
1520         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1521
1522         (Note to those following the source of FIG-FORTH / ciforth: My >DFA definition is
1523         different from theirs, because they have an extra indirection).
1524
1525         You can see that >DFA is easily defined in FORTH just by adding 4 to the result of >CFA.
1526 */
1527
1528         defword ">DFA",4,,TDFA
1529         .int TCFA               // >CFA         (get code field address)
1530         .int INCR4              // 4+           (add 4 to it to get to next word)
1531         .int EXIT               // EXIT         (return from FORTH word)
1532
1533 /*
1534         COMPILING ----------------------------------------------------------------------
1535
1536         Now we'll talk about how FORTH compiles words.  Recall that a word definition looks like this:
1537
1538                 : DOUBLE DUP + ;
1539
1540         and we have to turn this into:
1541
1542           pointer to previous word
1543            ^
1544            |
1545         +--|------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1546         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        | +          | EXIT       |
1547         +---------+---+---+---+---+---+---+---+---+------------+--|---------+------------+------------+
1548            ^       len                         pad  codeword      |
1549            |                                                      V
1550           LATEST points here                            points to codeword of DUP
1551
1552         There are several problems to solve.  Where to put the new word?  How do we read words?  How
1553         do we define the words : (COLON) and ; (SEMICOLON)?
1554
1555         FORTH solves this rather elegantly and as you might expect in a very low-level way which
1556         allows you to change how the compiler works on your own code.
1557
1558         FORTH has an INTERPRETER function (a true interpreter this time, not DOCOL) which runs in a
1559         loop, reading words (using WORD), looking them up (using FIND), turning them into codeword
1560         pointers (using >CFA) and deciding what to do with them.
1561
1562         What it does depends on the mode of the interpreter (in variable STATE).
1563
1564         When STATE is zero, the interpreter just runs each word as it looks them up.  This is known as
1565         immediate mode.
1566
1567         The interesting stuff happens when STATE is non-zero -- compiling mode.  In this mode the
1568         interpreter appends the codeword pointer to user memory (the HERE variable points to the next
1569         free byte of user memory).
1570
1571         So you may be able to see how we could define : (COLON).  The general plan is:
1572
1573         (1) Use WORD to read the name of the function being defined.
1574
1575         (2) Construct the dictionary entry -- just the header part -- in user memory:
1576
1577     pointer to previous word (from LATEST)                      +-- Afterwards, HERE points here, where
1578            ^                                                    |   the interpreter will start appending
1579            |                                                    V   codewords.
1580         +--|------+---+---+---+---+---+---+---+---+------------+
1581         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      |
1582         +---------+---+---+---+---+---+---+---+---+------------+
1583                    len                         pad  codeword
1584
1585         (3) Set LATEST to point to the newly defined word, ...
1586
1587         (4) .. and most importantly leave HERE pointing just after the new codeword.  This is where
1588             the interpreter will append codewords.
1589
1590         (5) Set STATE to 1.  This goes into compile mode so the interpreter starts appending codewords to
1591             our partially-formed header.
1592
1593         After : has run, our input is here:
1594
1595         : DOUBLE DUP + ;
1596                  ^
1597                  |
1598                 Next byte returned by KEY will be the 'D' character of DUP
1599
1600         so the interpreter (now it's in compile mode, so I guess it's really the compiler) reads "DUP",
1601         looks it up in the dictionary, gets its codeword pointer, and appends it:
1602
1603                                                                              +-- HERE updated to point here.
1604                                                                              |
1605                                                                              V
1606         +---------+---+---+---+---+---+---+---+---+------------+------------+
1607         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        |
1608         +---------+---+---+---+---+---+---+---+---+------------+------------+
1609                    len                         pad  codeword
1610
1611         Next we read +, get the codeword pointer, and append it:
1612
1613                                                                                           +-- HERE updated to point here.
1614                                                                                           |
1615                                                                                           V
1616         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+
1617         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        | +          |
1618         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+
1619                    len                         pad  codeword
1620
1621         The issue is what happens next.  Obviously what we _don't_ want to happen is that we
1622         read ";" and compile it and go on compiling everything afterwards.
1623
1624         At this point, FORTH uses a trick.  Remember the length byte in the dictionary definition
1625         isn't just a plain length byte, but can also contain flags.  One flag is called the
1626         IMMEDIATE flag (F_IMMED in this code).  If a word in the dictionary is flagged as
1627         IMMEDIATE then the interpreter runs it immediately _even if it's in compile mode_.
1628
1629         This is how the word ; (SEMICOLON) works -- as a word flagged in the dictionary as IMMEDIATE.
1630         And all it does is append the codeword for EXIT on to the current definition and switch
1631         back to immediate mode (set STATE back to 0).  Shortly we'll see the actual definition
1632         of ; and we'll see that it's really a very simple definition, declared IMMEDIATE.
1633
1634         After the interpreter reads ; and executes it 'immediately', we get this:
1635
1636         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1637         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      | DUP        | +          | EXIT       |
1638         +---------+---+---+---+---+---+---+---+---+------------+------------+------------+------------+
1639                    len                         pad  codeword                                           ^
1640                                                                                                        |
1641                                                                                                       HERE
1642
1643         STATE is set to 0.
1644
1645         And that's it, job done, our new definition is compiled, and we're back in immediate mode
1646         just reading and executing words, perhaps including a call to test our new word DOUBLE.
1647
1648         The only last wrinkle in this is that while our word was being compiled, it was in a
1649         half-finished state.  We certainly wouldn't want DOUBLE to be called somehow during
1650         this time.  There are several ways to stop this from happening, but in FORTH what we
1651         do is flag the word with the HIDDEN flag (F_HIDDEN in this code) just while it is
1652         being compiled.  This prevents FIND from finding it, and thus in theory stops any
1653         chance of it being called.
1654
1655         The above explains how compiling, : (COLON) and ; (SEMICOLON) works and in a moment I'm
1656         going to define them.  The : (COLON) function can be made a little bit more general by writing
1657         it in two parts.  The first part, called CREATE, makes just the header:
1658
1659                                                    +-- Afterwards, HERE points here.
1660                                                    |
1661                                                    V
1662         +---------+---+---+---+---+---+---+---+---+
1663         | LINK    | 6 | D | O | U | B | L | E | 0 |
1664         +---------+---+---+---+---+---+---+---+---+
1665                    len                         pad
1666
1667         and the second part, the actual definition of : (COLON), calls CREATE and appends the
1668         DOCOL codeword, so leaving:
1669
1670                                                                 +-- Afterwards, HERE points here.
1671                                                                 |
1672                                                                 V
1673         +---------+---+---+---+---+---+---+---+---+------------+
1674         | LINK    | 6 | D | O | U | B | L | E | 0 | DOCOL      |
1675         +---------+---+---+---+---+---+---+---+---+------------+
1676                    len                         pad  codeword
1677
1678         CREATE is a standard FORTH word and the advantage of this split is that we can reuse it to
1679         create other types of words (not just ones which contain code, but words which contain variables,
1680         constants and other data).
1681 */
1682
1683         defcode "CREATE",6,,CREATE
1684
1685         // Get the word.
1686         call _WORD              // Returns %ecx = length, %edi = pointer to word.
1687         mov %edi,%ebx           // %ebx = address of the word
1688
1689         // Link pointer.
1690         movl var_HERE,%edi      // %edi is the address of the header
1691         movl var_LATEST,%eax    // Get link pointer
1692         stosl                   // and store it in the header.
1693
1694         // Length byte and the word itself.
1695         mov %cl,%al             // Get the length.
1696         stosb                   // Store the length/flags byte.
1697         push %esi
1698         mov %ebx,%esi           // %esi = word
1699         rep movsb               // Copy the word
1700         pop %esi
1701         addl $3,%edi            // Align to next 4 byte boundary.
1702         andl $~3,%edi
1703
1704         // Update LATEST and HERE.
1705         movl var_HERE,%eax
1706         movl %eax,var_LATEST
1707         movl %edi,var_HERE
1708         NEXT
1709
1710 /*
1711         Because I want to define : (COLON) in FORTH, not assembler, we need a few more FORTH words
1712         to use.
1713
1714         The first is , (COMMA) which is a standard FORTH word which appends a 32 bit integer to the user
1715         data area pointed to by HERE, and adds 4 to HERE.  So the action of , (COMMA) is:
1716
1717                                                         previous value of HERE
1718                                                                  |
1719                                                                  V
1720         +---------+---+---+---+---+---+---+---+---+-- - - - - --+------------+
1721         | LINK    | 6 | D | O | U | B | L | E | 0 |             |  <data>    |
1722         +---------+---+---+---+---+---+---+---+---+-- - - - - --+------------+
1723                    len                         pad                            ^
1724                                                                               |
1725                                                                         new value of HERE
1726
1727         and <data> is whatever 32 bit integer was at the top of the stack.
1728
1729         , (COMMA) is quite a fundamental operation when compiling.  It is used to append codewords
1730         to the current word that is being compiled.
1731 */
1732
1733         defcode ",",1,,COMMA
1734         pop %eax                // Code pointer to store.
1735         call _COMMA
1736         NEXT
1737 _COMMA:
1738         movl var_HERE,%edi      // HERE
1739         stosl                   // Store it.
1740         movl %edi,var_HERE      // Update HERE (incremented)
1741         ret
1742
1743 /*
1744         Our definitions of : (COLON) and ; (SEMICOLON) will need to switch to and from compile mode.
1745
1746         Immediate mode vs. compile mode is stored in the global variable STATE, and by updating this
1747         variable we can switch between the two modes.
1748
1749         For various reasons which may become apparent later, FORTH defines two standard words called
1750         [ and ] (LBRAC and RBRAC) which switch between modes:
1751
1752         Word    Assembler       Action          Effect
1753         [       LBRAC           STATE := 0      Switch to immediate mode.
1754         ]       RBRAC           STATE := 1      Switch to compile mode.
1755
1756         [ (LBRAC) is an IMMEDIATE word.  The reason is as follows: If we are in compile mode and the
1757         interpreter saw [ then it would compile it rather than running it.  We would never be able to
1758         switch back to immediate mode!  So we flag the word as IMMEDIATE so that even in compile mode
1759         the word runs immediately, switching us back to immediate mode.
1760 */
1761
1762         defcode "[",1,F_IMMED,LBRAC
1763         xor %eax,%eax
1764         movl %eax,var_STATE     // Set STATE to 0.
1765         NEXT
1766
1767         defcode "]",1,,RBRAC
1768         movl $1,var_STATE       // Set STATE to 1.
1769         NEXT
1770
1771 /*
1772         Now we can define : (COLON) using CREATE.  It just calls CREATE, appends DOCOL (the codeword), sets
1773         the word HIDDEN and goes into compile mode.
1774 */
1775
1776         defword ":",1,,COLON
1777         .int CREATE             // CREATE the dictionary entry / header
1778         .int LIT, DOCOL, COMMA  // Append DOCOL  (the codeword).
1779         .int HIDDEN             // Make the word hidden (see below for definition).
1780         .int RBRAC              // Go into compile mode.
1781         .int EXIT               // Return from the function.
1782
1783 /*
1784         ; (SEMICOLON) is also elegantly simple.  Notice the F_IMMED flag.
1785 */
1786
1787         defword ";",1,F_IMMED,SEMICOLON
1788         .int LIT, EXIT, COMMA   // Append EXIT (so the word will return).
1789         .int HIDDEN             // Toggle hidden flag -- unhide the word (see below for definition).
1790         .int LBRAC              // Go back to IMMEDIATE mode.
1791         .int EXIT               // Return from the function.
1792
1793 /*
1794         EXTENDING THE COMPILER ----------------------------------------------------------------------
1795
1796         Words flagged with IMMEDIATE (F_IMMED) aren't just for the FORTH compiler to use.  You can define
1797         your own IMMEDIATE words too, and this is a crucial aspect when extending basic FORTH, because
1798         it allows you in effect to extend the compiler itself.  Does gcc let you do that?
1799
1800         Standard FORTH words like IF, WHILE, ." and so on are all written as extensions to the basic
1801         compiler, and are all IMMEDIATE words.
1802
1803         The IMMEDIATE word toggles the F_IMMED (IMMEDIATE flag) on the most recently defined word,
1804         or on the current word if you call it in the middle of a definition.
1805
1806         Typical usage is:
1807
1808         : MYIMMEDWORD IMMEDIATE
1809                 ...definition...
1810         ;
1811
1812         but some FORTH programmers write this instead:
1813
1814         : MYIMMEDWORD
1815                 ...definition...
1816         ; IMMEDIATE
1817
1818         The two usages are equivalent, to a first approximation.
1819 */
1820
1821         defcode "IMMEDIATE",9,F_IMMED,IMMEDIATE
1822         movl var_LATEST,%edi    // LATEST word.
1823         addl $4,%edi            // Point to name/flags byte.
1824         xorb $F_IMMED,(%edi)    // Toggle the IMMED bit.
1825         NEXT
1826
1827 /*
1828         HIDDEN toggles the other flag, F_HIDDEN, of the latest word.  Note that words flagged
1829         as hidden are defined but cannot be called, so this is only used when you are trying to
1830         hide the word as it is being defined.
1831 */
1832
1833         defcode "HIDDEN",6,,HIDDEN
1834         movl var_LATEST,%edi    // LATEST word.
1835         addl $4,%edi            // Point to name/flags byte.
1836         xorb $F_HIDDEN,(%edi)   // Toggle the HIDDEN bit.
1837         NEXT
1838
1839 /*
1840         ' (TICK) is a standard FORTH word which returns the codeword pointer of the next word.
1841
1842         The common usage is:
1843
1844         ' FOO ,
1845
1846         which appends the codeword of FOO to the current word we are defining (this only works in compiled code).
1847
1848         You tend to use ' in IMMEDIATE words.  For example an alternate (and rather useless) way to define
1849         a literal 2 might be:
1850
1851         : LIT2 IMMEDIATE
1852                 ' LIT ,         \ Appends LIT to the currently-being-defined word
1853                 2 ,             \ Appends the number 2 to the currently-being-defined word
1854         ;
1855
1856         So you could do:
1857
1858         : DOUBLE LIT2 * ;
1859
1860         (If you don't understand how LIT2 works, then you should review the material about compiling words
1861         and immediate mode).
1862
1863         This definition of ' uses a cheat which I copied from buzzard92.  As a result it only works in
1864         compiled code.  It is possible to write a version of ' based on WORD, FIND, >CFA which works in
1865         immediate mode too.
1866 */
1867         defcode "'",1,,TICK
1868         lodsl                   // Get the address of the next word and skip it.
1869         pushl %eax              // Push it on the stack.
1870         NEXT
1871
1872 /*
1873         BRANCHING ----------------------------------------------------------------------
1874
1875         It turns out that all you need in order to define looping constructs, IF-statements, etc.
1876         are two primitives.
1877
1878         BRANCH is an unconditional branch. 0BRANCH is a conditional branch (it only branches if the
1879         top of stack is zero).
1880
1881         The diagram below shows how BRANCH works in some imaginary compiled word.  When BRANCH executes,
1882         %esi starts by pointing to the offset field (compare to LIT above):
1883
1884         +---------------------+-------+---- - - ---+------------+------------+---- - - - ----+------------+
1885         | (Dictionary header) | DOCOL |            | BRANCH     | offset     | (skipped)     | word       |
1886         +---------------------+-------+---- - - ---+------------+-----|------+---- - - - ----+------------+
1887                                                                    ^  |                       ^
1888                                                                    |  |                       |
1889                                                                    |  +-----------------------+
1890                                                                   %esi added to offset
1891
1892         The offset is added to %esi to make the new %esi, and the result is that when NEXT runs, execution
1893         continues at the branch target.  Negative offsets work as expected.
1894
1895         0BRANCH is the same except the branch happens conditionally.
1896
1897         Now standard FORTH words such as IF, THEN, ELSE, WHILE, REPEAT, etc. can be implemented entirely
1898         in FORTH.  They are IMMEDIATE words which append various combinations of BRANCH or 0BRANCH
1899         into the word currently being compiled.
1900
1901         As an example, code written like this:
1902
1903                 condition-code IF true-part THEN rest-code
1904
1905         compiles to:
1906
1907                 condition-code 0BRANCH OFFSET true-part rest-code
1908                                           |             ^
1909                                           |             |
1910                                           +-------------+
1911 */
1912
1913         defcode "BRANCH",6,,BRANCH
1914         add (%esi),%esi         // add the offset to the instruction pointer
1915         NEXT
1916
1917         defcode "0BRANCH",7,,ZBRANCH
1918         pop %eax
1919         test %eax,%eax          // top of stack is zero?
1920         jz code_BRANCH          // if so, jump back to the branch function above
1921         lodsl                   // otherwise we need to skip the offset
1922         NEXT
1923
1924 /*
1925         PRINTING STRINGS ----------------------------------------------------------------------
1926
1927         LITSTRING and EMITSTRING are primitives used to implement the ." operator (which is
1928         written in FORTH).  See the definition of that operator below.
1929 */
1930
1931         defcode "LITSTRING",9,,LITSTRING
1932         lodsl                   // get the length of the string
1933         push %eax               // push it on the stack
1934         push %esi               // push the address of the start of the string
1935         addl %eax,%esi          // skip past the string
1936         addl $3,%esi            // but round up to next 4 byte boundary
1937         andl $~3,%esi
1938         NEXT
1939
1940         defcode "EMITSTRING",10,,EMITSTRING
1941         mov $1,%ebx             // 1st param: stdout
1942         pop %ecx                // 2nd param: address of string
1943         pop %edx                // 3rd param: length of string
1944         mov $__NR_write,%eax    // write syscall
1945         int $0x80
1946         NEXT
1947
1948 /*
1949         COLD START AND INTERPRETER ----------------------------------------------------------------------
1950
1951         COLD is the first FORTH function called, almost immediately after the FORTH system "boots".
1952
1953         INTERPRETER is the FORTH interpreter ("toploop", "toplevel" or "REPL" might be a more accurate
1954         description -- see: http://en.wikipedia.org/wiki/REPL).
1955 */
1956
1957         // COLD must not return (ie. must not call EXIT).
1958         defword "COLD",4,,COLD
1959         .int INTERPRETER        // call the interpreter loop (never returns)
1960         .int LIT,1,SYSEXIT      // hmmm, but in case it does, exit(1).
1961
1962 /* This interpreter is pretty simple, but remember that in FORTH you can always override
1963  * it later with a more powerful one!
1964  */
1965         defword "INTERPRETER",11,,INTERPRETER
1966         .int INTERPRET,RDROP,INTERPRETER
1967
1968         defcode "INTERPRET",9,,INTERPRET
1969         call _WORD              // Returns %ecx = length, %edi = pointer to word.
1970
1971         // Is it in the dictionary?
1972         xor %eax,%eax
1973         movl %eax,interpret_is_lit // Not a literal number (not yet anyway ...)
1974         call _FIND              // Returns %eax = pointer to header or 0 if not found.
1975         test %eax,%eax          // Found?
1976         jz 1f
1977
1978         // In the dictionary.  Is it an IMMEDIATE codeword?
1979         mov %eax,%edi           // %edi = dictionary entry
1980         movb 4(%edi),%al        // Get name+flags.
1981         push %ax                // Just save it for now.
1982         call _TCFA              // Convert dictionary entry (in %edi) to codeword pointer.
1983         pop %ax
1984         andb $F_IMMED,%al       // Is IMMED flag set?
1985         mov %edi,%eax
1986         jnz 4f                  // If IMMED, jump straight to executing.
1987
1988         jmp 2f
1989
1990 1:      // Not in the dictionary (not a word) so assume it's a literal number.
1991         incl interpret_is_lit
1992         call _SNUMBER           // Returns the parsed number in %eax
1993         mov %eax,%ebx
1994         mov $LIT,%eax           // The word is LIT
1995
1996 2:      // Are we compiling or executing?
1997         movl var_STATE,%edx
1998         test %edx,%edx
1999         jz 4f                   // Jump if executing.
2000
2001         // Compiling - just append the word to the current dictionary definition.
2002         call _COMMA
2003         mov interpret_is_lit,%ecx // Was it a literal?
2004         test %ecx,%ecx
2005         jz 3f
2006         mov %ebx,%eax           // Yes, so LIT is followed by a number.
2007         call _COMMA
2008 3:      NEXT
2009
2010 4:      // Executing - run it!
2011         mov interpret_is_lit,%ecx // Literal?
2012         test %ecx,%ecx          // Literal?
2013         jnz 5f
2014
2015         // Not a literal, execute it now.  This never returns, but the codeword will
2016         // eventually call NEXT which will reenter the loop in INTERPRETER.
2017         jmp *(%eax)
2018
2019 5:      // Executing a literal, which means push it on the stack.
2020         push %ebx
2021         NEXT
2022
2023         .data
2024         .align 4
2025 interpret_is_lit:
2026         .int 0                  // Flag used to record if reading a literal
2027
2028 /*
2029         ODDS AND ENDS ----------------------------------------------------------------------
2030
2031         CHAR puts the ASCII code of the first character of the following word on the stack.  For example
2032         CHAR A puts 65 on the stack.
2033
2034         SYSEXIT exits the process using Linux exit syscall.
2035
2036         In this FORTH, SYSEXIT must be the last word in the built-in (assembler) dictionary because we
2037         initialise the LATEST variable to point to it.  This means that if you want to extend the assembler
2038         part, you must put new words before SYSEXIT, or else change how LATEST is initialised.
2039 */
2040
2041         defcode "CHAR",4,,CHAR
2042         call _WORD              // Returns %ecx = length, %edi = pointer to word.
2043         xor %eax,%eax
2044         movb (%edi),%al         // Get the first character of the word.
2045         push %eax               // Push it onto the stack.
2046         NEXT
2047
2048         // NB: SYSEXIT must be the last entry in the built-in dictionary.
2049         defcode SYSEXIT,7,,SYSEXIT
2050         pop %ebx
2051         mov $__NR_exit,%eax
2052         int $0x80
2053
2054 /*
2055         START OF FORTH CODE ----------------------------------------------------------------------
2056
2057         We've now reached the stage where the FORTH system is running and self-hosting.  All further
2058         words can be written as FORTH itself, including words like IF, THEN, .", etc which in most
2059         languages would be considered rather fundamental.
2060
2061         As a kind of trick, I prefill the input buffer with the initial FORTH code.  Once this code
2062         has run (when we get to the "OK" prompt), this input buffer is reused for reading any further
2063         user input.
2064
2065         Some notes about the code:
2066
2067         \ (backslash) is the FORTH way to start a comment which goes up to the next newline.  However
2068         because this is a C-style string, I have to escape the backslash, which is why they appear as
2069         \\ comment.
2070
2071         Similarly, any backslashes in the code are doubled, and " becomes \" (eg. the definition of ."
2072         is written as : .\" ... ;)
2073
2074         I use indenting to show structure.  The amount of whitespace has no meaning to FORTH however
2075         except that you must use at least one whitespace character between words, and words themselves
2076         cannot contain whitespace.
2077
2078         FORTH is case-sensitive.  Use capslock!
2079
2080         Enjoy!
2081 */
2082
2083         .data
2084         .align 4096
2085 buffer:
2086         // Multi-line constant gives 'Warning: unterminated string; newline inserted' messages which you can ignore.
2087         .ascii "\
2088 \\ Define some character constants
2089 : '\\n'   10 ;
2090 : 'SPACE' 32 ;
2091
2092 \\ CR prints a carriage return
2093 : CR '\\n' EMIT ;
2094
2095 \\ SPACE prints a space
2096 : SPACE 'SPACE' EMIT ;
2097
2098 \\ DUP, DROP are defined in assembly for speed, but this is how you might define them
2099 \\ in FORTH.  Notice use of the scratch variables _X and _Y.
2100 \\ : DUP _X ! _X @ _X @ ;
2101 \\ : DROP _X ! ;
2102
2103 \\ The built-in . (DOT) function doesn't print a space after the number (unlike the real FORTH word).
2104 \\ However this is very easily fixed by redefining . (DOT).  Any built-in word can be redefined.
2105 : .
2106         .               \\ this refers back to the previous definition (but see also RECURSE below)
2107         SPACE
2108 ;
2109
2110 \\ The 2... versions of the standard operators work on pairs of stack entries.  They're not used
2111 \\ very commonly so not really worth writing in assembler.  Here is how they are defined in FORTH.
2112 : 2DUP OVER OVER ;
2113 : 2DROP DROP DROP ;
2114
2115 \\ More standard FORTH words.
2116 : 2* 2 * ;
2117 : 2/ 2 / ;
2118
2119 \\ Standard words for manipulating BASE.
2120 : DECIMAL 10 BASE ! ;
2121 : HEX 16 BASE ! ;
2122
2123 \\ Standard words for booleans.
2124 : TRUE 1 ;
2125 : FALSE 0 ;
2126 : NOT 0= ;
2127
2128 \\ LITERAL takes whatever is on the stack and compiles LIT <foo>
2129 : LITERAL IMMEDIATE
2130         ' LIT ,         \\ compile LIT
2131         ,               \\ compile the literal itself (from the stack)
2132         ;
2133
2134 \\ Now we can use [ and ] to insert literals which are calculated at compile time.
2135 \\ Within definitions, use [ ... ] LITERAL anywhere that '...' is a constant expression which you
2136 \\ would rather only compute once (at compile time, rather than calculating it each time your word runs).
2137 : ':'
2138         [               \\ go into immediate mode temporarily
2139         CHAR :          \\ push the number 58 (ASCII code of colon) on the stack
2140         ]               \\ go back to compile mode
2141         LITERAL         \\ compile LIT 58 as the definition of ':' word
2142 ;
2143
2144 \\ A few more character constants defined the same way as above.
2145 : '(' [ CHAR ( ] LITERAL ;
2146 : ')' [ CHAR ) ] LITERAL ;
2147 : '\"' [ CHAR \" ] LITERAL ;
2148
2149 \\ So far we have defined only very simple definitions.  Before we can go further, we really need to
2150 \\ make some control structures, like IF ... THEN and loops.  Luckily we can define arbitrary control
2151 \\ structures directly in FORTH.
2152 \\
2153 \\ Please note that the control structures as I have defined them here will only work inside compiled
2154 \\ words.  If you try to type in expressions using IF, etc. in immediate mode, then they won't work.
2155 \\ Making these work in immediate mode is left as an exercise for the reader.
2156
2157 \\ condition IF true-part THEN rest
2158 \\      -- compiles to: --> condition 0BRANCH OFFSET true-part rest
2159 \\      where OFFSET is the offset of 'rest'
2160 \\ condition IF true-part ELSE false-part THEN
2161 \\      -- compiles to: --> condition 0BRANCH OFFSET true-part BRANCH OFFSET2 false-part rest
2162 \\      where OFFSET if the offset of false-part and OFFSET2 is the offset of rest
2163
2164 \\ IF is an IMMEDIATE word which compiles 0BRANCH followed by a dummy offset, and places
2165 \\ the address of the 0BRANCH on the stack.  Later when we see THEN, we pop that address
2166 \\ off the stack, calculate the offset, and back-fill the offset.
2167 : IF IMMEDIATE
2168         ' 0BRANCH ,     \\ compile 0BRANCH
2169         HERE @          \\ save location of the offset on the stack
2170         0 ,             \\ compile a dummy offset
2171 ;
2172
2173 : THEN IMMEDIATE
2174         DUP
2175         HERE @ SWAP -   \\ calculate the offset from the address saved on the stack
2176         SWAP !          \\ store the offset in the back-filled location
2177 ;
2178
2179 : ELSE IMMEDIATE
2180         ' BRANCH ,      \\ definite branch to just over the false-part
2181         HERE @          \\ save location of the offset on the stack
2182         0 ,             \\ compile a dummy offset
2183         SWAP            \\ now back-fill the original (IF) offset
2184         DUP             \\ same as for THEN word above
2185         HERE @ SWAP -
2186         SWAP !
2187 ;
2188
2189 \\ BEGIN loop-part condition UNTIL
2190 \\      -- compiles to: --> loop-part condition 0BRANCH OFFSET
2191 \\      where OFFSET points back to the loop-part
2192 \\ This is like do { loop-part } while (condition) in the C language
2193 : BEGIN IMMEDIATE
2194         HERE @          \\ save location on the stack
2195 ;
2196
2197 : UNTIL IMMEDIATE
2198         ' 0BRANCH ,     \\ compile 0BRANCH
2199         HERE @ -        \\ calculate the offset from the address saved on the stack
2200         ,               \\ compile the offset here
2201 ;
2202
2203 \\ BEGIN loop-part AGAIN
2204 \\      -- compiles to: --> loop-part BRANCH OFFSET
2205 \\      where OFFSET points back to the loop-part
2206 \\ In other words, an infinite loop which can only be returned from with EXIT
2207 : AGAIN IMMEDIATE
2208         ' BRANCH ,      \\ compile BRANCH
2209         HERE @ -        \\ calculate the offset back
2210         ,               \\ compile the offset here
2211 ;
2212
2213 \\ BEGIN condition WHILE loop-part REPEAT
2214 \\      -- compiles to: --> condition 0BRANCH OFFSET2 loop-part BRANCH OFFSET
2215 \\      where OFFSET points back to condition (the beginning) and OFFSET2 points to after the whole piece of code
2216 \\ So this is like a while (condition) { loop-part } loop in the C language
2217 : WHILE IMMEDIATE
2218         ' 0BRANCH ,     \\ compile 0BRANCH
2219         HERE @          \\ save location of the offset2 on the stack
2220         0 ,             \\ compile a dummy offset2
2221 ;
2222
2223 : REPEAT IMMEDIATE
2224         ' BRANCH ,      \\ compile BRANCH
2225         SWAP            \\ get the original offset (from BEGIN)
2226         HERE @ - ,      \\ and compile it after BRANCH
2227         DUP
2228         HERE @ SWAP -   \\ calculate the offset2
2229         SWAP !          \\ and back-fill it in the original location
2230 ;
2231
2232 \\ FORTH allows ( ... ) as comments within function definitions.  This works by having an IMMEDIATE
2233 \\ word called ( which just drops input characters until it hits the corresponding ).
2234 : ( IMMEDIATE
2235         1               \\ allowed nested parens by keeping track of depth
2236         BEGIN
2237                 KEY             \\ read next character
2238                 DUP '(' = IF    \\ open paren?
2239                         DROP            \\ drop the open paren
2240                         1+              \\ depth increases
2241                 ELSE
2242                         ')' = IF        \\ close paren?
2243                                 1-              \\ depth decreases
2244                         THEN
2245                 THEN
2246         DUP 0= UNTIL            \\ continue until we reach matching close paren, depth 0
2247         DROP            \\ drop the depth counter
2248 ;
2249
2250 (
2251         From now on we can use ( ... ) for comments.
2252
2253         In FORTH style we can also use ( ... -- ... ) to show the effects that a word has on the
2254         parameter stack.  For example:
2255
2256         ( n -- )        means that the word consumes an integer (n) from the parameter stack.
2257         ( b a -- c )    means that the word uses two integers (a and b, where a is at the top of stack)
2258                                 and returns a single integer (c).
2259         ( -- )          means the word has no effect on the stack
2260 )
2261
2262 ( With the looping constructs, we can now write SPACES, which writes n spaces to stdout. )
2263 : SPACES        ( n -- )
2264         BEGIN
2265                 DUP 0>          ( while n > 0 )
2266         WHILE
2267                 SPACE           ( print a space )
2268                 1-              ( until we count down to 0 )
2269         REPEAT
2270         DROP
2271 ;
2272
2273 ( c a b WITHIN returns true if a <= c and c < b )
2274 : WITHIN
2275         ROT             ( b c a )
2276         OVER            ( b c a c )
2277         <= IF
2278                 > IF            ( b c -- )
2279                         TRUE
2280                 ELSE
2281                         FALSE
2282                 THEN
2283         ELSE
2284                 2DROP           ( b c -- )
2285                 FALSE
2286         THEN
2287 ;
2288
2289 ( .S prints the contents of the stack.  Very useful for debugging. )
2290 : .S            ( -- )
2291         DSP@            ( get current stack pointer )
2292         BEGIN
2293                 DUP S0 @ <
2294         WHILE
2295                 DUP @ .         ( print the stack element )
2296                 4+              ( move up )
2297         REPEAT
2298         DROP
2299 ;
2300
2301 ( DEPTH returns the depth of the stack. )
2302 : DEPTH         ( -- n )
2303         S0 @ DSP@ -
2304         4-                      ( adjust because S0 was on the stack when we pushed DSP )
2305 ;
2306
2307 (
2308         [NB. The following may be a bit confusing because of the need to use backslash before
2309         each double quote character.  The backslashes are there to keep the assembler happy.
2310         They are NOT part of the final output.  So here we are defining a function called
2311         'dot double-quote' (not 'dot backslash double-quote').]
2312
2313         .\" is the print string operator in FORTH.  Example: .\" Something to print\"
2314         The space after the operator is the ordinary space required between words.
2315
2316         This is tricky to define because it has to do different things depending on whether
2317         we are compiling or in immediate mode.  (Thus the word is marked IMMEDIATE so it can
2318         detect this and do different things).
2319
2320         In immediate mode we just keep reading characters and printing them until we get to
2321         the next double quote.
2322
2323         In compile mode we have the problem of where we're going to store the string (remember
2324         that the input buffer where the string comes from may be overwritten by the time we
2325         come round to running the function).  We store the string in the compiled function
2326         like this:
2327         ..., LITSTRING, string length, string rounded up to 4 bytes, EMITSTRING, ...
2328 )
2329 : .\" IMMEDIATE         ( -- )
2330         STATE @ IF      ( compiling? )
2331                 ' LITSTRING ,   ( compile LITSTRING )
2332                 HERE @          ( save the address of the length word on the stack )
2333                 0 ,             ( dummy length - we don't know what it is yet )
2334                 BEGIN
2335                         KEY             ( get next character of the string )
2336                         DUP '\"' <>
2337                 WHILE
2338                         HERE @ !b       ( store the character in the compiled image )
2339                         1 HERE +!       ( increment HERE pointer by 1 byte )
2340                 REPEAT
2341                 DROP            ( drop the double quote character at the end )
2342                 DUP             ( get the saved address of the length word )
2343                 HERE @ SWAP -   ( calculate the length )
2344                 4-              ( subtract 4 (because we measured from the start of the length word) )
2345                 SWAP !          ( and back-fill the length location )
2346                 HERE @          ( round up to next multiple of 4 bytes for the remaining code )
2347                 3 +
2348                 3 INVERT AND
2349                 HERE !
2350                 ' EMITSTRING ,  ( compile the final EMITSTRING )
2351         ELSE
2352                 ( In immediate mode, just read characters and print them until we get
2353                   to the ending double quote.  Much simpler than the above code! )
2354                 BEGIN
2355                         KEY
2356                         DUP '\"' = IF
2357                                 DROP    ( drop the double quote character )
2358                                 EXIT    ( return from this function )
2359                         THEN
2360                         EMIT
2361                 AGAIN
2362         THEN
2363 ;
2364
2365 (
2366         In FORTH, global constants and variables are defined like this:
2367
2368         10 CONSTANT TEN         when TEN is executed, it leaves the integer 10 on the stack
2369         VARIABLE VAR            when VAR is executed, it leaves the address of VAR on the stack
2370
2371         Constants can be read by not written, eg:
2372
2373         TEN . CR                prints 10
2374
2375         You can read a variable (in this example called VAR) by doing:
2376
2377         VAR @                   leaves the value of VAR on the stack
2378         VAR @ . CR              prints the value of VAR
2379
2380         and update the variable by doing:
2381
2382         20 VAR !                sets VAR to 20
2383
2384         Note that variables are uninitialised (but see VALUE later on which provides initialised
2385         variables with a slightly simpler syntax).
2386
2387         How can we define the words CONSTANT and VARIABLE?
2388
2389         The trick is to define a new word for the variable itself (eg. if the variable was called
2390         'VAR' then we would define a new word called VAR).  This is easy to do because we exposed
2391         dictionary entry creation through the CREATE word (part of the definition of : above).
2392         A call to CREATE TEN leaves the dictionary entry:
2393
2394                                    +--- HERE
2395                                    |
2396                                    V
2397         +---------+---+---+---+---+
2398         | LINK    | 3 | T | E | N |
2399         +---------+---+---+---+---+
2400                    len
2401
2402         For CONSTANT we can continue by appending DOCOL (the codeword), then LIT followed by
2403         the constant itself and then EXIT, forming a little word definition that returns the
2404         constant:
2405
2406         +---------+---+---+---+---+------------+------------+------------+------------+
2407         | LINK    | 3 | T | E | N | DOCOL      | LIT        | 10         | EXIT       |
2408         +---------+---+---+---+---+------------+------------+------------+------------+
2409                    len              codeword
2410
2411         Notice that this word definition is exactly the same as you would have got if you had
2412         written : TEN 10 ;
2413 )
2414 : CONSTANT
2415         CREATE          ( make the dictionary entry (the name follows CONSTANT) )
2416         DOCOL ,         ( append DOCOL (the codeword field of this word) )
2417         ' LIT ,         ( append the codeword LIT )
2418         ,               ( append the value on the top of the stack )
2419         ' EXIT ,        ( append the codeword EXIT )
2420 ;
2421
2422 (
2423         VARIABLE is a little bit harder because we need somewhere to put the variable.  There is
2424         nothing particularly special about the 'user definitions area' (the area of memory pointed
2425         to by HERE where we have previously just stored new word definitions).  We can slice off
2426         bits of this memory area to store anything we want, so one possible definition of
2427         VARIABLE might create this:
2428
2429            +--------------------------------------------------------------+
2430            |                                                              |
2431            V                                                              |
2432         +---------+---------+---+---+---+---+------------+------------+---|--------+------------+
2433         | <var>   | LINK    | 3 | V | A | R | DOCOL      | LIT        | <addr var> | EXIT       |
2434         +---------+---------+---+---+---+---+------------+------------+------------+------------+
2435                              len              codeword
2436
2437         where <var> is the place to store the variable, and <addr var> points back to it.
2438
2439         To make this more general let's define a couple of words which we can use to allocate
2440         arbitrary memory from the user definitions area.
2441
2442         First ALLOT, where n ALLOT allocates n bytes of memory.  (Note when calling this that
2443         it's a very good idea to make sure that n is a multiple of 4, or at least that next time
2444         a word is compiled that n has been left as a multiple of 4).
2445 )
2446 : ALLOT         ( n -- addr )
2447         HERE @ SWAP     ( here n -- )
2448         HERE +!         ( adds n to HERE, after this the old value of HERE is still on the stack )
2449 ;
2450
2451 (
2452         Second, CELLS.  In FORTH the phrase 'n CELLS ALLOT' means allocate n integers of whatever size
2453         is the natural size for integers on this machine architecture.  On this 32 bit machine therefore
2454         CELLS just multiplies the top of stack by 4.
2455 )
2456 : CELLS ( n -- n ) 4 * ;
2457
2458 (
2459         So now we can define VARIABLE easily in much the same way as CONSTANT above.  Refer to the
2460         diagram above to see what the word that this creates will look like.
2461 )
2462 : VARIABLE
2463         1 CELLS ALLOT   ( allocate 1 cell of memory, push the pointer to this memory )
2464         CREATE          ( make the dictionary entry (the name follows VARIABLE) )
2465         DOCOL ,         ( append DOCOL (the codeword field of this word) )
2466         ' LIT ,         ( append the codeword LIT )
2467         ,               ( append the pointer to the new memory )
2468         ' EXIT ,        ( append the codeword EXIT )
2469 ;
2470
2471 (
2472         VALUEs are like VARIABLEs but with a simpler syntax.  You would generally use them when you
2473         want a variable which is read often, and written infrequently.
2474
2475         20 VALUE VAL    creates VAL with initial value 20
2476         VAL             pushes the value directly on the stack
2477         30 TO VAL       updates VAL, setting it to 30
2478
2479         Notice that 'VAL' on its own doesn't return the address of the value, but the value itself,
2480         making values simpler and more obvious to use than variables (no indirection through '@').
2481         The price is a more complicated implementation, although despite the complexity there is no
2482         particular performance penalty at runtime.
2483
2484         A naive implementation of 'TO' would be quite slow, involving a dictionary search each time.
2485         But because this is FORTH we have complete control of the compiler so we can compile TO more
2486         efficiently, turning:
2487                 TO VAL
2488         into:
2489                 LIT <addr> !
2490         and calculating <addr> (the address of the value) at compile time.
2491
2492         Now this is the clever bit.  We'll compile our value like this:
2493
2494         +---------+---+---+---+---+------------+------------+------------+------------+
2495         | LINK    | 3 | V | A | L | DOCOL      | LIT        | <value>    | EXIT       |
2496         +---------+---+---+---+---+------------+------------+------------+------------+
2497                    len              codeword
2498
2499         where <value> is the actual value itself.  Note that when VAL executes, it will push the
2500         value on the stack, which is what we want.
2501
2502         But what will TO use for the address <addr>?  Why of course a pointer to that <value>:
2503
2504                 code compiled   - - - - --+------------+------------+------------+-- - - - -
2505                 by TO VAL                 | LIT        | <addr>     | !          |
2506                                 - - - - --+------------+-----|------+------------+-- - - - -
2507                                                              |
2508                                                              V
2509         +---------+---+---+---+---+------------+------------+------------+------------+
2510         | LINK    | 3 | V | A | L | DOCOL      | LIT        | <value>    | EXIT       |
2511         +---------+---+---+---+---+------------+------------+------------+------------+
2512                    len              codeword
2513
2514         In other words, this is a kind of self-modifying code.
2515
2516         (Note to the people who want to modify this FORTH to add inlining: values defined this
2517         way cannot be inlined).
2518 )
2519 : VALUE         ( n -- )
2520         CREATE          ( make the dictionary entry (the name follows VALUE) )
2521         DOCOL ,         ( append DOCOL )
2522         ' LIT ,         ( append the codeword LIT )
2523         ,               ( append the initial value )
2524         ' EXIT ,        ( append the codeword EXIT )
2525 ;
2526
2527 : TO IMMEDIATE  ( n -- )
2528         WORD            ( get the name of the value )
2529         FIND            ( look it up in the dictionary )
2530         >DFA            ( get a pointer to the first data field (the 'LIT') )
2531         4+              ( increment to point at the value )
2532         STATE @ IF      ( compiling? )
2533                 ' LIT ,         ( compile LIT )
2534                 ,               ( compile the address of the value )
2535                 ' ! ,           ( compile ! )
2536         ELSE            ( immediate mode )
2537                 !               ( update it straightaway )
2538         THEN
2539 ;
2540
2541 ( x +TO VAL adds x to VAL )
2542 : +TO IMMEDIATE
2543         WORD            ( get the name of the value )
2544         FIND            ( look it up in the dictionary )
2545         >DFA            ( get a pointer to the first data field (the 'LIT') )
2546         4+              ( increment to point at the value )
2547         STATE @ IF      ( compiling? )
2548                 ' LIT ,         ( compile LIT )
2549                 ,               ( compile the address of the value )
2550                 ' +! ,          ( compile +! )
2551         ELSE            ( immediate mode )
2552                 +!              ( update it straightaway )
2553         THEN
2554 ;
2555
2556 (
2557         ID. takes an address of a dictionary entry and prints the word's name.
2558
2559         For example: LATEST @ ID. would print the name of the last word that was defined.
2560 )
2561 : ID.
2562         4+              ( skip over the link pointer )
2563         DUP @b          ( get the flags/length byte )
2564         F_LENMASK AND   ( mask out the flags - just want the length )
2565
2566         BEGIN
2567                 DUP 0>          ( length > 0? )
2568         WHILE
2569                 SWAP 1+         ( addr len -- len addr+1 )
2570                 DUP @b          ( len addr -- len addr char | get the next character)
2571                 EMIT            ( len addr char -- len addr | and print it)
2572                 SWAP 1-         ( len addr -- addr len-1    | subtract one from length )
2573         REPEAT
2574         2DROP           ( len addr -- )
2575 ;
2576
2577 (
2578         WORDS prints all the words defined in the dictionary, starting with the word defined most recently.
2579
2580         The implementation simply iterates backwards from LATEST using the link pointers.
2581 )
2582 : WORDS
2583         LATEST @        ( start at LATEST dictionary entry )
2584         BEGIN
2585                 DUP 0<>         ( while link pointer is not null )
2586         WHILE
2587                 DUP ID.         ( print the word )
2588                 SPACE
2589                 @               ( dereference the link pointer - go to previous word )
2590         REPEAT
2591         DROP
2592         CR
2593 ;
2594
2595 (
2596         So far we have only allocated words and memory.  FORTH provides a rather primitive method
2597         to deallocate.
2598
2599         'FORGET word' deletes the definition of 'word' from the dictionary and everything defined
2600         after it, including any variables and other memory allocated after.
2601
2602         The implementation is very simple - we look up the word (which returns the dictionary entry
2603         address).  Then we set HERE to point to that address, so in effect all future allocations
2604         and definitions will overwrite memory starting at the word.  We also need to set LATEST to
2605         point to the previous word.
2606
2607         Note that you cannot FORGET built-in words (well, you can try but it will probably cause
2608         a segfault).
2609
2610         XXX: Because we wrote VARIABLE to store the variable in memory allocated before the word,
2611         in the current implementation VARIABLE FOO FORGET FOO will leak 1 cell of memory.
2612 )
2613 : FORGET
2614         WORD FIND       ( find the word, gets the dictionary entry address )
2615         DUP @ LATEST !  ( set LATEST to point to the previous word )
2616         HERE !          ( and store HERE with the dictionary address )
2617 ;
2618
2619 (
2620         While compiling, '[COMPILE] word' compiles 'word' if it would otherwise be IMMEDIATE.
2621 )
2622 : [COMPILE] IMMEDIATE
2623         WORD            ( get the next word )
2624         FIND            ( find it in the dictionary )
2625         >CFA            ( get its codeword )
2626         ,               ( and compile that )
2627 ;
2628
2629 (
2630         RECURSE makes a recursive call to the current word that is being compiled.
2631
2632         Normally while a word is being compiled, it is marked HIDDEN so that references to the
2633         same word within are calls to the previous definition of the word.  However we still have
2634         access to the word which we are currently compiling through the LATEST pointer so we
2635         can use that to compile a recursive call.
2636 )
2637 : RECURSE IMMEDIATE
2638         LATEST @ >CFA   ( LATEST points to the word being compiled at the moment )
2639         ,               ( compile it )
2640 ;
2641
2642 (
2643         DUMP is used to dump out the contents of memory, in the 'traditional' hexdump format.
2644 )
2645 : DUMP          ( addr len -- )
2646         BEGIN
2647                 DUP 0>          ( while len > 0 )
2648         WHILE
2649                 OVER .          ( print the address )
2650                 SPACE
2651
2652                 ( print up to 16 words on this line )
2653                 2DUP            ( addr len addr len )
2654                 1- 15 AND 1+    ( addr len addr linelen )
2655                 BEGIN
2656                         DUP 0>          ( while linelen > 0 )
2657                 WHILE
2658                         SWAP            ( addr len linelen addr )
2659                         DUP @b          ( addr len linelen addr byte )
2660                         . SPACE         ( print the byte )
2661                         1+ SWAP 1-      ( addr len linelen addr -- addr len addr+1 linelen-1 )
2662                 REPEAT
2663                 2DROP           ( addr len )
2664
2665                 ( print the ASCII equivalents )
2666                 2DUP 1- 15 AND 1+ ( addr len addr linelen )
2667                 BEGIN
2668                         DUP 0>          ( while linelen > 0)
2669                 WHILE
2670                         SWAP            ( addr len linelen addr )
2671                         DUP @b          ( addr len linelen addr byte )
2672                         DUP 32 128 WITHIN IF    ( 32 <= c < 128? )
2673                                 EMIT
2674                         ELSE
2675                                 DROP [ CHAR ? ] LITERAL EMIT
2676                         THEN
2677                         1+ SWAP 1-      ( addr len linelen addr -- addr len addr+1 linelen-1 )
2678                 REPEAT
2679                 2DROP           ( addr len )
2680                 CR
2681
2682                 DUP 1- 15 AND 1+ ( addr len linelen )
2683                 DUP             ( addr len linelen linelen )
2684                 ROT             ( addr linelen len linelen )
2685                 -               ( addr linelen len-linelen )
2686                 ROT             ( len-linelen addr linelen )
2687                 +               ( len-linelen addr+linelen )
2688                 SWAP            ( addr-linelen len-linelen )
2689         REPEAT
2690         2DROP
2691         CR
2692 ;
2693
2694 ( Finally print the welcome prompt. )
2695 .\" JONESFORTH VERSION \" VERSION . CR
2696 .\" OK \"
2697 "
2698
2699 _initbufftop:
2700         .align 4096
2701 buffend:
2702
2703 currkey:
2704         .int buffer
2705 bufftop:
2706         .int _initbufftop
2707
2708 /* END OF jonesforth.S */