1 ! Copyright (C) 2005, 2010 Slava Pestov.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: accessors arrays assocs classes classes.algebra
4 classes.algebra.private classes.builtin classes.private
5 combinators definitions effects generic kernel kernel.private
6 make math math.private memory namespaces quotations
7 sequences sequences.private slots slots.private strings words ;
11 PRIMITIVE: <tuple> ( layout -- tuple )
12 PRIMITIVE: <tuple-boa> ( slots... layout -- tuple )
15 PREDICATE: tuple-class < class
16 "metaclass" word-prop tuple-class eq? ;
18 ERROR: too-many-slots class slots got max ;
20 : all-slots ( class -- slots )
21 superclasses-of [ "slots" word-prop ] map concat ;
23 ERROR: no-slot name tuple ;
25 : ?offset-of-slot ( name tuple -- n/f )
26 class-of all-slots slot-named [ offset>> ] [ f ] if* ;
28 : offset-of-slot ( name tuple -- n )
29 2dup ?offset-of-slot [ 2nip ] [ no-slot ] if* ;
31 : get-slot-named ( name tuple -- value )
32 [ nip ] [ offset-of-slot ] 2bi slot ;
34 : set-slot-named ( value name tuple -- )
35 [ nip ] [ offset-of-slot ] 2bi set-slot ;
37 : set-slots ( assoc tuple -- )
38 [ swapd set-slot-named ] curry assoc-each ; inline
40 : from-slots ( assoc class -- tuple )
41 new [ set-slots ] keep ; inline
43 PREDICATE: immutable-tuple-class < tuple-class
44 all-slots [ read-only>> ] all? ;
48 : tuple-layout ( class -- layout )
51 : layout-of ( tuple -- layout )
52 1 slot { array } declare ; inline
54 M: tuple class-of layout-of 2 slot { word } declare ; inline
56 : tuple-size ( tuple -- size )
57 layout-of 3 slot { fixnum } declare ; inline
59 : layout-up-to-date? ( object -- ? )
61 [ layout-of ] [ class-of tuple-layout ] bi eq?
64 : prepare-tuple-slots ( tuple -- n tuple )
65 tuple check-instance [ tuple-size <iota> ] keep ;
67 : copy-tuple-slots ( n tuple -- array )
68 [ array-nth ] curry map ;
70 : check-slots ( seq class -- seq class )
73 class>> 2dup instance?
74 [ 2drop ] [ bad-slot-value ] if
76 ] if-bootstrapping ; inline
78 : initial-values ( class -- seq )
79 all-slots [ initial>> ] map ; inline
81 : pad-slots ( seq class -- seq' class )
82 [ initial-values ] keep
83 2over [ length ] bi@ 2dup > [
84 [ nip swap ] 2dip too-many-slots
86 drop [ tail append ] curry dip
91 : tuple-slots ( tuple -- seq )
92 prepare-tuple-slots copy-tuple-slots ;
94 GENERIC: slots>tuple ( seq class -- tuple )
96 M: tuple-class slots>tuple ( seq class -- tuple )
98 tuple-layout <tuple> [
100 [ [ set-array-nth ] curry ]
104 : tuple>array ( tuple -- array )
105 [ tuple-slots ] [ class-of prefix ] bi ;
107 : >tuple ( seq -- tuple )
110 ERROR: bad-superclass class ;
112 : tuple= ( tuple1 tuple2 -- ? )
113 2dup [ tuple? ] both? [
114 2dup [ layout-of ] bi@ eq? [
116 [ [ [ drop array-nth ] [ nip array-nth ] 3bi = ] 2curry ]
119 ] [ 2drop f ] if ; inline
121 GENERIC: final-class? ( object -- ? )
123 M: tuple-class final-class? "final" word-prop ;
125 M: builtin-class final-class? tuple eq? not ;
127 M: class final-class? drop t ;
129 M: object final-class? drop f ;
133 : tuple-predicate-quot/1 ( class -- quot )
134 ! Fast path for tuples with no superclass
135 [ ] curry [ layout-of 7 slot ] [ eq? ] surround 1quotation
136 [ dup tuple? ] [ [ drop f ] if ] surround ;
138 : tuple-instance? ( object class offset -- ? )
142 [ swap slot eq? ] [ 3drop f ] if
143 ] [ 3drop f ] if ; inline
145 : layout-class-offset ( echelon -- n )
148 : tuple-predicate-quot ( class echelon -- quot )
149 layout-class-offset [ tuple-instance? ] 2curry ;
151 : echelon-of ( class -- n )
154 : define-tuple-predicate ( class -- )
156 { 1 [ tuple-predicate-quot/1 ] }
157 [ tuple-predicate-quot ]
158 } case define-predicate ;
160 : class-size ( class -- n )
161 superclasses-of [ "slots" word-prop length ] map-sum ;
163 : boa-check-quot ( class -- quot )
164 all-slots [ class>> instance-check-quot ] map shallow-spread>quot
167 : define-boa-check ( class -- )
168 dup boa-check-quot "boa-check" set-word-prop ;
170 : tuple-prototype ( class -- prototype )
171 [ initial-values ] keep over [ ] any?
172 [ slots>tuple ] [ 2drop f ] if ;
174 : define-tuple-prototype ( class -- )
175 dup tuple-prototype "prototype" set-word-prop ;
177 : prepare-slots ( slots superclass -- slots' )
178 [ make-slots ] [ class-size 2 + ] bi* finalize-slots ;
180 : define-tuple-slots ( class -- )
181 dup "slots" word-prop over superclass-of prepare-slots
184 : make-tuple-layout ( class -- layout )
188 [ [ superclass-of class-size ] [ "slots" word-prop length ] bi + , ]
189 [ superclasses-of length 1 - , ]
190 [ superclasses-of [ [ , ] [ hashcode , ] bi ] each ]
194 : define-tuple-layout ( class -- )
195 dup make-tuple-layout "layout" set-word-prop ;
197 : compute-slot-permutation ( new-slots old-slots -- triples )
198 [ [ [ name>> ] map ] bi@ [ index ] curry map ]
199 [ drop [ class>> ] map ]
200 [ drop [ initial>> ] map ]
203 : update-slot ( old-values n class initial -- value )
205 [ [ swap nth dup ] dip instance? ] dip swap
209 : apply-slot-permutation ( old-values triples -- new-values )
210 [ first3 update-slot ] with map ;
212 SYMBOL: outdated-tuples
214 : permute-slots ( old-values layout -- new-values )
215 [ first all-slots ] [ outdated-tuples get at ] bi
216 compute-slot-permutation
217 apply-slot-permutation ;
219 : update-tuple ( tuple -- newtuple )
220 [ tuple-slots ] [ layout-of ] bi
221 [ permute-slots ] [ first ] bi
224 : outdated-tuple? ( tuple assoc -- ? )
225 [ [ layout-of ] dip key? ]
226 [ drop class-of "forgotten" word-prop not ]
229 : update-tuples ( outdated-tuples -- )
230 dup assoc-empty? [ drop ] [
231 [ [ tuple? ] instances ] dip [ outdated-tuple? ] curry filter
232 dup [ update-tuple ] map become
235 : update-tuples-after ( class -- )
236 [ all-slots ] [ tuple-layout ] bi outdated-tuples get set-at ;
238 M: tuple-class update-class
241 [ define-tuple-layout ]
242 [ define-tuple-slots ]
243 [ define-tuple-predicate ]
244 [ define-tuple-prototype ]
247 : define-new-tuple-class ( class superclass slots -- )
248 [ drop f f tuple-class define-class ]
249 [ nip "slots" set-word-prop ]
250 [ 2drop update-classes ] 3tri ;
252 : subclasses ( class -- classes )
253 class-usages [ tuple-class? ] filter ;
255 : each-subclass ( class quot -- )
256 [ subclasses ] dip each ; inline
258 : redefine-tuple-class ( class superclass slots -- )
262 [ update-tuples-after ]
263 [ changed-conditionally ]
267 [ define-new-tuple-class ] 3bi ;
269 : tuple-class-unchanged? ( class superclass slots -- ? )
270 [ [ superclass-of ] [ bootstrap-word ] bi* = ]
271 [ [ "slots" word-prop ] dip = ]
274 : check-superclass ( superclass -- )
275 dup final-class? [ bad-superclass ] when
276 dup class? [ bad-superclass ] unless drop ;
278 GENERIC#: (define-tuple-class) 2 ( class superclass slots -- )
280 : thrower-effect ( slots -- effect )
281 [ name>> ] map { "*" } <effect> ;
283 : error-slots ( slots -- slots' )
285 dup string? [ 1array ] when
286 read-only swap remove
290 : reset-final ( class -- )
292 [ f "final" set-word-prop ]
293 [ changed-conditionally ]
299 : define-tuple-class ( class superclass slots -- )
300 over check-superclass
302 (define-tuple-class) ;
304 GENERIC: make-final ( class -- )
306 M: tuple-class make-final
307 [ dup class-usage ?metaclass-changed ]
308 [ t "final" set-word-prop ]
311 M: word (define-tuple-class)
312 define-new-tuple-class ;
314 M: tuple-class (define-tuple-class)
316 3dup tuple-class-unchanged?
317 [ 2drop ?define-symbol ] [ redefine-tuple-class ] if ;
319 : boa-effect ( class -- effect )
320 [ all-slots [ name>> ] map ] [ name>> 1array ] bi <effect> ;
322 : define-boa-word ( word class -- )
323 tuple-class check-instance
324 [ [ boa ] curry ] [ boa-effect ] bi
327 : forget-slot-accessors ( class slots -- )
330 [ reader-word ?lookup-method forget ]
331 [ writer-word ?lookup-method forget ] 2bi
334 M: tuple-class reset-class
336 dup "slots" word-prop forget-slot-accessors
339 [ { "layout" "slots" "boa-check" "prototype" "final" } remove-word-props ]
343 M: tuple-class metaclass-changed
344 ! Our superclass is no longer a tuple class, redefine with
346 nip tuple over "slots" word-prop define-tuple-class ;
348 M: tuple-class rank-class drop 1 ;
350 M: tuple-class instance?
351 dup echelon-of layout-class-offset tuple-instance? ;
353 M: tuple-class (flatten-class) , ;
355 M: tuple-class (classes-intersect?)
357 { [ over builtin-class? ] [ drop tuple eq? ] }
358 { [ over tuple-class? ] [ [ class<= ] [ swap class<= ] 2bi or ] }
361 M: tuple clone (clone) ; inline
363 M: tuple equal? over tuple? [ tuple= ] [ 2drop f ] if ;
365 : tuple-hashcode ( depth obj -- hash )
368 [ class-of hashcode ] [ tuple-size ] bi
369 [ dup fixnum+fast 82520 fixnum+fast ] [ <iota> ] bi
371 swapd array-nth hashcode* integer>fixnum rot fixnum-bitxor
372 pick fixnum*fast [ [ fixnum+fast ] keep ] dip swap
373 ] 2curry each drop nip 97531 fixnum+fast ; inline
375 M: tuple hashcode* [ tuple-hashcode ] recursive-hashcode ;
378 dup "prototype" word-prop [ (clone) ] [ tuple-layout <tuple> ] ?if ;
381 [ "boa-check" word-prop [ call ] when* ]
385 M: tuple-class initial-value* new t ;