Diff for /gforth/search.fs between versions 1.8 and 1.33

version 1.8, 1999/03/23 20:24:20 version 1.33, 2011/11/17 17:52:14
Line 1 Line 1
 \ search order wordset                                 14may93py  \ search order wordset                                 14may93py
   
 \ Copyright (C) 1995,1996,1997,1998 Free Software Foundation, Inc.  \ Copyright (C) 1995,1996,1997,1998,2000,2003,2005,2007 Free Software Foundation, Inc.
   
 \ This file is part of Gforth.  \ This file is part of Gforth.
   
 \ Gforth is free software; you can redistribute it and/or  \ Gforth is free software; you can redistribute it and/or
 \ modify it under the terms of the GNU General Public License  \ 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.  \ of the License, or (at your option) any later version.
   
 \ This program is distributed in the hope that it will be useful,  \ This program is distributed in the hope that it will be useful,
Line 15 Line 15
 \ GNU General Public License for more details.  \ GNU General Public License for more details.
   
 \ You should have received a copy of the GNU General Public License  \ You should have received a copy of the GNU General Public License
 \ along with this program; if not, write to the Free Software  \ along with this program. If not, see http://www.gnu.org/licenses/.
 \ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  
   
 $10 constant maxvp  require struct.fs
 Variable vp  
   0 A, 0 A,  0 A, 0 A,   0 A, 0 A,   0 A, 0 A,   $10 Value maxvp         \ current size of search order stack
   0 A, 0 A,  0 A, 0 A,   0 A, 0 A,   0 A, 0 A,   $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  : get-current  ( -- wid ) \ search
   \G @var{wid} is the identifier of the current compilation word list.    \G @i{wid} is the identifier of the current compilation word list.
   current @ ;    current @ ;
   
 : set-current  ( wid -- )  \ search  : set-current  ( wid -- )  \ search
   \G Set the compilation word list to the word list identified by @var{wid}.    \G Set the compilation word list to the word list identified by @i{wid}.
   current ! ;    current ! ;
   
 \ : context ( -- addr )  vp dup @ cells + ;  :noname ( -- addr )
 : vp! dup vp ! cells vp + to context ;      vp dup @ cells + ;
   is context
   
   : vp! ( u -- )
       vp ! ;
 : definitions  ( -- ) \ search  : definitions  ( -- ) \ search
   \G Make the compilation word list the same as the word list    \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 stack.    \G that is currently at the top of the search order.
   context @ current ! ;    context @ current ! ;
   
 \ wordlist Vocabulary also previous                    14may93py  \ wordlist Vocabulary also previous                    14may93py
Line 46  Variable slowvoc   0 slowvoc ! Line 52  Variable slowvoc   0 slowvoc !
   
 : mappedwordlist ( map-struct -- wid )  \ gforth  : mappedwordlist ( map-struct -- wid )  \ gforth
 \G Create a wordlist with a special map-structure.  \G Create a wordlist with a special map-structure.
   here swap A, 0 A, voclink @ A, 0 A,    align here swap A, 0 A, voclink @ A, 0 A,
   dup wordlist-link voclink !    dup wordlist-link voclink !
   dup initvoc ;    dup initvoc ;
   
 : wordlist  ( -- wid ) \ search  : wordlist  ( -- wid ) \ search
   \G Create a new, empty word list represented by @var{wid}.    \G Create a new, empty word list represented by @i{wid}.
   slowvoc @    slowvoc @
   IF    \ this is now f83search because hashing may be loaded already    IF    \ this is now f83search because hashing may be loaded already
         \ jaw          \ jaw
Line 61  Variable slowvoc   0 slowvoc ! Line 67  Variable slowvoc   0 slowvoc !
   
 : Vocabulary ( "name" -- ) \ gforth  : Vocabulary ( "name" -- ) \ gforth
   \G Create a definition "name" and associate a new word list with it.    \G Create a definition "name" and associate a new word list with it.
   \G The run-time effect of "name" is to push the new word list's wid    \G The run-time effect of "name" is to replace the @i{wid} at the
   \G onto the top of the search order stack.    \G top of the search order with the @i{wid} associated with the new
     \G word list.
   Create wordlist drop  DOES> context ! ;    Create wordlist drop  DOES> context ! ;
   
 : also  ( -- ) \ search ext  : check-maxvp ( n -- )
   \G Perform a @code{DUP} on the search order stack. Usually used prior     dup maxvp-limit > -49 and throw
   \G to @code{Forth}, @code{definitions} etc.     dup maxvp > IF
   context @ vp @ 1+ dup maxvp > abort" Vocstack full"        BEGIN  dup  maxvp 2* dup TO maxvp  <= UNTIL
   vp! context ! ;        vp  maxvp 1+ cells resize throw TO vp
      THEN drop ;
 : previous ( -- ) \ search ext  
   \G Perform a @code{DROP} on the search order stack, thereby removing the wid at the  : >order ( wid -- ) \ gforth to-order
   \G top of the (search order) stack from the search order.      \g Push @var{wid} on the search order.
   vp @ 1- dup 0= abort" Vocstack empty" vp! ;      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  \ vocabulary find                                      14may93py
   
 : (vocfind)  ( addr count wid -- nfa|false )  : (vocfind)  ( addr count wid -- nfa|false )
     \ !! generalize this to be independent of vp      \ !! generalize this to be independent of vp
     drop vp dup @ 1- cells over +      drop 0 vp @ -DO ( addr count ) \ note that the loop does not reach 0
     DO  2dup I 2@ over <>          2dup vp i cells + @ (search-wordlist) dup if ( addr count nt )
         IF  (search-wordlist) dup              nip nip unloop exit then
             IF  nip nip  UNLOOP EXIT      drop 1 -loop
             THEN  drop  
         ELSE  drop 2drop  THEN  
     [ -1 cells ] Literal +LOOP  
     2drop false ;      2drop false ;
   
 0 value locals-wordlist  0 value locals-wordlist
Line 120  slowvoc off Line 134  slowvoc off
   
 \ Only root                                            14may93py  \ Only root                                            14may93py
   
 Vocabulary Forth  Vocabulary Forth ( -- ) \ search-ext
   \G ** this will not get annotated. See other defn below.. **    \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  Vocabulary Root ( -- ) \ gforth
   \G Add the vocabulary @code{Root} to the search order stack.    \G Add the root wordlist to the search order stack.  This vocabulary
   \G This vocabulary makes up the minimum search order and    \G makes up the minimum search order and contains only a
   \G contains these words: @code{order} @code{set-order}    \G search-order words.
   \G @code{forth-wordlist} @code{Forth} @code{words}  
   
 : Only ( -- ) \ search ext  : Only ( -- ) \ search-ext
   \G Set the search order to the implementation-defined minimum search    \G Set the search order to the implementation-defined minimum search
   \G order (for Gforth, this is the word list @code{Root}).    \G order (for Gforth, this is the word list @code{Root}).
   1 vp! Root also ;    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
   
   here 0 , to vp
   
   init-vp Only Forth also definitions
   
 \ set initial search order                             14may93py  \ set initial search order                             14may93py
   
 Forth-wordlist wordlist-id @ ' Forth >body wordlist-id !  Forth-wordlist wordlist-id @ ' Forth >body wordlist-id !
   
 0 vp! 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  ' Forth >body to Forth-wordlist \ "forth definitions get-current" and "forth-wordlist" should produce the same wid
Line 147  lookup ! \ our dictionary search order b Line 181  lookup ! \ our dictionary search order b
 \ get-order set-order                                  14may93py  \ get-order set-order                                  14may93py
   
 : get-order  ( -- widn .. wid1 n ) \ search  : get-order  ( -- widn .. wid1 n ) \ search
   \G Copy the search order stack to the data stack. The current search    \G Copy the search order to the data stack. The current search order
   \G order has @var{n} entries, of which @var{wid1} represents the word    \G has @i{n} entries, of which @i{wid1} represents the wordlist
   \G list that is searched first (the word list at the top of the stack) and    \G that is searched first (the word list at the top of the search
   \G @var{widn} represents the word order that is searched last.    \G order) and @i{widn} represents the wordlist that is searched
   vp @ 0 ?DO  vp cell+ I cells + @  LOOP  vp @ ;    \G last.
     vp @ 0 ?DO vp cell+ I cells + @ LOOP vp @ ;
   
 : set-order  ( widn .. wid1 n -- ) \ search  : set-order  ( widn .. wid1 n -- ) \ search
   \G ** this will not get annotated. See other defn below.. **      \G If @var{n}=0, empty the search order.  If @var{n}=-1, set the
   \G If n=0, empty the search order.      \G search order to the implementation-defined minimum search order
   \G If n=-1, set the search order to the implementation-defined minimum search      \G (for Gforth, this is the word list @code{Root}). Otherwise,
   \G order (for Gforth, this is the word list Root). Otherwise, replace the      \G replace the existing search order with the @var{n} wid entries
   \G existing search order with the n wid entries such that wid1 represents the      \G such that @var{wid1} represents the word list that will be
   \G word list that will be searched first and widn represents the word list that      \G searched first and @var{widn} represents the word list that will
   \G will be searched last.      \G be searched last.
   dup -1 = IF  drop Only exit  THEN  dup vp!      dup -1 = IF
   ?dup IF  1- FOR  vp cell+ I cells + !  NEXT  THEN ;          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  : seal ( -- ) \ gforth
   \G Remove all word lists from the search order stack other than the word    \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.    \G list that is currently on the top of the search order stack.
   context @ 1 set-order ;    context @ 1 set-order ;
   
 : .voc  [IFUNDEF] .name
     body> >head name>string type space ;  : 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 ;
   
   ' id. alias .id ( nt -- ) \ F83  dot-i-d
   \G F83 name for @code{id.}.
   
   ' id. alias .name ( nt -- ) \ gforth-obsolete  dot-name
   \G Gforth <=0.5.0 name for @code{id.}.
   
   [THEN]
   
   : .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? true = 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. ;
   
 : order ( -- )  \  search-ext  : order ( -- )  \  search-ext
     \G ** this will not get annotated. See other defn below.. **    \G Print the search order and the compilation word list.  The
     \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 word lists are printed in the order in which they are searched.    \G (which is reversed with respect to the conventional way of
     \G (which is reversed with respect to the conventional way of    \G displaying stacks). The compilation word list is displayed last.
     \G displaying stacks). The compilation word list is displayed last.    \ The standard requires that the word lists are printed in the order
     \ The standard requires that the word lists are printed in the order    \ in which they are searched. Therefore, the output is reversed
     \ in which they are searched. Therefore, the output is reversed    \ with respect to the conventional way of displaying stacks.
     \ with respect to the conventional way of displaying stacks.  
     get-order 0      get-order 0
     ?DO      ?DO
         .voc          .voc
Line 199  lookup ! \ our dictionary search order b Line 261  lookup ! \ our dictionary search order b
   
 Root definitions  Root definitions
   
 ' words Alias words ( -- ) \ tools  ' words Alias words  ( -- ) \ tools
   \G Display a list of all of the definitions in the word list at the top  \G Display a list of all of the definitions in the word list at the top
   \G of the search order.  \G of the search order.
 ' Forth Alias Forth ( -- ) \ search-ext  ' Forth Alias Forth \ alias- search-ext
   \G Push the @var{wid} associated with @code{forth-wordlist} onto the search order stack.  
 ' forth-wordlist alias forth-wordlist ( -- wid ) \ search  ' forth-wordlist alias forth-wordlist ( -- wid ) \ search
   \G CONSTANT: @var{wid} identifies the word list that includes all of the standard words    \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 provided by Gforth. When Gforth is invoked, this word list is the compilation word
   \G list and is at the top of the word list stack.    \G list and is at the top of the search order.
 ' set-order alias set-order ( widn .. wid1 n -- ) \ search  ' set-order alias set-order ( wid1 ... widu u -- ) \ alias- search
   \G If @var{n}=0, empty the search order.  ' order alias order ( -- ) \ alias- search-ext
   \G If @var{n}=-1, set the search order to the implementation-defined minimum search  
   \G order (for Gforth, this is the word list @code{Root}). Otherwise, replace the  
   \G existing search order with the @var{n} wid entries such that @var{wid1} represents the  
   \G word list that will be searched first and @var{widn} represents the word list that  
   \G will be searched last.  
 ' order alias order ( -- ) \ search-ext  
   \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.  
   
 Forth definitions  Forth definitions
   

Removed from v.1.8  
changed lines
  Added in v.1.33


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