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 ERROR: not-a-tuple object ;
22 : all-slots ( class -- slots )
23 superclasses-of [ "slots" word-prop ] map concat ;
25 ERROR: no-slot name tuple ;
27 : ?offset-of-slot ( name tuple -- n/f )
28 class-of all-slots slot-named [ offset>> ] [ f ] if* ;
30 : offset-of-slot ( name tuple -- n )
31 2dup ?offset-of-slot [ 2nip ] [ no-slot ] if* ;
33 : get-slot-named ( name tuple -- value )
34 [ nip ] [ offset-of-slot ] 2bi slot ;
36 : set-slot-named ( value name tuple -- )
37 [ nip ] [ offset-of-slot ] 2bi set-slot ;
39 : set-slots ( assoc tuple -- )
40 [ swapd set-slot-named ] curry assoc-each ; inline
42 : from-slots ( assoc class -- tuple )
43 new [ set-slots ] keep ; inline
45 PREDICATE: immutable-tuple-class < tuple-class
46 all-slots [ read-only>> ] all? ;
50 : tuple-layout ( class -- layout )
53 : layout-of ( tuple -- layout )
54 1 slot { array } declare ; inline
56 M: tuple class-of layout-of 2 slot { word } declare ; inline
58 : tuple-size ( tuple -- size )
59 layout-of 3 slot { fixnum } declare ; inline
61 : layout-up-to-date? ( object -- ? )
63 [ [ layout-of ] [ class-of tuple-layout ] bi eq? ] [ drop t ] if ;
65 : check-tuple ( object -- tuple )
66 dup tuple? [ not-a-tuple ] unless ; inline
68 : prepare-tuple-slots ( tuple -- n tuple )
69 check-tuple [ tuple-size <iota> ] keep ;
71 : copy-tuple-slots ( n tuple -- array )
72 [ array-nth ] curry map ;
74 : check-slots ( seq class -- seq class )
77 class>> 2dup instance?
78 [ 2drop ] [ bad-slot-value ] if
80 ] if-bootstrapping ; inline
82 : initial-values ( class -- seq )
83 all-slots [ initial>> ] map ; inline
85 : pad-slots ( seq class -- seq' class )
86 [ initial-values ] keep
87 2over [ length ] bi@ 2dup > [
88 [ nip swap ] 2dip too-many-slots
90 drop [ tail append ] curry dip
95 : tuple-slots ( tuple -- seq )
96 prepare-tuple-slots copy-tuple-slots ;
98 GENERIC: slots>tuple ( seq class -- tuple )
100 M: tuple-class slots>tuple ( seq class -- tuple )
101 check-slots pad-slots
102 tuple-layout <tuple> [
103 [ tuple-size <iota> ]
104 [ [ set-array-nth ] curry ]
108 : tuple>array ( tuple -- array )
109 [ tuple-slots ] [ class-of prefix ] bi ;
111 : >tuple ( seq -- tuple )
114 ERROR: bad-superclass class ;
116 : tuple= ( tuple1 tuple2 -- ? )
117 2dup [ tuple? ] both? [
118 2dup [ layout-of ] bi@ eq? [
120 [ [ [ drop array-nth ] [ nip array-nth ] 3bi = ] 2curry ]
123 ] [ 2drop f ] if ; inline
125 GENERIC: final-class? ( object -- ? )
127 M: tuple-class final-class? "final" word-prop ;
129 M: builtin-class final-class? tuple eq? not ;
131 M: class final-class? drop t ;
133 M: object final-class? drop f ;
137 : tuple-predicate-quot/1 ( class -- quot )
138 ! Fast path for tuples with no superclass
139 [ ] curry [ layout-of 7 slot ] [ eq? ] surround 1quotation
140 [ dup tuple? ] [ [ drop f ] if ] surround ;
142 : tuple-instance? ( object class offset -- ? )
146 [ swap slot eq? ] [ 3drop f ] if
147 ] [ 3drop f ] if ; inline
149 : layout-class-offset ( echelon -- n )
152 : tuple-predicate-quot ( class echelon -- quot )
153 layout-class-offset [ tuple-instance? ] 2curry ;
155 : echelon-of ( class -- n )
158 : define-tuple-predicate ( class -- )
160 { 1 [ tuple-predicate-quot/1 ] }
161 [ tuple-predicate-quot ]
162 } case define-predicate ;
164 : class-size ( class -- n )
165 superclasses-of [ "slots" word-prop length ] map-sum ;
167 : boa-check-quot ( class -- quot )
168 all-slots [ class>> instance-check-quot ] map shallow-spread>quot
171 : define-boa-check ( class -- )
172 dup boa-check-quot "boa-check" set-word-prop ;
174 : tuple-prototype ( class -- prototype )
175 [ initial-values ] keep over [ ] any?
176 [ slots>tuple ] [ 2drop f ] if ;
178 : define-tuple-prototype ( class -- )
179 dup tuple-prototype "prototype" set-word-prop ;
181 : prepare-slots ( slots superclass -- slots' )
182 [ make-slots ] [ class-size 2 + ] bi* finalize-slots ;
184 : define-tuple-slots ( class -- )
185 dup "slots" word-prop over superclass-of prepare-slots
188 : make-tuple-layout ( class -- layout )
192 [ [ superclass-of class-size ] [ "slots" word-prop length ] bi + , ]
193 [ superclasses-of length 1 - , ]
194 [ superclasses-of [ [ , ] [ hashcode , ] bi ] each ]
198 : define-tuple-layout ( class -- )
199 dup make-tuple-layout "layout" set-word-prop ;
201 : compute-slot-permutation ( new-slots old-slots -- triples )
202 [ [ [ name>> ] map ] bi@ [ index ] curry map ]
203 [ drop [ class>> ] map ]
204 [ drop [ initial>> ] map ]
207 : update-slot ( old-values n class initial -- value )
209 [ [ swap nth dup ] dip instance? ] dip swap
213 : apply-slot-permutation ( old-values triples -- new-values )
214 [ first3 update-slot ] with map ;
216 SYMBOL: outdated-tuples
218 : permute-slots ( old-values layout -- new-values )
219 [ first all-slots ] [ outdated-tuples get at ] bi
220 compute-slot-permutation
221 apply-slot-permutation ;
223 : update-tuple ( tuple -- newtuple )
224 [ tuple-slots ] [ layout-of ] bi
225 [ permute-slots ] [ first ] bi
228 : outdated-tuple? ( tuple assoc -- ? )
229 [ [ layout-of ] dip key? ]
230 [ drop class-of "forgotten" word-prop not ]
233 : update-tuples ( outdated-tuples -- )
234 dup assoc-empty? [ drop ] [
235 [ [ tuple? ] instances ] dip [ outdated-tuple? ] curry filter
236 dup [ update-tuple ] map become
239 : update-tuples-after ( class -- )
240 [ all-slots ] [ tuple-layout ] bi outdated-tuples get set-at ;
242 M: tuple-class update-class
245 [ define-tuple-layout ]
246 [ define-tuple-slots ]
247 [ define-tuple-predicate ]
248 [ define-tuple-prototype ]
251 : define-new-tuple-class ( class superclass slots -- )
252 [ drop f f tuple-class define-class ]
253 [ nip "slots" set-word-prop ]
254 [ 2drop update-classes ] 3tri ;
256 : subclasses ( class -- classes )
257 class-usages [ tuple-class? ] filter ;
259 : each-subclass ( class quot -- )
260 [ subclasses ] dip each ; inline
262 : redefine-tuple-class ( class superclass slots -- )
266 [ update-tuples-after ]
267 [ changed-conditionally ]
271 [ define-new-tuple-class ] 3bi ;
273 : tuple-class-unchanged? ( class superclass slots -- ? )
274 [ [ superclass-of ] [ bootstrap-word ] bi* = ]
275 [ [ "slots" word-prop ] dip = ]
278 : check-superclass ( superclass -- )
279 dup final-class? [ bad-superclass ] when
280 dup class? [ bad-superclass ] unless drop ;
282 GENERIC#: (define-tuple-class) 2 ( class superclass slots -- )
284 : thrower-effect ( slots -- effect )
285 [ name>> ] map { "*" } <effect> ;
287 : error-slots ( slots -- slots' )
289 dup string? [ 1array ] when
290 read-only swap remove
294 : reset-final ( class -- )
296 [ f "final" set-word-prop ]
297 [ changed-conditionally ]
303 : define-tuple-class ( class superclass slots -- )
304 over check-superclass
306 (define-tuple-class) ;
308 GENERIC: make-final ( class -- )
310 M: tuple-class make-final
311 [ dup class-usage ?metaclass-changed ]
312 [ t "final" set-word-prop ]
315 M: word (define-tuple-class)
316 define-new-tuple-class ;
318 M: tuple-class (define-tuple-class)
320 3dup tuple-class-unchanged?
321 [ 2drop ?define-symbol ] [ redefine-tuple-class ] if ;
323 : boa-effect ( class -- effect )
324 [ all-slots [ name>> ] map ] [ name>> 1array ] bi <effect> ;
326 ERROR: not-a-tuple-class object ;
328 : check-tuple-class ( class -- class )
329 dup tuple-class? [ not-a-tuple-class ] unless ; inline
331 : define-boa-word ( word class -- )
332 check-tuple-class [ [ boa ] curry ] [ boa-effect ] bi
335 : forget-slot-accessors ( class slots -- )
338 [ reader-word ?lookup-method forget ]
339 [ writer-word ?lookup-method forget ] 2bi
342 M: tuple-class reset-class
344 dup "slots" word-prop forget-slot-accessors
347 [ { "layout" "slots" "boa-check" "prototype" "final" } remove-word-props ]
351 M: tuple-class metaclass-changed
352 ! Our superclass is no longer a tuple class, redefine with
354 nip tuple over "slots" word-prop define-tuple-class ;
356 M: tuple-class rank-class drop 1 ;
358 M: tuple-class instance?
359 dup echelon-of layout-class-offset tuple-instance? ;
361 M: tuple-class (flatten-class) dup ,, ;
363 M: tuple-class (classes-intersect?)
365 { [ over builtin-class? ] [ drop tuple eq? ] }
366 { [ over tuple-class? ] [ [ class<= ] [ swap class<= ] 2bi or ] }
369 M: tuple clone (clone) ; inline
371 M: tuple equal? over tuple? [ tuple= ] [ 2drop f ] if ;
373 : tuple-hashcode ( depth obj -- hash )
376 [ class-of hashcode ] [ tuple-size ] bi
377 [ dup fixnum+fast 82520 fixnum+fast ] [ <iota> ] bi
379 swapd array-nth hashcode* >fixnum rot fixnum-bitxor
380 pick fixnum*fast [ [ fixnum+fast ] keep ] dip swap
381 ] 2curry each drop nip 97531 fixnum+fast ; inline
383 M: tuple hashcode* [ tuple-hashcode ] recursive-hashcode ;
386 dup "prototype" word-prop [ (clone) ] [ tuple-layout <tuple> ] ?if ;
389 [ "boa-check" word-prop [ call ] when* ]
393 M: tuple-class initial-value* new t ;