Annotation of gforth/extend.fs, revision 1.65

1.1       anton       1: \ EXTEND.FS    CORE-EXT Word not fully tested!         12may93jaw
                      2: 
1.65    ! anton       3: \ Copyright (C) 1995,1998,2000,2003,2005,2007,2009 Free Software Foundation, Inc.
1.12      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
1.62      anton       9: \ as published by the Free Software Foundation, either version 3
1.12      anton      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
1.62      anton      18: \ along with this program. If not, see http://www.gnu.org/licenses/.
1.12      anton      19: 
                     20: 
1.1       anton      21: \ May be cross-compiled
                     22: 
                     23: decimal
                     24: 
                     25: \ .(                                                    12may93jaw
                     26: 
1.50      anton      27: : .(   ( compilation&interpretation "ccc<paren>" -- ) \ core-ext dot-paren
1.41      anton      28:   \G Compilation and interpretation semantics: Parse a string @i{ccc}
                     29:   \G delimited by a @code{)} (right parenthesis). Display the
                     30:   \G string. This is often used to display progress information during
                     31:   \G compilation; see examples below.
1.32      crook      32:   [char] ) parse type ; immediate
1.1       anton      33: 
                     34: \ VALUE 2>R 2R> 2R@                                     17may93jaw
                     35: 
1.3       anton      36: \ !! 2value
1.1       anton      37: 
1.56      anton      38: [ifundef] 2literal
1.11      anton      39: : 2Literal ( compilation w1 w2 -- ; run-time  -- w1 w2 ) \ double two-literal
1.36      crook      40:     \G Compile appropriate code such that, at run-time, cell pair @i{w1, w2} are
1.32      crook      41:     \G placed on the stack. Interpretation semantics are undefined.
1.11      anton      42:     swap postpone Literal  postpone Literal ; immediate restrict
1.56      anton      43: [then]
1.2       pazsan     44: 
1.16      anton      45: ' drop alias d>s ( d -- n ) \ double           d_to_s
                     46: 
1.39      anton      47: : m*/ ( d1 n2 u3 -- dquot ) \ double m-star-slash
1.40      anton      48:     \G dquot=(d1*n2)/u3, with the intermediate result being triple-precision.
                     49:     \G In ANS Forth u3 can only be a positive signed number.
1.11      anton      50:     >r s>d >r abs -rot
                     51:     s>d r> xor r> swap >r >r dabs rot tuck um* 2swap um*
1.59      anton      52:     swap >r 0 d+ r> -rot r@ um/mod -rot r> um/mod
1.64      anton      53:     [ 1 -3 mod 0< ] [if]
1.59      anton      54:         -rot r> IF IF 1. d+ THEN dnegate ELSE drop THEN
                     55:     [else]
                     56:         nip swap r> IF dnegate THEN
                     57:     [then] ;
1.4       pazsan     58: 
1.1       anton      59: \ CASE OF ENDOF ENDCASE                                 17may93jaw
                     60: 
                     61: \ just as described in dpANS5
                     62: 
1.11      anton      63: 0 CONSTANT case ( compilation  -- case-sys ; run-time  -- ) \ core-ext
                     64:     immediate
1.1       anton      65: 
1.11      anton      66: : of ( compilation  -- of-sys ; run-time x1 x2 -- |x1 ) \ core-ext
                     67:     \ !! the implementation does not match the stack effect
                     68:     1+ >r
                     69:     postpone over postpone = postpone if postpone drop
                     70:     r> ; immediate
                     71: 
                     72: : endof ( compilation case-sys1 of-sys -- case-sys2 ; run-time  -- ) \ core-ext end-of
                     73:     >r postpone else r> ; immediate
                     74: 
                     75: : endcase ( compilation case-sys -- ; run-time x -- ) \ core-ext end-case
                     76:     postpone drop
                     77:     0 ?do postpone then loop ; immediate
1.1       anton      78: 
                     79: \ C"                                                    17may93jaw
                     80: 
1.32      crook      81: : C" ( compilation "ccc<quote>" -- ; run-time  -- c-addr ) \ core-ext c-quote
1.36      crook      82:     \G Compilation: parse a string @i{ccc} delimited by a @code{"}
                     83:     \G (double quote). At run-time, return @i{c-addr} which
                     84:     \G specifies the counted string @i{ccc}.  Interpretation
1.33      crook      85:     \G semantics are undefined.
1.11      anton      86:     [char] " parse postpone CLiteral ; immediate restrict
1.1       anton      87: 
                     88: \ [COMPILE]                                             17may93jaw
                     89: 
1.11      anton      90: : [compile] ( compilation "name" -- ; run-time ? -- ? ) \ core-ext bracket-compile
1.37      anton      91:     comp' drop
                     92:     dup [ comp' exit drop ] literal = if
                     93:        execute \ EXIT has default compilation semantics, perform them
                     94:     else
                     95:        compile,
                     96:     then ; immediate
1.1       anton      97: 
                     98: \ CONVERT                                               17may93jaw
                     99: 
1.60      anton     100: : convert ( ud1 c-addr1 -- ud2 c-addr2 ) \ core-ext-obsolescent
                    101:     \G Obsolescent: superseded by @code{>number}.
1.26      anton     102:     char+ true >number drop ;
1.1       anton     103: 
                    104: \ ERASE                                                 17may93jaw
                    105: 
1.40      anton     106: : erase ( addr u -- ) \ core-ext
                    107:     \G Clear all bits in @i{u} aus starting at @i{addr}.
1.11      anton     108:     \ !! dependence on "1 chars 1 ="
                    109:     ( 0 1 chars um/mod nip )  0 fill ;
1.34      crook     110: : blank ( c-addr u -- ) \ string
1.40      anton     111:     \G Store the space character into @i{u} chars starting at @i{c-addr}.
1.11      anton     112:     bl fill ;
1.1       anton     113: 
1.7       pazsan    114: \ SEARCH                                                02sep94py
                    115: 
1.28      anton     116: : search ( c-addr1 u1 c-addr2 u2 -- c-addr3 u3 flag ) \ string
1.36      crook     117:     \G Search the string specified by @i{c-addr1, u1} for the string
                    118:     \G specified by @i{c-addr2, u2}. If @i{flag} is true: match was found
                    119:     \G at @i{c-addr3} with @i{u3} characters remaining. If @i{flag} is false:
                    120:     \G no match was found; @i{c-addr3, u3} are equal to @i{c-addr1, u1}.
1.28      anton     121:     \ not very efficient; but if we want efficiency, we'll do it as primitive
                    122:     2>r 2dup
                    123:     begin
                    124:        dup r@ >=
                    125:     while
1.53      anton     126:        2dup 2r@ string-prefix? if
1.28      anton     127:            2swap 2drop 2r> 2drop true exit
                    128:        endif
                    129:        1 /string
                    130:     repeat
                    131:     2drop 2r> 2drop false ;
1.7       pazsan    132: 
1.1       anton     133: \ SOURCE-ID SAVE-INPUT RESTORE-INPUT                    11jun93jaw
                    134: 
1.46      pazsan    135: [IFUNDEF] source-id
1.22      anton     136: : source-id ( -- 0 | -1 | fileid ) \ core-ext,file source-i-d
1.34      crook     137:     \G Return 0 (the input source is the user input device), -1 (the
                    138:     \G input source is a string being processed by @code{evaluate}) or
1.36      crook     139:     \G a @i{fileid} (the input source is the file specified by
                    140:     \G @i{fileid}).
1.34      crook     141:     loadfile @ dup 0= IF  drop sourceline# 0 min  THEN ;
                    142: 
                    143: : save-input ( -- xn .. x1 n ) \ core-ext
1.36      crook     144:     \G The @i{n} entries @i{xn - x1} describe the current state of the
1.34      crook     145:     \G input source specification, in some platform-dependent way that can
                    146:     \G be used by @code{restore-input}.
1.14      anton     147:     >in @
                    148:     loadfile @
                    149:     if
1.43      pazsan    150:        loadfile @ file-position throw
                    151:        [IFDEF] #fill-bytes #fill-bytes @ [ELSE] #tib @ 1+ [THEN] 0 d-
1.14      anton     152:     else
                    153:        blk @
                    154:        linestart @
                    155:     then
                    156:     sourceline#
                    157:     >tib @
                    158:     source-id
                    159:     6 ;
1.1       anton     160: 
1.34      crook     161: : restore-input ( xn .. x1 n -- flag ) \ core-ext
                    162:     \G Attempt to restore the input source specification to the state
1.36      crook     163:     \G described by the @i{n} entries @i{xn - x1}. @i{flag} is
1.35      anton     164:     \G true if the restore fails.  In Gforth it fails pretty often
                    165:     \G (and sometimes with a @code{throw}).
1.14      anton     166:     6 <> -12 and throw
                    167:     source-id <> -12 and throw
                    168:     >tib !
                    169:     >r ( line# )
                    170:     loadfile @ 0<>
                    171:     if
                    172:        loadfile @ reposition-file throw
1.38      anton     173:        refill 0= -36 and throw \ should never throw
1.14      anton     174:     else
                    175:        linestart !
                    176:        blk !
                    177:        sourceline# r@ <> blk @ 0= and loadfile @ 0= and
                    178:        if
                    179:            drop rdrop true EXIT
                    180:        then
                    181:     then
                    182:     r> loadline !
                    183:     >in !
                    184:     false ;
1.46      pazsan    185: [THEN]
1.1       anton     186: \ This things we don't need, but for being complete... jaw
                    187: 
                    188: \ EXPECT SPAN                                           17may93jaw
                    189: 
1.60      anton     190: variable span ( -- c-addr ) \ core-ext-obsolescent
1.36      crook     191: \G @code{Variable} -- @i{c-addr} is the address of a cell that stores the
                    192: \G length of the last string received by @code{expect}. OBSOLESCENT.
1.34      crook     193: 
1.60      anton     194: : expect ( c-addr +n -- ) \ core-ext-obsolescent
1.36      crook     195:     \G Receive a string of at most @i{+n} characters, and store it
                    196:     \G in memory starting at @i{c-addr}. The string is
1.34      crook     197:     \G displayed. Input terminates when the <return> key is pressed or
1.36      crook     198:     \G @i{+n} characters have been received. The normal Gforth line
1.34      crook     199:     \G editing capabilites are available. The length of the string is
                    200:     \G stored in @code{span}; it does not include the <return>
                    201:     \G character. OBSOLESCENT: superceeded by @code{accept}.
1.9       anton     202:     0 rot over
                    203:     BEGIN ( maxlen span c-addr pos1 )
                    204:        key decode ( maxlen span c-addr pos2 flag )
                    205:        >r 2over = r> or
                    206:     UNTIL
1.17      pazsan    207:     2 pick swap /string type
                    208:     nip span ! ;
1.27      jwilke    209: 
                    210: \ marker                                               18dec94py
                    211: 
                    212: \ Marker creates a mark that is removed (including everything 
                    213: \ defined afterwards) when executing the mark.
                    214: 
1.31      anton     215: : included-files-mark ( -- u )
1.63      pazsan    216:     included-files @ ;
1.31      anton     217: 
                    218: \ hmm, most of the saving appears to be pretty unnecessary: we could
                    219: \ derive the wordlists and the words that have to be kept from the
                    220: \ saved value of dp value. - anton
                    221: 
                    222: : marker, ( -- mark )
                    223:     here
                    224:     included-files-mark ,
                    225:     dup A, \ here
                    226:     voclink @ A, \ vocabulary list start
                    227:     \ for all wordlists, remember wordlist-id (the linked list)
                    228:     voclink
                    229:     BEGIN
                    230:        @ dup
                    231:     WHILE
                    232:        dup 0 wordlist-link - wordlist-id @ A,
                    233:     REPEAT
                    234:     drop
                    235:     \ remember udp
1.48      anton     236:     udp @ ,
                    237:     \ remember dyncode-ptr
                    238:     here ['] noop , compile-prim1 finish-code ;
1.27      jwilke    239: 
                    240: : marker! ( mark -- )
1.31      anton     241:     \ reset included files count; resize will happen on next add-included-file
1.63      pazsan    242:     included-files @ over @ min included-files ! cell+
1.31      anton     243:     \ rest of marker!
                    244:     dup @ swap cell+ ( here rest-of-marker )
1.27      jwilke    245:     dup @ voclink ! cell+
1.31      anton     246:     \ restore wordlists to former words
1.27      jwilke    247:     voclink
                    248:     BEGIN
                    249:        @ dup 
                    250:     WHILE
1.31      anton     251:        over @ over 0 wordlist-link - wordlist-id !
1.27      jwilke    252:        swap cell+ swap
                    253:     REPEAT
1.31      anton     254:     drop
                    255:     \ rehash wordlists to remove forgotten words
                    256:     \ why don't we do this in a single step? - anton
                    257:     voclink
1.27      jwilke    258:     BEGIN
                    259:        @ dup
                    260:     WHILE
                    261:        dup 0 wordlist-link - rehash
                    262:     REPEAT
                    263:     drop
1.31      anton     264:     \ restore udp and dp
1.49      pazsan    265: [IFDEF] forget-dyncode
1.54      anton     266:     dup cell+ @ forget-dyncode drop
1.49      pazsan    267: [THEN]
1.29      pazsan    268:     @ udp !  dp !
                    269:     \ clean up vocabulary stack
                    270:     0 vp @ 0
                    271:     ?DO
                    272:        vp cell+ I cells + @ dup here >
                    273:        IF  drop  ELSE  swap 1+  THEN
                    274:     LOOP
                    275:     dup 0= or set-order \ -1 set-order if order is empty
                    276:     get-current here > IF
                    277:        forth-wordlist set-current
                    278:     THEN ;
1.27      jwilke    279: 
1.32      crook     280: : marker ( "<spaces> name" -- ) \ core-ext
1.36      crook     281:     \G Create a definition, @i{name} (called a @i{mark}) whose
1.32      crook     282:     \G execution semantics are to remove itself and everything 
                    283:     \G defined after it.
1.27      jwilke    284:     marker, Create A,
                    285: DOES> ( -- )
                    286:     @ marker! ;
1.1       anton     287: 

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