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.52 2006-04-25 22:10:36 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 (defmethod slot-readable-p ((slotd standard-effective-slot-definition))
67 (declare (ignore slotd))
70 (defmethod slot-writable-p ((slotd standard-effective-slot-definition))
71 (declare (ignore slotd))
75 (defbinding %object-ref () pointer
78 (defbinding %object-unref () nil
81 #?(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
83 (define-callback toggle-ref-callback nil
84 ((data pointer) (location pointer) (last-ref-p boolean))
85 (declare (ignore data))
88 (format t "Object at 0x~8,'0X has no foreign references~%" (pointer-address location))
89 (format t "Foreign reference added to object at 0x~8,'0X~%" (pointer-address location)))
91 (cache-instance (find-cached-instance location) t)
92 (cache-instance (find-cached-instance location) nil)))
94 (defbinding %object-add-toggle-ref (location) pointer
96 (toggle-ref-callback callback)
99 (defbinding %object-remove-toggle-ref (location) pointer
101 (toggle-ref-callback callback)
106 (define-callback weak-ref-callback nil ((data pointer) (location pointer))
107 (format t "Object at 0x~8,'0X (~A) being finalized~%" (pointer-address location) (type-from-number (%type-number-of-ginstance location))))
109 (defbinding %object-weak-ref (location) pointer
111 (weak-ref-callback callback)
115 ; (defbinding object-class-install-param () nil
118 ; (parameter parameter))
120 ; (defbinding object-class-find-param-spec () parameter
124 (defun signal-name-to-string (name)
125 (substitute #\_ #\- (string-downcase (string name))))
128 (defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
129 (case (getf initargs :allocation)
130 (:property (find-class 'direct-property-slot-definition))
131 (:user-data (find-class 'direct-user-data-slot-definition))
132 (t (call-next-method))))
134 (defmethod effective-slot-definition-class ((class gobject-class) &rest initargs)
135 (case (getf initargs :allocation)
136 (:property (find-class 'effective-property-slot-definition))
137 (:user-data (find-class 'effective-user-data-slot-definition))
138 (t (call-next-method))))
140 (defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds)
141 (if (eq (slot-definition-allocation (first direct-slotds)) :property)
143 (compute-most-specific-initargs direct-slotds
144 '(pname construct-only readable writable))
149 (defvar *ignore-setting-construct-only-property* nil)
150 (declaim (special *ignore-setting-construct-only-property*))
152 (defmethod compute-slot-reader-function ((slotd effective-property-slot-definition))
153 (if (slot-readable-p slotd)
154 (let* ((type (slot-definition-type slotd))
155 (pname (slot-definition-pname slotd))
156 (reader (reader-function type :ref :get)))
158 (with-memory (gvalue +gvalue-size+)
159 (%gvalue-init gvalue (find-type-number type))
160 (%object-get-property object pname gvalue)
161 (funcall reader gvalue +gvalue-value-offset+))))
164 (defmethod compute-slot-writer-function ((slotd effective-property-slot-definition))
166 ((slot-writable-p slotd)
167 (let* ((type (slot-definition-type slotd))
168 (pname (slot-definition-pname slotd))
169 (writer (writer-function type :temp t))
170 (destroy (destroy-function type :temp t)))
171 #'(lambda (value object)
172 (with-memory (gvalue +gvalue-size+)
173 (%gvalue-init gvalue (find-type-number type))
174 (funcall writer value gvalue +gvalue-value-offset+)
175 (%object-set-property object pname gvalue)
176 (funcall destroy gvalue +gvalue-value-offset+))
179 ((construct-only-property-p slotd)
180 #'(lambda (value object)
181 (declare (ignore value object))
182 (unless *ignore-setting-construct-only-property*
183 (error 'unwritable-slot :name (slot-definition-name slotd) :instance object))))
184 ((call-next-method))))
186 (defmethod compute-slot-reader-function ((slotd effective-user-data-slot-definition))
187 (let ((slot-name (slot-definition-name slotd)))
189 (user-data object slot-name))))
191 (defmethod compute-slot-boundp-function ((slotd effective-user-data-slot-definition))
192 (let ((slot-name (slot-definition-name slotd)))
194 (user-data-p object slot-name))))
196 (defmethod compute-slot-writer-function ((slotd effective-user-data-slot-definition))
197 (let ((slot-name (slot-definition-name slotd)))
198 #'(lambda (value object)
199 (setf (user-data object slot-name) value))))
201 (defmethod compute-slot-makunbound-function ((slotd effective-user-data-slot-definition))
202 (let ((slot-name (slot-definition-name slotd)))
204 (unset-user-data object slot-name))))
206 (defmethod compute-slots :around ((class gobject-class))
207 (let ((slots (call-next-method)))
208 (when (some #'(lambda (slotd)
210 (eq (slot-definition-allocation slotd) :instance)
211 (not (typep slotd 'effective-special-slot-definition))))
213 (setf (slot-value class 'instance-slots-p) t))
217 ;;;; Super class for all classes in the GObject type hierarchy
219 (eval-when (:compile-toplevel :load-toplevel :execute)
220 (defclass gobject (ginstance)
221 (#+debug-ref-counting
222 (ref-count :allocation :alien :type int :reader ref-count))
223 (:metaclass gobject-class)
227 (defmethod print-object ((instance gobject) stream)
228 (print-unreadable-object (instance stream :type t :identity nil)
229 (if (proxy-valid-p instance)
230 (format stream "at 0x~X (~D)" (pointer-address (foreign-location instance)) (ref-count instance))
231 (write-string "at \"unbound\"" stream))))
234 (define-type-method reader-function ((type gobject) &key (ref :read) inlined)
235 (assert-not-inlined type inlined)
237 ((:read :peek) (call-next-method type :ref :read))
239 #'(lambda (location &optional (offset 0))
240 (let ((instance (ref-pointer location offset)))
241 (unless (null-pointer-p instance)
242 (multiple-value-bind (gobject new-p)
243 (ensure-proxy-instance 'gobject instance :reference nil)
245 (%object-unref instance))
246 (setf (ref-pointer location offset) (make-pointer 0))
249 (define-type-method callback-wrapper ((type gobject) var arg form)
250 (let ((class (type-expand type)))
251 `(let ((,var (ensure-proxy-instance ',class ,arg)))
254 (defun initial-add (object function initargs key pkey)
256 as (initarg value . rest) = initargs then rest
258 ((eq initarg key) (funcall function object value))
259 ((eq initarg pkey) (mapc #'(lambda (value)
260 (funcall function object value))
264 (defun initial-apply-add (object function initargs key pkey)
265 (initial-add object #'(lambda (object value)
266 (apply function object (mklist value)))
270 (defmethod make-proxy-instance ((class gobject-class) location &rest initargs)
271 (declare (ignore location initargs))
272 (if (slot-value class 'instance-slots-p)
273 (error "Objects of class ~A has instance slots and should only be created with MAKE-INSTANCE" class)
277 (defmethod allocate-foreign ((object gobject) &rest initargs)
278 (let ((init-slots ()))
279 (flet ((value-from-initargs (slotd)
281 with slot-initargs = (slot-definition-initargs slotd)
282 for (initarg value) on initargs by #'cddr
283 when (find initarg slot-initargs)
284 do (return (values value t)))))
287 for slotd in (class-slots (class-of object))
289 (eq (slot-definition-allocation slotd) :property)
290 (construct-only-property-p slotd))
291 do (multiple-value-bind (value initarg-p) (value-from-initargs slotd)
293 (initarg-p (push (cons slotd value) init-slots))
294 ((slot-definition-initfunction slotd)
296 (cons slotd (funcall (slot-definition-initfunction slotd)))
301 (let* ((pointer-size (size-of 'pointer))
302 (element-size (+ +gvalue-size+ pointer-size))
303 (num-slots (length init-slots)))
304 (with-memory (params (* num-slots element-size))
306 with string-writer = (writer-function 'string)
307 for (slotd . value) in init-slots
308 as param = params then (pointer+ param element-size)
309 as type = (slot-definition-type slotd)
310 as pname = (slot-definition-pname slotd)
311 do (funcall string-writer pname param)
312 (gvalue-init (pointer+ param pointer-size) type value))
315 (%gobject-newv (type-number-of object) num-slots params)
318 with string-destroy = (destroy-function 'string)
320 as param = params then (pointer+ param element-size)
321 do (funcall string-destroy param)
322 (gvalue-unset (pointer+ param pointer-size)))))))
324 (t (%gobject-new (type-number-of object))))))
327 (defmethod shared-initialize ((object gobject) names &rest initargs)
328 (declare (ignore names initargs))
329 (let ((*ignore-setting-construct-only-property* t))
332 (defmethod initialize-instance :around ((object gobject) &rest initargs)
333 (declare (ignore initargs))
336 #+debug-ref-counting(%object-weak-ref (foreign-location object))
337 #?(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
338 (when (slot-value (class-of object) 'instance-slots-p)
339 (%object-add-toggle-ref (foreign-location object))
340 (%object-unref (foreign-location object)))))
343 (defmethod instance-finalizer ((instance gobject))
344 (let ((location (foreign-location instance)))
345 #?(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
346 (if (slot-value (class-of instance) 'instance-slots-p)
349 (format t "Finalizing proxy for 0x~8,'0X~%" (pointer-address location))
350 (%object-remove-toggle-ref location))
353 (format t "Finalizing proxy for 0x~8,'0X~%" (pointer-address location))
354 (%object-unref location)))
355 #?-(pkg-exists-p "glib-2.0" :atleast-version "2.8.0")
357 (%object-unref location))))
360 (defbinding (%gobject-new "g_object_new") () pointer
364 (defbinding (%gobject-newv "g_object_newv") () pointer
366 (n-parameters unsigned-int)
373 (defbinding %object-set-property () nil
378 (defbinding %object-get-property () nil
383 (defbinding %object-notify () nil
387 (defbinding object-freeze-notify () nil
390 (defbinding object-thaw-notify () nil
396 (defbinding %object-set-qdata-full () nil
400 (destroy-marshal callback))
402 (define-callback user-data-destroy-callback nil ((id unsigned-int))
403 (destroy-user-data id))
405 (defun (setf user-data) (data object key)
406 (%object-set-qdata-full object (quark-intern key)
407 (register-user-data data) user-data-destroy-callback)
410 (defbinding %object-get-qdata () unsigned-long
414 (defun user-data (object key)
415 (find-user-data (%object-get-qdata object (quark-intern key))))
417 (defun user-data-p (object key)
418 (user-data-exists-p (%object-get-qdata object (quark-intern key))))
420 (defbinding %object-steal-qdata () unsigned-long
424 (defun unset-user-data (object key)
425 (destroy-user-data (%object-steal-qdata object (quark-intern key))))
430 (defbinding %object-class-list-properties () pointer
432 (n-properties unsigned-int :out))
435 (defun %map-params (params length type inherited-p)
437 (map-c-vector 'list #'identity params 'param length)
438 (let ((properties ()))
441 (when (eql (param-owner-type param) type)
442 (push param properties)))
443 params 'param length)
444 (nreverse properties))))
446 (defun query-object-class-properties (type &optional inherited-p)
447 (let* ((type-number (find-type-number type t))
448 (class (type-class-ref type-number)))
450 (multiple-value-bind (array length)
451 (%object-class-list-properties class)
452 (unless (null-pointer-p array)
454 (%map-params array length type-number inherited-p)
455 (deallocate-memory array))))
456 ; (type-class-unref type-number)
460 (defun default-slot-name (name)
461 (let ((prefix-len (length (package-prefix))))
462 (intern (substitute #\- #\_
465 (string-prefix-p (package-prefix) name)
466 (char= #\- (char name prefix-len)))
467 (subseq name (1+ prefix-len))
470 (defun default-slot-accessor (class-name slot-name type)
473 nil "~A-~A~A" class-name slot-name
474 (if (eq type 'boolean) "-P" ""))))
477 (defun slot-definition-from-property (class property &optional slot-name args)
478 (with-slots (name flags value-type documentation) property
479 (let* ((slot-name (or slot-name (default-slot-name name)))
480 (slot-type (or (getf args :type) (type-from-number value-type) 'pointer))
481 (accessor (default-slot-accessor class slot-name slot-type)))
484 :allocation :property :pname ,name
486 ,@(when (find :unbound args) (list :unbound (getf args :unbound)))
487 ,@(when (find :getter args) (list :getter (getf args :getter)))
488 ,@(when (find :setter args) (list :setter (getf args :setter)))
493 (member :writable flags) (member :readable flags)
494 (not (member :construct-only flags)))
495 (list :accessor accessor))
496 ((and (member :writable flags) (not (member :construct-only flags)))
497 (list :writer `(setf ,accessor)))
498 ((member :readable flags)
499 (list :reader accessor)))
501 ;; readable/writable/construct
502 ,@(when (or (not (member :writable flags))
503 (member :construct-only flags))
505 ,@(when (not (member :readable flags))
507 ,@(when (member :construct-only flags)
508 '(:construct-only t))
511 ,@(if (find :initarg args)
512 (let ((initarg (getf args :initarg)))
515 (symbol `(:initarg ,initarg))))
516 (when (or (member :construct flags)
517 (member :construct-only flags)
518 (member :writable flags))
519 (list :initarg (intern (string slot-name) "KEYWORD"))))
522 :documentation ,documentation))))
525 (defun slot-definitions (class properties slots)
527 for property in properties
529 (find (param-name property) slots
530 :key #'(lambda (slot) (getf (rest slot) :pname))
532 (find (param-name property) slots
533 :key #'first :test #'string-equal))
536 (push (slot-definition-from-property class property) slots))
537 ((getf (rest slot) :merge)
540 (rest (slot-definition-from-property class property (first slot) (rest slot)))))))
541 (delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots))
544 (defun expand-gobject-type (type forward-p options &optional (metaclass 'gobject-class))
545 (let ((supers (cons (supertype type) (implements type)))
546 (class (type-from-number type))
547 (slots (getf options :slots)))
548 `(defclass ,class ,supers
550 (slot-definitions class (query-object-class-properties type) slots))
551 (:metaclass ,metaclass)
552 (:gtype ,(register-type-as type)))))
554 (defun gobject-dependencies (type options)
559 (type-interfaces type)
560 (mapcar #'param-value-type (query-object-class-properties type))
561 (getf options :dependencies)
563 for slot in (getf options :slots)
564 as type = (getf (rest slot) :type)
565 when (and type (symbolp type) (find-type-number type))
566 collect (find-type-number type))))))
569 (register-derivable-type 'gobject "GObject" 'expand-gobject-type 'gobject-dependencies)
572 ;;; Pseudo type for gobject instances which have their reference count
573 ;;; increased by the returning function
575 (deftype referenced (type) type)
577 (define-type-method from-alien-form ((type referenced) form &key (ref :free))
579 ((not (eq ref :free))
580 (error "Keyword arg :REF to FROM-ALIEN-FORM should be :FREE for type ~A. It was give ~A" type ref))
581 ((subtypep type 'gobject)
582 (from-alien-form (second (type-expand-to 'referenced type)) form :ref ref))))
584 (define-type-method from-alien-function ((type referenced) &key (ref :free))
586 ((not (eq ref :free))
587 (error "Keyword arg :REF to FROM-ALIEN-FUNCTION should be :FREE for type ~A. It was give ~A" type ref))
588 ; ((subtypep type 'gobject) (call-next-method type ref :free))))
589 ((subtypep type 'gobject)
590 (from-alien-function (second (type-expand-to 'referenced type)) :ref ref))))