5 :type cffi:foreign-pointer
11 :accessor g-object-has-reference
14 (defvar *foreign-gobjects* (make-weak-hash-table :test 'equal :weakness :value))
15 (defvar *foreign-gobjects-ref-count* (make-hash-table :test 'equal))
16 (defvar *lisp-objects-pointers* (make-hash-table :test 'equal))
17 (defvar *current-creating-object* nil)
19 (defcstruct g-object-struct
20 (type-instance g-type-instance)
24 (defun ref-count (pointer)
25 (foreign-slot-value (if (pointerp pointer) pointer (pointer pointer)) 'g-object-struct 'ref-count))
27 (defmethod initialize-instance :around ((obj g-object) &key)
28 (let ((*current-creating-object* obj))
31 (defmethod initialize-instance :after ((obj g-object) &key &allow-other-keys)
32 (unless (slot-boundp obj 'pointer)
33 (error "Pointer slot is not initialized for ~A" obj))
34 (let* ((pointer (pointer obj))
35 (s (format nil "~A" obj)))
39 (g-object-dispose-carefully pointer)
40 (error (e) (format t "Error in finalizer for ~A: ~A~%" s e))))))
41 (register-g-object obj)
44 (defvar *gobject-gc-hooks-lock* (make-recursive-lock "gobject-gc-hooks-lock"))
45 (defvar *gobject-gc-hooks* nil);;pointers to objects to be freed
47 (defun activate-gc-hooks ()
48 (with-recursive-lock-held (*gobject-gc-hooks-lock*)
49 (when *gobject-gc-hooks*
50 (debugf "activating gc hooks for objects: ~A~%" *gobject-gc-hooks*)
52 for pointer in *gobject-gc-hooks*
53 do (g-object-unref pointer))
54 (setf *gobject-gc-hooks* nil))))
56 (defcallback g-idle-gc-hook :boolean ((data :pointer))
57 (declare (ignore data))
61 (defun register-gobject-for-gc (pointer)
62 (with-recursive-lock-held (*gobject-gc-hooks-lock*)
63 (let ((locks-were-present (not (null *gobject-gc-hooks*))))
64 (push pointer *gobject-gc-hooks*)
65 (unless locks-were-present
66 (debugf "adding idle-gc-hook to main loop~%")
67 (glib::g-idle-add (callback g-idle-gc-hook) (null-pointer))))))
69 (defun g-object-dispose-carefully (pointer)
71 (register-gobject-for-gc pointer)
72 (error (e) (format t "Error in dispose: ~A~%" e))))
74 (defcallback weak-notify-print :void ((data :pointer) (object-pointer :pointer))
75 (declare (ignore data))
76 (debugf "g-object has finalized ~A ~A~%" (g-type-name (g-type-from-object object-pointer)) object-pointer))
78 (defun erase-pointer (data object-pointer)
79 (declare (ignore data))
80 (remhash (pointer-address object-pointer) *lisp-objects-pointers*))
82 (defcallback weak-notify-erase-pointer :void ((data :pointer) (object-pointer :pointer))
83 (erase-pointer data object-pointer))
85 (defun should-ref-sink-at-creation (object)
86 ;;If object was not created from lisp-side, we should ref it
87 ;;If an object is regular g-object, we should not ref-sink it
88 ;;If an object is GInitiallyUnowned, then it is created with a floating reference, we should ref-sink it
89 ;;A special case is GtkWindow: we should ref-sink it anyway
90 (if (g-object-has-reference object)
91 (let ((object-type (g-type-from-object (pointer object)))
92 (initially-unowned-type (g-type-from-name "GInitiallyUnowned")))
93 (g-type-is-a object-type initially-unowned-type))
96 (defun register-g-object (obj)
97 (debugf "registered GObject ~A with gobject ref-count ~A ~A~%" (pointer obj) (ref-count obj) (if (g-object-is-floating (pointer obj)) "(floating)" ""))
98 (when (should-ref-sink-at-creation obj)
99 (debugf "g_object_ref_sink(~A)~%" (pointer obj))
100 (g-object-ref-sink (pointer obj)))
101 (g-object-weak-ref (pointer obj) (callback weak-notify-print) (null-pointer))
102 (g-object-weak-ref (pointer obj) (callback weak-notify-erase-pointer) (null-pointer))
103 (setf (g-object-has-reference obj) t)
104 (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects*)
106 (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects-ref-count*) 1))
108 (defun g-object-dispose (pointer)
109 (unless (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
110 (debugf "GObject ~A is already disposed, signalling error~%" pointer)
111 (error "GObject ~A is already disposed" pointer))
112 (debugf "g_object_unref(~A) (of type ~A, lisp-value ~A) (lisp ref-count ~A, gobject ref-count ~A)~%"
114 (g-type-name (g-type-from-object pointer))
115 (gethash (pointer-address pointer) *foreign-gobjects*)
116 (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
118 (awhen (gethash (pointer-address pointer) *foreign-gobjects*)
119 (setf (pointer it) nil)
120 (cancel-finalization it))
121 (remhash (pointer-address pointer) *foreign-gobjects*)
122 (remhash (pointer-address pointer) *foreign-gobjects-ref-count*)
123 (g-object-unref pointer))
125 (defmethod release ((object g-object))
126 (debugf "Releasing object ~A (type ~A, lisp-value ~A)~%" (pointer object) (when (pointer object) (g-type-name (g-type-from-object (pointer object)))) object)
127 (unless (and (pointer object) (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
128 (error "Object ~A already disposed of from lisp side" object))
129 (decf (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
130 (when (zerop (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
131 (g-object-dispose (pointer object)))
134 (defvar *registered-object-types* (make-hash-table :test 'equal))
135 (defun register-object-type (name type)
136 (setf (gethash name *registered-object-types*) type))
137 (defun get-g-object-lisp-type (g-type)
139 while (not (zerop g-type))
140 for lisp-type = (gethash (g-type-name g-type) *registered-object-types*)
141 when lisp-type do (return lisp-type)
142 do (setf g-type (g-type-parent g-type))))
144 (defun make-g-object-from-pointer (pointer)
145 (let* ((g-type (g-type-from-instance pointer))
146 (lisp-type (get-g-object-lisp-type g-type)))
148 (error "Type ~A is not registered with REGISTER-OBJECT-TYPE"
149 (g-type-name g-type)))
150 (make-instance lisp-type :pointer pointer)))
152 (define-foreign-type foreign-g-object-type ()
153 ((sub-type :reader sub-type :initarg :sub-type :initform 'g-object))
154 (:actual-type :pointer))
156 (define-parse-method g-object (&optional (sub-type 'g-object))
157 (make-instance 'foreign-g-object-type :sub-type sub-type))
159 (defmethod translate-to-foreign (object (type foreign-g-object-type))
161 ((null (pointer object))
162 (error "Object ~A has been disposed" object))
163 ((typep object 'g-object)
164 (assert (typep object (sub-type type))
166 "Object ~A is not a subtype of ~A" object (sub-type type))
168 ((pointerp object) object)
169 (t (error "Object ~A is not translatable as GObject*" object))))
171 (defun get-g-object-for-pointer (pointer)
172 (unless (null-pointer-p pointer)
173 (aif (gethash (pointer-address pointer) *foreign-gobjects*)
175 (incf (gethash (pointer-address pointer) *foreign-gobjects-ref-count*))
176 (debugf "increfering object ~A~%" pointer))
177 (make-g-object-from-pointer pointer))))
179 (defmethod translate-from-foreign (pointer (type foreign-g-object-type))
180 (get-g-object-for-pointer pointer))
182 (register-object-type "GObject" 'g-object)
184 (defun ensure-g-type (type)
187 (string (or (g-type-from-name type)
188 (error "Type ~A is invalid" type)))))
190 (defun ensure-object-pointer (object)
191 (if (pointerp object)
194 (g-object (pointer object)))))
196 (defun g-object-type-property-type (object-type property-name
197 &key assert-readable assert-writable)
198 (let* ((object-class (g-type-class-ref object-type))
199 (param-spec (g-object-class-find-property object-class property-name)))
202 (when (null-pointer-p param-spec)
203 (error "Property ~A on type ~A is not found"
205 (g-type-name object-type)))
206 (when (and assert-readable
207 (not (member :readable
208 (foreign-slot-value param-spec
211 (error "Property ~A on type ~A is not readable"
213 (g-type-name object-type)))
214 (when (and assert-writable
215 (not (member :writable
216 (foreign-slot-value param-spec
219 (error "Property ~A on type ~A is not writable"
221 (g-type-name object-type)))
222 (foreign-slot-value param-spec 'g-param-spec 'value-type))
223 (g-type-class-unref object-class))))
225 (defun g-object-property-type (object property-name
226 &key assert-readable assert-writable)
227 (g-object-type-property-type (g-type-from-object (ensure-object-pointer object))
229 :assert-readable assert-readable
230 :assert-writable assert-writable))
232 (defun g-object-call-constructor (object-type args-names args-values
233 &optional args-types)
234 (setf object-type (ensure-g-type object-type))
237 (mapcar (lambda (name)
238 (g-object-type-property-type object-type name))
240 (let ((args-count (length args-names)))
241 (with-foreign-object (parameters 'g-parameter args-count)
243 for i from 0 below args-count
244 for arg-name in args-names
245 for arg-value in args-values
246 for arg-type in args-types
247 for arg-g-type = (ensure-g-type arg-type)
248 for parameter = (mem-aref parameters 'g-parameter i)
249 do (setf (foreign-slot-value parameter 'g-parameter 'name) arg-name)
250 do (set-g-value (foreign-slot-value parameter 'g-parameter 'value)
254 (g-object-newv object-type args-count parameters)
256 for i from 0 below args-count
257 for parameter = (mem-aref parameters 'g-parameter i)
259 (mem-ref (foreign-slot-pointer parameter 'g-parameter 'name)
262 (foreign-slot-pointer parameter 'g-parameter 'value)))))))
264 (defun g-object-call-get-property (object property-name &optional property-type)
265 (unless property-type
267 (g-object-property-type object property-name :assert-readable t)))
268 (setf property-type (ensure-g-type property-type))
269 (with-foreign-object (value 'g-value)
271 (g-value-init value property-type)
272 (g-object-get-property (ensure-object-pointer object)
276 (g-value-unset value))))
278 (defun g-object-call-set-property (object property-name new-value
279 &optional property-type)
280 (unless property-type
282 (g-object-property-type object property-name :assert-writable t)))
283 (setf property-type (ensure-g-type property-type))
284 (with-foreign-object (value 'g-value)
285 (set-g-value value new-value property-type :zero-g-value t)
287 (g-object-set-property (ensure-object-pointer object)
289 (g-value-unset value))))