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 ;
10 { hashcode fixnum initial: 0 } name vocabulary
11 { def quotation initial: [ ] } props pic-def pic-tail-def
12 { sub-primitive read-only } ;
14 ! Need a dummy word here because BUILTIN: word is not a real word
15 ! and parse-datum looks for things that are actually words instead of
16 ! also looking for classes
17 : word ( -- * ) "dummy word" throw ;
19 : last-word ( -- word ) \ last-word get-global ;
21 : set-last-word ( word -- ) \ last-word set-global ;
23 M: word execute (execute) ;
26 [ [ name>> ] [ vocabulary>> ] bi 2array ] compare ;
28 M: word definer drop \ : \ ; ;
30 M: word definition def>> ;
32 : word-prop ( word name -- value ) swap props>> at ;
34 : remove-word-prop ( word name -- ) swap props>> delete-at ;
36 : remove-word-props ( word seq -- )
37 swap props>> [ delete-at ] curry each ;
39 : set-word-prop ( word value name -- )
41 [ pick props>> ?set-at >>props drop ]
42 [ nip remove-word-prop ] if ;
44 : change-word-prop ( ..a word prop quot: ( ..a value -- ..b newvalue ) -- ..b )
45 [ swap props>> ] dip change-at ; inline
49 : caller ( callstack -- word ) callstack>array <reversed> third ;
53 TUPLE: undefined-word word ;
55 : undefined ( -- * ) callstack caller undefined-word boa throw ;
57 : undefined-def ( -- quot )
58 #! 'f' inhibits tail call optimization in non-optimizing
59 #! compiler, ensuring that we can pull out the caller word
63 PREDICATE: deferred < word def>> undefined-def = ;
64 M: deferred definer drop \ DEFER: f ;
65 M: deferred definition drop f ;
67 PREDICATE: primitive < word "primitive" word-prop ;
68 M: primitive definer drop \ PRIMITIVE: f ;
69 M: primitive definition drop f ;
71 : lookup-word ( name vocab -- word ) vocab-words-assoc at ;
73 : target-word ( word -- target )
74 [ name>> ] [ vocabulary>> ] bi lookup-word ;
76 SYMBOL: bootstrapping?
78 : if-bootstrapping ( true false -- )
79 [ bootstrapping? get ] 2dip if ; inline
81 : bootstrap-word ( word -- target )
82 [ target-word ] [ ] if-bootstrapping ;
84 GENERIC: crossref? ( word -- ? )
87 dup "forgotten" word-prop [ drop f ] [ vocabulary>> >boolean ] if ;
89 GENERIC: subwords ( word -- seq )
91 M: word subwords drop f ;
93 GENERIC: parent-word ( word -- word/f )
95 M: word parent-word drop f ;
97 : define ( word def -- )
98 over changed-definition [ ] like >>def drop ;
100 : changed-effect ( word -- )
101 [ changed-effects get add-to-unit ]
102 [ dup primitive? [ drop ] [ changed-definition ] if ] bi ;
104 : set-stack-effect ( effect word -- )
105 2dup "declared-effect" word-prop = [ 2drop ] [
106 [ nip changed-effect ]
107 [ nip subwords [ changed-effect ] each ]
108 [ swap "declared-effect" set-word-prop ]
112 : define-declared ( word def effect -- )
113 [ nip swap set-stack-effect ] [ drop define ] 3bi ;
115 : make-deprecated ( word -- )
116 t "deprecated" set-word-prop ;
118 : inline? ( obj -- ? )
119 dup word? [ "inline" word-prop ] [ drop f ] if ; inline
121 : recursive? ( obj -- ? )
122 dup word? [ "recursive" word-prop ] [ drop f ] if ; inline
124 : inline-recursive? ( obj -- ? )
126 dup "inline" word-prop
127 [ "recursive" word-prop ] [ drop f ] if
128 ] [ drop f ] if ; inline
130 ERROR: cannot-be-inline word ;
132 GENERIC: make-inline ( word -- )
135 dup inline? [ drop ] [
136 [ t "inline" set-word-prop ]
141 : define-inline ( word def effect -- )
142 [ define-declared ] [ 2drop make-inline ] 3bi ;
144 : make-recursive ( word -- )
145 t "recursive" set-word-prop ;
147 GENERIC: flushable? ( word -- ? )
150 [ "flushable" word-prop ]
151 [ parent-word dup [ flushable? ] when ] bi or ;
153 : make-flushable ( word -- )
154 t "flushable" set-word-prop ;
156 GENERIC: foldable? ( word -- ? )
159 [ "foldable" word-prop ]
160 [ parent-word dup [ foldable? ] when ] bi or ;
162 : make-foldable ( word -- )
163 dup make-flushable t "foldable" set-word-prop ;
165 GENERIC: reset-word ( word -- )
168 dup flushable? [ dup changed-conditionally ] when
170 "unannotated-def" "parsing" "inline" "recursive"
171 "foldable" "flushable" "reading" "writing" "reader"
172 "writer" "delimiter" "deprecated"
173 } remove-word-props ;
175 : reset-generic ( word -- )
176 [ subwords forget-all ]
190 : <word> ( name vocab -- word )
191 2dup [ hashcode ] bi@ hash-combine >fixnum (word) dup new-word ;
193 : <uninterned-word> ( name -- word )
194 f \ <uninterned-word> counter >fixnum (word)
195 new-words get [ dup new-word ] when ;
198 "( gensym )" <uninterned-word> ;
200 : define-temp ( quot effect -- word )
201 [ gensym dup ] 2dip define-declared ;
204 dup [ name>> ] [ vocabulary>> ] bi dup vocab-words-assoc
205 [ ] [ no-vocab ] ?if set-at ;
207 ERROR: bad-create name vocab ;
209 : check-create ( name vocab -- name vocab )
210 2dup [ string? ] [ [ string? ] [ vocab? ] bi or ] bi* and
211 [ bad-create ] unless ;
213 : create-word ( name vocab -- word )
214 check-create 2dup lookup-word
218 dup changed-definition
221 : constructor-word ( name vocab -- word )
222 [ "<" ">" surround ] dip create-word ;
224 PREDICATE: parsing-word < word "parsing" word-prop ;
226 M: parsing-word definer drop \ SYNTAX: \ ; ;
228 : define-syntax ( word quot -- )
229 [ drop ] [ define ] 2bi t "parsing" set-word-prop ;
231 : delimiter? ( obj -- ? )
232 dup word? [ "delimiter" word-prop ] [ drop f ] if ;
234 : deprecated? ( obj -- ? )
235 dup word? [ "deprecated" word-prop ] [ drop f ] if ;
237 ! Definition protocol
238 M: word where "loc" word-prop ;
240 M: word set-where swap "loc" set-word-prop ;
243 dup "forgotten" word-prop [ drop ] [
244 [ subwords forget-all ]
245 [ [ name>> ] [ vocabulary>> vocab-words-assoc ] bi delete-at ]
246 [ t "forgotten" set-word-prop ]
251 nip 1 slot { fixnum } declare ; inline foldable
253 M: word literalize <wrapper> ;
255 INSTANCE: word definition-mixin