Annotation of gforth/kernel/int.fs, revision 1.90

1.1       pazsan      1: \ definitions needed for interpreter only
                      2: 
1.90    ! anton       3: \ Copyright (C) 1995-2000 Free Software Foundation, Inc.
1.11      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.63      anton      19: \ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.11      anton      20: 
1.1       pazsan     21: \ \ Revision-Log
                     22: 
                     23: \       put in seperate file                           14sep97jaw 
                     24: 
                     25: \ \ input stream primitives                            23feb93py
                     26: 
1.33      jwilke     27: require ./basics.fs    \ bounds decimal hex ...
                     28: require ./io.fs                \ type ...
                     29: require ./nio.fs       \ . <# ...
                     30: require ./errore.fs    \ .error ...
1.50      anton      31: require kernel/version.fs      \ version-string
1.33      jwilke     32: require ./../chains.fs
                     33: 
1.64      pazsan     34: has? new-input 0= [IF]
1.43      crook      35: : tib ( -- c-addr ) \ core-ext t-i-b
1.40      crook      36:     \G @i{c-addr} is the address of the Terminal Input Buffer.
1.29      crook      37:     \G OBSOLESCENT: @code{source} superceeds the function of this word.
1.1       pazsan     38:     >tib @ ;
                     39: 
1.29      crook      40: Defer source ( -- c-addr u ) \ core
1.1       pazsan     41: \ used by dodefer:, must be defer
1.40      crook      42: \G @i{c-addr} is the address of the input buffer and @i{u} is the
1.29      crook      43: \G number of characters in it.
1.1       pazsan     44: 
1.29      crook      45: : (source) ( -- c-addr u )
1.1       pazsan     46:     tib #tib @ ;
                     47: ' (source) IS source
1.64      pazsan     48: [THEN]
1.1       pazsan     49: 
                     50: : (word) ( addr1 n1 char -- addr2 n2 )
                     51:   dup >r skip 2dup r> scan  nip - ;
                     52: 
                     53: \ (word) should fold white spaces
                     54: \ this is what (parse-white) does
                     55: 
                     56: \ word parse                                           23feb93py
                     57: 
1.29      crook      58: : sword  ( char -- addr len ) \ gforth s-word
1.40      crook      59:     \G Parses like @code{word}, but the output is like @code{parse} output.
1.47      anton      60:     \G @xref{core-idef}.
1.3       anton      61:   \ this word was called PARSE-WORD until 0.3.0, but Open Firmware and
                     62:   \ dpANS6 A.6.2.2008 have a word with that name that behaves
                     63:   \ differently (like NAME).
1.1       pazsan     64:   source 2dup >r >r >in @ over min /string
                     65:   rot dup bl = IF  drop (parse-white)  ELSE  (word)  THEN
                     66:   2dup + r> - 1+ r> min >in ! ;
                     67: 
1.29      crook      68: : word   ( char "<chars>ccc<char>-- c-addr ) \ core
1.40      crook      69:     \G Skip leading delimiters. Parse @i{ccc}, delimited by
                     70:     \G @i{char}, in the parse area. @i{c-addr} is the address of a
1.29      crook      71:     \G transient region containing the parsed string in
1.40      crook      72:     \G counted-string format. If the parse area was empty or
1.29      crook      73:     \G contained no characters other than delimiters, the resulting
                     74:     \G string has zero length. A program may replace characters within
                     75:     \G the counted string. OBSOLESCENT: the counted string has a
                     76:     \G trailing space that is not included in its length.
                     77:     sword here place  bl here count + c!  here ;
                     78: 
                     79: : parse    ( char "ccc<char>" -- c-addr u ) \ core-ext
1.80      anton      80: \G Parse @i{ccc}, delimited by @i{char}, in the parse
                     81: \G area. @i{c-addr u} specifies the parsed string within the
                     82: \G parse area. If the parse area was empty, @i{u} is 0.
1.29      crook      83:     >r  source  >in @ over min /string  over  swap r>  scan >r
1.80      anton      84:     over - dup r> IF 1+ THEN  >in +! ;
1.1       pazsan     85: 
                     86: \ name                                                 13feb93py
                     87: 
                     88: [IFUNDEF] (name) \ name might be a primitive
                     89: 
1.40      crook      90: : (name) ( -- c-addr count ) \ gforth
1.1       pazsan     91:     source 2dup >r >r >in @ /string (parse-white)
                     92:     2dup + r> - 1+ r> min >in ! ;
                     93: \    name count ;
                     94: [THEN]
                     95: 
                     96: : name-too-short? ( c-addr u -- c-addr u )
                     97:     dup 0= -&16 and throw ;
                     98: 
                     99: : name-too-long? ( c-addr u -- c-addr u )
1.67      anton     100:     dup lcount-mask u> -&19 and throw ;
1.1       pazsan    101: 
                    102: \ \ Number parsing                                     23feb93py
                    103: 
                    104: \ number? number                                       23feb93py
                    105: 
                    106: hex
                    107: const Create bases   10 ,   2 ,   A , 100 ,
                    108: \                     16     2    10   character
                    109: 
1.18      anton     110: \ !! protect BASE saving wrapper against exceptions
1.1       pazsan    111: : getbase ( addr u -- addr' u' )
                    112:     over c@ [char] $ - dup 4 u<
                    113:     IF
                    114:        cells bases + @ base ! 1 /string
                    115:     ELSE
                    116:        drop
                    117:     THEN ;
                    118: 
1.20      pazsan    119: : sign? ( addr u -- addr u flag )
1.33      jwilke    120:     over c@ [char] - =  dup >r
1.1       pazsan    121:     IF
                    122:        1 /string
                    123:     THEN
1.20      pazsan    124:     r> ;
                    125: 
                    126: : s>unumber? ( addr u -- ud flag )
1.21      pazsan    127:     base @ >r  dpl on  getbase
1.20      pazsan    128:     0. 2swap
1.18      anton     129:     BEGIN ( d addr len )
1.1       pazsan    130:        dup >r >number dup
1.18      anton     131:     WHILE \ there are characters left
1.1       pazsan    132:        dup r> -
1.18      anton     133:     WHILE \ the last >number parsed something
                    134:        dup 1- dpl ! over c@ [char] . =
                    135:     WHILE \ the current char is '.'
1.1       pazsan    136:        1 /string
1.18      anton     137:     REPEAT  THEN \ there are unparseable characters left
1.21      pazsan    138:        2drop false
1.20      pazsan    139:     ELSE
                    140:        rdrop 2drop true
1.21      pazsan    141:     THEN
                    142:     r> base ! ;
1.20      pazsan    143: 
                    144: \ ouch, this is complicated; there must be a simpler way - anton
                    145: : s>number? ( addr len -- d f )
                    146:     \ converts string addr len into d, flag indicates success
1.21      pazsan    147:     sign? >r
1.20      pazsan    148:     s>unumber?
                    149:     0= IF
1.21      pazsan    150:         rdrop false
1.18      anton     151:     ELSE \ no characters left, all ok
1.20      pazsan    152:        r>
1.1       pazsan    153:        IF
                    154:            dnegate
                    155:        THEN
1.18      anton     156:        true
1.21      pazsan    157:     THEN ;
1.1       pazsan    158: 
1.18      anton     159: : s>number ( addr len -- d )
                    160:     \ don't use this, there is no way to tell success
                    161:     s>number? drop ;
                    162: 
1.1       pazsan    163: : snumber? ( c-addr u -- 0 / n -1 / d 0> )
1.18      anton     164:     s>number? 0=
1.1       pazsan    165:     IF
                    166:        2drop false  EXIT
                    167:     THEN
1.18      anton     168:     dpl @ dup 0< IF
1.1       pazsan    169:        nip
1.18      anton     170:     ELSE
                    171:        1+
1.1       pazsan    172:     THEN ;
                    173: 
                    174: : number? ( string -- string 0 / n -1 / d 0> )
                    175:     dup >r count snumber? dup if
                    176:        rdrop
                    177:     else
                    178:        r> swap
                    179:     then ;
                    180: 
                    181: : number ( string -- d )
                    182:     number? ?dup 0= abort" ?"  0<
                    183:     IF
                    184:        s>d
                    185:     THEN ;
                    186: 
                    187: \ \ Comments ( \ \G
                    188: 
1.29      crook     189: : ( ( compilation 'ccc<close-paren>' -- ; run-time -- ) \ thisone- core,file   paren
1.17      crook     190:     \G ** this will not get annotated. The alias in glocals.fs will instead **
1.29      crook     191:     \G It does not work to use "wordset-" prefix since this file is glossed
                    192:     \G by cross.fs which doesn't have the same functionalty as makedoc.fs
1.1       pazsan    193:     [char] ) parse 2drop ; immediate
                    194: 
1.51      anton     195: : \ ( compilation 'ccc<newline>' -- ; run-time -- ) \ thisone- core-ext,block-ext backslash
1.29      crook     196:     \G ** this will not get annotated. The alias in glocals.fs will instead ** 
                    197:     \G It does not work to use "wordset-" prefix since this file is glossed
                    198:     \G by cross.fs which doesn't have the same functionalty as makedoc.fs
1.12      pazsan    199:     [ has? file [IF] ]
1.1       pazsan    200:     blk @
                    201:     IF
                    202:        >in @ c/l / 1+ c/l * >in !
                    203:        EXIT
                    204:     THEN
1.12      pazsan    205:     [ [THEN] ]
1.1       pazsan    206:     source >in ! drop ; immediate
                    207: 
1.51      anton     208: : \G ( compilation 'ccc<newline>' -- ; run-time -- ) \ gforth backslash-gee
1.19      crook     209:     \G Equivalent to @code{\} but used as a tag to annotate definition
                    210:     \G comments into documentation.
1.1       pazsan    211:     POSTPONE \ ; immediate
                    212: 
                    213: \ \ object oriented search list                         17mar93py
                    214: 
                    215: \ word list structure:
                    216: 
                    217: struct
                    218:   cell% field find-method   \ xt: ( c_addr u wid -- nt )
                    219:   cell% field reveal-method \ xt: ( nt wid -- ) \ used by dofield:, must be field
                    220:   cell% field rehash-method \ xt: ( wid -- )      \ re-initializes a "search-data" (hashtables)
                    221:   cell% field hash-method   \ xt: ( wid -- )    \ initializes ""
                    222: \   \ !! what else
                    223: end-struct wordlist-map-struct
                    224: 
                    225: struct
1.6       pazsan    226:   cell% field wordlist-map \ pointer to a wordlist-map-struct
1.13      anton     227:   cell% field wordlist-id \ linked list of words (for WORDS etc.)
1.1       pazsan    228:   cell% field wordlist-link \ link field to other wordlists
1.13      anton     229:   cell% field wordlist-extend \ wordlist extensions (eg bucket offset)
1.1       pazsan    230: end-struct wordlist-struct
                    231: 
                    232: : f83find      ( addr len wordlist -- nt / false )
1.67      anton     233:     wordlist-id @ (listlfind) ;
1.1       pazsan    234: 
                    235: : initvoc              ( wid -- )
                    236:   dup wordlist-map @ hash-method perform ;
                    237: 
                    238: \ Search list table: find reveal
                    239: Create f83search ( -- wordlist-map )
                    240:     ' f83find A,  ' drop A,  ' drop A, ' drop A,
                    241: 
1.6       pazsan    242: here G f83search T A, NIL A, NIL A, NIL A,
1.1       pazsan    243: AValue forth-wordlist \ variable, will be redefined by search.fs
                    244: 
                    245: AVariable lookup               forth-wordlist lookup !
                    246: \ !! last is user and lookup?! jaw
                    247: AVariable current ( -- addr ) \ gforth
1.43      crook     248: \G @code{Variable} -- holds the @i{wid} of the compilation word list.
1.1       pazsan    249: AVariable voclink      forth-wordlist wordlist-link voclink !
1.38      anton     250: \ lookup AValue context ( -- addr ) \ gforth
                    251: Defer context ( -- addr ) \ gforth
1.43      crook     252: \G @code{context} @code{@@} is the @i{wid} of the word list at the
                    253: \G top of the search order.
1.1       pazsan    254: 
1.38      anton     255: ' lookup is context
1.1       pazsan    256: forth-wordlist current !
                    257: 
                    258: \ \ header, finding, ticks                              17dec92py
                    259: 
1.69      pazsan    260: \ The constants are defined as 32 bits, but then erased
                    261: \ and overwritten by the right ones
1.67      anton     262: 
                    263: $80000000 constant alias-mask
1.69      pazsan    264: 1 bits/char 1 - lshift
                    265: -1 cells allot  bigendian [IF]   c, 0 1 cells 1- times
                    266:                           [ELSE] 0 1 cells 1- times c, [THEN]
1.67      anton     267: $40000000 constant immediate-mask
1.69      pazsan    268: 1 bits/char 2 - lshift
                    269: -1 cells allot  bigendian [IF]   c, 0 1 cells 1- times
                    270:                           [ELSE] 0 1 cells 1- times c, [THEN]
1.67      anton     271: $20000000 constant restrict-mask
1.69      pazsan    272: 1 bits/char 3 - lshift
                    273: -1 cells allot  bigendian [IF]   c, 0 1 cells 1- times
                    274:                           [ELSE] 0 1 cells 1- times c, [THEN]
1.67      anton     275: $1fffffff constant lcount-mask
1.69      pazsan    276: 1 bits/char 3 - lshift 1 -
1.71      pazsan    277: -1 cells allot  bigendian [IF]   c, -1 1 cells 1- times
                    278:                           [ELSE] -1 1 cells 1- times c, [THEN]
1.1       pazsan    279: 
                    280: \ higher level parts of find
                    281: 
                    282: : flag-sign ( f -- 1|-1 )
                    283:     \ true becomes 1, false -1
                    284:     0= 2* 1+ ;
                    285: 
1.79      anton     286: : ticking-compile-only-error ( ... -- )
                    287:     -&2048 throw ;
1.1       pazsan    288: 
                    289: : (cfa>int) ( cfa -- xt )
                    290: [ has? compiler [IF] ]
                    291:     dup interpret/compile?
                    292:     if
                    293:        interpret/compile-int @
                    294:     then 
                    295: [ [THEN] ] ;
                    296: 
1.67      anton     297: : (x>int) ( cfa w -- xt )
1.1       pazsan    298:     \ get interpretation semantics of name
                    299:     restrict-mask and
                    300:     if
1.79      anton     301:        drop ['] ticking-compile-only-error
1.1       pazsan    302:     else
                    303:        (cfa>int)
                    304:     then ;
                    305: 
                    306: : name>string ( nt -- addr count ) \ gforth     head-to-string
1.40      crook     307:     \g @i{addr count} is the name of the word represented by @i{nt}.
1.67      anton     308:     cell+ dup cell+ swap @ lcount-mask and ;
1.1       pazsan    309: 
                    310: : ((name>))  ( nfa -- cfa )
                    311:     name>string + cfaligned ;
                    312: 
1.67      anton     313: : (name>x) ( nfa -- cfa w )
                    314:     \ cfa is an intermediate cfa and w is the flags cell of nfa
1.1       pazsan    315:     dup ((name>))
1.67      anton     316:     swap cell+ @ dup alias-mask and 0=
1.1       pazsan    317:     IF
                    318:         swap @ swap
                    319:     THEN ;
                    320: 
                    321: : name>int ( nt -- xt ) \ gforth
1.31      crook     322:     \G @i{xt} represents the interpretation semantics of the word
                    323:     \G @i{nt}. If @i{nt} has no interpretation semantics (i.e. is
                    324:     \G @code{compile-only}), @i{xt} is the execution token for
1.79      anton     325:     \G @code{ticking-compile-only-error}, which performs @code{-2048 throw}.
1.1       pazsan    326:     (name>x) (x>int) ;
                    327: 
                    328: : name?int ( nt -- xt ) \ gforth
1.79      anton     329:     \G Like @code{name>int}, but perform @code{-2048 throw} if @i{nt}
1.31      crook     330:     \G has no interpretation semantics.
1.1       pazsan    331:     (name>x) restrict-mask and
                    332:     if
1.79      anton     333:        ticking-compile-only-error \ does not return
1.1       pazsan    334:     then
                    335:     (cfa>int) ;
                    336: 
                    337: : (name>comp) ( nt -- w +-1 ) \ gforth
1.31      crook     338:     \G @i{w xt} is the compilation token for the word @i{nt}.
1.1       pazsan    339:     (name>x) >r 
                    340: [ has? compiler [IF] ]
                    341:     dup interpret/compile?
                    342:     if
                    343:         interpret/compile-comp @
                    344:     then 
                    345: [ [THEN] ]
                    346:     r> immediate-mask and flag-sign
                    347:     ;
                    348: 
                    349: : (name>intn) ( nfa -- xt +-1 )
1.67      anton     350:     (name>x) tuck (x>int) ( w xt )
1.1       pazsan    351:     swap immediate-mask and flag-sign ;
                    352: 
1.72      pazsan    353: const Create ???  0 , 3 , char ? c, char ? c, char ? c,
1.30      jwilke    354: \ ??? is used by dovar:, must be created/:dovar
                    355: 
                    356: [IFDEF] forthstart
                    357: \ if we have a forthstart we can define head? with it
                    358: \ otherwise leave out the head? check
                    359: 
1.14      anton     360: : head? ( addr -- f )
1.82      anton     361: \G heuristic check whether addr is a name token; may deliver false
                    362: \G positives; addr must be a valid address; returns 1 for
                    363: \G particularly unsafe positives
1.14      anton     364:     \ we follow the link fields and check for plausibility; two
                    365:     \ iterations should catch most false addresses: on the first
                    366:     \ iteration, we may get an xt, on the second a code address (or
                    367:     \ some code), which is typically not in the dictionary.
1.82      anton     368:     \ we added a third iteration for working with code and ;code words.
                    369:     3 0 do
1.41      anton     370:        dup dup aligned <> if \ protect @ against unaligned accesses
                    371:            drop false unloop exit
                    372:        then
1.14      anton     373:        dup @ dup
                    374:        if ( addr addr1 )
                    375:            dup rot forthstart within
                    376:            if \ addr1 is outside forthstart..addr, not a head
                    377:                drop false unloop exit
                    378:            then ( addr1 )
                    379:        else \ 0 in the link field, no further checks
1.81      anton     380:            2drop 1 unloop exit \ this is very unsure, so return 1
1.14      anton     381:        then
                    382:     loop
                    383:     \ in dubio pro:
                    384:     drop true ;
                    385: 
1.48      anton     386: : >head-noprim ( cfa -- nt ) \ gforth  to-head-noprim
1.67      anton     387:     \ also heuristic; finds only names with up to 32 chars
1.45      pazsan    388:     $25 cell do ( cfa )
1.70      pazsan    389:        dup i - dup @ [ alias-mask lcount-mask or ] literal
                    390:        [ 1 bits/char 3 - lshift 1 - 1 bits/char 1 - lshift or
1.71      pazsan    391:        -1 cells allot bigendian [IF]   c, -1 1 cells 1- times
                    392:        [ELSE] -1 1 cells 1- times c, [THEN] ]
1.70      pazsan    393:        and ( cfa len|alias )
1.67      anton     394:        swap + cell + cfaligned over alias-mask + =
1.14      anton     395:        if ( cfa )
                    396:            dup i - cell - dup head?
                    397:            if
                    398:                nip unloop exit
                    399:            then
                    400:            drop
                    401:        then
                    402:        cell +loop
                    403:     drop ??? ( wouldn't 0 be better? ) ;
1.1       pazsan    404: 
1.30      jwilke    405: [ELSE]
                    406: 
1.48      anton     407: : >head-noprim ( cfa -- nt ) \ gforth  to-head-noprim
1.45      pazsan    408:     $25 cell do ( cfa )
1.70      pazsan    409:        dup i - dup @ [ alias-mask lcount-mask or ] literal
                    410:        [ 1 bits/char 3 - lshift 1 - 1 bits/char 1 - lshift or
1.71      pazsan    411:        -1 cells allot bigendian [IF]   c, -1 1 cells 1- times
                    412:        [ELSE] -1 1 cells 1- times c, [THEN] ]
1.70      pazsan    413:        and ( cfa len|alias )
1.67      anton     414:        swap + cell + cfaligned over alias-mask + =
1.30      jwilke    415:        if ( cfa ) i - cell - unloop exit
                    416:        then
                    417:        cell +loop
                    418:     drop ??? ( wouldn't 0 be better? ) ;
                    419: 
                    420: [THEN]
1.1       pazsan    421: 
1.83      anton     422: cell% 2* 0 0 field >body ( xt -- a_addr ) \ core
                    423: \G Get the address of the body of the word represented by @i{xt} (the
                    424: \G address of the word's data field).
                    425: drop drop
                    426: 
                    427: cell% -2 * 0 0 field body> ( xt -- a_addr )
1.84      anton     428:     drop drop
                    429: 
                    430: has? standardthreading has? compiler and [IF]
                    431: 
                    432: ' @ alias >code-address ( xt -- c_addr ) \ gforth
                    433: \G @i{c-addr} is the code address of the word @i{xt}.
                    434: 
                    435: : >does-code ( xt -- a_addr ) \ gforth
                    436: \G If @i{xt} is the execution token of a child of a @code{DOES>} word,
                    437: \G @i{a-addr} is the start of the Forth code after the @code{DOES>};
                    438: \G Otherwise @i{a-addr} is 0.
                    439:     dup @ dodoes: = if
                    440:        cell+ @
                    441:     else
                    442:        drop 0
                    443:     endif ;
                    444: 
1.85      anton     445: ' ! alias code-address! ( c_addr xt -- ) \ gforth
                    446: \G Create a code field with code address @i{c-addr} at @i{xt}.
                    447: 
                    448: : does-code! ( a_addr xt -- ) \ gforth
                    449: \G Create a code field at @i{xt} for a child of a @code{DOES>}-word;
                    450: \G @i{a-addr} is the start of the Forth code after @code{DOES>}.
                    451:     dodoes: over ! cell+ ! ;
                    452: 
1.86      anton     453: ' drop alias does-handler! ( a_addr -- ) \ gforth
                    454: \G Create a @code{DOES>}-handler at address @i{a-addr}. Normally,
                    455: \G @i{a-addr} points just behind a @code{DOES>}.
                    456: 
1.85      anton     457: 2 cells constant /does-handler ( -- n ) \ gforth
                    458: \G The size of a @code{DOES>}-handler (includes possible padding).
                    459: 
1.84      anton     460: [THEN] 
1.1       pazsan    461: 
1.31      crook     462: : (search-wordlist)  ( addr count wid -- nt | false )
1.1       pazsan    463:     dup wordlist-map @ find-method perform ;
                    464: 
1.31      crook     465: : search-wordlist ( c-addr count wid -- 0 | xt +-1 ) \ search
1.53      anton     466:     \G Search the word list identified by @i{wid} for the definition
                    467:     \G named by the string at @i{c-addr count}.  If the definition is
                    468:     \G not found, return 0. If the definition is found return 1 (if
                    469:     \G the definition is immediate) or -1 (if the definition is not
                    470:     \G immediate) together with the @i{xt}.  In Gforth, the @i{xt}
                    471:     \G returned represents the interpretation semantics.  ANS Forth
                    472:     \G does not specify clearly what @i{xt} represents.
1.1       pazsan    473:     (search-wordlist) dup if
                    474:        (name>intn)
                    475:     then ;
                    476: 
1.31      crook     477: : find-name ( c-addr u -- nt | 0 ) \ gforth
                    478:     \g Find the name @i{c-addr u} in the current search
                    479:     \g order. Return its @i{nt}, if found, otherwise 0.
1.1       pazsan    480:     lookup @ (search-wordlist) ;
                    481: 
                    482: : sfind ( c-addr u -- 0 / xt +-1  ) \ gforth-obsolete
                    483:     find-name dup
                    484:     if ( nt )
                    485:        state @
                    486:        if
                    487:            (name>comp)
                    488:        else
                    489:            (name>intn)
                    490:        then
                    491:    then ;
                    492: 
1.31      crook     493: : find ( c-addr -- xt +-1 | c-addr 0 ) \ core,search
1.53      anton     494:     \G Search all word lists in the current search order for the
                    495:     \G definition named by the counted string at @i{c-addr}.  If the
                    496:     \G definition is not found, return 0. If the definition is found
                    497:     \G return 1 (if the definition has non-default compilation
                    498:     \G semantics) or -1 (if the definition has default compilation
                    499:     \G semantics).  The @i{xt} returned in interpret state represents
                    500:     \G the interpretation semantics.  The @i{xt} returned in compile
                    501:     \G state represented either the compilation semantics (for
                    502:     \G non-default compilation semantics) or the run-time semantics
                    503:     \G that the compilation semantics would @code{compile,} (for
                    504:     \G default compilation semantics).  The ANS Forth standard does
                    505:     \G not specify clearly what the returned @i{xt} represents (and
                    506:     \G also talks about immediacy instead of non-default compilation
                    507:     \G semantics), so this word is questionable in portable programs.
                    508:     \G If non-portability is ok, @code{find-name} and friends are
                    509:     \G better (@pxref{Name token}).
1.1       pazsan    510:     dup count sfind dup
                    511:     if
                    512:        rot drop
                    513:     then ;
                    514: 
1.34      jwilke    515: \ ticks in interpreter
1.1       pazsan    516: 
                    517: : (') ( "name" -- nt ) \ gforth
1.32      anton     518:     name name-too-short?
1.28      anton     519:     find-name dup 0=
1.1       pazsan    520:     IF
1.42      anton     521:        drop -&13 throw
1.1       pazsan    522:     THEN  ;
                    523: 
                    524: : '    ( "name" -- xt ) \ core tick
1.31      crook     525:     \g @i{xt} represents @i{name}'s interpretation
                    526:     \g semantics. Perform @code{-14 throw} if the word has no
1.1       pazsan    527:     \g interpretation semantics.
                    528:     (') name?int ;
1.34      jwilke    529: 
                    530: has? compiler 0= [IF]  \ interpreter only version of IS and TO
                    531: 
                    532: : IS ' >body ! ;
                    533: ' IS Alias TO
                    534: 
                    535: [THEN]
1.1       pazsan    536: 
                    537: \ \ the interpreter loop                                 mar92py
                    538: 
                    539: \ interpret                                            10mar92py
                    540: 
1.37      anton     541: Defer parser ( c-addr u -- )
1.77      anton     542: Defer parse-word ( -- c-addr count ) \ gforth
1.55      anton     543: \G Get the next word from the input buffer
1.77      anton     544: ' (name) IS parse-word
                    545: 
                    546: ' parse-word alias name ( -- c-addr u ) \ gforth-obsolete
                    547: \G old name for @code{parse-word}
                    548: 
1.1       pazsan    549: Defer compiler-notfound ( c-addr count -- )
                    550: Defer interpreter-notfound ( c-addr count -- )
                    551: 
                    552: : no.extensions  ( addr u -- )
1.42      anton     553:     2drop -&13 throw ;
1.1       pazsan    554: ' no.extensions IS compiler-notfound
                    555: ' no.extensions IS interpreter-notfound
                    556: 
1.66      anton     557: : interpret1 ( ... -- ... )
1.33      jwilke    558: [ has? backtrace [IF] ]
1.24      anton     559:     rp@ backtrace-rp0 !
1.33      jwilke    560: [ [THEN] ]
1.1       pazsan    561:     BEGIN
                    562:        ?stack name dup
                    563:     WHILE
                    564:        parser
                    565:     REPEAT
1.66      anton     566:     2drop ;
                    567:     
                    568: : interpret ( ?? -- ?? ) \ gforth
                    569:     \ interpret/compile the (rest of the) input buffer
                    570: [ has? backtrace [IF] ]
                    571:     backtrace-rp0 @ >r 
                    572: [ [THEN] ]
                    573:     ['] interpret1 catch
1.65      anton     574: [ has? backtrace [IF] ]
                    575:     r> backtrace-rp0 !
1.66      anton     576:     [ [THEN] ]
                    577:     throw ;
1.1       pazsan    578: 
                    579: \ interpreter                                  30apr92py
                    580: 
                    581: \ not the most efficient implementations of interpreter and compiler
1.33      jwilke    582: : interpreter ( c-addr u -- ) 
1.1       pazsan    583:     2dup find-name dup
                    584:     if
                    585:        nip nip name>int execute
                    586:     else
                    587:        drop
                    588:        2dup 2>r snumber?
                    589:        IF
                    590:            2rdrop
                    591:        ELSE
                    592:            2r> interpreter-notfound
                    593:        THEN
                    594:     then ;
                    595: 
                    596: ' interpreter  IS  parser
                    597: 
                    598: \ \ Query Evaluate                                     07apr93py
                    599: 
                    600: has? file 0= [IF]
1.12      pazsan    601: : sourceline# ( -- n )  1 ;
1.61      pazsan    602: [ELSE]
1.64      pazsan    603: has? new-input 0= [IF]
1.58      pazsan    604: Variable #fill-bytes
                    605: \G number of bytes read via (read-line) by the last refill
1.61      pazsan    606: [THEN]
1.64      pazsan    607: [THEN]
1.58      pazsan    608: 
1.64      pazsan    609: has? new-input 0= [IF]
1.1       pazsan    610: : refill ( -- flag ) \ core-ext,block-ext,file-ext
1.29      crook     611:     \G Attempt to fill the input buffer from the input source.  When
                    612:     \G the input source is the user input device, attempt to receive
                    613:     \G input into the terminal input device. If successful, make the
                    614:     \G result the input buffer, set @code{>IN} to 0 and return true;
                    615:     \G otherwise return false. When the input source is a block, add 1
                    616:     \G to the value of @code{BLK} to make the next block the input
                    617:     \G source and current input buffer, and set @code{>IN} to 0;
                    618:     \G return true if the new value of @code{BLK} is a valid block
                    619:     \G number, false otherwise. When the input source is a text file,
                    620:     \G attempt to read the next line from the file. If successful,
                    621:     \G make the result the current input buffer, set @code{>IN} to 0
                    622:     \G and return true; otherwise, return false.  A successful result
                    623:     \G includes receipt of a line containing 0 characters.
1.12      pazsan    624:     [ has? file [IF] ]
                    625:        blk @  IF  1 blk +!  true  0 >in !  EXIT  THEN
                    626:        [ [THEN] ]
                    627:     tib /line
                    628:     [ has? file [IF] ]
                    629:        loadfile @ ?dup
1.59      pazsan    630:        IF    (read-line) throw #fill-bytes !
1.12      pazsan    631:        ELSE
                    632:            [ [THEN] ]
                    633:        sourceline# 0< IF 2drop false EXIT THEN
                    634:        accept true
                    635:        [ has? file [IF] ]
                    636:        THEN
                    637:        1 loadline +!
                    638:        [ [THEN] ]
                    639:     swap #tib ! 0 >in ! ;
1.1       pazsan    640: 
                    641: : query   ( -- ) \ core-ext
1.29      crook     642:     \G Make the user input device the input source. Receive input into
                    643:     \G the Terminal Input Buffer. Set @code{>IN} to zero. OBSOLESCENT:
                    644:     \G superceeded by @code{accept}.
1.12      pazsan    645:     [ has? file [IF] ]
                    646:        blk off loadfile off
                    647:        [ [THEN] ]
1.64      pazsan    648:     refill drop ;
                    649: [THEN]
1.1       pazsan    650: 
                    651: \ save-mem extend-mem
                    652: 
                    653: has? os [IF]
                    654: : save-mem     ( addr1 u -- addr2 u ) \ gforth
                    655:     \g copy a memory block into a newly allocated region in the heap
                    656:     swap >r
                    657:     dup allocate throw
                    658:     swap 2dup r> -rot move ;
                    659: 
1.68      anton     660: : free-mem-var ( addr -- )
                    661:     \ addr is the address of a 2variable containing address and size
                    662:     \ of a memory range; frees memory and clears the 2variable.
                    663:     dup 2@ drop dup
                    664:     if ( addr mem-start )
                    665:        free throw
                    666:        0 0 rot 2!
                    667:     else
                    668:        2drop
                    669:     then ;
                    670: 
1.1       pazsan    671: : extend-mem   ( addr1 u1 u -- addr addr2 u2 )
                    672:     \ extend memory block allocated from the heap by u aus
                    673:     \ the (possibly reallocated piece is addr2 u2, the extension is at addr
                    674:     over >r + dup >r resize throw
                    675:     r> over r> + -rot ;
                    676: [THEN]
                    677: 
                    678: \ EVALUATE                                              17may93jaw
                    679: 
1.64      pazsan    680: has? file 0= has? new-input 0= and [IF]
1.1       pazsan    681: : push-file  ( -- )  r>
1.12      pazsan    682:   tibstack @ >r  >tib @ >r  #tib @ >r
1.1       pazsan    683:   >tib @ tibstack @ = IF  r@ tibstack +!  THEN
                    684:   tibstack @ >tib ! >in @ >r  >r ;
                    685: 
                    686: : pop-file   ( throw-code -- throw-code )
                    687:   r>
1.12      pazsan    688:   r> >in !  r> #tib !  r> >tib !  r> tibstack !  >r ;
1.1       pazsan    689: [THEN]
                    690: 
1.64      pazsan    691: has? new-input 0= [IF]
1.29      crook     692: : evaluate ( c-addr u -- ) \ core,block
1.40      crook     693:     \G Save the current input source specification. Store @code{-1} in
                    694:     \G @code{source-id} and @code{0} in @code{blk}. Set @code{>IN} to
                    695:     \G @code{0} and make the string @i{c-addr u} the input source
                    696:     \G and input buffer. Interpret. When the parse area is empty,
                    697:     \G restore the input source specification.
1.64      pazsan    698: [ has? file [IF] ]
1.56      anton     699:     loadfilename# @ >r
1.60      anton     700:     1 loadfilename# ! \ "*evaluated string*"
1.64      pazsan    701: [ [THEN] ]
1.40      crook     702:     push-file #tib ! >tib !
1.29      crook     703:     >in off
                    704:     [ has? file [IF] ]
                    705:        blk off loadfile off -1 loadline !
                    706:        [ [THEN] ]
                    707:     ['] interpret catch
1.56      anton     708:     pop-file
1.64      pazsan    709: [ has? file [IF] ]
1.56      anton     710:     r> loadfilename# !
1.64      pazsan    711: [ [THEN] ]
1.56      anton     712:     throw ;
1.64      pazsan    713: [THEN]
1.1       pazsan    714: 
                    715: \ \ Quit                                               13feb93py
                    716: 
                    717: Defer 'quit
                    718: 
                    719: Defer .status
                    720: 
                    721: : prompt        state @ IF ."  compiled" EXIT THEN ."  ok" ;
                    722: 
1.39      anton     723: : (quit) ( -- )
                    724:     \ exits only through THROW etc.
1.42      anton     725: \    sp0 @ cell - handler @ &12 + ! \ !! kludge: fix the stack pointer
1.39      anton     726:     \ stored in the system's CATCH frame, so the stack depth will be 0
                    727:     \ after the next THROW it catches (it may be off due to BOUNCEs or
                    728:     \ because process-args left something on the stack)
                    729:     BEGIN
1.64      pazsan    730:        .status cr query interpret prompt
1.39      anton     731:     AGAIN ;
1.1       pazsan    732: 
                    733: ' (quit) IS 'quit
                    734: 
                    735: \ \ DOERROR (DOERROR)                                  13jun93jaw
                    736: 
                    737: 8 Constant max-errors
                    738: Variable error-stack  0 error-stack !
1.64      pazsan    739: max-errors has? file [IF] 6 [ELSE] 4 [THEN] * cells allot
1.1       pazsan    740: \ format of one cell:
                    741: \ source ( addr u )
                    742: \ >in
                    743: \ line-number
                    744: \ Loadfilename ( addr u )
                    745: 
1.64      pazsan    746: : error> ( -- addr u >in line# [addr u] )
                    747:     -1 error-stack +!
                    748:     error-stack dup @
                    749:     [ has? file [IF] 6 [ELSE] 4 [THEN] ] Literal * cells + cell+
                    750:     [ has? file [IF] 6 [ELSE] 4 [THEN] ] Literal cells bounds DO
                    751:        I @
                    752:        cell +LOOP ;
                    753: : >error ( addr u >in line# [addr u] -- )
                    754:     error-stack dup @ dup 1+
                    755:     max-errors 1- min error-stack !
                    756:     [ has? file [IF] 6 [ELSE] 4 [THEN] ] Literal * cells + cell+
                    757:     [ has? file [IF] 6 [ELSE] 4 [THEN] 1- ] Literal cells bounds swap DO
                    758:        I !
                    759:        -1 cells +LOOP ;
                    760: 
1.1       pazsan    761: : dec. ( n -- ) \ gforth
1.40      crook     762:     \G Display @i{n} as a signed decimal number, followed by a space.
                    763:     \ !! not used...
1.1       pazsan    764:     base @ decimal swap . base ! ;
                    765: 
1.23      jwilke    766: : dec.r ( u -- ) \ gforth
1.40      crook     767:     \G Display @i{u} as a unsigned decimal number
1.23      jwilke    768:     base @ decimal swap 0 .r base ! ;
                    769: 
1.1       pazsan    770: : hex. ( u -- ) \ gforth
1.40      crook     771:     \G Display @i{u} as an unsigned hex number, prefixed with a "$" and
1.17      crook     772:     \G followed by a space.
1.40      crook     773:     \ !! not used...
1.33      jwilke    774:     [char] $ emit base @ swap hex u. base ! ;
1.1       pazsan    775: 
                    776: : typewhite ( addr u -- ) \ gforth
1.40      crook     777:     \G Like type, but white space is printed instead of the characters.
1.1       pazsan    778:     bounds ?do
                    779:        i c@ #tab = if \ check for tab
                    780:            #tab
                    781:        else
                    782:            bl
                    783:        then
                    784:        emit
                    785:     loop ;
                    786: 
                    787: DEFER DOERROR
1.33      jwilke    788: 
                    789: has? backtrace [IF]
1.15      anton     790: Defer dobacktrace ( -- )
                    791: ' noop IS dobacktrace
1.33      jwilke    792: [THEN]
1.1       pazsan    793: 
1.23      jwilke    794: : .error-string ( throw-code -- )
                    795:   dup -2 = 
                    796:   IF   "error @ ?dup IF count type  THEN drop
                    797:   ELSE .error
                    798:   THEN ;
                    799: 
1.64      pazsan    800: : .error-frame ( throwcode addr1 u1 n1 n2 [addr2 u2] -- throwcode )
                    801: \ addr2 u2:    filename of included file - optional
1.23      jwilke    802: \ n2:          line number
                    803: \ n1:          error position in input line
                    804: \ addr1 u1:    input line
1.1       pazsan    805:   cr error-stack @
                    806:   IF
1.64      pazsan    807: [ has? file [IF] ]
                    808:     ." in file included from "
                    809:     type ." :"
                    810: [ [THEN] ]
                    811:     dec.r  drop 2drop
1.1       pazsan    812:   ELSE
1.64      pazsan    813: [ has? file [IF] ]
                    814:       type ." :"
                    815: [ [THEN] ]
                    816:       dup >r dec.r ." : " 3 pick .error-string
1.57      anton     817:       r> IF \ if line# non-zero, there is a line
                    818:          cr dup 2over type cr drop
                    819:          nip -trailing 1- ( line-start index2 )
                    820:          0 >r  BEGIN
                    821:              2dup + c@ bl >  WHILE
                    822:              r> 1+ >r  1- dup 0<  UNTIL  THEN  1+
                    823:          ( line-start index1 )
                    824:          typewhite
                    825:          r> 1 max 0 ?do \ we want at least one "^", even if the length is 0
                    826:              [char] ^ emit
                    827:          loop
                    828:       ELSE
                    829:          2drop drop
                    830:       THEN
1.23      jwilke    831:   THEN ;
1.1       pazsan    832: 
                    833: : (DoError) ( throw-code -- )
                    834:   [ has? os [IF] ]
1.8       pazsan    835:       >stderr
1.1       pazsan    836:   [ [THEN] ] 
1.64      pazsan    837:   source >in @ sourceline# [ has? file [IF] ]
                    838:       sourcefilename
                    839:   [ [THEN] ] .error-frame
1.1       pazsan    840:   error-stack @ 0 ?DO
1.64      pazsan    841:     error>
1.1       pazsan    842:     .error-frame
                    843:   LOOP
1.33      jwilke    844:   drop 
                    845: [ has? backtrace [IF] ]
                    846:   dobacktrace
                    847: [ [THEN] ]
1.8       pazsan    848:   normal-dp dpp ! ;
1.1       pazsan    849: 
                    850: ' (DoError) IS DoError
                    851: 
                    852: : quit ( ?? -- ?? ) \ core
1.27      crook     853:     \G Empty the return stack, make the user input device
                    854:     \G the input source, enter interpret state and start
                    855:     \G the text interpreter.
1.64      pazsan    856:     rp0 @ rp! handler off clear-tibstack
                    857:     [ has? new-input 0= [IF] ] >tib @ >r [ [THEN] ]
1.1       pazsan    858:     BEGIN
                    859:        [ has? compiler [IF] ]
1.76      jwilke    860:        [compile] [
1.1       pazsan    861:        [ [THEN] ]
                    862:        ['] 'quit CATCH dup
                    863:     WHILE
1.22      anton     864:        <# \ reset hold area, or we may get another error
1.64      pazsan    865:        DoError
                    866:        [ has? new-input [IF] ] clear-tibstack
                    867:        [ [ELSE] ] r@ >tib ! r@ tibstack !
                    868:        [ [THEN] ]
1.1       pazsan    869:     REPEAT
1.64      pazsan    870:     drop [ has? new-input [IF] ] clear-tibstack
                    871:     [ [ELSE] ] r> >tib !
                    872:     [ [THEN] ] ;
1.1       pazsan    873: 
                    874: \ \ Cold Boot                                          13feb93py
                    875: 
                    876: : (bootmessage)
                    877:     ." GForth " version-string type 
1.88      pazsan    878:     ." , Copyright (C) 1995-2003 Free Software Foundation, Inc." cr
1.1       pazsan    879:     ." GForth comes with ABSOLUTELY NO WARRANTY; for details type `license'"
                    880: [ has? os [IF] ]
                    881:      cr ." Type `bye' to exit"
                    882: [ [THEN] ] ;
                    883: 
                    884: defer bootmessage
                    885: defer process-args
                    886: 
                    887: ' (bootmessage) IS bootmessage
                    888: 
1.10      anton     889: Defer 'cold ( -- ) \ gforth  tick-cold
1.1       pazsan    890: \ hook (deferred word) for things to do right before interpreting the
                    891: \ command-line arguments
                    892: ' noop IS 'cold
                    893: 
                    894: 
1.76      jwilke    895: AVariable init8 NIL init8 !
1.1       pazsan    896: 
                    897: : cold ( -- ) \ gforth
1.44      anton     898: [ has? backtrace [IF] ]
                    899:     rp@ backtrace-rp0 !
                    900: [ [THEN] ]
1.1       pazsan    901: [ has? file [IF] ]
1.78      pazsan    902:     os-cold
1.1       pazsan    903: [ [THEN] ]
                    904:     'cold
                    905:     init8 chainperform
                    906: [ has? file [IF] ]
1.62      anton     907:     loadfilename# off
1.8       pazsan    908:     process-args
1.12      pazsan    909:     loadline off
1.1       pazsan    910: [ [THEN] ]
                    911:     bootmessage
1.12      pazsan    912:     quit ;
1.1       pazsan    913: 
1.64      pazsan    914: has? new-input 0= [IF]
1.5       anton     915: : clear-tibstack ( -- )
                    916: [ has? glocals [IF] ]
                    917:     lp@ forthstart 7 cells + @ - 
                    918: [ [ELSE] ]
                    919:     [ has? os [IF] ]
1.8       pazsan    920:     r0 @ forthstart 6 cells + @ -
1.5       anton     921:     [ [ELSE] ]
1.16      pazsan    922:     sp@ $10 cells +
1.5       anton     923:     [ [THEN] ]
                    924: [ [THEN] ]
                    925:     dup >tib ! tibstack ! #tib off >in off ;
1.64      pazsan    926: [THEN]
1.5       anton     927: 
1.64      pazsan    928: : boot ( path n **argv argc -- )
1.1       pazsan    929:     main-task up!
                    930: [ has? os [IF] ]
1.78      pazsan    931:     os-boot
1.1       pazsan    932: [ [THEN] ]
                    933:     sp@ sp0 !
1.74      pazsan    934: [ has? peephole [IF] ]
1.87      anton     935:     \ only needed for greedy static superinstruction selection
                    936:     \ primtable prepare-peephole-table TO peeptable
1.74      pazsan    937: [ [THEN] ]
1.64      pazsan    938: [ has? new-input [IF] ]
                    939:     current-input off
                    940: [ [THEN] ]
1.5       anton     941:     clear-tibstack
1.1       pazsan    942:     rp@ rp0 !
                    943: [ has? floating [IF] ]
                    944:     fp@ fp0 !
                    945: [ [THEN] ]
1.46      anton     946:     handler off
1.8       pazsan    947:     ['] cold catch DoError cr
1.1       pazsan    948: [ has? os [IF] ]
1.35      anton     949:     1 (bye) \ !! determin exit code from throw code?
1.1       pazsan    950: [ [THEN] ]
                    951: ;
                    952: 
                    953: has? os [IF]
                    954: : bye ( -- ) \ tools-ext
                    955: [ has? file [IF] ]
                    956:     script? 0= IF  cr  THEN
                    957: [ [ELSE] ]
                    958:     cr
                    959: [ [THEN] ]
                    960:     0 (bye) ;
                    961: [THEN]
                    962: 
                    963: \ **argv may be scanned by the C starter to get some important
                    964: \ information, as -display and -geometry for an X client FORTH
                    965: \ or space and stackspace overrides
                    966: 
                    967: \ 0 arg contains, however, the name of the program.
                    968: 

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