| |
\ A powerful locals implementation |
| |
|
| |
\ Copyright (C) 1995 Free Software Foundation, Inc. |
| |
|
| |
\ This file is part of Gforth. |
| |
|
| |
\ Gforth is free software; you can redistribute it and/or |
| |
\ modify it under the terms of the GNU General Public License |
| |
\ as published by the Free Software Foundation; either version 2 |
| |
\ of the License, or (at your option) any later version. |
| |
|
| |
\ This program is distributed in the hope that it will be useful, |
| |
\ but WITHOUT ANY WARRANTY; without even the implied warranty of |
| |
\ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| |
\ GNU General Public License for more details. |
| |
|
| |
\ You should have received a copy of the GNU General Public License |
| |
\ along with this program; if not, write to the Free Software |
| |
\ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| |
|
| |
|
| |
\ More documentation can be found in the manual and in |
| |
\ http://www.complang.tuwien.ac.at/papers/ertl94l.ps.gz |
| |
|
| \ Local variables are quite important for writing readable programs, but |
\ Local variables are quite important for writing readable programs, but |
| \ IMO (anton) they are the worst part of the standard. There they are very |
\ IMO (anton) they are the worst part of the standard. There they are very |
| \ restricted and have an ugly interface. |
\ restricted and have an ugly interface. |
| \ Currently locals may only be |
\ Currently locals may only be |
| \ defined at the outer level and TO is not supported. |
\ defined at the outer level and TO is not supported. |
| |
|
| include search-order.fs |
require search-order.fs |
| include float.fs |
require float.fs |
| |
|
| : compile-@local ( n -- ) \ new compile-fetch-local |
: compile-@local ( n -- ) \ gforth compile-fetch-local |
| case |
case |
| 0 of postpone @local0 endof |
0 of postpone @local0 endof |
| 1 cells of postpone @local1 endof |
1 cells of postpone @local1 endof |
| ( otherwise ) dup postpone @local# , |
( otherwise ) dup postpone @local# , |
| endcase ; |
endcase ; |
| |
|
| : compile-f@local ( n -- ) \ new compile-f-fetch-local |
: compile-f@local ( n -- ) \ gforth compile-f-fetch-local |
| case |
case |
| 0 of postpone f@local0 endof |
0 of postpone f@local0 endof |
| 1 floats of postpone f@local1 endof |
1 floats of postpone f@local1 endof |
| \ defines the local "name"; the offset of the local shall be |
\ defines the local "name"; the offset of the local shall be |
| \ stored in a-addr |
\ stored in a-addr |
| create |
create |
| immediate |
immediate restrict |
| here 0 , ( place for the offset ) ; |
here 0 , ( place for the offset ) ; |
| |
|
| : lp-offset ( n1 -- n2 ) |
: lp-offset ( n1 -- n2 ) |
| vocabulary locals-types \ this contains all the type specifyers, -- and } |
vocabulary locals-types \ this contains all the type specifyers, -- and } |
| locals-types definitions |
locals-types definitions |
| |
|
| : W: |
: W: ( "name" -- a-addr xt ) \ gforth w-colon |
| create-local ( "name" -- a-addr xt ) |
create-local |
| \ xt produces the appropriate locals pushing code when executed |
\ xt produces the appropriate locals pushing code when executed |
| ['] compile-pushlocal-w |
['] compile-pushlocal-w |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| \ compiles a local variable access |
\ compiles a local variable access |
| @ lp-offset compile-@local ; |
@ lp-offset compile-@local ; |
| |
|
| : W^ |
: W^ ( "name" -- a-addr xt ) \ gforth w-caret |
| create-local ( "name" -- a-addr xt ) |
create-local |
| ['] compile-pushlocal-w |
['] compile-pushlocal-w |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| postpone laddr# @ lp-offset, ; |
postpone laddr# @ lp-offset, ; |
| |
|
| : F: |
: F: ( "name" -- a-addr xt ) \ gforth f-colon |
| create-local ( "name" -- a-addr xt ) |
create-local |
| ['] compile-pushlocal-f |
['] compile-pushlocal-f |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| @ lp-offset compile-f@local ; |
@ lp-offset compile-f@local ; |
| |
|
| : F^ |
: F^ ( "name" -- a-addr xt ) \ gforth f-caret |
| create-local ( "name" -- a-addr xt ) |
create-local |
| ['] compile-pushlocal-f |
['] compile-pushlocal-f |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| postpone laddr# @ lp-offset, ; |
postpone laddr# @ lp-offset, ; |
| |
|
| : D: |
: D: ( "name" -- a-addr xt ) \ gforth d-colon |
| create-local ( "name" -- a-addr xt ) |
create-local |
| ['] compile-pushlocal-d |
['] compile-pushlocal-d |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| postpone laddr# @ lp-offset, postpone 2@ ; |
postpone laddr# @ lp-offset, postpone 2@ ; |
| |
|
| : D^ |
: D^ ( "name" -- a-addr xt ) \ gforth d-caret |
| create-local ( "name" -- a-addr xt ) |
create-local |
| ['] compile-pushlocal-d |
['] compile-pushlocal-d |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| postpone laddr# @ lp-offset, ; |
postpone laddr# @ lp-offset, ; |
| |
|
| : C: |
: C: ( "name" -- a-addr xt ) \ gforth c-colon |
| create-local ( "name" -- a-addr xt ) |
create-local |
| ['] compile-pushlocal-c |
['] compile-pushlocal-c |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| postpone laddr# @ lp-offset, postpone c@ ; |
postpone laddr# @ lp-offset, postpone c@ ; |
| |
|
| : C^ |
: C^ ( "name" -- a-addr xt ) \ gforth c-caret |
| create-local ( "name" -- a-addr xt ) |
create-local |
| ['] compile-pushlocal-c |
['] compile-pushlocal-c |
| does> ( Compilation: -- ) ( Run-time: -- w ) |
does> ( Compilation: -- ) ( Run-time: -- w ) |
| postpone laddr# @ lp-offset, ; |
postpone laddr# @ lp-offset, ; |
| variable old-dpp |
variable old-dpp |
| |
|
| \ and now, finally, the user interface words |
\ and now, finally, the user interface words |
| : { ( -- addr wid 0 ) |
: { ( -- addr wid 0 ) \ gforth open-brace |
| dp old-dpp ! |
dp old-dpp ! |
| locals-dp dpp ! |
locals-dp dpp ! |
| also new-locals |
also new-locals |
| |
|
| locals-types definitions |
locals-types definitions |
| |
|
| : } ( addr wid 0 a-addr1 xt1 ... -- ) |
: } ( addr wid 0 a-addr1 xt1 ... -- ) \ gforth close-brace |
| \ ends locals definitions |
\ ends locals definitions |
| ] old-dpp @ dpp ! |
] old-dpp @ dpp ! |
| begin |
begin |
| previous previous |
previous previous |
| locals-list TO locals-wordlist ; |
locals-list TO locals-wordlist ; |
| |
|
| : -- ( addr wid 0 ... -- ) |
: -- ( addr wid 0 ... -- ) \ gforth dash-dash |
| } |
} |
| [char] } parse 2drop ; |
[char] } parse 2drop ; |
| |
|
| |
|
| \ explicit scoping |
\ explicit scoping |
| |
|
| : scope ( -- scope ) |
: scope ( compilation -- scope ; run-time -- ) \ gforth |
| cs-push-part scopestart ; immediate |
cs-push-part scopestart ; immediate |
| |
|
| : endscope ( scope -- ) |
: endscope ( compilation scope -- ; run-time -- ) \ gforth |
| scope? |
scope? |
| drop |
drop |
| locals-list @ common-list |
locals-list @ common-list |
| |
|
| \ And here's finally the ANS standard stuff |
\ And here's finally the ANS standard stuff |
| |
|
| : (local) ( addr u -- ) |
: (local) ( addr u -- ) \ local paren-local-paren |
| \ a little space-inefficient, but well deserved ;-) |
\ a little space-inefficient, but well deserved ;-) |
| \ In exchange, there are no restrictions whatsoever on using (local) |
\ In exchange, there are no restrictions whatsoever on using (local) |
| \ as long as you use it in a definition |
\ as long as you use it in a definition |
| \ this gives a unique identifier for the way the xt was defined |
\ this gives a unique identifier for the way the xt was defined |
| \ words defined with different does>-codes have different definers |
\ words defined with different does>-codes have different definers |
| \ the definer can be used for comparison and in definer! |
\ the definer can be used for comparison and in definer! |
| dup >code-address [ ' bits >code-address ] Literal = |
dup >code-address [ ' spaces >code-address ] Literal = |
| \ !! this definition will not work on some implementations for `bits' |
\ !! this definition will not work on some implementations for `bits' |
| if \ if >code-address delivers the same value for all does>-def'd words |
if \ if >code-address delivers the same value for all does>-def'd words |
| >does-code 1 or \ bit 0 marks special treatment for does codes |
>does-code 1 or \ bit 0 marks special treatment for does codes |
| : definer! ( definer xt -- ) |
: definer! ( definer xt -- ) |
| \ gives the word represented by xt the behaviour associated with definer |
\ gives the word represented by xt the behaviour associated with definer |
| over 1 and if |
over 1 and if |
| does-code! |
swap [ 1 invert ] literal and does-code! |
| else |
else |
| code-address! |
code-address! |
| then ; |
then ; |
| |
|
| \ !! untested |
: TO ( c|w|d|r "name" -- ) \ core-ext,local |
| : TO ( c|w|d|r "name" -- ) |
|
| \ !! state smart |
\ !! state smart |
| 0 0 0. 0.0e0 { c: clocal w: wlocal d: dlocal f: flocal } |
0 0 0. 0.0e0 { c: clocal w: wlocal d: dlocal f: flocal } |
| ' dup >definer |
' dup >definer |
| [ ' wlocal >definer ] literal |
[ ' wlocal >definer ] literal |
| OF POSTPONE laddr# >body @ lp-offset, POSTPONE ! ENDOF |
OF POSTPONE laddr# >body @ lp-offset, POSTPONE ! ENDOF |
| [ ' dlocal >definer ] literal |
[ ' dlocal >definer ] literal |
| OF POSTPONE laddr# >body @ lp-offset, POSTPONE d! ENDOF |
OF POSTPONE laddr# >body @ lp-offset, POSTPONE 2! ENDOF |
| [ ' flocal >definer ] literal |
[ ' flocal >definer ] literal |
| OF POSTPONE laddr# >body @ lp-offset, POSTPONE f! ENDOF |
OF POSTPONE laddr# >body @ lp-offset, POSTPONE f! ENDOF |
| -&32 throw |
-&32 throw |
| endif ; immediate |
endif ; immediate |
| |
|
| : locals| |
: locals| |
| |
\ don't use 'locals|'! use '{'! A portable and free '{' |
| |
\ implementation is anslocals.fs |
| BEGIN |
BEGIN |
| name 2dup s" |" compare 0<> |
name 2dup s" |" compare 0<> |
| WHILE |
WHILE |