5 :type cffi:foreign-pointer
11 :accessor g-object-has-reference
14 "Base class for GObject classes hierarchy."))
16 (defvar *foreign-gobjects* (make-weak-hash-table :test 'equal :weakness :value))
17 (defvar *foreign-gobjects-ref-count* (make-hash-table :test 'equal))
18 (defvar *lisp-objects-pointers* (make-hash-table :test 'equal))
19 (defvar *current-creating-object* nil)
21 (defun ref-count (pointer)
22 (foreign-slot-value (if (pointerp pointer) pointer (pointer pointer)) 'g-object-struct :ref-count))
24 (defmethod initialize-instance :around ((obj g-object) &key)
25 (let ((*current-creating-object* obj))
28 (defmethod initialize-instance :after ((obj g-object) &key &allow-other-keys)
29 (unless (slot-boundp obj 'pointer)
30 (error "Pointer slot is not initialized for ~A" obj))
31 (let* ((pointer (pointer obj))
32 (s (format nil "~A" obj)))
36 (g-object-dispose-carefully pointer)
37 (error (e) (format t "Error in finalizer for ~A: ~A~%" s e))))))
38 (register-g-object obj)
41 (defvar *gobject-gc-hooks-lock* (make-recursive-lock "gobject-gc-hooks-lock"))
42 (defvar *gobject-gc-hooks* nil);;pointers to objects to be freed
44 (defun activate-gc-hooks ()
45 (with-recursive-lock-held (*gobject-gc-hooks-lock*)
46 (when *gobject-gc-hooks*
47 (debugf "activating gc hooks for objects: ~A~%" *gobject-gc-hooks*)
49 for pointer in *gobject-gc-hooks*
50 do (g-object-unref pointer))
51 (setf *gobject-gc-hooks* nil))))
53 (defcallback g-idle-gc-hook :boolean ((data :pointer))
54 (declare (ignore data))
58 (defun register-gobject-for-gc (pointer)
59 (with-recursive-lock-held (*gobject-gc-hooks-lock*)
60 (let ((locks-were-present (not (null *gobject-gc-hooks*))))
61 (push pointer *gobject-gc-hooks*)
62 (unless locks-were-present
63 (debugf "adding idle-gc-hook to main loop~%")
64 (glib::g-idle-add (callback g-idle-gc-hook) (null-pointer))))))
66 (defun g-object-dispose-carefully (pointer)
68 (register-gobject-for-gc pointer)
69 (error (e) (format t "Error in dispose: ~A~%" e))))
71 (defcallback weak-notify-print :void ((data :pointer) (object-pointer :pointer))
72 (declare (ignore data))
73 (debugf "g-object has finalized ~A ~A~%" (g-type-name (g-type-from-object object-pointer)) object-pointer))
75 (defun erase-pointer (data object-pointer)
76 (declare (ignore data))
77 (remhash (pointer-address object-pointer) *lisp-objects-pointers*))
79 (defcallback weak-notify-erase-pointer :void ((data :pointer) (object-pointer :pointer))
80 (erase-pointer data object-pointer))
82 (defun should-ref-sink-at-creation (object)
83 ;;If object was not created from lisp-side, we should ref it
84 ;;If an object is regular g-object, we should not ref-sink it
85 ;;If an object is GInitiallyUnowned, then it is created with a floating reference, we should ref-sink it
86 ;;A special case is GtkWindow: we should ref-sink it anyway
87 (if (g-object-has-reference object)
88 (let ((object-type (g-type-from-object (pointer object)))
89 (initially-unowned-type (g-type-from-name "GInitiallyUnowned")))
90 (g-type-is-a object-type initially-unowned-type))
93 (defun register-g-object (obj)
94 (debugf "registered GObject ~A with gobject ref-count ~A ~A~%" (pointer obj) (ref-count obj) (if (g-object-is-floating (pointer obj)) "(floating)" ""))
95 (when (should-ref-sink-at-creation obj)
96 (debugf "g_object_ref_sink(~A)~%" (pointer obj))
97 (g-object-ref-sink (pointer obj)))
98 (g-object-weak-ref (pointer obj) (callback weak-notify-print) (null-pointer))
99 (g-object-weak-ref (pointer obj) (callback weak-notify-erase-pointer) (null-pointer))
100 (setf (g-object-has-reference obj) t)
101 (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects*)
103 (setf (gethash (pointer-address (pointer obj)) *foreign-gobjects-ref-count*) 1))
105 (defun g-object-dispose (pointer)
106 (unless (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
107 (debugf "GObject ~A is already disposed, signalling error~%" pointer)
108 (error "GObject ~A is already disposed" pointer))
109 (debugf "g_object_unref(~A) (of type ~A, lisp-value ~A) (lisp ref-count ~A, gobject ref-count ~A)~%"
111 (g-type-name (g-type-from-object pointer))
112 (gethash (pointer-address pointer) *foreign-gobjects*)
113 (gethash (pointer-address pointer) *foreign-gobjects-ref-count*)
115 (let ((object (gethash (pointer-address pointer) *foreign-gobjects*)))
117 (setf (pointer object) nil)
118 (cancel-finalization object)))
119 (remhash (pointer-address pointer) *foreign-gobjects*)
120 (remhash (pointer-address pointer) *foreign-gobjects-ref-count*)
121 (g-object-unref pointer))
123 (defmethod release ((object g-object))
124 (debugf "Releasing object ~A (type ~A, lisp-value ~A)~%" (pointer object) (when (pointer object) (g-type-name (g-type-from-object (pointer object)))) object)
125 (unless (and (pointer object) (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
126 (error "Object ~A already disposed of from lisp side" object))
127 (decf (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
128 (when (zerop (gethash (pointer-address (pointer object)) *foreign-gobjects-ref-count*))
129 (g-object-dispose (pointer object)))
132 (defvar *registered-object-types* (make-hash-table :test 'equal))
133 (defun register-object-type (name type)
134 (setf (gethash name *registered-object-types*) type))
135 (defun registered-object-type-by-name (name)
136 (gethash name *registered-object-types*))
137 (defun get-g-object-lisp-type (g-type)
138 (setf g-type (ensure-g-type g-type))
140 while (not (zerop g-type))
141 for lisp-type = (gethash (g-type-name g-type) *registered-object-types*)
142 when lisp-type do (return lisp-type)
143 do (setf g-type (ensure-g-type (g-type-parent g-type)))))
145 (defun make-g-object-from-pointer (pointer)
146 (let* ((g-type (g-type-from-instance pointer))
147 (lisp-type (get-g-object-lisp-type g-type)))
149 (error "Type ~A is not registered with REGISTER-OBJECT-TYPE"
150 (g-type-name g-type)))
151 (g-object-ref pointer)
152 (make-instance lisp-type :pointer pointer)))
154 (define-foreign-type foreign-g-object-type ()
155 ((sub-type :reader sub-type :initarg :sub-type :initform 'g-object))
156 (:actual-type :pointer))
158 (define-parse-method g-object (&optional (sub-type 'g-object))
159 (make-instance 'foreign-g-object-type :sub-type sub-type))
161 (defmethod translate-to-foreign (object (type foreign-g-object-type))
165 ((pointerp object) object)
166 ((null (pointer object))
167 (error "Object ~A has been disposed" object))
168 ((typep object 'g-object)
169 (assert (typep object (sub-type type))
171 "Object ~A is not a subtype of ~A" object (sub-type type))
173 (t (error "Object ~A is not translatable as GObject*" object))))
175 (defun get-g-object-for-pointer (pointer)
176 (unless (null-pointer-p pointer)
177 (let ((object (gethash (pointer-address pointer) *foreign-gobjects*)))
180 (incf (gethash (pointer-address pointer) *foreign-gobjects-ref-count*))
181 (debugf "increfering object ~A~%" pointer))
182 (make-g-object-from-pointer pointer)))))
184 (defmethod translate-from-foreign (pointer (type foreign-g-object-type))
185 (get-g-object-for-pointer pointer))
187 (register-object-type "GObject" 'g-object)
189 (defun ensure-g-type (type)
190 "Returns the GType value for a given type. If type is an integer, it is returned. If type is a string, GType corresponding to this type name is looked up and returned.
191 @arg[type]{a string or and integer}
192 @return{integer equal to GType of @code{type}}"
195 (string (or (g-type-from-name type)
196 (error "Type ~A is invalid" type)))))
198 (defun ensure-object-pointer (object)
199 (if (pointerp object)
202 (g-object (pointer object)))))
204 (define-condition property-access-error (error)
205 ((property-name :initarg :property-name :reader property-access-error-property-name)
206 (class-name :initarg :class-name :reader property-access-error-class-name)
207 (message :initarg :message :reader property-access-error-message))
208 (:report (lambda (condition stream)
209 (format stream "Error accessing property '~A' on class '~A': ~A"
210 (property-access-error-property-name condition)
211 (property-access-error-class-name condition)
212 (property-access-error-message condition)))))
214 (define-condition property-unreadable-error (property-access-error)
216 (:default-initargs :message "property is not readable"))
218 (define-condition property-unwritable-error (property-access-error)
220 (:default-initargs :message "property is not writable"))
222 (defun g-param-spec-property-type (param-spec property-name object-type assert-readable assert-writable)
223 (when (null-pointer-p param-spec)
224 (error "Property ~A on type ~A is not found"
226 (g-type-name object-type)))
227 (when (and assert-readable
228 (not (member :readable
229 (foreign-slot-value param-spec
232 (error 'property-unreadable-error
233 :property-name property-name
234 :class-name (g-type-name object-type)))
235 (when (and assert-writable
236 (not (member :writable
237 (foreign-slot-value param-spec
240 (error 'property-unwritable-error
241 :property-name property-name
242 :class-name (g-type-name object-type)))
243 (foreign-slot-value param-spec 'g-param-spec :value-type))
245 (defun g-object-type-property-type (object-type property-name
246 &key assert-readable assert-writable)
247 (let* ((object-class (g-type-class-ref object-type))
248 (param-spec (g-object-class-find-property object-class property-name)))
250 (g-param-spec-property-type param-spec property-name object-type assert-readable assert-writable)
251 (g-type-class-unref object-class))))
253 (defun g-object-property-type (object property-name
254 &key assert-readable assert-writable)
255 (g-object-type-property-type (g-type-from-object (ensure-object-pointer object))
257 :assert-readable assert-readable
258 :assert-writable assert-writable))
260 (defun g-object-call-constructor (object-type args-names args-values
261 &optional args-types)
264 (mapcar (lambda (name)
265 (g-object-type-property-type object-type name))
267 (let ((args-count (length args-names)))
268 (with-foreign-object (parameters 'g-parameter args-count)
270 for i from 0 below args-count
271 for arg-name in args-names
272 for arg-value in args-values
273 for arg-type in args-types
274 for arg-g-type = (if arg-type (ensure-g-type arg-type) (g-object-type-property-type object-type arg-name))
275 for parameter = (mem-aref parameters 'g-parameter i)
276 do (setf (foreign-slot-value parameter 'g-parameter :name) arg-name)
277 do (set-g-value (foreign-slot-value parameter 'g-parameter :value)
281 (g-object-newv object-type args-count parameters)
283 for i from 0 below args-count
284 for parameter = (mem-aref parameters 'g-parameter i)
286 (mem-ref (foreign-slot-pointer parameter 'g-parameter 'name)
289 (foreign-slot-pointer parameter 'g-parameter 'value)))))))
291 (defun g-object-call-get-property (object property-name &optional property-type)
293 (unless property-type
295 (g-object-property-type object property-name :assert-readable t)))
296 (return-nil () (return-from g-object-call-get-property nil)))
297 (setf property-type (ensure-g-type property-type))
298 (with-foreign-object (value 'g-value)
300 (g-value-init value property-type)
301 (g-object-get-property (ensure-object-pointer object)
305 (g-value-unset value))))
307 (defun g-object-call-set-property (object property-name new-value
308 &optional property-type)
309 (unless property-type
311 (g-object-property-type object property-name :assert-writable t)))
312 (setf property-type (ensure-g-type property-type))
313 (with-foreign-object (value 'g-value)
314 (set-g-value value new-value property-type :zero-g-value t)
316 (g-object-set-property (ensure-object-pointer object)
318 (g-value-unset value))))