3 (define-foreign-type g-boxed-foreign-type ()
5 :accessor g-boxed-foreign-info
6 :initform (error "info must be specified"))
7 (return-p :initarg :return-p
8 :accessor g-boxed-foreign-return-p
10 (:actual-type :pointer))
12 (eval-when (:compile-toplevel :load-toplevel :execute)
13 (defstruct g-boxed-info
17 (eval-when (:compile-toplevel :load-toplevel :execute)
18 (defun get-g-boxed-foreign-info (name)
19 (get name 'g-boxed-foreign-info)))
21 (defvar *g-type-name->g-boxed-foreign-info* (make-hash-table :test 'equal))
23 (defun get-g-boxed-foreign-info-for-gtype (g-type-designator)
24 (or (gethash (g-type-string g-type-designator) *g-type-name->g-boxed-foreign-info*)
25 (error "Unknown GBoxed type '~A'" (g-type-string g-type-designator))))
27 (defgeneric make-foreign-type (info &key return-p))
29 (define-parse-method g-boxed-foreign (name &rest options)
30 (let ((info (get-g-boxed-foreign-info name)))
31 (assert info nil "Unknown foreign GBoxed type ~A" name)
32 (make-foreign-type info :return-p (member :return options))))
34 (defgeneric boxed-copy-fn (type-info native)
35 (:method (type-info native)
36 (g-boxed-copy (g-boxed-info-g-type type-info) native)))
38 (defmethod boxed-copy-fn :before (type-info native)
39 (format t "(boxed-copy-fn ~A ~A)~%" (g-boxed-info-name type-info) native))
41 (defgeneric boxed-free-fn (type-info native)
42 (:method (type-info native)
43 (g-boxed-free (g-boxed-info-g-type type-info) native)))
45 (defmethod boxed-free-fn :before (type-info native)
46 (format t "(boxed-free-fn ~A ~A)~%" (g-boxed-info-name type-info) native))
48 (defmethod has-callback-cleanup ((type g-boxed-foreign-type))
51 (eval-when (:load-toplevel :compile-toplevel :execute)
52 (defstruct (g-boxed-cstruct-wrapper-info (:include g-boxed-info))
55 (defclass boxed-cstruct-foreign-type (g-boxed-foreign-type) ())
57 (defstruct cstruct-slot-description
63 (defmethod make-load-form ((object cstruct-slot-description) &optional environment)
64 (make-load-form-saving-slots object :environment environment))
66 (defstruct cstruct-description
70 (defmethod make-load-form ((object cstruct-description) &optional environment)
71 (make-load-form-saving-slots object :environment environment))
73 (defun parse-cstruct-slot (slot)
74 (destructuring-bind (name type &key count initform) slot
75 (make-cstruct-slot-description :name name :type type :count count :initform initform)))
77 (defun parse-cstruct-definition (name slots)
78 (make-cstruct-description :name name
79 :slots (mapcar #'parse-cstruct-slot slots)))
81 (defmacro define-g-boxed-cstruct (name g-type-name &body slots)
82 (let ((cstruct-description (parse-cstruct-definition name slots)))
85 ,@(iter (for slot in (cstruct-description-slots cstruct-description))
86 (for name = (cstruct-slot-description-name slot))
87 (for initform = (cstruct-slot-description-initform slot))
88 (collect (list name initform))))
89 (defcstruct ,(generated-cstruct-name name)
90 ,@(iter (for slot in (cstruct-description-slots cstruct-description))
91 (for name = (cstruct-slot-description-name slot))
92 (for type = (cstruct-slot-description-type slot))
93 (for count = (cstruct-slot-description-count slot))
94 (collect `(,name ,type ,@(when count `(:count ,count))))))
95 (eval-when (:compile-toplevel :load-toplevel :execute)
96 (setf (get ',name 'g-boxed-foreign-info)
97 (make-g-boxed-cstruct-wrapper-info :name ',name
99 :cstruct-description ,cstruct-description)
100 (gethash ,g-type-name *g-type-name->g-boxed-foreign-info*)
101 (get ',name 'g-boxed-foreign-info))))))
103 (defmethod make-foreign-type ((info g-boxed-cstruct-wrapper-info) &key return-p)
104 (make-instance 'boxed-cstruct-foreign-type :info info :return-p return-p))
106 (defun memcpy (target source bytes)
107 (iter (for i from 0 below bytes)
108 (setf (mem-aref target :uchar i)
109 (mem-aref source :uchar i))))
111 (defmethod boxed-copy-fn ((info g-boxed-cstruct-wrapper-info) native)
112 (if (g-boxed-info-g-type info)
113 (g-boxed-copy (g-boxed-info-g-type info) native)
114 (let ((copy (foreign-alloc (generated-cstruct-name (g-boxed-info-name info)))))
115 (memcpy copy native (foreign-type-size (generated-cstruct-name (g-boxed-info-name info))))
118 (defmethod boxed-free-fn ((info g-boxed-cstruct-wrapper-info) native)
119 (if (g-boxed-info-g-type info)
120 (g-boxed-free (g-boxed-info-g-type info) native)
121 (foreign-free native)))
123 (defun copy-slots-to-native (proxy native cstruct-description)
124 (iter (with cstruct-type = (generated-cstruct-name (cstruct-description-name cstruct-description)))
125 (for slot in (cstruct-description-slots cstruct-description))
126 (for slot-name = (cstruct-slot-description-name slot))
127 (setf (foreign-slot-value native cstruct-type slot-name)
128 (slot-value proxy slot-name))))
130 (defun copy-slots-to-proxy (proxy native cstruct-description)
131 (iter (with cstruct-type = (generated-cstruct-name (cstruct-description-name cstruct-description)))
132 (for slot in (cstruct-description-slots cstruct-description))
133 (for slot-name = (cstruct-slot-description-name slot))
134 (setf (slot-value proxy slot-name)
135 (foreign-slot-value native cstruct-type slot-name))))
137 (defmethod translate-to-foreign (proxy (type boxed-cstruct-foreign-type))
140 (let* ((info (g-boxed-foreign-info type))
141 (native-structure-type (generated-cstruct-name (g-boxed-info-name info))))
142 (with-foreign-object (native-structure native-structure-type)
143 (copy-slots-to-native proxy native-structure (g-boxed-cstruct-wrapper-info-cstruct-description info))
144 (values (boxed-copy-fn info native-structure) proxy)))))
146 (defmethod free-translated-object (native-structure (type boxed-cstruct-foreign-type) proxy)
148 (let ((info (g-boxed-foreign-info type)))
149 (copy-slots-to-proxy proxy native-structure (g-boxed-cstruct-wrapper-info-cstruct-description info))
150 (boxed-free-fn info native-structure))))
152 (defmethod translate-from-foreign (native-structure (type boxed-cstruct-foreign-type))
153 (unless (null-pointer-p native-structure)
154 (let* ((info (g-boxed-foreign-info type))
155 (proxy-structure-type (g-boxed-info-name info))
156 (proxy (make-instance proxy-structure-type)))
157 (copy-slots-to-proxy proxy native-structure (g-boxed-cstruct-wrapper-info-cstruct-description info))
158 (when (g-boxed-foreign-return-p type)
159 (boxed-free-fn info native-structure))
162 (defmethod cleanup-translated-object-for-callback ((type boxed-cstruct-foreign-type) proxy native-structure)
164 (let ((info (g-boxed-foreign-info type)))
165 (copy-slots-to-native proxy native-structure (g-boxed-cstruct-wrapper-info-cstruct-description info)))))
167 (eval-when (:compile-toplevel :load-toplevel :execute)
168 (defstruct (g-boxed-opaque-wrapper-info (:include g-boxed-info))
171 (define-foreign-type boxed-opaque-foreign-type (g-boxed-foreign-type) ())
173 (defclass g-boxed-opaque ()
174 ((pointer :initarg :pointer
176 :accessor g-boxed-opaque-pointer)))
178 (defmethod make-foreign-type ((info g-boxed-opaque-wrapper-info) &key return-p)
179 (make-instance 'boxed-opaque-foreign-type :info info :return-p return-p))
181 (defmethod translate-to-foreign (proxy (type boxed-opaque-foreign-type))
182 (prog1 (g-boxed-opaque-pointer proxy)
183 (when (g-boxed-foreign-return-p type)
184 (tg:cancel-finalization proxy)
185 (setf (g-boxed-opaque-pointer proxy) nil))))
187 (defmethod free-translated-object (native (type boxed-opaque-foreign-type) param)
188 (declare (ignore native type param)))
190 (defun make-boxed-free-finalizer (type pointer)
191 (lambda () (boxed-free-fn type pointer)))
193 (defmethod translate-from-foreign (native (foreign-type boxed-opaque-foreign-type))
194 (let* ((type (g-boxed-foreign-info foreign-type))
195 (proxy (make-instance (g-boxed-info-name type) :pointer native)))
196 (tg:finalize proxy (make-boxed-free-finalizer type native))))
198 (defmethod cleanup-translated-object-for-callback ((type boxed-opaque-foreign-type) proxy native)
199 (tg:cancel-finalization proxy)
200 (setf (g-boxed-opaque-pointer proxy) nil))
202 (defmacro define-g-boxed-opaque (name g-type-name &key
203 (alloc (error "Alloc must be specified")))
204 (let ((native-copy (gensym "NATIVE-COPY-"))
205 (instance (gensym "INSTANCE-"))
206 (finalizer (gensym "FINALIZER-")))
207 `(progn (defclass ,name (g-boxed-opaque) ())
208 (defmethod initialize-instance :after ((,instance ,name) &key &allow-other-keys)
209 (unless (g-boxed-opaque-pointer ,instance)
210 (let ((,native-copy ,alloc))
211 (flet ((,finalizer () (boxed-free-fn ,g-type-name ,native-copy)))
212 (setf (g-boxed-opaque-pointer ,instance) ,native-copy)
213 (finalize ,instance (make-boxed-free-finalizer (get ',name 'g-boxed-foreign-info) ,native-copy))))))
214 (eval-when (:compile-toplevel :load-toplevel :execute)
215 (setf (get ',name 'g-boxed-foreign-info)
216 (make-g-boxed-opaque-wrapper-info :name ',name
217 :g-type ,g-type-name)
218 (gethash ,g-type-name *g-type-name->g-boxed-foreign-info*)
219 (get ',name 'g-boxed-foreign-info))))))
221 (defstruct var-structure
227 resulting-cstruct-description)
229 (defstruct var-structure-variant
230 discriminating-values
233 (defmethod make-load-form ((object var-structure) &optional env)
234 (make-load-form-saving-slots object :environment env))
236 (defmethod make-load-form ((object var-structure-variant) &optional env)
237 (make-load-form-saving-slots object :environment env))
239 (defun var-struct-all-slots (struct)
241 (append (var-struct-all-slots (var-structure-parent struct))
242 (var-structure-slots struct))))
244 (defun all-structures (structure)
245 (append (iter (for variant in (var-structure-variants structure))
246 (appending (all-structures (var-structure-variant-structure variant))))
249 (defun parse-variant-structure-definition (name slots &optional parent)
250 (iter (with result = (make-var-structure :name name
253 :discriminator-slot nil
256 (if (eq :variant (first slot))
258 (when (var-structure-discriminator-slot result)
259 (error "Structure has more than one discriminator slot"))
260 (setf (var-structure-discriminator-slot result) (second slot)
261 (var-structure-variants result) (parse-variants result (nthcdr 2 slot))))
262 (push (parse-cstruct-slot slot) (var-structure-slots result)))
263 (finally (setf (var-structure-slots result)
264 (reverse (var-structure-slots result)))
266 (set-variant-result-structure result))
269 (defun set-variant-result-structure (var-structure)
270 (setf (var-structure-resulting-cstruct-description var-structure)
271 (make-cstruct-description
273 (var-structure-name var-structure)
276 (when (var-structure-parent var-structure)
277 (cstruct-description-slots (var-structure-resulting-cstruct-description (var-structure-parent var-structure))))
278 (var-structure-slots var-structure))))
279 (iter (for variant in (var-structure-variants var-structure))
280 (for child-var-structure = (var-structure-variant-structure variant))
281 (set-variant-result-structure child-var-structure)))
283 (defun ensure-list (thing)
288 (defun parse-variants (parent variants)
289 (iter (for var-descr in variants)
290 (for (options variant-name . slots) in variants)
292 (make-var-structure-variant
293 :discriminating-values (ensure-list options)
294 :structure (parse-variant-structure-definition variant-name slots parent)))
297 (defun generated-cstruct-name (symbol)
298 (or (get symbol 'generated-cstruct-name)
299 (setf (get symbol 'generated-cstruct-name) (gensym (format nil "GEN-~A-CSTRUCT-" (symbol-name symbol))))))
301 (defun generated-cunion-name (symbol)
302 (or (get symbol 'generated-cunion-name)
303 (setf (get symbol 'generated-cunion-name) (gensym (format nil "GEN-~A-CUNION-" (symbol-name symbol))))))
305 (defun generate-cstruct-1 (struct)
306 `(defcstruct ,(generated-cstruct-name (cstruct-description-name struct))
307 ,@(iter (for slot in (cstruct-description-slots struct))
308 (collect `(,(cstruct-slot-description-name slot) ,(cstruct-slot-description-type slot)
309 ,@(when (cstruct-slot-description-count slot)
310 `(:count ,(cstruct-slot-description-count slot))))))))
312 (defun generate-c-structures (structure)
313 (iter (for str in (all-structures structure))
314 (for cstruct = (var-structure-resulting-cstruct-description str))
315 (collect (generate-cstruct-1 cstruct))))
317 (defun generate-variant-union (struct)
318 `(defcunion ,(generated-cunion-name (var-structure-name struct))
319 ,@(iter (for str in (all-structures struct))
320 (collect `(,(var-structure-name str)
321 ,(generated-cstruct-name (var-structure-name str)))))))
323 (defun generate-structure-1 (str)
324 `(defstruct ,(if (var-structure-parent str)
325 `(,(var-structure-name str) (:include ,(var-structure-name (var-structure-parent str))
326 (,(var-structure-discriminator-slot (var-structure-parent str))
327 ,(first (var-structure-variant-discriminating-values
329 (var-structure-variants
330 (var-structure-parent str))
331 :key #'var-structure-variant-structure))))))
332 `,(var-structure-name str))
333 ,@(iter (for slot in (var-structure-slots str))
334 (collect `(,(cstruct-slot-description-name slot)
335 ,(cstruct-slot-description-initform slot))))))
337 (defun generate-structures (str)
338 (iter (for variant in (reverse (all-structures str)))
339 (collect (generate-structure-1 variant))))
341 (defun generate-native-type-decision-procedure-1 (str proxy-var)
342 (if (null (var-structure-discriminator-slot str))
343 `(values ',(var-structure-resulting-cstruct-description str))
344 `(typecase ,proxy-var
345 ,@(iter (for variant in (var-structure-variants str))
346 (for v-str = (var-structure-variant-structure variant))
347 (collect `(,(var-structure-name v-str)
348 ,(generate-native-type-decision-procedure-1 v-str proxy-var))))
349 (,(var-structure-name str)
350 (values ',(var-structure-resulting-cstruct-description str))))))
352 (defun generate-proxy-type-decision-procedure-1 (str native-var)
353 (if (null (var-structure-discriminator-slot str))
354 `(values ',(var-structure-name str)
355 ',(var-structure-resulting-cstruct-description str))
356 `(case (foreign-slot-value ,native-var
357 ',(generated-cstruct-name (var-structure-name str))
358 ',(var-structure-discriminator-slot str))
359 ,@(iter (for variant in (var-structure-variants str))
360 (for v-str = (var-structure-variant-structure variant))
361 (collect `(,(var-structure-variant-discriminating-values variant)
362 ,(generate-proxy-type-decision-procedure-1
365 (t (values ',(var-structure-name str)
366 ',(var-structure-resulting-cstruct-description str))))))
368 (defun generate-proxy-type-decision-procedure (str)
369 (let ((native (gensym "NATIVE-")))
371 ,(generate-proxy-type-decision-procedure-1 str native))))
373 (defun generate-native-type-decision-procedure (str)
374 (let ((proxy (gensym "PROXY-")))
376 ,(generate-native-type-decision-procedure-1 str proxy))))
378 (defun compile-proxy-type-decision-procedure (str)
379 (compile nil (generate-proxy-type-decision-procedure str)))
381 (defun compile-native-type-decision-procedure (str)
382 (compile nil (generate-native-type-decision-procedure str)))
384 (defstruct (g-boxed-variant-cstruct-info (:include g-boxed-info))
386 native-type-decision-procedure
387 proxy-type-decision-procedure)
389 (defmethod make-load-form ((object g-boxed-variant-cstruct-info) &optional env)
390 (make-load-form-saving-slots object :environment env))
392 (define-foreign-type boxed-variant-cstruct-foreign-type (g-boxed-foreign-type) ())
394 (defmethod make-foreign-type ((info g-boxed-variant-cstruct-info) &key return-p)
395 (make-instance 'boxed-variant-cstruct-foreign-type :info info :return-p return-p))
397 (defmacro define-g-boxed-variant-cstruct (name g-type-name &body slots)
398 (let* ((structure (parse-variant-structure-definition name slots)))
399 `(progn ,@(generate-c-structures structure)
400 ,(generate-variant-union structure)
401 ,@(generate-structures structure)
402 (eval-when (:compile-toplevel :load-toplevel :execute)
403 (setf (get ',name 'g-boxed-foreign-info)
404 (make-g-boxed-variant-cstruct-info :name ',name
407 :native-type-decision-procedure
408 ,(generate-native-type-decision-procedure structure)
409 :proxy-type-decision-procedure
410 ,(generate-proxy-type-decision-procedure structure))
411 (gethash ,g-type-name *g-type-name->g-boxed-foreign-info*)
412 (get ',name 'g-boxed-foreign-info))))))
414 (defun decide-native-type (info proxy)
415 (funcall (g-boxed-variant-cstruct-info-native-type-decision-procedure info) proxy))
417 (defmethod boxed-copy-fn ((info g-boxed-variant-cstruct-info) native)
418 (if (g-boxed-info-g-type info)
419 (g-boxed-copy (g-boxed-info-g-type info) native)
420 (let ((copy (foreign-alloc (generated-cunion-name (g-boxed-info-name info)))))
421 (memcpy copy native (foreign-type-size (generated-cunion-name (g-boxed-info-name info))))
424 (defmethod boxed-free-fn ((info g-boxed-variant-cstruct-info) native)
425 (if (g-boxed-info-g-type info)
426 (g-boxed-free (g-boxed-info-g-type info) native)
427 (foreign-free native)))
429 (defmethod translate-to-foreign (proxy (foreign-type boxed-variant-cstruct-foreign-type))
432 (let* ((type (g-boxed-foreign-info foreign-type))
433 (cstruct-description (decide-native-type type proxy)))
434 (with-foreign-object (native-structure (generated-cstruct-name
436 (g-boxed-variant-cstruct-info-root type))))
437 (copy-slots-to-native proxy native-structure cstruct-description)
438 (values (boxed-copy-fn type native-structure) proxy)))))
440 (defun decide-proxy-type (info native-structure)
441 (funcall (g-boxed-variant-cstruct-info-proxy-type-decision-procedure info) native-structure))
443 (defmethod free-translated-object (native (foreign-type boxed-variant-cstruct-foreign-type) proxy)
445 (let ((type (g-boxed-foreign-info foreign-type)))
446 (multiple-value-bind (actual-struct cstruct-description) (decide-proxy-type type native)
447 (unless (eq (type-of proxy) (cstruct-description-name actual-struct))
449 (error "Expected type of boxed variant structure ~A and actual type ~A do not match"
450 (type-of proxy) actual-struct)
451 (skip-parsing-values () (return-from free-translated-object))))
452 (copy-slots-to-proxy proxy native cstruct-description)))))
454 (defmethod translate-from-foreign (native (foreign-type boxed-variant-cstruct-foreign-type))
455 (unless (null-pointer-p native)
456 (let ((type (g-boxed-foreign-info foreign-type)))
457 (multiple-value-bind (actual-struct cstruct-description) (decide-proxy-type type native)
458 (let ((proxy (make-instance actual-struct)))
459 (copy-slots-to-proxy proxy native cstruct-description)
460 (when (g-boxed-foreign-return-p foreign-type)
461 (boxed-free-fn type native))
464 (defmethod cleanup-translated-object-for-callback ((foreign-type boxed-variant-cstruct-foreign-type) proxy native)
466 (let ((type (g-boxed-foreign-info foreign-type)))
467 (let ((cstruct-description (decide-native-type type proxy)))
468 (copy-slots-to-native proxy native cstruct-description)))))
470 (defgeneric boxed-parse-g-value (gvalue-ptr info))
472 (defgeneric boxed-set-g-value (gvalue-ptr info proxy))
474 (defmethod parse-g-value-for-type (gvalue-ptr (type-numeric (eql +g-type-boxed+)) parse-kind)
475 (declare (ignore parse-kind))
476 (if (g-type= (g-value-type gvalue-ptr) (g-strv-get-type))
477 (convert-from-foreign (g-value-get-boxed gvalue-ptr) '(glib:gstrv :free-from-foreign nil))
478 (let ((boxed-type (get-g-boxed-foreign-info-for-gtype type-numeric)))
479 (boxed-parse-g-value gvalue-ptr boxed-type))))
481 (defmethod set-gvalue-for-type (gvalue-ptr (type-numeric (eql +g-type-boxed+)) value)
482 (if (g-type= (g-value-type gvalue-ptr) (g-strv-get-type))
483 (g-value-set-boxed gvalue-ptr (convert-to-foreign value '(glib:gstrv :free-from-foreign nil)))
484 (let ((boxed-type (get-g-boxed-foreign-info-for-gtype type-numeric)))
485 (boxed-set-g-value gvalue-ptr boxed-type value))))
487 (defmethod boxed-parse-g-value (gvalue-ptr (info g-boxed-cstruct-wrapper-info))
488 (translate-from-foreign (g-value-get-boxed gvalue-ptr) (make-foreign-type info :return-p nil)))
490 (defmethod boxed-set-g-value (gvalue-ptr (info g-boxed-cstruct-wrapper-info) proxy)
491 (g-value-take-boxed gvalue-ptr (translate-to-foreign proxy (make-foreign-type info :return-p nil))))
493 (defmethod boxed-parse-g-value (gvalue-ptr (info g-boxed-variant-cstruct-info))
494 (translate-from-foreign (g-value-get-boxed gvalue-ptr) (make-foreign-type info :return-p nil)))
496 (defmethod boxed-set-g-value (gvalue-ptr (info g-boxed-variant-cstruct-info) proxy)
497 (g-value-take-boxed gvalue-ptr (translate-to-foreign proxy (make-foreign-type info :return-p nil))))
499 (defmethod boxed-parse-g-value (gvalue-ptr (info g-boxed-opaque-wrapper-info))
500 (translate-from-foreign (boxed-copy-fn info (g-value-get-boxed gvalue-ptr)) (make-foreign-type info :return-p nil)))
502 (defmethod boxed-set-g-value (gvalue-ptr (info g-boxed-opaque-wrapper-info) proxy)
503 (g-value-set-boxed gvalue-ptr (translate-to-foreign proxy (make-foreign-type info :return-p nil))))