3 (defun ensure-list (thing)
4 (if (listp thing) thing (list thing)))
6 (defun slot->cstruct-slot (slot)
7 (destructuring-bind (name type &key &allow-other-keys) slot
10 (defun slot->slot-name (slot)
11 (destructuring-bind (name type &key &allow-other-keys) slot
12 (declare (ignore type))
15 (defun cstruct-definition (name slots)
16 `(defcstruct ,name ,@(mapcar #'slot->cstruct-slot slots)))
18 (defun maybe-unlist (thing)
19 (if (or (not (listp thing)) (cdr thing))
23 (defun slot->struct-slot (slot)
24 (destructuring-bind (name type &key initform &allow-other-keys) slot
25 (declare (ignore type))
26 (maybe-unlist `(,name ,@(when initform (list initform))))))
28 (defun struct-definition (name superclass slots)
29 `(defstruct ,@(if superclass
30 (list `(,name (:include ,superclass)))
32 ,@(mapcar #'slot->struct-slot slots)))
34 (define-foreign-type g-boxed-pointer-type ()
35 ((name :accessor g-boxed-pointer-type-name :initarg :name)
36 (outp :accessor g-boxed-pointer-type-outp :initarg :outp)))
38 (define-parse-method g-boxed-ptr (name &optional (type :in))
39 (make-instance 'g-boxed-pointer-type :name name :actual-type :pointer :outp (ecase type
43 (defmethod translate-from-foreign (value (type g-boxed-pointer-type))
44 (unless (null-pointer-p value)
45 (parse-g-boxed value (g-boxed-pointer-type-name type))))
47 (defmethod translate-to-foreign (value (type g-boxed-pointer-type))
48 (let ((ptr (foreign-alloc (boxed-c-structure-name (g-boxed-pointer-type-name type)))))
49 (real-unparse-g-boxed ptr value)
52 (defmethod free-translated-object (ptr (type g-boxed-pointer-type) param)
53 (when (g-boxed-pointer-type-outp type)
54 (let ((original-object param)
55 (new-real-name (g-boxed-real-name ptr (g-boxed-pointer-type-name type))))
56 (if (eq new-real-name (type-of original-object))
57 (real-parse-g-boxed ptr original-object)
58 (error "Type has changed!"))))
61 (defmethod expand-to-foreign-dyn (value var body (type g-boxed-pointer-type))
62 (let ((value-var (gensym)))
63 `(with-foreign-object (,var ',(boxed-c-structure-name (g-boxed-pointer-type-name type)))
64 (let ((,value-var ,value))
65 (real-unparse-g-boxed ,var ,value-var)
67 ,@(when (g-boxed-pointer-type-outp type)
68 (list `(let ((new-real-name (g-boxed-real-name ,var ',(g-boxed-pointer-type-name type))))
69 (if (eq new-real-name (type-of ,value-var))
70 (real-parse-g-boxed ,var ,value-var)
71 (error "Type has changed from ~A to ~A" (type-of ,value-var) new-real-name)))))))))
73 (define-foreign-type g-boxed-inline-type ()
74 ((name :accessor g-boxed-inline-type :initarg :name)))
76 (define-parse-method g-boxed-inline (name)
77 (make-instance 'g-boxed-inline-type :name name :actual-type name))
79 (defgeneric real-parse-g-boxed (pointer object))
80 (defgeneric real-unparse-g-boxed (pointer object))
82 (defun parse-g-boxed (pointer name)
83 (let* ((real-name (g-boxed-real-name pointer name))
84 (object (make-instance real-name)))
85 (real-parse-g-boxed pointer object)
88 (defun g-boxed->cstruct (object)
89 (let ((pointer (foreign-alloc (type-of object))))
90 (real-unparse-g-boxed pointer object)
93 (defun g-boxed-real-name (pointer name)
95 for (sub-name slot values) in (get name 'boxed-dispatch)
96 do (debugf "Checking ~A ~A ~A against ~A.~A = ~A~%" sub-name slot values name slot (foreign-slot-value pointer name slot))
97 when (member (foreign-slot-value pointer name slot) values :test 'equalp)
98 return (g-boxed-real-name pointer sub-name))
101 (defun slot->slot-parser (class-name pointer-var slot)
102 (bind (((slot-name slot-type &key parser &allow-other-keys) slot))
105 `(setf ,slot-name (funcall ,parser ',class-name ,pointer-var)))
106 ((and (listp slot-type) (eq 'g-boxed-inline (first slot-type)))
107 `(setf ,slot-name (parse-g-boxed (foreign-slot-pointer ,pointer-var ',class-name ',slot-name) ',(second slot-type))))
109 `(setf ,slot-name (foreign-slot-value ,pointer-var ',class-name ',slot-name))))))
111 (defun parse-method-definition (name slots)
112 (let ((slot-names (mapcar #'slot->slot-name slots)))
113 `(defmethod real-parse-g-boxed (pointer (object ,name))
114 (with-slots (,@slot-names) object
115 ,@(mapcar (lambda (slot) (slot->slot-parser name 'pointer slot)) slots)))))
117 (defun slot->slot-unparser (class-name pointer-var slot object)
118 (bind (((slot-name slot-type &key unparser &allow-other-keys) slot))
121 `(funcall ,unparser ',class-name ,pointer-var ,object))
122 ((and (listp slot-type) (eq 'g-boxed-inline (first slot-type)))
123 `(real-unparse-g-boxed (foreign-slot-pointer ,pointer-var ',class-name ',slot-name) ,slot-name))
125 `(setf (foreign-slot-value ,pointer-var ',class-name ',slot-name) ,slot-name)))))
127 (defun unparse-method-definition (name slots)
128 (let ((slot-names (mapcar #'slot->slot-name slots)))
129 `(defmethod real-unparse-g-boxed (pointer (object ,name))
130 (with-slots (,@slot-names) object
131 ,@(mapcar (lambda (slot) (slot->slot-unparser name 'pointer slot 'object)) slots)))))
133 (defun slot->export-accessor (class-name slot)
134 (destructuring-bind (slot-name slot-type &key &allow-other-keys) slot
135 (declare (ignore slot-type))
136 (let ((accessor-name (intern (format nil "~A-~A" (symbol-name class-name) (symbol-name slot-name))
137 (symbol-package class-name))))
138 `(export ',accessor-name (symbol-package ',accessor-name)))))
140 (defun struct-constructor-name (name)
141 (intern (format nil "MAKE-~A" (symbol-name name)) (symbol-package name)))
143 (defun get-g-boxed-direct-subclasses (name)
144 (mapcar (lambda (spec) (bind (((name slot values) spec))
145 (declare (ignore slot values))
147 (get name 'boxed-dispatch)))
149 (defun map-append (f &rest lists)
150 (reduce #'append (apply #'mapcar f lists)))
152 (defun get-g-boxed-all-subclasses (name)
154 (map-append #'get-g-boxed-all-subclasses (get-g-boxed-direct-subclasses name))))
156 (defun get-g-boxed-completed-c-definition (name union-name)
157 `(defcunion ,union-name
158 ,@(mapcar (lambda (sub-name)
159 `(,sub-name ,sub-name))
160 (get-g-boxed-all-subclasses name))))
162 (defun g-boxed-root (name)
163 (if (get name 'superclass)
164 (g-boxed-root (get name 'superclass))
167 (defmacro update-g-boxed-root-c-class (name)
168 (when (get name 'c-name)
169 (get-g-boxed-completed-c-definition (g-boxed-root name) (get name 'c-name))))
171 (defmacro define-g-boxed-class (g-name-and-c-name name (&optional superclass-and-dispatch (export t)) &body slots)
172 (bind (((&optional g-name c-name) (ensure-list g-name-and-c-name))
173 ((&optional superclass dispatch-slot dispatch-values) superclass-and-dispatch)
174 (superclass-slots (get superclass 'boxed-combined-slots))
175 (combined-slots (append superclass-slots slots)))
176 (setf c-name (or c-name (gensym "C-UNION-")))
177 `(progn ,(cstruct-definition name combined-slots)
178 ,(struct-definition name superclass slots)
179 ,(parse-method-definition name combined-slots)
180 ,(unparse-method-definition name combined-slots)
181 (eval-when (:load-toplevel :compile-toplevel :execute)
182 (setf (get ',name 'boxed-slots) ',slots
183 (get ',name 'boxed-combined-slots) ',combined-slots
184 (get ',name 'superclass) ',superclass
185 (get ',name 'c-name) (or (get ',name 'c-name) ',c-name))
187 (list `(pushnew '(,name ,dispatch-slot ,(ensure-list dispatch-values)) (get ',superclass 'boxed-dispatch) :test 'equalp))))
188 (update-g-boxed-root-c-class ,name)
190 (list `(register-boxed-type ,g-name ',name)))
192 (append (list `(export ',name (symbol-package ',name))
193 `(export ',(struct-constructor-name name) (symbol-package ',(struct-constructor-name name))))
194 (mapcar (lambda (slot) (slot->export-accessor name slot)) slots))))))
196 (defun boxed-c-structure-name (name)
197 (get (g-boxed-root name) 'c-name))
199 (defclass g-boxed-ref () ((pointer :accessor pointer :initarg :pointer)))
201 (defvar *known-boxed-refs* (tg:make-weak-hash-table :test 'equal :weakness :value))
202 (defvar *boxed-ref-count* (make-hash-table :test 'equal))
203 (defvar *boxed-ref-owner* (make-hash-table :test 'equal))
205 (defun boxed-ref-free-function (name)
206 (or (get name 'free-function)
207 (error "g-boxed-ref class ~A has no free-function" name)))
209 (defun disown-boxed-ref (object)
210 (setf (gethash (pointer-address (pointer object)) *boxed-ref-owner*) :foreign))
212 (defun dispose-boxed-ref (type pointer)
213 (debugf "disposing g-boxed-ref ~A~%" pointer)
214 (unless (gethash (pointer-address pointer) *boxed-ref-count*)
215 (error "g-boxed-ref ~A is already disposed from lisp-side" pointer))
216 ;;This actually turned out to be wrong
218 (unless (zerop (gethash (pointer-address pointer) *boxed-ref-count*))
219 (error "g-boxed-ref ~A is being disposed too early, it has still ~A references from lisp-side"
220 (pointer-address pointer)
221 (gethash (pointer-address pointer) *boxed-ref-count*)))
222 (aif (gethash (pointer-address pointer) *known-boxed-refs*)
223 (tg:cancel-finalization it))
224 (when (eq :lisp (gethash (pointer-address pointer) *boxed-ref-owner*))
225 (funcall (boxed-ref-free-function type) pointer))
226 (remhash (pointer-address pointer) *known-boxed-refs*)
227 (remhash (pointer-address pointer) *boxed-ref-count*)
228 (remhash (pointer-address pointer) *boxed-ref-owner*))
230 (defmethod initialize-instance :after ((object g-boxed-ref) &key)
231 (let ((address (pointer-address (pointer object))))
232 (setf (gethash address *known-boxed-refs*) object)
233 (setf (gethash address *boxed-ref-count*) 1)
234 (setf (gethash address *boxed-ref-owner*)
235 (gethash address *boxed-ref-owner* :foreign)))
236 (debugf "setting g-boxed-ref-count of ~A to 1~%" (pointer object))
237 (let ((p (pointer object))
238 (type (type-of object))
239 (s (format nil "~A" object)))
240 (tg:finalize object (lambda ()
242 (dispose-boxed-ref type p)
243 (error (e) (format t "Error ~A for ~A~%" e s)))))))
245 (defmethod release ((object g-boxed-ref))
246 (debugf "releasing g-boxed-ref ~A~%" (pointer object))
247 (unless (gethash (pointer-address (pointer object)) *boxed-ref-count*)
248 (error "g-boxed-ref ~A is already disposed from lisp-side" (pointer object)))
249 (decf (gethash (pointer-address (pointer object)) *boxed-ref-count*))
250 (when (zerop (gethash (pointer-address (pointer object)) *boxed-ref-count*))
251 (dispose-boxed-ref (type-of object) (pointer object))))
253 (define-foreign-type g-boxed-ref-type ()
254 ((class-name :reader g-boxed-ref-class-name :initarg :class-name)
255 (owner :reader g-boxed-ref-owner :initarg :owner :initform nil))
256 (:actual-type :pointer))
258 (define-parse-method g-boxed-ref (class-name &key (owner :foreign))
259 (unless (get class-name 'is-g-boxed-ref)
260 (error "~A is not a subtype of G-BOXED-REF (~A: ~S)" class-name class-name (symbol-plist class-name)))
261 (make-instance 'g-boxed-ref-type :class-name class-name :owner owner))
263 (defmethod translate-to-foreign (value (type g-boxed-ref-type))
268 (defun convert-g-boxed-ref-from-pointer (pointer name type)
269 (unless (null-pointer-p pointer)
270 (or (gethash (pointer-address pointer) *known-boxed-refs*)
271 (prog1 (make-instance name :pointer pointer)
272 (setf (gethash (pointer-address pointer) *boxed-ref-owner*) (g-boxed-ref-owner type))))))
274 (defmethod translate-from-foreign (value (type g-boxed-ref-type))
275 (let ((owner (or (gethash (pointer-address value) *boxed-ref-owner*) (g-boxed-ref-owner type)))) ;;This is needed to prevent changing ownership of already created
277 (convert-g-boxed-ref-from-pointer value (g-boxed-ref-class-name type) type)
278 (setf (gethash (pointer-address value) *boxed-ref-owner*) owner))))
280 (defun g-boxed-ref-slot->methods (class slot)
281 (bind (((slot-name &key reader writer type) slot))
282 `(progn ,@(when reader
283 (list `(defmethod ,slot-name ((object ,class))
284 ,(if (stringp reader)
285 `(foreign-funcall ,reader :pointer (pointer object) ,type)
286 `(,reader object)))))
288 (list `(defmethod (setf ,slot-name) (new-value (object ,class))
289 ,(if (stringp writer)
290 `(foreign-funcall ,writer :pointer (pointer object) ,type new-value)
291 `(,writer new-value object))))))))
293 (defmacro define-g-boxed-ref (gobject-name name &rest properties)
294 (let ((free-fn (second (find :free-function properties :key 'first)))
295 (alloc-fn (second (find :alloc-function properties :key 'first)))
296 (slots (rest (find :slots properties :key 'first))))
297 (unless (and free-fn alloc-fn) (error "All of :free-function, :alloc-function must be specified"))
298 `(progn (defclass ,name (g-boxed-ref) ())
299 (defmethod initialize-instance :before ((object ,name) &key pointer)
300 (unless (or pointer (slot-boundp object 'pointer))
301 (setf (pointer object) (,alloc-fn)
302 (gethash (pointer-address (pointer object)) *boxed-ref-owner*) :lisp)))
303 (setf (get ',name 'free-function) ',free-fn)
304 (eval-when (:compile-toplevel :load-toplevel :execute)
305 (setf (get ',name 'is-g-boxed-ref) t))
306 ,@(mapcar (lambda (slot)
307 (g-boxed-ref-slot->methods name slot))
309 (register-boxed-type ,gobject-name ',name))))
311 (define-foreign-type fixed-array ()
312 ((element-type :reader fixed-array-element-type :initarg :element-type :initform (error "Element type must be specified"))
313 (array-size :reader fixed-array-array-size :initarg :array-size :initform (error "Array size must be specified")))
314 (:actual-type :pointer))
316 (define-parse-method fixed-array (element-type array-size)
317 (make-instance 'fixed-array :element-type element-type :array-size array-size))
319 (defmethod translate-from-foreign (ptr (type fixed-array))
320 (when (not (null-pointer-p ptr))
321 (let ((result (make-array (fixed-array-array-size type)))
322 (el-type (fixed-array-element-type type)))
324 for i from 0 below (fixed-array-array-size type)
325 do (setf (aref result i) (mem-aref ptr el-type i)))
328 (defvar *registered-boxed-types* (make-hash-table :test 'equal))
329 (defun register-boxed-type (name type)
330 (setf (gethash name *registered-boxed-types*) type))
331 (defun get-registered-boxed-type (name)
332 (gethash name *registered-boxed-types*))
334 (defun set-gvalue-boxed (gvalue value)
337 (unless (typep value 'g-boxed-ref) (error "Can only set g-boxed-ref!"))
338 (g-value-set-boxed gvalue (pointer value)))
339 (g-value-set-boxed gvalue (null-pointer))))
341 (defun parse-gvalue-boxed (gvalue)
342 (let* ((g-type (gvalue-type gvalue))
343 (type-name (g-type-name g-type))
344 (boxed-type (get-registered-boxed-type type-name)))
346 (warn t "Type ~A is a not registered GBoxed~%" type-name)
347 (return-from parse-gvalue-boxed nil))
348 (unless (null-pointer-p (g-value-get-boxed gvalue))
350 ((subtypep boxed-type 'g-boxed-ref) (convert-g-boxed-ref-from-pointer (g-value-get-boxed gvalue) boxed-type (make-instance 'g-boxed-ref-type :class-name boxed-type :owner :foreign)))
351 (t (parse-g-boxed (g-value-get-boxed gvalue) boxed-type))))))