Annotation of gforth/stuff.fs, revision 1.26

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> ;
1.24      anton     131: 
1.25      anton     132: \ ]] ... [[
                    133: 
                    134: : compile-literal ( n -- )
                    135:     postpone literal ;
                    136: 
                    137: : [[ ( -- )
                    138: \G switch from postpone state to compile state
                    139:     \ this is only a marker; it is never really interpreted
                    140:     compile-only-error ; immediate
                    141: 
                    142: : postponer ( c-addr u -- )
                    143:     2dup find-name dup if ( c-addr u nt )
                    144:        nip nip name>comp
                    145:        2dup [comp'] [[ d= if
                    146:            2drop ['] compiler is parser
                    147:        else
                    148:            postpone,
                    149:        endif
                    150:     else
                    151:        drop
                    152:        2dup snumber? dup if
                    153:            0> IF
                    154:                swap postpone literal postpone compile-literal
                    155:            THEN
                    156:            postpone Literal postpone compile-literal
                    157:            2drop
                    158:        ELSE
                    159:            drop no.extensions
                    160:        THEN
                    161:     then ;
                    162: 
                    163: : ]] ( -- )
                    164:     \ switch into postpone state
                    165:     ['] postponer is parser state on ; immediate restrict
                    166: 
1.26    ! anton     167: \ f.rdp
        !           168: 
        !           169: : move-right ( c-addr u1 u2 cfill -- )
        !           170:     \ move string at c-addr u1 right by u2 chars (without exceeding
        !           171:     \ the original bound); fill the gap with cfill
        !           172:     >r dup >r rot dup >r ( u1 u2 c-addr R: cfill u2 c-addr )
        !           173:     dup 2swap /string cmove>
        !           174:     r> r> r> fill ;
        !           175: 
        !           176: : f>buf-rdp { f: rf c-addr ur nd up -- } \ gforth
        !           177: \G Convert @i{rf} into a string at @i{c-addr ur}.  The conversion
        !           178: \G rules and the meanings of @i{ur nd up} are the same as for
        !           179: \G @code{f.rdp}.
        !           180:     rf c-addr ur represent if { nexp fsign }
        !           181:        nd nexp + up >=
        !           182:        ur nd - 1- dup { beforep } fsign + nexp 0 max >= and if
        !           183:            \ fixed-point notation
        !           184:            c-addr ur beforep nexp - dup { befored } '0 move-right
        !           185:            c-addr beforep 1- befored min dup { beforez } 0 max bl fill
        !           186:            fsign if
        !           187:                '- c-addr beforez 1- 0 max + c!
        !           188:            endif
        !           189:            c-addr ur beforep /string 1 '. move-right
        !           190:        else \ exponential notation
        !           191:            c-addr ur 1 /string 1 '. move-right
        !           192:            fsign if
        !           193:                c-addr ur 1 '- move-right
        !           194:            endif
        !           195:            nexp 1- s>d tuck dabs <<# #s rot sign 'E hold #> { explen }
        !           196:            explen 1+ fsign - ur > if \ exponent too large
        !           197:                drop c-addr ur '* fill
        !           198:            else
        !           199:                c-addr ur + 0 explen negate /string move
        !           200:            endif
        !           201:            #>>
        !           202:        endif
        !           203:     else \ inf or nan
        !           204:        if \ negative
        !           205:            c-addr ur 1 '- move-right
        !           206:        endif
        !           207:        drop
        !           208:        \ !! align in some way?
        !           209:     endif ;
        !           210: 
        !           211: : f>str-rdp ( rf ur +nd up -- c-addr ur ) \ gforth
        !           212: \G Convert @i{rf} into a string at @i{c-addr ur}.  The conversion
        !           213: \G rules and the meanings of @i{ur +nd up} are the same as for
        !           214: \G @code{f.rdp}.  The result in in the pictured numeric output buffer
        !           215: \G and will be destroyed by anything destroying that buffer.
        !           216:     rot holdptr @ 1- 0 rot negate /string ( rf +nd up c-addr ur )
        !           217:     over holdbuf u< -&17 and throw
        !           218:     2tuck 2>r f>buf-rdp 2r> ;
        !           219: 
        !           220: : f.rdp ( rf ur +nd up -- ) \ gforth
        !           221: \G Print float @i{rf} formatted.  The total width of the output is
        !           222: \G @i{nr}, the number of digits after the decimal point is @i{+nd},
        !           223: \G the minimum number of significant digits for fixed-point notation
        !           224: \G is @i{up}.  @code{Set-precision} has no effect on @code{f.rdp}.
        !           225: \G Fixed-point notation is used if the number of siginicant digits
        !           226: \G would be larger than @i{up} and if the number of digits before the
        !           227: \G decimal point would fit.  If fixed-point notation is not used,
        !           228: \G exponential notation is used, and if that does not fit, asterisks
        !           229: \G are printed.  We recommend using @i{ur}>=7 to avoid the risk of
        !           230: \G numbers not fitting at all.  We recommend @i{ur}>=@i{up}+5 to avoid
        !           231: \G cases where @code{f.rdp} switches to exponential notation because
        !           232: \G fixed-point notation would have too few significant digits, yet
        !           233: \G exponential notation offers fewer significant digits.  We recomment
        !           234: \G @i{ur}>=@i{nd}+2, if you want to have fixed-point notation for some
        !           235: \G numbers.  Currently, trailing digits are cut off.
        !           236:     f>str-rdp type ;
        !           237: 
        !           238: 0 [if]
        !           239: : testx ( rf ur nd up -- )
        !           240:     '| emit f.rdp ;
        !           241: 
        !           242: : test ( -- )
        !           243:     -0.123456789123456789e-20
        !           244:     40 0 ?do
        !           245:        cr
        !           246:        fdup 7 3 1 testx
        !           247:        fdup 7 3 4 testx
        !           248:        fdup 7 3 0 testx
        !           249:        fdup 7 7 1 testx
        !           250:        fdup 7 5 1 testx
        !           251:        fdup 7 0 2 testx
        !           252:        fdup 5 2 1 testx
        !           253:        fdup 4 2 1 testx
        !           254:        fdup 18 8 5 testx
        !           255:        '| emit
        !           256:        10e f*
        !           257:     loop ;
        !           258: [then]

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