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: not-a-tuple object ;
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 )
26 2dup class-of all-slots slot-named
27 [ 2nip offset>> ] [ throw-no-slot ] if* ;
29 : get-slot-named ( name tuple -- value )
30 [ nip ] [ offset-of-slot ] 2bi slot ;
32 : set-slot-named ( value name tuple -- )
33 [ nip ] [ offset-of-slot ] 2bi set-slot ;
35 : set-slots ( assoc tuple -- )
36 [ swapd set-slot-named ] curry assoc-each ; inline
38 : from-slots ( assoc class -- tuple )
39 new [ set-slots ] keep ; inline
41 PREDICATE: immutable-tuple-class < tuple-class
42 all-slots [ read-only>> ] all? ;
46 : tuple-layout ( class -- layout )
49 : layout-of ( tuple -- layout )
50 1 slot { array } declare ; inline
52 M: tuple class-of layout-of 2 slot { word } declare ; inline
54 : tuple-size ( tuple -- size )
55 layout-of 3 slot { fixnum } declare ; inline
57 : layout-up-to-date? ( object -- ? )
59 [ [ layout-of ] [ class-of tuple-layout ] bi eq? ] [ drop t ] if ;
61 : check-tuple ( object -- tuple )
62 dup tuple? [ throw-not-a-tuple ] unless ; inline
64 : prepare-tuple-slots ( tuple -- n tuple )
65 check-tuple [ 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 -- slots )
79 all-slots [ initial>> ] map ;
81 : pad-slots ( slots class -- slots' class )
82 [ initial-values over length tail append ] keep ; inline
86 : tuple-slots ( tuple -- seq )
87 prepare-tuple-slots copy-tuple-slots ;
89 GENERIC: slots>tuple ( seq class -- tuple )
91 M: tuple-class slots>tuple ( seq class -- tuple )
93 tuple-layout <tuple> [
95 [ [ set-array-nth ] curry ]
99 : tuple>array ( tuple -- array )
100 [ tuple-slots ] [ layout-of first prefix ] bi ;
102 : >tuple ( seq -- tuple )
105 ERROR: bad-superclass class ;
107 : tuple= ( tuple1 tuple2 -- ? )
108 2dup [ tuple? ] both? [
109 2dup [ layout-of ] bi@ eq? [
111 [ [ [ drop array-nth ] [ nip array-nth ] 3bi = ] 2curry ]
114 ] [ 2drop f ] if ; inline
116 GENERIC: final-class? ( object -- ? )
118 M: tuple-class final-class? "final" word-prop ;
120 M: builtin-class final-class? tuple eq? not ;
122 M: class final-class? drop t ;
124 M: object final-class? drop f ;
128 : tuple-predicate-quot/1 ( class -- quot )
129 #! Fast path for tuples with no superclass
130 [ ] curry [ layout-of 7 slot ] [ eq? ] surround 1quotation
131 [ dup tuple? ] [ [ drop f ] if ] surround ;
133 : tuple-instance? ( object class offset -- ? )
137 [ swap slot eq? ] [ 3drop f ] if
138 ] [ 3drop f ] if ; inline
140 : layout-class-offset ( echelon -- n )
143 : tuple-predicate-quot ( class echelon -- quot )
144 layout-class-offset [ tuple-instance? ] 2curry ;
146 : echelon-of ( class -- n )
149 : define-tuple-predicate ( class -- )
151 { 1 [ tuple-predicate-quot/1 ] }
152 [ tuple-predicate-quot ]
153 } case define-predicate ;
155 : class-size ( class -- n )
156 superclasses-of [ "slots" word-prop length ] map-sum ;
158 : boa-check-quot ( class -- quot )
159 all-slots [ class>> instance-check-quot ] map shallow-spread>quot
162 : define-boa-check ( class -- )
163 dup boa-check-quot "boa-check" set-word-prop ;
165 : tuple-prototype ( class -- prototype )
166 [ initial-values ] keep over [ ] any?
167 [ slots>tuple ] [ 2drop f ] if ;
169 : define-tuple-prototype ( class -- )
170 dup tuple-prototype "prototype" set-word-prop ;
172 : prepare-slots ( slots superclass -- slots' )
173 [ make-slots ] [ class-size 2 + ] bi* finalize-slots ;
175 : define-tuple-slots ( class -- )
176 dup "slots" word-prop over superclass-of prepare-slots
179 : make-tuple-layout ( class -- layout )
183 [ [ superclass-of class-size ] [ "slots" word-prop length ] bi + , ]
184 [ superclasses-of length 1 - , ]
185 [ superclasses-of [ [ , ] [ hashcode , ] bi ] each ]
189 : define-tuple-layout ( class -- )
190 dup make-tuple-layout "layout" set-word-prop ;
192 : compute-slot-permutation ( new-slots old-slots -- triples )
193 [ [ [ name>> ] map ] bi@ [ index ] curry map ]
194 [ drop [ class>> ] map ]
195 [ drop [ initial>> ] map ]
198 : update-slot ( old-values n class initial -- value )
200 [ [ swap nth dup ] dip instance? ] dip swap
202 ] [ [ 3drop ] dip ] if ;
204 : apply-slot-permutation ( old-values triples -- new-values )
205 [ first3 update-slot ] with map ;
207 SYMBOL: outdated-tuples
209 : permute-slots ( old-values layout -- new-values )
210 [ first all-slots ] [ outdated-tuples get at ] bi
211 compute-slot-permutation
212 apply-slot-permutation ;
214 : update-tuple ( tuple -- newtuple )
215 [ tuple-slots ] [ layout-of ] bi
216 [ permute-slots ] [ first ] bi
219 : outdated-tuple? ( tuple assoc -- ? )
220 [ [ layout-of ] dip key? ]
221 [ drop class-of "forgotten" word-prop not ]
224 : update-tuples ( -- )
226 dup assoc-empty? [ drop ] [
227 [ [ tuple? ] instances ] dip [ outdated-tuple? ] curry filter
228 dup [ update-tuple ] map become
231 : update-tuples-after ( class -- )
232 [ all-slots ] [ tuple-layout ] bi outdated-tuples get set-at ;
234 M: tuple-class update-class
237 [ define-tuple-layout ]
238 [ define-tuple-slots ]
239 [ define-tuple-predicate ]
240 [ define-tuple-prototype ]
243 ! The "defining-class" word-prop is to ensure that the tuple being
244 ! defined becomes a classoid as it's being parsed so that it can
245 ! be used as the type of its own slots.
246 : 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 ]
251 [ 2drop f "defining-class" set-word-prop ]
254 : subclasses ( class -- classes )
255 class-usages [ tuple-class? ] filter ;
257 : each-subclass ( class quot -- )
258 [ subclasses ] dip each ; inline
260 : redefine-tuple-class ( class superclass slots -- )
264 [ update-tuples-after ]
265 [ changed-conditionally ]
269 [ define-new-tuple-class ] 3bi ;
271 : tuple-class-unchanged? ( class superclass slots -- ? )
272 [ [ superclass-of ] [ bootstrap-word ] bi* = ]
273 [ [ "slots" word-prop ] dip = ]
276 : check-superclass ( superclass -- )
277 dup final-class? [ bad-superclass ] when
278 dup class? [ bad-superclass ] unless drop ;
280 GENERIC# (define-tuple-class) 2 ( class superclass slots -- )
282 : thrower-effect ( slots -- effect )
283 [ name>> ] map { "*" } <effect> ;
285 : error-slots ( slots -- slots' )
287 dup string? [ 1array ] when
288 read-only swap remove
292 : reset-final ( class -- )
294 [ f "final" set-word-prop ]
295 [ changed-conditionally ]
301 : define-tuple-class ( class superclass slots -- )
302 over check-superclass
304 (define-tuple-class) ;
306 GENERIC: make-final ( class -- )
308 M: tuple-class make-final
309 [ dup class-usage ?metaclass-changed ]
310 [ t "final" set-word-prop ]
313 M: word (define-tuple-class)
314 define-new-tuple-class ;
316 M: tuple-class (define-tuple-class)
318 3dup tuple-class-unchanged?
319 [ 2drop ?define-symbol ] [ redefine-tuple-class ] if ;
321 : boa-effect ( class -- effect )
322 [ all-slots [ name>> ] map ] [ name>> 1array ] bi <effect> ;
324 ERROR: not-a-tuple-class object ;
326 : check-tuple-class ( class -- class )
327 dup tuple-class? [ throw-not-a-tuple-class ] unless ; inline
329 : define-boa-word ( word class -- )
330 check-tuple-class [ [ boa ] curry ] [ boa-effect ] bi
333 : forget-slot-accessors ( class slots -- )
336 [ reader-word ?lookup-method forget ]
337 [ writer-word ?lookup-method forget ] 2bi
340 M: tuple-class reset-class
342 dup "slots" word-prop forget-slot-accessors
345 [ { "layout" "slots" "boa-check" "prototype" "final" } remove-word-props ]
349 M: tuple-class metaclass-changed
350 ! Our superclass is no longer a tuple class, redefine with
352 nip tuple over "slots" word-prop define-tuple-class ;
354 M: tuple-class rank-class drop 1 ;
356 M: tuple-class instance?
357 dup echelon-of layout-class-offset tuple-instance? ;
359 M: tuple-class (flatten-class) dup ,, ;
361 M: tuple-class (classes-intersect?)
363 { [ over builtin-class? ] [ drop tuple eq? ] }
364 { [ over tuple-class? ] [ [ class<= ] [ swap class<= ] 2bi or ] }
367 M: tuple clone (clone) ; inline
369 M: tuple equal? over tuple? [ tuple= ] [ 2drop f ] if ;
371 : tuple-hashcode ( depth obj -- hash )
374 [ class-of hashcode ] [ tuple-size ] bi
375 [ dup fixnum+fast 82520 fixnum+fast ] [ iota ] bi
377 swapd array-nth hashcode* >fixnum rot fixnum-bitxor
378 pick fixnum*fast [ [ fixnum+fast ] keep ] dip swap
379 ] 2curry each drop nip 97531 fixnum+fast ; inline
381 M: tuple hashcode* [ tuple-hashcode ] recursive-hashcode ;
384 dup "prototype" word-prop [ (clone) ] [ tuple-layout <tuple> ] ?if ;
387 [ "boa-check" word-prop [ call ] when* ]
391 M: tuple-class initial-value* new t ;