1 ! (c)Joe Groff, Daniel Ehrenberg bsd license
2 USING: accessors alien alien.c-types alien.data alien.parser
3 arrays byte-arrays classes classes.private classes.parser
4 classes.tuple classes.tuple.parser classes.tuple.private
5 combinators combinators.short-circuit combinators.smart
6 cpu.architecture definitions functors.backend fry
7 generalizations generic.parser kernel kernel.private lexer libc
8 locals macros make math math.order parser quotations sequences
9 slots slots.private specialized-arrays vectors words summary
10 namespaces assocs vocabs.parser math.functions
11 classes.struct.bit-accessors bit-arrays
12 stack-checker.dependencies system layouts ;
16 SPECIALIZED-ARRAY: uchar
18 ERROR: struct-must-have-slots ;
20 M: struct-must-have-slots summary
21 drop "Struct definitions must have slots" ;
24 { (underlying) c-ptr read-only } ;
26 TUPLE: struct-slot-spec < slot-spec
29 ! For a struct-bit-slot-spec, offset is in bits, not bytes
30 TUPLE: struct-bit-slot-spec < struct-slot-spec
33 PREDICATE: struct-class < tuple-class
34 superclass \ struct eq? ;
38 : struct-slots ( struct-class -- slots )
39 "c-type" word-prop fields>> ;
44 2 slot { c-ptr } declare ; inline
49 [ [ >c-ptr ] [ binary-object ] bi* memory= ]
53 binary-object <direct-uchar-array> hashcode* ; inline
55 : struct-prototype ( class -- prototype ) "prototype" word-prop ; foldable
57 : memory>struct ( ptr class -- struct )
58 ! This is sub-optimal if the class is not literal, but gets
59 ! optimized down to efficient code if it is.
60 '[ _ boa ] call( ptr -- struct ) ; inline
63 : (init-struct) ( class with-prototype: ( prototype -- alien ) sans-prototype: ( class -- alien ) -- alien )
64 '[ dup struct-prototype _ _ ?if ] keep memory>struct ; inline
67 : (malloc-struct) ( class -- struct )
68 [ heap-size malloc ] keep memory>struct ; inline
70 : malloc-struct ( class -- struct )
71 [ >c-ptr malloc-byte-array ] [ 1 swap heap-size calloc ] (init-struct) ; inline
73 : (struct) ( class -- struct )
74 [ heap-size (byte-array) ] keep memory>struct ; inline
76 : <struct> ( class -- struct )
77 [ >c-ptr clone ] [ heap-size <byte-array> ] (init-struct) ; inline
79 MACRO: <struct-boa> ( class -- quot: ( ... -- struct ) )
81 [ <wrapper> \ (struct) [ ] 2sequence ]
85 [ [ name>> setter-word 1quotation ] map \ spread ] bi
87 ] [ ] output>sequence ;
90 : pad-struct-slots ( values class -- values' class )
91 [ struct-slots [ initial>> ] map over length tail append ] keep ;
93 : sign-extend ( n bits -- n' )
95 ! http://guru.multimedia.cx/fast-sign-extension/
96 1 - -1 swap shift [ + ] keep bitxor ; inline
98 : sign-extender ( signed? bits -- quot )
99 '[ _ [ _ sign-extend ] when ] ;
101 GENERIC: (reader-quot) ( slot -- quot )
103 M: struct-slot-spec (reader-quot)
105 [ offset>> [ >c-ptr ] swap suffix ] bi prepend ;
107 M: struct-bit-slot-spec (reader-quot)
108 [ [ offset>> ] [ bits>> ] bi bit-reader ]
109 [ [ signed?>> ] [ bits>> ] bi sign-extender ]
113 GENERIC: (writer-quot) ( slot -- quot )
115 M: struct-slot-spec (writer-quot)
117 [ offset>> [ >c-ptr ] swap suffix ] bi prepend ;
119 M: struct-bit-slot-spec (writer-quot)
120 [ offset>> ] [ bits>> ] bi bit-writer
123 : (boxer-quot) ( class -- quot )
124 '[ _ memory>struct ] ;
126 : (unboxer-quot) ( class -- quot )
129 MACRO: read-struct-slot ( slot -- )
130 dup type>> depends-on-c-type
133 MACRO: write-struct-slot ( slot -- )
134 dup type>> depends-on-c-type
138 M: struct-class boa>object
139 swap pad-struct-slots
140 [ <struct> ] [ struct-slots ] bi
141 [ [ (writer-quot) call( value struct -- ) ] with 2each ] curry keep ;
143 M: struct-class initial-value* <struct> ; inline
145 ! Struct slot accessors
147 GENERIC: struct-slot-values ( struct -- sequence )
149 M: struct-class reader-quot
150 dup type>> array? [ dup type>> first define-array-vocab drop ] when
151 nip '[ _ read-struct-slot ] ;
153 M: struct-class writer-quot
154 nip '[ _ write-struct-slot ] ;
156 : offset-of ( field struct -- offset )
157 struct-slots slot-named offset>> ; inline
161 TUPLE: struct-c-type < abstract-c-type
163 return-in-registers? ;
165 INSTANCE: struct-c-type value-type
167 M: struct-c-type c-type ;
169 M: struct-c-type base-type ;
171 M: struct-c-type stack-size
172 dup value-struct? [ heap-size cell align ] [ drop cell ] if ;
174 HOOK: flatten-struct-type cpu ( type -- pairs )
176 M: object flatten-struct-type
177 stack-size cell /i { int-rep f } <repetition> ;
179 : large-struct? ( type -- ? )
181 { [ dup void? ] [ drop f ] }
182 { [ dup base-type struct-c-type? not ] [ drop f ] }
183 [ return-struct-in-registers? not ]
187 : struct-slot-values-quot ( class -- quot )
189 [ name>> reader-word 1quotation ] map
190 \ cleave [ ] 2sequence
191 \ output>array [ ] 2sequence ;
193 : (define-struct-slot-values-method) ( class -- )
194 [ \ struct-slot-values ] [ struct-slot-values-quot ] bi
195 define-inline-method ;
197 : clone-underlying ( struct -- byte-array )
198 binary-object memory>byte-array ; inline
200 : (define-clone-method) ( class -- )
202 [ \ clone-underlying swap literalize \ memory>struct [ ] 3sequence ] bi
203 define-inline-method ;
205 :: c-type-for-class ( class slots size align -- c-type )
213 class (unboxer-quot) >>unboxer-quot
214 class (boxer-quot) >>boxer-quot ;
216 GENERIC: compute-slot-offset ( offset class -- offset' )
218 : c-type-align-at ( class offset -- n )
219 0 = [ c-type-align-first ] [ c-type-align ] if ;
221 M: struct-slot-spec compute-slot-offset
222 [ type>> over c-type-align-at 8 * align ] keep
223 [ [ 8 /i ] dip offset<< ] [ type>> heap-size 8 * + ] 2bi ;
225 M: struct-bit-slot-spec compute-slot-offset
226 [ offset<< ] [ bits>> + ] 2bi ;
228 : compute-struct-offsets ( slots -- size )
229 0 [ compute-slot-offset ] reduce 8 align 8 /i ;
231 : compute-union-offsets ( slots -- size )
232 1 [ 0 >>offset type>> heap-size max ] reduce ;
234 : struct-alignment ( slots -- align )
235 [ struct-bit-slot-spec? not ] filter
236 1 [ [ type>> ] [ offset>> ] bi c-type-align-at max ] reduce ;
240 M: struct byte-length class "struct-size" word-prop ; foldable
245 GENERIC: binary-zero? ( value -- ? )
247 M: object binary-zero? drop f ;
248 M: f binary-zero? drop t ;
249 M: number binary-zero? 0 = ;
250 M: struct binary-zero? >c-ptr [ 0 = ] all? ;
252 : struct-needs-prototype? ( class -- ? )
253 struct-slots [ initial>> binary-zero? ] all? not ;
255 : make-struct-prototype ( class -- prototype )
256 dup struct-needs-prototype? [
257 [ "c-type" word-prop size>> <byte-array> ]
263 over [ swapd [ call( value struct -- ) ] curry keep ] [ 2drop ] if
267 : (struct-methods) ( class -- )
268 [ (define-struct-slot-values-method) ]
269 [ (define-clone-method) ]
272 : check-struct-slots ( slots -- )
273 [ type>> c-type drop ] each ;
275 : redefine-struct-tuple-class ( class -- )
276 [ struct f define-tuple-class ] [ make-final ] bi ;
278 :: (define-struct-class) ( class slots offsets-quot -- )
279 slots empty? [ struct-must-have-slots ] when
280 class redefine-struct-tuple-class
281 slots make-slots dup check-struct-slots :> slot-specs
282 slot-specs offsets-quot call :> unaligned-size
283 slot-specs struct-alignment :> alignment
284 unaligned-size alignment align :> size
286 class slot-specs size alignment c-type-for-class :> c-type
289 class slot-specs define-accessors
290 class size "struct-size" set-word-prop
291 class dup make-struct-prototype "prototype" set-word-prop
292 class (struct-methods) ; inline
295 : define-struct-class ( class slots -- )
296 [ compute-struct-offsets ] (define-struct-class) ;
298 : define-union-struct-class ( class slots -- )
299 [ compute-union-offsets ] (define-struct-class) ;
301 ERROR: invalid-struct-slot token ;
303 : struct-slot-class ( c-type -- class' )
304 c-type c-type-boxed-class
305 dup \ byte-array = [ drop \ c-ptr ] when ;
311 ERROR: bad-type-for-bits type ;
313 :: set-bits ( slot-spec n -- slot-spec )
314 struct-bit-slot-spec new
319 [ bad-type-for-bits ]
321 slot-spec name>> >>name
322 slot-spec class>> >>class
323 slot-spec type>> >>type
324 slot-spec read-only>> >>read-only
325 slot-spec initial>> >>initial ;
327 : peel-off-struct-attributes ( slot-spec array -- slot-spec array )
330 { initial: [ [ first >>initial ] [ rest ] bi ] }
331 { read-only [ [ t >>read-only ] dip ] }
332 { bits: [ [ first set-bits ] [ rest ] bi ] }
333 [ bad-slot-attribute ]
339 : <struct-slot-spec> ( name c-type attributes -- slot-spec )
340 [ struct-slot-spec new ] 3dip
342 [ [ >>type ] [ struct-slot-class >>class ] bi ]
343 [ [ dup empty? ] [ peel-off-struct-attributes ] until drop ] tri* ;
346 : parse-struct-slot ( -- slot )
347 scan scan-c-type \ } parse-until <struct-slot-spec> ;
349 : parse-struct-slots ( slots -- slots' more? )
352 { "{" [ parse-struct-slot suffix! t ] }
353 { f [ unexpected-eof ] }
354 [ invalid-struct-slot ]
357 : parse-struct-definition ( -- class slots )
358 CREATE-CLASS 8 <vector> [ parse-struct-slots ] [ ] while >array
359 dup [ name>> ] map check-duplicate-slots ;
363 parse-struct-definition define-struct-class ;
364 SYNTAX: UNION-STRUCT:
365 parse-struct-definition define-union-struct-class ;
368 scan-word dup struct-slots parse-tuple-literal-slots suffix! ;
371 scan-word scan-object swap memory>struct suffix! ;
376 : scan-c-type` ( -- c-type/param )
377 scan dup "{" = [ drop \ } parse-until >array ] [ search ] if ;
379 : parse-struct-slot` ( accum -- accum )
380 scan-string-param scan-c-type` \ } parse-until
381 [ <struct-slot-spec> suffix! ] 3curry append! ;
383 : parse-struct-slots` ( accum -- accum more? )
386 { "{" [ parse-struct-slot` t ] }
387 [ invalid-struct-slot ]
391 FUNCTOR-SYNTAX: STRUCT:
393 [ 8 <vector> ] append!
394 [ parse-struct-slots` ] [ ] while
395 [ >array define-struct-class ] append! ;
397 USING: vocabs vocabs.loader ;
399 { "classes.struct" "prettyprint" } "classes.struct.prettyprint" require-when