1 ! Copyright (C) 2004, 2010 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: accessors arrays assocs definitions hashtables kernel
4 kernel.private math math.order namespaces quotations sequences
5 slots.private strings vocabs ;
6 FROM: assocs => change-at ;
9 : word ( -- word ) \ word get-global ;
11 : set-word ( word -- ) \ word set-global ;
13 M: word execute (execute) ;
15 M: word ?execute execute( -- value ) ; inline
18 [ [ name>> ] [ vocabulary>> ] bi 2array ] compare ;
20 M: word definer drop \ : \ ; ;
22 M: word definition def>> ;
24 : word-prop ( word name -- value ) swap props>> at ;
26 : remove-word-prop ( word name -- ) swap props>> delete-at ;
28 : set-word-prop ( word value name -- )
30 [ pick props>> ?set-at >>props drop ]
31 [ nip remove-word-prop ] if ;
33 : change-word-prop ( ..a word prop quot: ( ..a value -- ..b newvalue ) -- ..b )
34 [ swap props>> ] dip change-at ; inline
36 : reset-props ( word seq -- ) [ remove-word-prop ] with each ;
40 : caller ( callstack -- word ) callstack>array <reversed> third ;
44 TUPLE: undefined word ;
45 : undefined ( -- * ) callstack caller \ undefined boa throw ;
47 : undefined-def ( -- quot )
48 #! 'f' inhibits tail call optimization in non-optimizing
49 #! compiler, ensuring that we can pull out the caller word
53 PREDICATE: deferred < word def>> undefined-def = ;
54 M: deferred definer drop \ DEFER: f ;
55 M: deferred definition drop f ;
57 PREDICATE: primitive < word "primitive" word-prop ;
58 M: primitive definer drop \ PRIMITIVE: f ;
59 M: primitive definition drop f ;
61 : lookup-word ( name vocab -- word ) vocab-words at ;
63 : target-word ( word -- target )
64 [ name>> ] [ vocabulary>> ] bi lookup-word ;
66 SYMBOL: bootstrapping?
68 : if-bootstrapping ( true false -- )
69 [ bootstrapping? get ] 2dip if ; inline
71 : bootstrap-word ( word -- target )
72 [ target-word ] [ ] if-bootstrapping ;
74 GENERIC: crossref? ( word -- ? )
77 dup "forgotten" word-prop [ drop f ] [ vocabulary>> >boolean ] if ;
79 GENERIC: subwords ( word -- seq )
81 M: word subwords drop f ;
83 GENERIC: parent-word ( word -- word/f )
85 M: word parent-word drop f ;
87 : define ( word def -- )
88 over changed-definition [ ] like >>def drop ;
90 : changed-effect ( word -- )
91 [ dup changed-effects get set-in-unit ]
92 [ dup primitive? [ drop ] [ changed-definition ] if ] bi ;
94 : set-stack-effect ( effect word -- )
95 2dup "declared-effect" word-prop = [ 2drop ] [
96 [ nip changed-effect ]
97 [ nip subwords [ changed-effect ] each ]
98 [ swap "declared-effect" set-word-prop ]
102 : define-declared ( word def effect -- )
103 [ nip swap set-stack-effect ] [ drop define ] 3bi ;
105 : make-deprecated ( word -- )
106 t "deprecated" set-word-prop ;
108 : inline? ( word -- ? ) "inline" word-prop ; inline
110 : inline-recursive? ( word -- ? )
111 dup "inline" word-prop
112 [ "recursive" word-prop ] [ drop f ] if ; inline
114 ERROR: cannot-be-inline word ;
116 GENERIC: make-inline ( word -- )
119 dup inline? [ drop ] [
120 [ t "inline" set-word-prop ]
125 : define-inline ( word def effect -- )
126 [ define-declared ] [ 2drop make-inline ] 3bi ;
128 : make-recursive ( word -- )
129 t "recursive" set-word-prop ;
131 GENERIC: flushable? ( word -- ? )
134 [ "flushable" word-prop ]
135 [ parent-word dup [ flushable? ] when ] bi or ;
137 : make-flushable ( word -- )
138 t "flushable" set-word-prop ;
140 GENERIC: foldable? ( word -- ? )
143 [ "foldable" word-prop ]
144 [ parent-word dup [ foldable? ] when ] bi or ;
146 : make-foldable ( word -- )
147 dup make-flushable t "foldable" set-word-prop ;
149 GENERIC: reset-word ( word -- )
152 dup flushable? [ dup changed-conditionally ] when
154 "unannotated-def" "parsing" "inline" "recursive"
155 "foldable" "flushable" "reading" "writing" "reader"
156 "writer" "delimiter" "deprecated"
159 : reset-generic ( word -- )
160 [ subwords forget-all ]
174 : <word> ( name vocab -- word )
175 2dup 0 hash-combine hash-combine >fixnum (word) dup new-word ;
177 : <uninterned-word> ( name -- word )
178 f \ <uninterned-word> counter >fixnum (word)
179 new-words get [ dup new-word ] when ;
182 "( gensym )" <uninterned-word> ;
184 : define-temp ( quot effect -- word )
185 [ gensym dup ] 2dip define-declared ;
188 dup [ name>> ] [ vocabulary>> ] bi dup vocab-words
192 ERROR: bad-create name vocab ;
194 : check-create ( name vocab -- name vocab )
195 2dup [ string? ] [ [ string? ] [ vocab? ] bi or ] bi* and
196 [ bad-create ] unless ;
198 : create ( name vocab -- word )
199 check-create 2dup lookup-word
204 dup changed-definition
207 : constructor-word ( name vocab -- word )
208 [ "<" ">" surround ] dip create ;
210 PREDICATE: parsing-word < word "parsing" word-prop ;
212 M: parsing-word definer drop \ SYNTAX: \ ; ;
214 : define-syntax ( word quot -- )
215 [ drop ] [ define ] 2bi t "parsing" set-word-prop ;
217 : delimiter? ( obj -- ? )
218 dup word? [ "delimiter" word-prop ] [ drop f ] if ;
220 : deprecated? ( obj -- ? )
221 dup word? [ "deprecated" word-prop ] [ drop f ] if ;
223 ! Definition protocol
224 M: word where "loc" word-prop ;
226 M: word set-where swap "loc" set-word-prop ;
229 dup "forgotten" word-prop [ drop ] [
230 [ subwords forget-all ]
231 [ [ name>> ] [ vocabulary>> vocab-words ] bi delete-at ]
232 [ t "forgotten" set-word-prop ]
237 nip 1 slot { fixnum } declare ; inline foldable
239 M: word literalize <wrapper> ;
241 INSTANCE: word definition