forked from nornagon/jonesforth
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jonesforth.f
1788 lines (1490 loc) · 58 KB
/
jonesforth.f
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
\ -*- text -*-
\ A sometimes minimal FORTH compiler and tutorial for Linux / i386 systems. -*- asm -*-
\ By Richard W.M. Jones <[email protected]> http://annexia.org/forth
\ This is PUBLIC DOMAIN (see public domain release statement below).
\ $Id: jonesforth.f,v 1.18 2009-09-11 08:32:33 rich Exp $
\
\ The first part of this tutorial is in jonesforth.S. Get if from http://annexia.org/forth
\
\ PUBLIC DOMAIN ----------------------------------------------------------------------
\
\ I, the copyright holder of this work, hereby release it into the public domain. This applies worldwide.
\
\ In case this is not legally possible, I grant any entity the right to use this work for any purpose,
\ without any conditions, unless such conditions are required by law.
\
\ SETTING UP ----------------------------------------------------------------------
\
\ Let's get a few housekeeping things out of the way. Firstly because I need to draw lots of
\ ASCII-art diagrams to explain concepts, the best way to look at this is using a window which
\ uses a fixed width font and is at least this wide:
\
\<------------------------------------------------------------------------------------------------------------------------>
\
\ Secondly make sure TABS are set to 8 characters. The following should be a vertical
\ line. If not, sort out your tabs.
\
\ |
\ |
\ |
\
\ Thirdly I assume that your screen is at least 50 characters high.
\
\ START OF FORTH CODE ----------------------------------------------------------------------
\
\ We've now reached the stage where the FORTH system is running and self-hosting. All further
\ words can be written as FORTH itself, including words like IF, THEN, .", etc which in most
\ languages would be considered rather fundamental.
\
\ Some notes about the code:
\
\ I use indenting to show structure. The amount of whitespace has no meaning to FORTH however
\ except that you must use at least one whitespace character between words, and words themselves
\ cannot contain whitespace.
\
\ FORTH is case-sensitive. Use capslock!
\ The primitive word /MOD (DIVMOD) leaves both the quotient and the remainder on the stack. (On
\ i386, the idivl instruction gives both anyway). Now we can define the / and MOD in terms of /MOD
\ and a few other primitives.
: / /MOD SWAP DROP ;
: MOD /MOD DROP ;
\ Define some character constants
: '\n' 10 ;
: BL 32 ; \ BL (BLank) is a standard FORTH word for space.
\ CR prints a carriage return
: CR '\n' EMIT ;
\ SPACE prints a space
: SPACE BL EMIT ;
\ NEGATE leaves the negative of a number on the stack.
: NEGATE 0 SWAP - ;
\ Standard words for booleans.
: TRUE 1 ;
: FALSE 0 ;
: NOT 0= ;
\ LITERAL takes whatever is on the stack and compiles LIT <foo>
: LITERAL IMMEDIATE
' LIT , \ compile LIT
, \ compile the literal itself (from the stack)
;
\ Now we can use [ and ] to insert literals which are calculated at compile time. (Recall that
\ [ and ] are the FORTH words which switch into and out of immediate mode.)
\ Within definitions, use [ ... ] LITERAL anywhere that '...' is a constant expression which you
\ would rather only compute once (at compile time, rather than calculating it each time your word runs).
: ':'
[ \ go into immediate mode (temporarily)
CHAR : \ push the number 58 (ASCII code of colon) on the parameter stack
] \ go back to compile mode
LITERAL \ compile LIT 58 as the definition of ':' word
;
\ A few more character constants defined the same way as above.
: ';' [ CHAR ; ] LITERAL ;
: '(' [ CHAR ( ] LITERAL ;
: ')' [ CHAR ) ] LITERAL ;
: '"' [ CHAR " ] LITERAL ;
: 'A' [ CHAR A ] LITERAL ;
: '0' [ CHAR 0 ] LITERAL ;
: '-' [ CHAR - ] LITERAL ;
: '.' [ CHAR . ] LITERAL ;
\ While compiling, '[COMPILE] word' compiles 'word' if it would otherwise be IMMEDIATE.
: [COMPILE] IMMEDIATE
WORD \ get the next word
FIND \ find it in the dictionary
>CFA \ get its codeword
, \ and compile that
;
\ RECURSE makes a recursive call to the current word that is being compiled.
\
\ Normally while a word is being compiled, it is marked HIDDEN so that references to the
\ same word within are calls to the previous definition of the word. However we still have
\ access to the word which we are currently compiling through the LATEST pointer so we
\ can use that to compile a recursive call.
: RECURSE IMMEDIATE
LATEST @ \ LATEST points to the word being compiled at the moment
>CFA \ get the codeword
, \ compile it
;
\ CONTROL STRUCTURES ----------------------------------------------------------------------
\
\ So far we have defined only very simple definitions. Before we can go further, we really need to
\ make some control structures, like IF ... THEN and loops. Luckily we can define arbitrary control
\ structures directly in FORTH.
\
\ Please note that the control structures as I have defined them here will only work inside compiled
\ words. If you try to type in expressions using IF, etc. in immediate mode, then they won't work.
\ Making these work in immediate mode is left as an exercise for the reader.
\ condition IF true-part THEN rest
\ -- compiles to: --> condition 0BRANCH OFFSET true-part rest
\ where OFFSET is the offset of 'rest'
\ condition IF true-part ELSE false-part THEN
\ -- compiles to: --> condition 0BRANCH OFFSET true-part BRANCH OFFSET2 false-part rest
\ where OFFSET if the offset of false-part and OFFSET2 is the offset of rest
\ IF is an IMMEDIATE word which compiles 0BRANCH followed by a dummy offset, and places
\ the address of the 0BRANCH on the stack. Later when we see THEN, we pop that address
\ off the stack, calculate the offset, and back-fill the offset.
: IF IMMEDIATE
' 0BRANCH , \ compile 0BRANCH
HERE @ \ save location of the offset on the stack
0 , \ compile a dummy offset
;
: THEN IMMEDIATE
DUP
HERE @ SWAP - \ calculate the offset from the address saved on the stack
SWAP ! \ store the offset in the back-filled location
;
: ELSE IMMEDIATE
' BRANCH , \ definite branch to just over the false-part
HERE @ \ save location of the offset on the stack
0 , \ compile a dummy offset
SWAP \ now back-fill the original (IF) offset
DUP \ same as for THEN word above
HERE @ SWAP -
SWAP !
;
\ BEGIN loop-part condition UNTIL
\ -- compiles to: --> loop-part condition 0BRANCH OFFSET
\ where OFFSET points back to the loop-part
\ This is like do { loop-part } while (condition) in the C language
: BEGIN IMMEDIATE
HERE @ \ save location on the stack
;
: UNTIL IMMEDIATE
' 0BRANCH , \ compile 0BRANCH
HERE @ - \ calculate the offset from the address saved on the stack
, \ compile the offset here
;
\ BEGIN loop-part AGAIN
\ -- compiles to: --> loop-part BRANCH OFFSET
\ where OFFSET points back to the loop-part
\ In other words, an infinite loop which can only be returned from with EXIT
: AGAIN IMMEDIATE
' BRANCH , \ compile BRANCH
HERE @ - \ calculate the offset back
, \ compile the offset here
;
\ BEGIN condition WHILE loop-part REPEAT
\ -- compiles to: --> condition 0BRANCH OFFSET2 loop-part BRANCH OFFSET
\ where OFFSET points back to condition (the beginning) and OFFSET2 points to after the whole piece of code
\ So this is like a while (condition) { loop-part } loop in the C language
: WHILE IMMEDIATE
' 0BRANCH , \ compile 0BRANCH
HERE @ \ save location of the offset2 on the stack
0 , \ compile a dummy offset2
;
: REPEAT IMMEDIATE
' BRANCH , \ compile BRANCH
SWAP \ get the original offset (from BEGIN)
HERE @ - , \ and compile it after BRANCH
DUP
HERE @ SWAP - \ calculate the offset2
SWAP ! \ and back-fill it in the original location
;
\ UNLESS is the same as IF but the test is reversed.
\
\ Note the use of [COMPILE]: Since IF is IMMEDIATE we don't want it to be executed while UNLESS
\ is compiling, but while UNLESS is running (which happens to be when whatever word using UNLESS is
\ being compiled -- whew!). So we use [COMPILE] to reverse the effect of marking IF as immediate.
\ This trick is generally used when we want to write our own control words without having to
\ implement them all in terms of the primitives 0BRANCH and BRANCH, but instead reusing simpler
\ control words like (in this instance) IF.
: UNLESS IMMEDIATE
' NOT , \ compile NOT (to reverse the test)
[COMPILE] IF \ continue by calling the normal IF
;
\ COMMENTS ----------------------------------------------------------------------
\
\ FORTH allows ( ... ) as comments within function definitions. This works by having an IMMEDIATE
\ word called ( which just drops input characters until it hits the corresponding ).
: ( IMMEDIATE
1 \ allowed nested parens by keeping track of depth
BEGIN
KEY \ read next character
DUP '(' = IF \ open paren?
DROP \ drop the open paren
1+ \ depth increases
ELSE
')' = IF \ close paren?
1- \ depth decreases
THEN
THEN
DUP 0= UNTIL \ continue until we reach matching close paren, depth 0
DROP \ drop the depth counter
;
(
From now on we can use ( ... ) for comments.
STACK NOTATION ----------------------------------------------------------------------
In FORTH style we can also use ( ... -- ... ) to show the effects that a word has on the
parameter stack. For example:
( n -- ) means that the word consumes an integer (n) from the parameter stack.
( b a -- c ) means that the word uses two integers (a and b, where a is at the top of stack)
and returns a single integer (c).
( -- ) means the word has no effect on the stack
)
( Some more complicated stack examples, showing the stack notation. )
: NIP ( x y -- y ) SWAP DROP ;
: TUCK ( x y -- y x y ) SWAP OVER ;
: PICK ( x_u ... x_1 x_0 u -- x_u ... x_1 x_0 x_u )
1+ ( add one because of 'u' on the stack )
4 * ( multiply by the word size )
DSP@ + ( add to the stack pointer )
@ ( and fetch )
;
( With the looping constructs, we can now write SPACES, which writes n spaces to stdout. )
: SPACES ( n -- )
BEGIN
DUP 0> ( while n > 0 )
WHILE
SPACE ( print a space )
1- ( until we count down to 0 )
REPEAT
DROP
;
( Standard words for manipulating BASE. )
: DECIMAL ( -- ) 10 BASE ! ;
: HEX ( -- ) 16 BASE ! ;
(
PRINTING NUMBERS ----------------------------------------------------------------------
The standard FORTH word . (DOT) is very important. It takes the number at the top
of the stack and prints it out. However first I'm going to implement some lower-level
FORTH words:
U.R ( u width -- ) which prints an unsigned number, padded to a certain width
U. ( u -- ) which prints an unsigned number
.R ( n width -- ) which prints a signed number, padded to a certain width.
For example:
-123 6 .R
will print out these characters:
<space> <space> - 1 2 3
In other words, the number padded left to a certain number of characters.
The full number is printed even if it is wider than width, and this is what allows us to
define the ordinary functions U. and . (we just set width to zero knowing that the full
number will be printed anyway).
Another wrinkle of . and friends is that they obey the current base in the variable BASE.
BASE can be anything in the range 2 to 36.
While we're defining . &c we can also define .S which is a useful debugging tool. This
word prints the current stack (non-destructively) from top to bottom.
)
( This is the underlying recursive definition of U. )
: U. ( u -- )
BASE @ /MOD ( width rem quot )
?DUP IF ( if quotient <> 0 then )
RECURSE ( print the quotient )
THEN
( print the remainder )
DUP 10 < IF
'0' ( decimal digits 0..9 )
ELSE
10 - ( hex and beyond digits A..Z )
'A'
THEN
+
EMIT
;
(
FORTH word .S prints the contents of the stack. It doesn't alter the stack.
Very useful for debugging.
)
: .S ( -- )
DSP@ ( get current stack pointer )
BEGIN
DUP S0 @ <
WHILE
DUP @ U. ( print the stack element )
SPACE
4+ ( move up )
REPEAT
DROP
;
( This word returns the width (in characters) of an unsigned number in the current base )
: UWIDTH ( u -- width )
BASE @ / ( rem quot )
?DUP IF ( if quotient <> 0 then )
RECURSE 1+ ( return 1+recursive call )
ELSE
1 ( return 1 )
THEN
;
: U.R ( u width -- )
SWAP ( width u )
DUP ( width u u )
UWIDTH ( width u uwidth )
ROT ( u uwidth width )
SWAP - ( u width-uwidth )
( At this point if the requested width is narrower, we'll have a negative number on the stack.
Otherwise the number on the stack is the number of spaces to print. But SPACES won't print
a negative number of spaces anyway, so it's now safe to call SPACES ... )
SPACES
( ... and then call the underlying implementation of U. )
U.
;
(
.R prints a signed number, padded to a certain width. We can't just print the sign
and call U.R because we want the sign to be next to the number ('-123' instead of '- 123').
)
: .R ( n width -- )
SWAP ( width n )
DUP 0< IF
NEGATE ( width u )
1 ( save a flag to remember that it was negative | width n 1 )
SWAP ( width 1 u )
ROT ( 1 u width )
1- ( 1 u width-1 )
ELSE
0 ( width u 0 )
SWAP ( width 0 u )
ROT ( 0 u width )
THEN
SWAP ( flag width u )
DUP ( flag width u u )
UWIDTH ( flag width u uwidth )
ROT ( flag u uwidth width )
SWAP - ( flag u width-uwidth )
SPACES ( flag u )
SWAP ( u flag )
IF ( was it negative? print the - character )
'-' EMIT
THEN
U.
;
( Finally we can define word . in terms of .R, with a trailing space. )
: . 0 .R SPACE ;
( The real U., note the trailing space. )
: U. U. SPACE ;
( ? fetches the integer at an address and prints it. )
: ? ( addr -- ) @ . ;
( c a b WITHIN returns true if a <= c and c < b )
( or define without ifs: OVER - >R - R> U< )
: WITHIN
-ROT ( b c a )
OVER ( b c a c )
<= IF
> IF ( b c -- )
TRUE
ELSE
FALSE
THEN
ELSE
2DROP ( b c -- )
FALSE
THEN
;
( DEPTH returns the depth of the stack. )
: DEPTH ( -- n )
S0 @ DSP@ -
4- ( adjust because S0 was on the stack when we pushed DSP )
;
(
ALIGNED takes an address and rounds it up (aligns it) to the next 4 byte boundary.
)
: ALIGNED ( addr -- addr )
3 + 3 INVERT AND ( (addr+3) & ~3 )
;
(
ALIGN aligns the HERE pointer, so the next word appended will be aligned properly.
)
: ALIGN HERE @ ALIGNED HERE ! ;
(
STRINGS ----------------------------------------------------------------------
S" string" is used in FORTH to define strings. It leaves the address of the string and
its length on the stack, (length at the top of stack). The space following S" is the normal
space between FORTH words and is not a part of the string.
This is tricky to define because it has to do different things depending on whether
we are compiling or in immediate mode. (Thus the word is marked IMMEDIATE so it can
detect this and do different things).
In compile mode we append
LITSTRING <string length> <string rounded up 4 bytes>
to the current word. The primitive LITSTRING does the right thing when the current
word is executed.
In immediate mode there isn't a particularly good place to put the string, but in this
case we put the string at HERE (but we _don't_ change HERE). This is meant as a temporary
location, likely to be overwritten soon after.
)
( C, appends a byte to the current compiled word. )
: C,
HERE @ C! ( store the character in the compiled image )
1 HERE +! ( increment HERE pointer by 1 byte )
;
: S" IMMEDIATE ( -- addr len )
STATE @ IF ( compiling? )
' LITSTRING , ( compile LITSTRING )
HERE @ ( save the address of the length word on the stack )
0 , ( dummy length - we don't know what it is yet )
BEGIN
KEY ( get next character of the string )
DUP '"' <>
WHILE
C, ( copy character )
REPEAT
DROP ( drop the double quote character at the end )
DUP ( get the saved address of the length word )
HERE @ SWAP - ( calculate the length )
4- ( subtract 4 (because we measured from the start of the length word) )
SWAP ! ( and back-fill the length location )
ALIGN ( round up to next multiple of 4 bytes for the remaining code )
ELSE ( immediate mode )
HERE @ ( get the start address of the temporary space )
BEGIN
KEY
DUP '"' <>
WHILE
OVER C! ( save next character )
1+ ( increment address )
REPEAT
DROP ( drop the final " character )
HERE @ - ( calculate the length )
HERE @ ( push the start address )
SWAP ( addr len )
THEN
;
(
." is the print string operator in FORTH. Example: ." Something to print"
The space after the operator is the ordinary space required between words and is not
a part of what is printed.
In immediate mode we just keep reading characters and printing them until we get to
the next double quote.
In compile mode we use S" to store the string, then add TELL afterwards:
LITSTRING <string length> <string rounded up to 4 bytes> TELL
It may be interesting to note the use of [COMPILE] to turn the call to the immediate
word S" into compilation of that word. It compiles it into the definition of .",
not into the definition of the word being compiled when this is running (complicated
enough for you?)
)
: ." IMMEDIATE ( -- )
STATE @ IF ( compiling? )
[COMPILE] S" ( read the string, and compile LITSTRING, etc. )
' TELL , ( compile the final TELL )
ELSE
( In immediate mode, just read characters and print them until we get
to the ending double quote. )
BEGIN
KEY
DUP '"' = IF
DROP ( drop the double quote character )
EXIT ( return from this function )
THEN
EMIT
AGAIN
THEN
;
(
CONSTANTS AND VARIABLES ----------------------------------------------------------------------
In FORTH, global constants and variables are defined like this:
10 CONSTANT TEN when TEN is executed, it leaves the integer 10 on the stack
VARIABLE VAR when VAR is executed, it leaves the address of VAR on the stack
Constants can be read but not written, eg:
TEN . CR prints 10
You can read a variable (in this example called VAR) by doing:
VAR @ leaves the value of VAR on the stack
VAR @ . CR prints the value of VAR
VAR ? CR same as above, since ? is the same as @ .
and update the variable by doing:
20 VAR ! sets VAR to 20
Note that variables are uninitialised (but see VALUE later on which provides initialised
variables with a slightly simpler syntax).
How can we define the words CONSTANT and VARIABLE?
The trick is to define a new word for the variable itself (eg. if the variable was called
'VAR' then we would define a new word called VAR). This is easy to do because we exposed
dictionary entry creation through the CREATE word (part of the definition of : above).
A call to WORD [TEN] CREATE (where [TEN] means that "TEN" is the next word in the input)
leaves the dictionary entry:
+--- HERE
|
V
+---------+---+---+---+---+
| LINK | 3 | T | E | N |
+---------+---+---+---+---+
len
For CONSTANT we can continue by appending DOCOL (the codeword), then LIT followed by
the constant itself and then EXIT, forming a little word definition that returns the
constant:
+---------+---+---+---+---+------------+------------+------------+------------+
| LINK | 3 | T | E | N | DOCOL | LIT | 10 | EXIT |
+---------+---+---+---+---+------------+------------+------------+------------+
len codeword
Notice that this word definition is exactly the same as you would have got if you had
written : TEN 10 ;
Note for people reading the code below: DOCOL is a constant word which we defined in the
assembler part which returns the value of the assembler symbol of the same name.
)
: CONSTANT
WORD ( get the name (the name follows CONSTANT) )
CREATE ( make the dictionary entry )
DOCOL , ( append DOCOL (the codeword field of this word) )
' LIT , ( append the codeword LIT )
, ( append the value on the top of the stack )
' EXIT , ( append the codeword EXIT )
;
(
VARIABLE is a little bit harder because we need somewhere to put the variable. There is
nothing particularly special about the user memory (the area of memory pointed to by HERE
where we have previously just stored new word definitions). We can slice off bits of this
memory area to store anything we want, so one possible definition of VARIABLE might create
this:
+--------------------------------------------------------------+
| |
V |
+---------+---------+---+---+---+---+------------+------------+---|--------+------------+
| <var> | LINK | 3 | V | A | R | DOCOL | LIT | <addr var> | EXIT |
+---------+---------+---+---+---+---+------------+------------+------------+------------+
len codeword
where <var> is the place to store the variable, and <addr var> points back to it.
To make this more general let's define a couple of words which we can use to allocate
arbitrary memory from the user memory.
First ALLOT, where n ALLOT allocates n bytes of memory. (Note when calling this that
it's a very good idea to make sure that n is a multiple of 4, or at least that next time
a word is compiled that HERE has been left as a multiple of 4).
)
: ALLOT ( n -- addr )
HERE @ SWAP ( here n )
HERE +! ( adds n to HERE, after this the old value of HERE is still on the stack )
;
(
Second, CELLS. In FORTH the phrase 'n CELLS ALLOT' means allocate n integers of whatever size
is the natural size for integers on this machine architecture. On this 32 bit machine therefore
CELLS just multiplies the top of stack by 4.
)
: CELLS ( n -- n ) 4 * ;
(
So now we can define VARIABLE easily in much the same way as CONSTANT above. Refer to the
diagram above to see what the word that this creates will look like.
)
: VARIABLE
1 CELLS ALLOT ( allocate 1 cell of memory, push the pointer to this memory )
WORD CREATE ( make the dictionary entry (the name follows VARIABLE) )
DOCOL , ( append DOCOL (the codeword field of this word) )
' LIT , ( append the codeword LIT )
, ( append the pointer to the new memory )
' EXIT , ( append the codeword EXIT )
;
(
VALUES ----------------------------------------------------------------------
VALUEs are like VARIABLEs but with a simpler syntax. You would generally use them when you
want a variable which is read often, and written infrequently.
20 VALUE VAL creates VAL with initial value 20
VAL pushes the value (20) directly on the stack
30 TO VAL updates VAL, setting it to 30
VAL pushes the value (30) directly on the stack
Notice that 'VAL' on its own doesn't return the address of the value, but the value itself,
making values simpler and more obvious to use than variables (no indirection through '@').
The price is a more complicated implementation, although despite the complexity there is no
performance penalty at runtime.
A naive implementation of 'TO' would be quite slow, involving a dictionary search each time.
But because this is FORTH we have complete control of the compiler so we can compile TO more
efficiently, turning:
TO VAL
into:
LIT <addr> !
and calculating <addr> (the address of the value) at compile time.
Now this is the clever bit. We'll compile our value like this:
+---------+---+---+---+---+------------+------------+------------+------------+
| LINK | 3 | V | A | L | DOCOL | LIT | <value> | EXIT |
+---------+---+---+---+---+------------+------------+------------+------------+
len codeword
where <value> is the actual value itself. Note that when VAL executes, it will push the
value on the stack, which is what we want.
But what will TO use for the address <addr>? Why of course a pointer to that <value>:
code compiled - - - - --+------------+------------+------------+-- - - - -
by TO VAL | LIT | <addr> | ! |
- - - - --+------------+-----|------+------------+-- - - - -
|
V
+---------+---+---+---+---+------------+------------+------------+------------+
| LINK | 3 | V | A | L | DOCOL | LIT | <value> | EXIT |
+---------+---+---+---+---+------------+------------+------------+------------+
len codeword
In other words, this is a kind of self-modifying code.
(Note to the people who want to modify this FORTH to add inlining: values defined this
way cannot be inlined).
)
: VALUE ( n -- )
WORD CREATE ( make the dictionary entry (the name follows VALUE) )
DOCOL , ( append DOCOL )
' LIT , ( append the codeword LIT )
, ( append the initial value )
' EXIT , ( append the codeword EXIT )
;
: TO IMMEDIATE ( n -- )
WORD ( get the name of the value )
FIND ( look it up in the dictionary )
>DFA ( get a pointer to the first data field (the 'LIT') )
4+ ( increment to point at the value )
STATE @ IF ( compiling? )
' LIT , ( compile LIT )
, ( compile the address of the value )
' ! , ( compile ! )
ELSE ( immediate mode )
! ( update it straightaway )
THEN
;
( x +TO VAL adds x to VAL )
: +TO IMMEDIATE
WORD ( get the name of the value )
FIND ( look it up in the dictionary )
>DFA ( get a pointer to the first data field (the 'LIT') )
4+ ( increment to point at the value )
STATE @ IF ( compiling? )
' LIT , ( compile LIT )
, ( compile the address of the value )
' +! , ( compile +! )
ELSE ( immediate mode )
+! ( update it straightaway )
THEN
;
(
PRINTING THE DICTIONARY ----------------------------------------------------------------------
ID. takes an address of a dictionary entry and prints the word's name.
For example: LATEST @ ID. would print the name of the last word that was defined.
)
: ID.
4+ ( skip over the link pointer )
DUP C@ ( get the flags/length byte )
F_LENMASK AND ( mask out the flags - just want the length )
BEGIN
DUP 0> ( length > 0? )
WHILE
SWAP 1+ ( addr len -- len addr+1 )
DUP C@ ( len addr -- len addr char | get the next character)
EMIT ( len addr char -- len addr | and print it)
SWAP 1- ( len addr -- addr len-1 | subtract one from length )
REPEAT
2DROP ( len addr -- )
;
(
'WORD word FIND ?HIDDEN' returns true if 'word' is flagged as hidden.
'WORD word FIND ?IMMEDIATE' returns true if 'word' is flagged as immediate.
)
: ?HIDDEN
4+ ( skip over the link pointer )
C@ ( get the flags/length byte )
F_HIDDEN AND ( mask the F_HIDDEN flag and return it (as a truth value) )
;
: ?IMMEDIATE
4+ ( skip over the link pointer )
C@ ( get the flags/length byte )
F_IMMED AND ( mask the F_IMMED flag and return it (as a truth value) )
;
(
WORDS prints all the words defined in the dictionary, starting with the word defined most recently.
However it doesn't print hidden words.
The implementation simply iterates backwards from LATEST using the link pointers.
)
: WORDS
LATEST @ ( start at LATEST dictionary entry )
BEGIN
?DUP ( while link pointer is not null )
WHILE
DUP ?HIDDEN NOT IF ( ignore hidden words )
DUP ID. ( but if not hidden, print the word )
SPACE
THEN
@ ( dereference the link pointer - go to previous word )
REPEAT
CR
;
(
FORGET ----------------------------------------------------------------------
So far we have only allocated words and memory. FORTH provides a rather primitive method
to deallocate.
'FORGET word' deletes the definition of 'word' from the dictionary and everything defined
after it, including any variables and other memory allocated after.
The implementation is very simple - we look up the word (which returns the dictionary entry
address). Then we set HERE to point to that address, so in effect all future allocations
and definitions will overwrite memory starting at the word. We also need to set LATEST to
point to the previous word.
Note that you cannot FORGET built-in words (well, you can try but it will probably cause
a segfault).
XXX: Because we wrote VARIABLE to store the variable in memory allocated before the word,
in the current implementation VARIABLE FOO FORGET FOO will leak 1 cell of memory.
)
: FORGET
WORD FIND ( find the word, gets the dictionary entry address )
DUP @ LATEST ! ( set LATEST to point to the previous word )
HERE ! ( and store HERE with the dictionary address )
;
(
DUMP ----------------------------------------------------------------------
DUMP is used to dump out the contents of memory, in the 'traditional' hexdump format.
Notice that the parameters to DUMP (address, length) are compatible with string words
such as WORD and S".
You can dump out the raw code for the last word you defined by doing something like:
LATEST @ 128 DUMP
)
: DUMP ( addr len -- )
BASE @ -ROT ( save the current BASE at the bottom of the stack )
HEX ( and switch to hexadecimal mode )
BEGIN
?DUP ( while len > 0 )
WHILE
OVER 8 U.R ( print the address )
SPACE
( print up to 16 words on this line )
2DUP ( addr len addr len )
1- 15 AND 1+ ( addr len addr linelen )
BEGIN
?DUP ( while linelen > 0 )
WHILE
SWAP ( addr len linelen addr )
DUP C@ ( addr len linelen addr byte )
2 .R SPACE ( print the byte )
1+ SWAP 1- ( addr len linelen addr -- addr len addr+1 linelen-1 )
REPEAT
DROP ( addr len )
( print the ASCII equivalents )
2DUP 1- 15 AND 1+ ( addr len addr linelen )
BEGIN
?DUP ( while linelen > 0)
WHILE
SWAP ( addr len linelen addr )
DUP C@ ( addr len linelen addr byte )
DUP 32 128 WITHIN IF ( 32 <= c < 128? )
EMIT
ELSE
DROP '.' EMIT
THEN
1+ SWAP 1- ( addr len linelen addr -- addr len addr+1 linelen-1 )
REPEAT
DROP ( addr len )
CR
DUP 1- 15 AND 1+ ( addr len linelen )
TUCK ( addr linelen len linelen )
- ( addr linelen len-linelen )
>R + R> ( addr+linelen len-linelen )
REPEAT
DROP ( restore stack )
BASE ! ( restore saved BASE )
;
(
CASE ----------------------------------------------------------------------
CASE...ENDCASE is how we do switch statements in FORTH. There is no generally
agreed syntax for this, so I've gone for the syntax mandated by the ISO standard
FORTH (ANS-FORTH).
( some value on the stack )
CASE
test1 OF ... ENDOF
test2 OF ... ENDOF
testn OF ... ENDOF
... ( default case )
ENDCASE
The CASE statement tests the value on the stack by comparing it for equality with
test1, test2, ..., testn and executes the matching piece of code within OF ... ENDOF.
If none of the test values match then the default case is executed. Inside the ... of
the default case, the value is still at the top of stack (it is implicitly DROP-ed
by ENDCASE). When ENDOF is executed it jumps after ENDCASE (ie. there is no "fall-through"
and no need for a break statement like in C).
The default case may be omitted. In fact the tests may also be omitted so that you
just have a default case, although this is probably not very useful.
An example (assuming that 'q', etc. are words which push the ASCII value of the letter
on the stack):
0 VALUE QUIT
0 VALUE SLEEP
KEY CASE
'q' OF 1 TO QUIT ENDOF
's' OF 1 TO SLEEP ENDOF
( default case: )
." Sorry, I didn't understand key <" DUP EMIT ." >, try again." CR
ENDCASE
(In some versions of FORTH, more advanced tests are supported, such as ranges, etc.
Other versions of FORTH need you to write OTHERWISE to indicate the default case.
As I said above, this FORTH tries to follow the ANS FORTH standard).
The implementation of CASE...ENDCASE is somewhat non-trivial. I'm following the
implementations from here:
http://www.uni-giessen.de/faq/archiv/forthfaq.case_endcase/msg00000.html
The general plan is to compile the code as a series of IF statements:
CASE (push 0 on the immediate-mode parameter stack)
test1 OF ... ENDOF test1 OVER = IF DROP ... ELSE
test2 OF ... ENDOF test2 OVER = IF DROP ... ELSE
testn OF ... ENDOF testn OVER = IF DROP ... ELSE
... ( default case ) ...
ENDCASE DROP THEN [THEN [THEN ...]]
The CASE statement pushes 0 on the immediate-mode parameter stack, and that number
is used to count how many THEN statements we need when we get to ENDCASE so that each
IF has a matching THEN. The counting is done implicitly. If you recall from the
implementation above of IF, each IF pushes a code address on the immediate-mode stack,
and these addresses are non-zero, so by the time we get to ENDCASE the stack contains
some number of non-zeroes, followed by a zero. The number of non-zeroes is how many
times IF has been called, so how many times we need to match it with THEN.
This code uses [COMPILE] so that we compile calls to IF, ELSE, THEN instead of
actually calling them while we're compiling the words below.
As is the case with all of our control structures, they only work within word
definitions, not in immediate mode.
)
: CASE IMMEDIATE
0 ( push 0 to mark the bottom of the stack )
;
: OF IMMEDIATE
' OVER , ( compile OVER )
' = , ( compile = )
[COMPILE] IF ( compile IF )
' DROP , ( compile DROP )
;
: ENDOF IMMEDIATE
[COMPILE] ELSE ( ENDOF is the same as ELSE )
;
: ENDCASE IMMEDIATE
' DROP , ( compile DROP )
( keep compiling THEN until we get to our zero marker )
BEGIN
?DUP
WHILE
[COMPILE] THEN
REPEAT
;
(
DECOMPILER ----------------------------------------------------------------------
CFA> is the opposite of >CFA. It takes a codeword and tries to find the matching
dictionary definition. (In truth, it works with any pointer into a word, not just
the codeword pointer, and this is needed to do stack traces).
In this FORTH this is not so easy. In fact we have to search through the dictionary
because we don't have a convenient back-pointer (as is often the case in other versions
of FORTH). Because of this search, CFA> should not be used when performance is critical,
so it is only used for debugging tools such as the decompiler and printing stack
traces.
This word returns 0 if it doesn't find a match.
)
: CFA>
LATEST @ ( start at LATEST dictionary entry )
BEGIN
?DUP ( while link pointer is not null )
WHILE
2DUP SWAP ( cfa curr curr cfa )
< IF ( current dictionary entry < cfa? )
NIP ( leave curr dictionary entry on the stack )
EXIT
THEN
@ ( follow link pointer back )