Annotation of gforth/search.fs, revision 1.32
1.1 anton 1: \ search order wordset 14may93py
2:
1.31 anton 3: \ Copyright (C) 1995,1996,1997,1998,2000,2003,2005,2007 Free Software Foundation, Inc.
1.1 anton 4:
5: \ This file is part of Gforth.
6:
7: \ Gforth is free software; you can redistribute it and/or
8: \ modify it under the terms of the GNU General Public License
1.32 ! anton 9: \ as published by the Free Software Foundation, either version 3
1.1 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.32 ! anton 18: \ along with this program. If not, see http://www.gnu.org/licenses/.
1.1 anton 19:
1.24 anton 20: require struct.fs
21:
1.20 pazsan 22: $10 Value maxvp \ current size of search order stack
23: $400 Value maxvp-limit \ upper limit for resizing search order stack
24: 0 AValue vp \ will be initialized later (dynamic)
1.30 anton 25: \ the first cell at vp contains the search order depth, the others
26: \ contain the wordlists, starting with the last-searched one.
1.1 anton 27:
1.7 crook 28: : get-current ( -- wid ) \ search
1.12 crook 29: \G @i{wid} is the identifier of the current compilation word list.
1.7 crook 30: current @ ;
31:
32: : set-current ( wid -- ) \ search
1.12 crook 33: \G Set the compilation word list to the word list identified by @i{wid}.
1.7 crook 34: current ! ;
1.1 anton 35:
1.11 anton 36: :noname ( -- addr )
37: vp dup @ cells + ;
38: is context
39:
40: : vp! ( u -- )
41: vp ! ;
1.7 crook 42: : definitions ( -- ) \ search
1.13 crook 43: \G Set the compilation word list to be the same as the word list
44: \G that is currently at the top of the search order.
1.7 crook 45: context @ current ! ;
1.1 anton 46:
47: \ wordlist Vocabulary also previous 14may93py
48:
1.2 jwilke 49: Variable slowvoc 0 slowvoc !
1.1 anton 50:
1.2 jwilke 51: \ Forth-wordlist AConstant Forth-wordlist
1.1 anton 52:
1.2 jwilke 53: : mappedwordlist ( map-struct -- wid ) \ gforth
1.7 crook 54: \G Create a wordlist with a special map-structure.
1.28 anton 55: align here swap A, 0 A, voclink @ A, 0 A,
1.2 jwilke 56: dup wordlist-link voclink !
57: dup initvoc ;
1.1 anton 58:
1.7 crook 59: : wordlist ( -- wid ) \ search
1.12 crook 60: \G Create a new, empty word list represented by @i{wid}.
1.1 anton 61: slowvoc @
1.2 jwilke 62: IF \ this is now f83search because hashing may be loaded already
63: \ jaw
64: f83search
1.1 anton 65: ELSE Forth-wordlist wordlist-map @ THEN
1.2 jwilke 66: mappedwordlist ;
1.1 anton 67:
1.7 crook 68: : Vocabulary ( "name" -- ) \ gforth
69: \G Create a definition "name" and associate a new word list with it.
1.13 crook 70: \G The run-time effect of "name" is to replace the @i{wid} at the
71: \G top of the search order with the @i{wid} associated with the new
72: \G word list.
1.7 crook 73: Create wordlist drop DOES> context ! ;
74:
1.10 anton 75: : check-maxvp ( n -- )
1.19 dvdkhlng 76: dup maxvp-limit > -49 and throw
77: dup maxvp > IF
1.20 pazsan 78: BEGIN dup maxvp 2* dup TO maxvp <= UNTIL
1.19 dvdkhlng 79: vp maxvp 1+ cells resize throw TO vp
80: THEN drop ;
81:
1.16 anton 82: : >order ( wid -- ) \ gforth to-order
1.10 anton 83: \g Push @var{wid} on the search order.
84: vp @ 1+ dup check-maxvp vp! context ! ;
85:
1.13 crook 86: : also ( -- ) \ search-ext
1.15 anton 87: \G Like @code{DUP} for the search order. Usually used before a
88: \G vocabulary (e.g., @code{also Forth}); the combined effect is to push
89: \G the wordlist represented by the vocabulary on the search order.
1.16 anton 90: context @ >order ;
1.1 anton 91:
1.13 crook 92: : previous ( -- ) \ search-ext
1.15 anton 93: \G Drop the wordlist at the top of the search order.
1.10 anton 94: vp @ 1- dup 0= -50 and throw vp! ;
1.1 anton 95:
96: \ vocabulary find 14may93py
97:
98: : (vocfind) ( addr count wid -- nfa|false )
99: \ !! generalize this to be independent of vp
1.30 anton 100: drop 0 vp @ -DO ( addr count ) \ note that the loop does not reach 0
101: 2dup vp i cells + @ (search-wordlist) dup if ( addr count nt )
102: nip nip unloop exit then
103: drop 1 -loop
1.1 anton 104: 2drop false ;
105:
106: 0 value locals-wordlist
107:
108: : (localsvocfind) ( addr count wid -- nfa|false )
109: \ !! use generalized (vocfind)
110: drop locals-wordlist
111: IF 2dup locals-wordlist (search-wordlist) dup
112: IF nip nip
113: EXIT
114: THEN drop
115: THEN
116: 0 (vocfind) ;
117:
118: \ In the kernel the dictionary search works on only one wordlist.
119: \ The following stuff builds a thing that looks to the kernel like one
120: \ wordlist, but when searched it searches the whole search order
121: \ (including locals)
122:
123: \ this is the wordlist-map of the dictionary
124: Create vocsearch ( -- wordlist-map )
1.2 jwilke 125: ' (localsvocfind) A, ' (reveal) A, ' drop A, ' drop A,
126:
127: \ create dummy wordlist for kernel
128: slowvoc on
129: vocsearch mappedwordlist \ the wordlist structure ( -- wid )
130:
131: \ we don't want the dummy wordlist in our linked list
132: 0 Voclink !
133: slowvoc off
1.1 anton 134:
135: \ Only root 14may93py
136:
1.29 anton 137: Vocabulary Forth ( -- ) \ search-ext
1.13 crook 138: \G Replace the @i{wid} at the top of the search order with the
139: \G @i{wid} associated with the word list @code{forth-wordlist}.
140:
1.9 crook 141:
1.7 crook 142: Vocabulary Root ( -- ) \ gforth
1.15 anton 143: \G Add the root wordlist to the search order stack. This vocabulary
144: \G makes up the minimum search order and contains only a
145: \G search-order words.
1.7 crook 146:
1.9 crook 147: : Only ( -- ) \ search-ext
1.7 crook 148: \G Set the search order to the implementation-defined minimum search
1.8 crook 149: \G order (for Gforth, this is the word list @code{Root}).
1.7 crook 150: 1 vp! Root also ;
1.1 anton 151:
1.23 anton 152: : update-image-order ( -- )
153: \ save search order here, let vp point there
154: here vp over vp @ 1+ cells
155: dup allot move
156: to vp ;
157:
1.20 pazsan 158: : init-vp ( -- )
1.23 anton 159: vp @ $10 max to maxvp
160: maxvp 1+ cells allocate throw
161: vp over vp @ 1+ cells move
162: TO vp ;
1.20 pazsan 163:
164: :noname
165: init-vp DEFERS 'cold ;
166: IS 'cold
167:
1.23 anton 168: here 0 , to vp
169:
170: init-vp Only Forth also definitions
1.20 pazsan 171:
1.1 anton 172: \ set initial search order 14may93py
173:
1.5 pazsan 174: Forth-wordlist wordlist-id @ ' Forth >body wordlist-id !
1.1 anton 175:
1.2 jwilke 176: lookup ! \ our dictionary search order becomes the law ( -- )
1.1 anton 177:
178: ' Forth >body to Forth-wordlist \ "forth definitions get-current" and "forth-wordlist" should produce the same wid
179:
180:
181: \ get-order set-order 14may93py
182:
1.7 crook 183: : get-order ( -- widn .. wid1 n ) \ search
1.13 crook 184: \G Copy the search order to the data stack. The current search order
1.15 anton 185: \G has @i{n} entries, of which @i{wid1} represents the wordlist
1.13 crook 186: \G that is searched first (the word list at the top of the search
1.15 anton 187: \G order) and @i{widn} represents the wordlist that is searched
1.13 crook 188: \G last.
189: vp @ 0 ?DO vp cell+ I cells + @ LOOP vp @ ;
1.1 anton 190:
1.29 anton 191: : set-order ( widn .. wid1 n -- ) \ search
1.10 anton 192: \G If @var{n}=0, empty the search order. If @var{n}=-1, set the
193: \G search order to the implementation-defined minimum search order
194: \G (for Gforth, this is the word list @code{Root}). Otherwise,
195: \G replace the existing search order with the @var{n} wid entries
196: \G such that @var{wid1} represents the word list that will be
197: \G searched first and @var{widn} represents the word list that will
198: \G be searched last.
199: dup -1 = IF
200: drop only exit
201: THEN
202: dup check-maxvp
203: dup vp!
1.30 anton 204: 0 swap -DO ( wid1 ... widi )
205: vp i cells + ! \ note that the loop does not reach 0
206: 1 -loop ;
1.1 anton 207:
1.7 crook 208: : seal ( -- ) \ gforth
209: \G Remove all word lists from the search order stack other than the word
210: \G list that is currently on the top of the search order stack.
211: context @ 1 set-order ;
1.1 anton 212:
1.24 anton 213: [IFUNDEF] .name
1.26 anton 214: : id. ( nt -- ) \ gforth i-d-dot
1.24 anton 215: \G Print the name of the word represented by @var{nt}.
216: \ this name comes from fig-Forth
217: name>string type space ;
218:
1.26 anton 219: ' id. alias .id ( nt -- ) \ F83 dot-i-d
1.24 anton 220: \G F83 name for @code{id.}.
221:
1.26 anton 222: ' id. alias .name ( nt -- ) \ gforth-obsolete dot-name
1.24 anton 223: \G Gforth <=0.5.0 name for @code{id.}.
224:
225: [THEN]
226:
1.26 anton 227: : .voc ( wid -- ) \ gforth dot-voc
1.24 anton 228: \G print the name of the wordlist represented by @var{wid}. Can
229: \G only print names defined with @code{vocabulary} or
230: \G @code{wordlist constant}, otherwise prints @samp{???}.
231: dup >r wordlist-struct %size + dup head? if ( wid nt )
232: dup name>int dup >code-address docon: = swap >body @ r@ = and if
233: id. rdrop exit
234: endif
235: endif
236: drop r> body> >head-noprim id. ;
1.1 anton 237:
1.29 anton 238: : order ( -- ) \ search-ext
1.9 crook 239: \G Print the search order and the compilation word list. The
240: \G word lists are printed in the order in which they are searched
241: \G (which is reversed with respect to the conventional way of
242: \G displaying stacks). The compilation word list is displayed last.
243: \ The standard requires that the word lists are printed in the order
244: \ in which they are searched. Therefore, the output is reversed
245: \ with respect to the conventional way of displaying stacks.
1.1 anton 246: get-order 0
247: ?DO
248: .voc
249: LOOP
250: 4 spaces get-current .voc ;
1.2 jwilke 251:
1.1 anton 252: : vocs ( -- ) \ gforth
1.7 crook 253: \G List vocabularies and wordlists defined in the system.
1.1 anton 254: voclink
255: BEGIN
1.2 jwilke 256: @ dup
1.1 anton 257: WHILE
258: dup 0 wordlist-link - .voc
259: REPEAT
260: drop ;
261:
262: Root definitions
263:
1.9 crook 264: ' words Alias words ( -- ) \ tools
265: \G Display a list of all of the definitions in the word list at the top
266: \G of the search order.
1.29 anton 267: ' Forth Alias Forth \ alias- search-ext
1.7 crook 268: ' forth-wordlist alias forth-wordlist ( -- wid ) \ search
1.12 crook 269: \G @code{Constant} -- @i{wid} identifies the word list that includes all of the standard words
1.7 crook 270: \G provided by Gforth. When Gforth is invoked, this word list is the compilation word
1.13 crook 271: \G list and is at the top of the search order.
1.29 anton 272: ' set-order alias set-order ( wid1 ... widu u -- ) \ alias- search
273: ' order alias order ( -- ) \ alias- search-ext
1.1 anton 274:
275: Forth definitions
276:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to search.fs CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [gforth] / gforth