Fixed 2swap bug, added ?do, fixed +loop.
[forth.jl.git] / src / lib.4th
1 : / /MOD SWAP DROP ;
2 : MOD /MOD DROP ;
3 : */ -ROT * SWAP / ;
4
5 : NEGATE 0 SWAP - ;
6
7 : TRUE -1 ;
8 : FALSE 0 ;
9 : NOT 0= ;
10
11 : CELLS ; \ Allow for slightly more portable code
12
13 : DEPTH PSP@ PSP0 @ - ;
14
15 : '\n' 10 ;
16 : BL 32 ;
17
18 : LITERAL IMMEDIATE ' LIT , , ;
19
20 : ':' [ CHAR : ] LITERAL ;
21 : ';' [ CHAR ; ] LITERAL ;
22 : '(' [ CHAR ( ] LITERAL ;
23 : ')' [ CHAR ) ] LITERAL ;
24 : '<' [ CHAR < ] LITERAL ;
25 : '>' [ CHAR > ] LITERAL ;
26 : '"' [ CHAR " ] LITERAL ;
27 : 'A' [ CHAR A ] LITERAL ;
28 : '0' [ CHAR 0 ] LITERAL ;
29 : '-' [ CHAR - ] LITERAL ;
30 : '.' [ CHAR . ] LITERAL ;
31
32 : CR '\n' emit ;
33 : SPACE BL emit ;
34
35 : [COMPILE] IMMEDIATE
36         WORD            \ get the next word
37         FIND            \ find it in the dictionary
38         >CFA            \ get its codeword
39         ,               \ and compile that
40 ;
41
42 : RECURSE IMMEDIATE
43         LATEST @        \ LATEST points to the word being compiled at the moment
44         >CFA            \ get the codeword
45         ,               \ compile it
46 ;
47
48 : DEBUGON TRUE DEBUG ! ;
49 : DEBUGOFF FALSE DEBUG ! ;
50
51 \ CONTROL STRUCTURES ----------------------------------------------------------------------
52
53 : IF IMMEDIATE
54         ' 0BRANCH ,     \ compile 0BRANCH
55         HERE @          \ save location of the offset on the stack
56         0 ,             \ compile a dummy offset
57 ;
58
59 : THEN IMMEDIATE
60         DUP
61         HERE @ SWAP -   \ calculate the offset from the address saved on the stack
62         SWAP !          \ store the offset in the back-filled location
63 ;
64
65 : ELSE IMMEDIATE
66         ' BRANCH ,      \ definite branch to just over the false-part
67         HERE @          \ save location of the offset on the stack
68         0 ,             \ compile a dummy offset
69         SWAP            \ now back-fill the original (IF) offset
70         DUP             \ same as for THEN word above
71         HERE @ SWAP -
72         SWAP !
73 ;
74
75 : BEGIN IMMEDIATE
76         HERE @          \ save location on the stack
77 ;
78
79 : UNTIL IMMEDIATE
80         ' 0BRANCH ,     \ compile 0BRANCH
81         HERE @ -        \ calculate the offset from the address saved on the stack
82         ,               \ compile the offset here
83 ;
84
85 : AGAIN IMMEDIATE
86         ' BRANCH ,      \ compile BRANCH
87         HERE @ -        \ calculate the offset back
88         ,               \ compile the offset here
89 ;
90
91 : WHILE IMMEDIATE
92         ' 0BRANCH ,     \ compile 0BRANCH
93         HERE @          \ save location of the offset2 on the stack
94         0 ,             \ compile a dummy offset2
95 ;
96
97 : REPEAT IMMEDIATE
98         ' BRANCH ,      \ compile BRANCH
99         SWAP            \ get the original offset (from BEGIN)
100         HERE @ - ,      \ and compile it after BRANCH
101         DUP
102         HERE @ SWAP -   \ calculate the offset2
103         SWAP !          \ and back-fill it in the original location
104 ;
105
106 : UNLESS IMMEDIATE
107         ' NOT ,         \ compile NOT (to reverse the test)
108         [COMPILE] IF    \ continue by calling the normal IF
109 ;
110
111 : DO IMMEDIATE
112         ' LIT , -1 , [COMPILE] IF
113         ' >R , ' >R ,
114         ' LIT , HERE @ 0 , ' >R ,
115         HERE @
116 ;
117
118 : ?DO IMMEDIATE
119         ' 2DUP , ' - , [COMPILE] IF
120         ' >R , ' >R ,
121         ' LIT , HERE @ 0 , ' >R ,
122         HERE @
123 ;
124
125 : I RSP@ 3 - @ ;
126
127 : J RSP@ 6 - @ ;
128
129 : ?LEAVE IMMEDIATE
130         ' 0BRANCH , 13 ,
131         ' R> , ' RDROP , ' RDROP ,
132         ' LIT ,  HERE @ 7 + , ' DUP , ' -ROT , ' - , ' SWAP , ' ! ,
133         ' BRANCH ,
134         0 ,
135 ;
136
137 : LEAVE IMMEDIATE
138         ' LIT , -1 ,
139         [COMPILE] ?LEAVE
140 ;
141
142 : +LOOP IMMEDIATE
143         ' DUP , \ Store copy of increment
144
145         ' R> , ' SWAP , ' R> , ' SWAP , ' R> , ' SWAP , ' + , ' 2DUP , ' - ,
146         ' SWAP , ' >R , ' SWAP , ' >R , ' SWAP , ' >R ,
147
148         \ Condition differently depending on sign of increment
149         ' SWAP , ' 0>= , [COMPILE] IF
150             ' 0<= ,
151         [COMPILE] ELSE
152             ' 0> ,
153         [COMPILE] THEN
154
155         \ Branch back to begining of loop kernel
156         ' 0BRANCH , HERE @ - ,
157
158         \ Clean up
159         ' RDROP , ' RDROP , ' RDROP ,
160
161         \ Record address of loop end for any LEAVEs to use
162         HERE @ SWAP !
163
164         [COMPILE] ELSE
165             ' 2DROP , \ Clean up if loop was entirely skipped (?DO)
166         [COMPILE] THEN
167 ;
168
169 : LOOP IMMEDIATE
170         ' LIT , 1 ,
171         [COMPILE] +LOOP
172 ;
173
174 \ COMMENTS ----------------------------------------------------------------------
175
176 : ( IMMEDIATE
177         1               \ allowed nested parens by keeping track of depth
178         BEGIN
179                 KEY             \ read next character
180                 DUP '(' = IF    \ open paren?
181                         DROP            \ drop the open paren
182                         1+              \ depth increases
183                 ELSE
184                         ')' = IF        \ close paren?
185                                 1-              \ depth decreases
186                         THEN
187                 THEN
188         DUP 0= UNTIL            \ continue until we reach matching close paren, depth 0
189         DROP            \ drop the depth counter
190 ;
191
192 ( Some more complicated stack examples, showing the stack notation. )
193 : NIP ( x y -- y ) SWAP DROP ;
194 : TUCK ( x y -- y x y ) DUP -ROT ;
195 : PICK ( x_u ... x_1 x_0 u -- x_u ... x_1 x_0 x_u )
196         1+              ( add one because of 'u' on the stack )
197         PSP@ SWAP -     ( add to the stack pointer )
198         @               ( and fetch )
199 ;
200 : ROLL ( x_u x_u-1... x_0 u -- x_u-1 ... x_0 x_u )
201         1+ DUP PICK SWAP    ( x_u x_u-1 ... x_0 x_u u+1 )
202         PSP@ 1- SWAP - PSP@ 2- SWAP
203         DO
204             i 1+ @ i !
205         LOOP
206         SWAP DROP
207 ;
208
209 ( With the looping constructs, we can now write SPACES, which writes n spaces to stdout. )
210 : SPACES        ( n -- )
211         DUP 0> IF
212             0 DO SPACE LOOP
213         ELSE
214             DROP
215         THEN
216 ;
217
218 ( Standard words for manipulating BASE. )
219 : DECIMAL ( -- ) 10 BASE ! ;
220 : HEX ( -- ) 16 BASE ! ;
221
222 ( Compute absolute value. )
223 : ABS           ( n -- |n| )
224         dup 0< if
225                 negate
226         then
227 ;
228
229 : MAX           ( n m -- max )
230         2dup - 0< if
231                 swap drop
232         else
233                 drop
234         then
235 ;
236
237 : MIN           ( n m -- max )
238         2dup - 0> if
239                 swap drop
240         else
241                 drop
242         then
243 ;
244
245 ( PRINTING NUMBERS ---------------------------------------------------------------------- )
246
247 ( This is the underlying recursive definition of U. )
248 : U.            ( u -- )
249         BASE @ /MOD     ( width rem quot )
250         ?DUP IF                 ( if quotient <> 0 then )
251                 RECURSE         ( print the quotient )
252         THEN
253
254         ( print the remainder )
255         DUP 10 < IF
256                 '0'             ( decimal digits 0..9 )
257         ELSE
258                 10 -            ( hex and beyond digits A..Z )
259                 'A'
260         THEN
261         +
262         EMIT
263 ;
264
265 ( This word returns the width (in characters) of an unsigned number in the current base )
266 : UWIDTH        ( u -- width )
267         BASE @ /        ( rem quot )
268         ?DUP IF         ( if quotient <> 0 then )
269                 RECURSE 1+      ( return 1+recursive call )
270         ELSE
271                 1               ( return 1 )
272         THEN
273 ;
274
275 : U.R           ( u width -- )
276         SWAP            ( width u )
277         DUP             ( width u u )
278         UWIDTH          ( width u uwidth )
279         ROT            ( u uwidth width )
280         SWAP -          ( u width-uwidth )
281         ( At this point if the requested width is narrower, we'll have a negative number on the stack.
282           Otherwise the number on the stack is the number of spaces to print.  But SPACES won't print
283           a negative number of spaces anyway, so it's now safe to call SPACES ... )
284         SPACES
285         ( ... and then call the underlying implementation of U. )
286         U.
287 ;
288
289 : .R            ( n width -- )
290         SWAP            ( width n )
291         DUP 0< IF
292                 NEGATE          ( width u )
293                 1               ( save a flag to remember that it was negative | width n 1 )
294                 -ROT             ( 1 width u )
295                 SWAP            ( 1 u width )
296                 1-              ( 1 u width-1 )
297         ELSE
298                 0               ( width u 0 )
299                 -ROT             ( 0 width u )
300                 SWAP            ( 0 u width )
301         THEN
302         SWAP            ( flag width u )
303         DUP             ( flag width u u )
304         UWIDTH          ( flag width u uwidth )
305         ROT            ( flag u uwidth width )
306         SWAP -          ( flag u width-uwidth )
307
308         SPACES          ( flag u )
309         SWAP            ( u flag )
310
311         IF                      ( was it negative? print the - character )
312                 '-' EMIT
313         THEN
314
315         U.
316 ;
317
318 : . 0 .R SPACE ;
319
320 : .S            ( -- )
321         '<' EMIT DEPTH U. '>' EMIT SPACE
322         PSP0 @ 1+
323         BEGIN
324                 DUP PSP@ 2 - <=
325         WHILE
326                 DUP @ .
327                 1+
328         REPEAT
329         DROP
330 ;
331
332 : U. U. SPACE ;
333
334 ( ? fetches the integer at an address and prints it. )
335 : ? ( addr -- ) @ . ;
336
337 ( c a b WITHIN returns true if a <= c and c < b )
338 : WITHIN
339         -ROT             ( b c a )
340         OVER            ( b c a c )
341         <= IF
342                 > IF            ( b c -- )
343                         TRUE
344                 ELSE
345                         FALSE
346                 THEN
347         ELSE
348                 2DROP           ( b c -- )
349                 FALSE
350         THEN
351 ;