--- gforth/search.fs 1997/05/21 20:39:38 1.1 +++ gforth/search.fs 2007/12/31 18:40:24 1.32 @@ -1,12 +1,12 @@ \ search order wordset 14may93py -\ Copyright (C) 1995 Free Software Foundation, Inc. +\ Copyright (C) 1995,1996,1997,1998,2000,2003,2005,2007 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 +\ as published by the Free Software Foundation, either version 3 \ of the License, or (at your option) any later version. \ This program is distributed in the hope that it will be useful, @@ -15,58 +15,92 @@ \ 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. +\ along with this program. If not, see http://www.gnu.org/licenses/. -$10 constant maxvp -Variable vp - 0 A, 0 A, 0 A, 0 A, 0 A, 0 A, 0 A, 0 A, - 0 A, 0 A, 0 A, 0 A, 0 A, 0 A, 0 A, 0 A, +require struct.fs -: get-current ( -- wid ) current @ ; -: set-current ( wid -- ) current ! ; - -: context ( -- addr ) vp dup @ cells + ; -: definitions ( -- ) context @ current ! ; +$10 Value maxvp \ current size of search order stack +$400 Value maxvp-limit \ upper limit for resizing search order stack +0 AValue vp \ will be initialized later (dynamic) +\ the first cell at vp contains the search order depth, the others +\ contain the wordlists, starting with the last-searched one. + +: get-current ( -- wid ) \ search + \G @i{wid} is the identifier of the current compilation word list. + current @ ; + +: set-current ( wid -- ) \ search + \G Set the compilation word list to the word list identified by @i{wid}. + current ! ; + +:noname ( -- addr ) + vp dup @ cells + ; +is context + +: vp! ( u -- ) + vp ! ; +: definitions ( -- ) \ search + \G Set the compilation word list to be the same as the word list + \G that is currently at the top of the search order. + context @ current ! ; \ wordlist Vocabulary also previous 14may93py -AVariable voclink - -Defer 'initvoc -' drop ' 'initvoc >body ! +Variable slowvoc 0 slowvoc ! -Variable slowvoc slowvoc off +\ Forth-wordlist AConstant Forth-wordlist -Forth-wordlist AConstant Forth-wordlist +: mappedwordlist ( map-struct -- wid ) \ gforth +\G Create a wordlist with a special map-structure. + align here swap A, 0 A, voclink @ A, 0 A, + dup wordlist-link voclink ! + dup initvoc ; -: wordlist ( -- wid ) - here 0 A, +: wordlist ( -- wid ) \ search + \G Create a new, empty word list represented by @i{wid}. slowvoc @ - IF [ Forth-wordlist wordlist-map @ ] ALiteral + IF \ this is now f83search because hashing may be loaded already + \ jaw + f83search ELSE Forth-wordlist wordlist-map @ THEN - A, voclink @ A, slowvoc @ A, - dup wordlist-link dup voclink ! 'initvoc ; - -: Vocabulary ( -- ) Create wordlist drop DOES> context ! ; + mappedwordlist ; -: also ( -- ) - context @ vp @ 1+ dup maxvp > abort" Vocstack full" - vp ! context ! ; - -: previous ( -- ) vp @ 1- dup 0= abort" Vocstack empty" vp ! ; +: Vocabulary ( "name" -- ) \ gforth + \G Create a definition "name" and associate a new word list with it. + \G The run-time effect of "name" is to replace the @i{wid} at the + \G top of the search order with the @i{wid} associated with the new + \G word list. + Create wordlist drop DOES> context ! ; + +: check-maxvp ( n -- ) + dup maxvp-limit > -49 and throw + dup maxvp > IF + BEGIN dup maxvp 2* dup TO maxvp <= UNTIL + vp maxvp 1+ cells resize throw TO vp + THEN drop ; + +: >order ( wid -- ) \ gforth to-order + \g Push @var{wid} on the search order. + vp @ 1+ dup check-maxvp vp! context ! ; + +: also ( -- ) \ search-ext + \G Like @code{DUP} for the search order. Usually used before a + \G vocabulary (e.g., @code{also Forth}); the combined effect is to push + \G the wordlist represented by the vocabulary on the search order. + context @ >order ; + +: previous ( -- ) \ search-ext + \G Drop the wordlist at the top of the search order. + vp @ 1- dup 0= -50 and throw vp! ; \ vocabulary find 14may93py : (vocfind) ( addr count wid -- nfa|false ) \ !! generalize this to be independent of vp - drop vp dup @ 1- cells over + - DO 2dup I 2@ over <> - IF (search-wordlist) dup - IF nip nip UNLOOP EXIT - THEN drop - ELSE drop 2drop THEN - [ -1 cells ] Literal +LOOP + drop 0 vp @ -DO ( addr count ) \ note that the loop does not reach 0 + 2dup vp i cells + @ (search-wordlist) dup if ( addr count nt ) + nip nip unloop exit then + drop 1 -loop 2drop false ; 0 value locals-wordlist @@ -88,85 +122,138 @@ Forth-wordlist AConstant Forth-wordlist \ this is the wordlist-map of the dictionary Create vocsearch ( -- wordlist-map ) -' (localsvocfind) A, ' (reveal) A, ' drop A, +' (localsvocfind) A, ' (reveal) A, ' drop A, ' drop A, + +\ create dummy wordlist for kernel +slowvoc on +vocsearch mappedwordlist \ the wordlist structure ( -- wid ) + +\ we don't want the dummy wordlist in our linked list +0 Voclink ! +slowvoc off \ Only root 14may93py -wordlist \ the wordlist structure -vocsearch over wordlist-map ! \ patch the map into it +Vocabulary Forth ( -- ) \ search-ext + \G Replace the @i{wid} at the top of the search order with the + \G @i{wid} associated with the word list @code{forth-wordlist}. + + +Vocabulary Root ( -- ) \ gforth + \G Add the root wordlist to the search order stack. This vocabulary + \G makes up the minimum search order and contains only a + \G search-order words. + +: Only ( -- ) \ search-ext + \G Set the search order to the implementation-defined minimum search + \G order (for Gforth, this is the word list @code{Root}). + 1 vp! Root also ; + +: update-image-order ( -- ) + \ save search order here, let vp point there + here vp over vp @ 1+ cells + dup allot move + to vp ; + +: init-vp ( -- ) + vp @ $10 max to maxvp + maxvp 1+ cells allocate throw + vp over vp @ 1+ cells move + TO vp ; + +:noname + init-vp DEFERS 'cold ; +IS 'cold -Vocabulary Forth -Vocabulary Root +here 0 , to vp -: Only vp off also Root also definitions ; +init-vp Only Forth also definitions \ set initial search order 14may93py -Forth-wordlist @ ' Forth >body ! +Forth-wordlist wordlist-id @ ' Forth >body wordlist-id ! -vp off also Root also definitions -Only Forth also definitions - -lookup ! \ our dictionary search order becomes the law +lookup ! \ our dictionary search order becomes the law ( -- ) ' Forth >body to Forth-wordlist \ "forth definitions get-current" and "forth-wordlist" should produce the same wid \ get-order set-order 14may93py -: get-order ( -- wid1 .. widn n ) - vp @ 0 ?DO vp cell+ I cells + @ LOOP vp @ ; - -: set-order ( wid1 .. widn n / -1 -- ) - dup -1 = IF drop Only exit THEN dup vp ! - ?dup IF 1- FOR vp cell+ I cells + ! NEXT THEN ; - -: seal ( -- ) context @ 1 set-order ; - -\ words visible in roots 14may93py - -: .name ( name -- ) \ gforth dot-name +: get-order ( -- widn .. wid1 n ) \ search + \G Copy the search order to the data stack. The current search order + \G has @i{n} entries, of which @i{wid1} represents the wordlist + \G that is searched first (the word list at the top of the search + \G order) and @i{widn} represents the wordlist that is searched + \G last. + vp @ 0 ?DO vp cell+ I cells + @ LOOP vp @ ; + +: set-order ( widn .. wid1 n -- ) \ search + \G If @var{n}=0, empty the search order. If @var{n}=-1, set the + \G search order to the implementation-defined minimum search order + \G (for Gforth, this is the word list @code{Root}). Otherwise, + \G replace the existing search order with the @var{n} wid entries + \G such that @var{wid1} represents the word list that will be + \G searched first and @var{widn} represents the word list that will + \G be searched last. + dup -1 = IF + drop only exit + THEN + dup check-maxvp + dup vp! + 0 swap -DO ( wid1 ... widi ) + vp i cells + ! \ note that the loop does not reach 0 + 1 -loop ; + +: seal ( -- ) \ gforth + \G Remove all word lists from the search order stack other than the word + \G list that is currently on the top of the search order stack. + context @ 1 set-order ; + +[IFUNDEF] .name +: id. ( nt -- ) \ gforth i-d-dot + \G Print the name of the word represented by @var{nt}. + \ this name comes from fig-Forth name>string type space ; -require termsize.fs +' id. alias .id ( nt -- ) \ F83 dot-i-d +\G F83 name for @code{id.}. -: words ( -- ) \ tools - cr 0 context @ - BEGIN - @ dup - WHILE - 2dup name>string nip 2 + dup >r + - cols >= - IF - cr nip 0 swap - THEN - dup .name space r> rot + swap - REPEAT - 2drop ; +' id. alias .name ( nt -- ) \ gforth-obsolete dot-name +\G Gforth <=0.5.0 name for @code{id.}. -' words alias vlist ( -- ) \ gforth -\g Old (pre-Forth-83) name for @code{WORDS}. +[THEN] -: body> ( data -- cfa ) 0 >body - ; +: .voc ( wid -- ) \ gforth dot-voc +\G print the name of the wordlist represented by @var{wid}. Can +\G only print names defined with @code{vocabulary} or +\G @code{wordlist constant}, otherwise prints @samp{???}. + dup >r wordlist-struct %size + dup head? if ( wid nt ) + dup name>int dup >code-address docon: = swap >body @ r@ = and if + id. rdrop exit + endif + endif + drop r> body> >head-noprim id. ; -: .voc - body> >name .name ; : order ( -- ) \ search-ext - \g prints the search order and the @code{current} wordlist. The - \g standard requires that the wordlists are printed in the order - \g in which they are searched. Therefore, the output is reversed - \g with respect to the conventional way of displaying stacks. The - \g @code{current} wordlist is displayed last. + \G Print the search order and the compilation word list. The + \G word lists are printed in the order in which they are searched + \G (which is reversed with respect to the conventional way of + \G displaying stacks). The compilation word list is displayed last. + \ The standard requires that the word lists are printed in the order + \ in which they are searched. Therefore, the output is reversed + \ with respect to the conventional way of displaying stacks. get-order 0 ?DO .voc LOOP 4 spaces get-current .voc ; + : vocs ( -- ) \ gforth - \g prints vocabularies and wordlists defined in the system. + \G List vocabularies and wordlists defined in the system. voclink BEGIN - @ dup @ + @ dup WHILE dup 0 wordlist-link - .voc REPEAT @@ -174,59 +261,16 @@ require termsize.fs Root definitions -' words Alias words -' Forth Alias Forth -' forth-wordlist alias forth-wordlist -' set-order alias set-order -' order alias order +' words Alias words ( -- ) \ tools +\G Display a list of all of the definitions in the word list at the top +\G of the search order. +' Forth Alias Forth \ alias- search-ext +' forth-wordlist alias forth-wordlist ( -- wid ) \ search + \G @code{Constant} -- @i{wid} identifies the word list that includes all of the standard words + \G provided by Gforth. When Gforth is invoked, this word list is the compilation word + \G list and is at the top of the search order. +' set-order alias set-order ( wid1 ... widu u -- ) \ alias- search +' order alias order ( -- ) \ alias- search-ext Forth definitions -include hash.fs - -\ table (case-sensitive wordlist) - -: table-find ( addr len wordlist -- nfa / false ) - >r 2dup r> bucket @ (tablefind) ; - -Create tablesearch-map ( -- wordlist-map ) - ' table-find A, ' hash-reveal A, ' (rehash) A, - -: table ( -- wid ) - \g create a case-sensitive wordlist - wordlist - tablesearch-map over wordlist-map ! ; - -\ marker 18dec94py - -\ Marker creates a mark that is removed (including everything -\ defined afterwards) when executing the mark. - -: marker, ( -- mark ) here dup A, - voclink @ A, voclink - BEGIN @ dup @ WHILE dup 0 wordlist-link - @ A, REPEAT drop - udp @ , ; - -: marker! ( mark -- ) - dup @ swap cell+ - dup @ voclink ! cell+ - voclink - BEGIN - @ dup @ - WHILE - over @ over 0 wordlist-link - ! - swap cell+ swap - REPEAT - drop voclink - BEGIN - @ dup @ - WHILE - dup 0 wordlist-link - rehash - REPEAT - drop - @ udp ! dp ! ; - -: marker ( "mark" -- ) - marker, Create A, -DOES> ( -- ) - @ marker! ;