1 ;; Common Lisp bindings for GTK+ v2.x
2 ;; Copyright 2000-2006 Espen S. Johnsen <espen@users.sf.net>
4 ;; Permission is hereby granted, free of charge, to any person obtaining
5 ;; a copy of this software and associated documentation files (the
6 ;; "Software"), to deal in the Software without restriction, including
7 ;; without limitation the rights to use, copy, modify, merge, publish,
8 ;; distribute, sublicense, and/or sell copies of the Software, and to
9 ;; permit persons to whom the Software is furnished to do so, subject to
10 ;; the following conditions:
12 ;; The above copyright notice and this permission notice shall be
13 ;; included in all copies or substantial portions of the Software.
15 ;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 ;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 ;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18 ;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19 ;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20 ;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21 ;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 ;; $Id: gobject.lisp,v 1.57 2007/06/01 10:46:15 espen Exp $
28 ;;;; Metaclass used for subclasses of gobject
30 (eval-when (:compile-toplevel :load-toplevel :execute)
31 ;; (push :debug-ref-counting *features*)
32 (defclass gobject-class (ginstance-class)
33 ((instance-slots-p :initform nil :reader instance-slots-p
34 :documentation "Non NIL if the class has slots with instance allocation")))
35 (defmethod shared-initialize ((class gobject-class) names &rest initargs)
36 (declare (ignore names initargs))
38 (unless (slot-boundp class 'ref)
39 (setf (slot-value class 'ref) '%object-ref))
40 (unless (slot-boundp class 'unref)
41 (setf (slot-value class 'unref) '%object-unref)))
43 (defmethod validate-superclass ((class gobject-class) (super standard-class))
44 ; (subtypep (class-name super) 'gobject)
47 (defclass direct-property-slot-definition (direct-virtual-slot-definition)
48 ((pname :reader slot-definition-pname :initarg :pname)
49 (readable :reader slot-readable-p :initarg :readable)
50 (writable :reader slot-writable-p :initarg :writable)
51 (construct-only :initarg :construct-only :reader construct-only-property-p)))
53 (defclass effective-property-slot-definition (effective-virtual-slot-definition)
54 ((pname :reader slot-definition-pname :initarg :pname)
55 (readable :initform t :reader slot-readable-p :initarg :readable)
56 (writable :initform t :reader slot-writable-p :initarg :writable)
57 (construct-only :initform nil :initarg :construct-only :reader construct-only-property-p)))
59 (defclass direct-user-data-slot-definition (direct-virtual-slot-definition)
62 (defclass effective-user-data-slot-definition (effective-virtual-slot-definition)
66 (defbinding %object-ref () pointer
69 (defbinding %object-unref () nil
72 #?(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
74 (define-callback toggle-ref-callback nil
75 ((data pointer) (location pointer) (last-ref-p boolean))
76 (declare (ignore data))
79 (format t "Object at 0x~8,'0X has no foreign references~%" (pointer-address location))
80 (format t "Foreign reference added to object at 0x~8,'0X~%" (pointer-address location)))
82 (cache-instance (find-cached-instance location) t)
83 (cache-instance (find-cached-instance location) nil)))
85 (defbinding %object-add-toggle-ref (location) pointer
87 (toggle-ref-callback callback)
90 (defbinding %object-remove-toggle-ref (location) pointer
92 (toggle-ref-callback callback)
97 (define-callback weak-ref-callback nil ((data pointer) (location pointer))
98 (format t "Object at 0x~8,'0X (~A) being finalized~%" (pointer-address location) (type-from-number (%type-number-of-ginstance location))))
100 (defbinding %object-weak-ref (location) pointer
102 (weak-ref-callback callback)
106 ; (defbinding object-class-install-param () nil
109 ; (parameter parameter))
111 ; (defbinding object-class-find-param-spec () parameter
115 (defun signal-name-to-string (name)
116 (substitute #\_ #\- (string-downcase (string name))))
119 (defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
120 (case (getf initargs :allocation)
121 (:property (find-class 'direct-property-slot-definition))
122 (:user-data (find-class 'direct-user-data-slot-definition))
123 (t (call-next-method))))
125 (defmethod effective-slot-definition-class ((class gobject-class) &rest initargs)
126 (case (getf initargs :allocation)
127 (:property (find-class 'effective-property-slot-definition))
128 (:user-data (find-class 'effective-user-data-slot-definition))
129 (t (call-next-method))))
131 (defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds)
132 (if (eq (slot-definition-allocation (first direct-slotds)) :property)
134 (compute-most-specific-initargs direct-slotds
135 '(pname construct-only readable writable))
140 (defvar *ignore-setting-construct-only-property* nil)
141 (declaim (special *ignore-setting-construct-only-property*))
143 (defmethod compute-slot-reader-function ((slotd effective-property-slot-definition) &optional signal-unbound-p)
144 (declare (ignore signal-unbound-p))
145 (let* ((type (slot-definition-type slotd))
146 (pname (slot-definition-pname slotd))
147 (reader (reader-function type :ref :get)))
149 (with-memory (gvalue +gvalue-size+)
150 (%gvalue-init gvalue (find-type-number type))
151 (%object-get-property object pname gvalue)
152 (funcall reader gvalue +gvalue-value-offset+)))))
154 (defmethod compute-slot-writer-function :around ((slotd effective-property-slot-definition))
155 (if (construct-only-property-p slotd)
156 #'(lambda (value object)
157 (declare (ignore value))
158 (unless *ignore-setting-construct-only-property*
159 (error 'unwritable-slot :name (slot-definition-name slotd) :instance object)))
162 (defmethod compute-slot-writer-function ((slotd effective-property-slot-definition))
163 (let* ((type (slot-definition-type slotd))
164 (pname (slot-definition-pname slotd))
165 (writer (writer-function type :temp t))
166 (destroy (destroy-function type :temp t)))
167 #'(lambda (value object)
168 (with-memory (gvalue +gvalue-size+)
169 (%gvalue-init gvalue (find-type-number type))
170 (funcall writer value gvalue +gvalue-value-offset+)
171 (%object-set-property object pname gvalue)
172 (funcall destroy gvalue +gvalue-value-offset+))
175 (defmethod slot-readable-p ((slotd effective-user-data-slot-definition))
176 (declare (ignore slotd))
179 (defmethod compute-slot-reader-function ((slotd effective-user-data-slot-definition) &optional signal-unbound-p)
180 (declare (ignore signal-unbound-p))
181 (let ((slot-name (slot-definition-name slotd)))
183 (user-data object slot-name))))
185 (defmethod compute-slot-boundp-function ((slotd effective-user-data-slot-definition))
186 (let ((slot-name (slot-definition-name slotd)))
188 (user-data-p object slot-name))))
190 (defmethod slot-writable-p ((slotd effective-user-data-slot-definition))
191 (declare (ignore slotd))
194 (defmethod compute-slot-writer-function ((slotd effective-user-data-slot-definition))
195 (let ((slot-name (slot-definition-name slotd)))
196 #'(lambda (value object)
197 (setf (user-data object slot-name) value))))
199 (defmethod compute-slot-makunbound-function ((slotd effective-user-data-slot-definition))
200 (let ((slot-name (slot-definition-name slotd)))
202 (unset-user-data object slot-name))))
204 (defmethod compute-slots :around ((class gobject-class))
205 (let ((slots (call-next-method)))
206 (when (some #'(lambda (slotd)
208 (eq (slot-definition-allocation slotd) :instance)
209 (not (typep slotd 'effective-special-slot-definition))))
211 (setf (slot-value class 'instance-slots-p) t))
215 ;;;; Super class for all classes in the GObject type hierarchy
217 (eval-when (:compile-toplevel :load-toplevel :execute)
218 (defclass gobject (ginstance)
219 (#+debug-ref-counting
220 (ref-count :allocation :alien :type int :reader ref-count))
221 (:metaclass gobject-class)
225 (defmethod print-object ((instance gobject) stream)
226 (print-unreadable-object (instance stream :type t :identity nil)
227 (if (proxy-valid-p instance)
228 (format stream "at 0x~X (~D)" (pointer-address (foreign-location instance)) (ref-count instance))
229 (write-string "at \"unbound\"" stream))))
232 (define-type-method reader-function ((type gobject) &key (ref :read) inlined)
233 (assert-not-inlined type inlined)
235 ((:read :peek) (call-next-method type :ref :read))
237 #'(lambda (location &optional (offset 0))
238 (let ((instance (ref-pointer location offset)))
239 (unless (null-pointer-p instance)
240 (multiple-value-bind (gobject new-p)
241 (ensure-proxy-instance 'gobject instance :reference nil)
243 (%object-unref instance))
244 (setf (ref-pointer location offset) (make-pointer 0))
247 (define-type-method callback-wrapper ((type gobject) var arg form)
248 (let ((class (type-expand type)))
249 `(let ((,var (ensure-proxy-instance ',class ,arg)))
252 (defun initial-add (object function initargs key pkey)
254 as (initarg value . rest) = initargs then rest
256 ((eq initarg key) (funcall function object value))
257 ((eq initarg pkey) (mapc #'(lambda (value)
258 (funcall function object value))
262 (defun initial-apply-add (object function initargs key pkey)
263 (initial-add object #'(lambda (object value)
264 (apply function object (mklist value)))
268 (defmethod make-proxy-instance ((class gobject-class) location &rest initargs)
269 (declare (ignore location initargs))
270 (if (slot-value class 'instance-slots-p)
271 (error "Objects of class ~A has instance slots and should only be created with MAKE-INSTANCE" class)
274 (defparameter +gparameter-gvalue-offset+
275 (max (size-of 'pointer) (type-alignment '(unsigned-byte 64))))
276 (defparameter +gparameter-size+
277 (+ +gparameter-gvalue-offset+ +gvalue-size+))
279 (defmethod allocate-foreign ((object gobject) &rest initargs)
280 (let ((init-slots ()))
281 (flet ((value-from-initargs (slotd)
283 with slot-initargs = (slot-definition-initargs slotd)
284 for (initarg value) on initargs by #'cddr
285 when (find initarg slot-initargs)
286 do (return (values value t)))))
289 for slotd in (class-slots (class-of object))
291 (eq (slot-definition-allocation slotd) :property)
292 (construct-only-property-p slotd))
293 do (multiple-value-bind (value initarg-p) (value-from-initargs slotd)
295 (initarg-p (push (cons slotd value) init-slots))
296 ((slot-definition-initfunction slotd)
298 (cons slotd (funcall (slot-definition-initfunction slotd)))
303 (let* ((num-slots (length init-slots)))
304 (with-memory (params (* num-slots +gparameter-size+))
306 with string-writer = (writer-function 'string)
307 for (slotd . value) in init-slots
308 as param = params then (pointer+ param +gparameter-size+)
309 as type = (slot-definition-type slotd)
310 as pname = (slot-definition-pname slotd)
311 do (funcall string-writer pname param)
313 (pointer+ param +gparameter-gvalue-offset+) type value))
316 (%gobject-newv (type-number-of object) num-slots params)
319 with string-destroy = (destroy-function 'string)
321 as param = params then (pointer+ param +gparameter-size+)
322 do (funcall string-destroy param)
323 (gvalue-unset (pointer+ param +gparameter-gvalue-offset+)))))))
325 (t (%gobject-new (type-number-of object))))))
328 (defmethod shared-initialize ((object gobject) names &rest initargs)
329 (declare (ignore names initargs))
330 (let ((*ignore-setting-construct-only-property* t))
333 (defmethod initialize-instance :around ((object gobject) &rest initargs)
334 (declare (ignore initargs))
337 #+debug-ref-counting(%object-weak-ref (foreign-location object))
338 #?(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
339 (when (slot-value (class-of object) 'instance-slots-p)
340 (%object-add-toggle-ref (foreign-location object))
341 (%object-unref (foreign-location object)))))
344 (defmethod instance-finalizer ((instance gobject))
345 (let ((location (foreign-location instance)))
346 #?(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
347 (if (slot-value (class-of instance) 'instance-slots-p)
350 (format t "Finalizing proxy for 0x~8,'0X~%" (pointer-address location))
351 (%object-remove-toggle-ref location))
354 (format t "Finalizing proxy for 0x~8,'0X~%" (pointer-address location))
355 (%object-unref location)))
356 #?-(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
358 (%object-unref location))))
361 (defbinding (%gobject-new "g_object_new") () pointer
365 (defbinding (%gobject-newv "g_object_newv") () pointer
367 (n-parameters unsigned-int)
374 (defbinding %object-set-property () nil
379 (defbinding %object-get-property () nil
384 (defbinding %object-notify () nil
388 (defbinding object-freeze-notify () nil
391 (defbinding object-thaw-notify () nil
397 (defgeneric (setf user-data) (data object key))
398 (defgeneric user-data (object key))
399 (defgeneric user-data-p (object key))
400 (defgeneric unset-user-data (object key))
402 (defbinding %object-set-qdata-full () nil
406 (destroy-marshal callback))
408 (define-callback user-data-destroy-callback nil ((id pointer-data))
409 (destroy-user-data id))
411 (defmethod (setf user-data) (data (object gobject) key)
412 (%object-set-qdata-full object (quark-intern key)
413 (register-user-data data) user-data-destroy-callback)
416 (defbinding %object-get-qdata () pointer-data
420 (defmethod user-data ((object gobject) key)
421 (find-user-data (%object-get-qdata object (quark-intern key))))
423 (defmethod user-data-p ((object gobject) key)
424 (user-data-exists-p (%object-get-qdata object (quark-intern key))))
426 (defbinding %object-steal-qdata () pointer-data
430 (defmethod unset-user-data ((object gobject) key)
431 (destroy-user-data (%object-steal-qdata object (quark-intern key))))
436 (defbinding %object-class-list-properties () pointer
438 (n-properties unsigned-int :out))
441 (defun %map-params (params length type inherited-p)
443 (map-c-vector 'list #'identity params 'param length)
444 (let ((properties ()))
447 (when (eql (param-owner-type param) type)
448 (push param properties)))
449 params 'param length)
450 (nreverse properties))))
452 (defun query-object-class-properties (type &optional inherited-p)
453 (let* ((type-number (find-type-number type t))
454 (class (type-class-ref type-number)))
456 (multiple-value-bind (array length)
457 (%object-class-list-properties class)
458 (unless (null-pointer-p array)
460 (%map-params array length type-number inherited-p)
461 (deallocate-memory array))))
462 ; (type-class-unref type-number)
466 (defun default-slot-name (name)
467 (let ((prefix-len (length (package-prefix))))
468 (intern (substitute #\- #\_
471 (string-prefix-p (package-prefix) name)
472 (char= #\- (char name prefix-len)))
473 (subseq name (1+ prefix-len))
476 (defun default-slot-accessor (class-name slot-name type)
479 nil "~A-~A~A" class-name slot-name
480 (if (eq type 'boolean) "-P" ""))))
483 (defun slot-definition-from-property (class property &optional slot-name args)
484 (with-slots (name flags value-type documentation) property
485 (let* ((slot-name (or slot-name (default-slot-name name)))
486 (slot-type (or (getf args :type) (type-from-number value-type) 'pointer))
487 (accessor (default-slot-accessor class slot-name slot-type)))
490 :allocation :property :pname ,name
492 ,@(when (find :unbound args) (list :unbound (getf args :unbound)))
493 ,@(when (find :getter args) (list :getter (getf args :getter)))
494 ,@(when (find :setter args) (list :setter (getf args :setter)))
499 (member :writable flags) (member :readable flags)
500 (not (member :construct-only flags)))
501 (list :accessor accessor))
502 ((and (member :writable flags) (not (member :construct-only flags)))
503 (list :writer `(setf ,accessor)))
504 ((member :readable flags)
505 (list :reader accessor)))
507 ;; readable/writable/construct
508 ,@(when (or (not (member :writable flags))
509 (member :construct-only flags))
511 ,@(when (not (member :readable flags))
513 ,@(when (member :construct-only flags)
514 '(:construct-only t))
517 ,@(if (find :initarg args)
518 (let ((initarg (getf args :initarg)))
521 (symbol `(:initarg ,initarg))))
522 (when (or (member :construct flags)
523 (member :construct-only flags)
524 (member :writable flags))
525 (list :initarg (intern (string slot-name) "KEYWORD"))))
528 :documentation ,documentation))))
531 (defun slot-definitions (class properties slots)
533 for property in properties
535 (find (param-name property) slots
536 :key #'(lambda (slot) (getf (rest slot) :pname))
538 (find (param-name property) slots
539 :key #'first :test #'string-equal))
542 (push (slot-definition-from-property class property) slots))
543 ((getf (rest slot) :merge)
546 (rest (slot-definition-from-property class property (first slot) (rest slot)))))))
547 (delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots))
550 (defun expand-gobject-type (type forward-p options &optional (metaclass 'gobject-class))
551 (let ((supers (cons (supertype type) (implements type)))
552 (class (type-from-number type))
553 (slots (getf options :slots)))
554 `(defclass ,class ,supers
556 (slot-definitions class (query-object-class-properties type) slots))
557 (:metaclass ,metaclass)
558 (:gtype ,(register-type-as type)))))
560 (defun gobject-dependencies (type options)
565 (type-interfaces type)
566 (mapcar #'param-value-type (query-object-class-properties type))
567 (getf options :dependencies)
569 for slot in (getf options :slots)
570 as type = (getf (rest slot) :type)
571 when (and type (symbolp type) (find-type-number type))
572 collect (find-type-number type))))))
575 (register-derivable-type 'gobject "GObject" 'expand-gobject-type 'gobject-dependencies)
578 ;;; Pseudo type for gobject instances which have their reference count
579 ;;; increased by the returning function
581 (deftype referenced (type) type)
583 (define-type-method from-alien-form ((type referenced) form &key (ref :free))
585 ((not (eq ref :free))
586 (error "Keyword arg :REF to FROM-ALIEN-FORM should be :FREE for type ~A. It was give ~A" type ref))
587 ((subtypep type 'gobject)
588 (from-alien-form (second (type-expand-to 'referenced type)) form :ref ref))))
590 (define-type-method from-alien-function ((type referenced) &key (ref :free))
592 ((not (eq ref :free))
593 (error "Keyword arg :REF to FROM-ALIEN-FUNCTION should be :FREE for type ~A. It was give ~A" type ref))
594 ; ((subtypep type 'gobject) (call-next-method type ref :free))))
595 ((subtypep type 'gobject)
596 (from-alien-function (second (type-expand-to 'referenced type)) :ref ref))))