Annotation of gforth/stuff.fs, revision 1.23

1.1       anton       1: \ miscelleneous words
                      2: 
1.15      anton       3: \ Copyright (C) 1996,1997,1998,2000 Free Software Foundation, Inc.
1.1       anton       4: 
                      5: \ This file is part of Gforth.
                      6: 
                      7: \ Gforth is free software; you can redistribute it and/or
                      8: \ modify it under the terms of the GNU General Public License
                      9: \ as published by the Free Software Foundation; either version 2
                     10: \ of the License, or (at your option) any later version.
                     11: 
                     12: \ This program is distributed in the hope that it will be useful,
                     13: \ but WITHOUT ANY WARRANTY; without even the implied warranty of
                     14: \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     15: \ GNU General Public License for more details.
                     16: 
                     17: \ You should have received a copy of the GNU General Public License
                     18: \ along with this program; if not, write to the Free Software
1.16      anton      19: \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.1       anton      20: 
1.17      anton      21: require glocals.fs
1.8       anton      22: 
1.6       anton      23: ' require alias needs ( ... "name" -- ... ) \ gforth
1.11      crook      24: \G An alias for @code{require}; exists on other systems (e.g., Win32Forth).
1.1       anton      25: \ needs is an F-PC name. we will probably switch to 'needs' in the future
                     26: 
                     27: \ a little more compiler security
                     28: 
                     29: \ currently not used by Gforth, but maybe by add-ons e.g., the 486asm
                     30: AUser CSP
                     31: 
                     32: : !CSP ( -- )
                     33:     sp@ csp ! ;
                     34: 
                     35: : ?CSP ( -- )
                     36:     sp@ csp @ <> -22 and throw ;
1.2       anton      37: 
1.4       anton      38: \ DMIN and DMAX
                     39: 
1.13      crook      40: : dmin ( d1 d2 -- d ) \ double d-min
1.5       pazsan     41:     2over 2over d> IF  2swap  THEN 2drop ;
1.2       anton      42: 
1.13      crook      43: 
                     44: : dmax ( d1 d2 -- d ) \ double d-max
1.5       pazsan     45:     2over 2over d< IF  2swap  THEN 2drop ;
1.4       anton      46: 
                     47: \ shell commands
                     48: 
1.10      crook      49: 0 Value $? ( -- n ) \ gforth dollar-question
1.12      crook      50: \G @code{Value} -- the exit status returned by the most recently executed
1.9       crook      51: \G @code{system} command.
1.4       anton      52: 
1.14      anton      53: : system ( c-addr u -- ) \ gforth
                     54: \G Pass the string specified by @var{c-addr u} to the host operating system
1.9       crook      55: \G for execution in a sub-shell.
1.4       anton      56:     (system) throw TO $? ;
1.9       crook      57: 
1.4       anton      58: : sh ( "..." -- ) \ gforth
1.9       crook      59: \G Parse a string and use @code{system} to pass it to the host
                     60: \G operating system for execution in a sub-shell.
1.4       anton      61:     '# parse cr system ;
                     62: 
1.8       anton      63: \ stuff
                     64: 
1.10      crook      65: : ]L ( compilation: n -- ; run-time: -- n ) \ gforth
                     66:     \G equivalent to @code{] literal}
1.8       anton      67:     ] postpone literal ;
                     68: 
1.23    ! anton      69: [ifundef] in-dictionary?
1.8       anton      70: : in-dictionary? ( x -- f )
                     71:     forthstart dictionary-end within ;
1.23    ! anton      72: [endif]
1.8       anton      73: 
                     74: : in-return-stack? ( addr -- f )
                     75:     rp0 @ swap - [ forthstart 6 cells + ]L @ u< ;
1.17      anton      76: 
                     77: \ const-does>
                     78: 
                     79: : compile-literals ( w*u u -- ; run-time: -- w*u ) recursive
1.18      anton      80:     \ compile u literals, starting with the bottommost one
1.17      anton      81:     ?dup-if
                     82:        swap >r 1- compile-literals
                     83:        r> POSTPONE literal
                     84:     endif ;
                     85: 
                     86: : compile-fliterals ( r*u u -- ; run-time: -- w*u ) recursive
1.18      anton      87:     \ compile u fliterals, starting with the bottommost one
1.17      anton      88:     ?dup-if
                     89:        { F: r } 1- compile-fliterals
                     90:        r POSTPONE fliteral
                     91:     endif ;
                     92: 
                     93: : (const-does>) ( w*uw r*ur uw ur target "name" -- )
1.18      anton      94:     \ define a colon definition "name" containing w*uw r*ur as
                     95:     \ literals and a call to target.
1.17      anton      96:     { uw ur target }
                     97:     header docol: cfa, \ start colon def without stack junk
                     98:     ur compile-fliterals uw compile-literals
                     99:     target compile, POSTPONE exit reveal ;
                    100: 
                    101: : const-does> ( run-time: w*uw r*ur uw ur "name" -- )
1.18      anton     102:     \G Defines @var{name} and returns.@sp 0
                    103:     \G @var{name} execution: pushes @var{w*uw r*ur}, then performs the
                    104:     \G code following the @code{const-does>}.
1.17      anton     105:     here >r 0 POSTPONE literal
                    106:     POSTPONE (const-does>)
                    107:     POSTPONE ;
                    108:     noname : POSTPONE rdrop
                    109:     lastxt r> cell+ ! \ patch the literal
                    110: ; immediate
1.19      anton     111: 
1.20      anton     112: \ !! rewrite slurp-file using slurp-fid
1.19      anton     113: : slurp-file ( c-addr1 u1 -- c-addr2 u2 )
1.20      anton     114:     \G @var{c-addr1 u1} is the filename, @var{c-addr2 u2} is the file's contents
1.19      anton     115:     r/o bin open-file throw >r
                    116:     r@ file-size throw abort" file too large"
                    117:     dup allocate throw swap
                    118:     2dup r@ read-file throw over <> abort" could not read whole file"
                    119:     r> close-file throw ;
                    120: 
1.20      anton     121: : slurp-fid { fid -- addr u }
                    122:     \G @var{addr u} is the content of the file @var{fid}
                    123:     0 0 begin ( awhole uwhole )
                    124:        dup 1024 + dup >r extend-mem ( anew awhole uwhole R: unew )
                    125:        rot r@ fid read-file throw ( awhole uwhole uread R: unew )
                    126:        r> 2dup =
                    127:     while ( awhole uwhole uread unew )
                    128:        2drop
                    129:     repeat
                    130:     - + dup >r resize throw r> ;

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>