Added DEFCALLBACK to list of exported symbols
[clg] / glib / gobject.lisp
CommitLineData
560af5c5 1;; Common Lisp bindings for GTK+ v2.0
82747bbd 2;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
560af5c5 3;;
4;; This library is free software; you can redistribute it and/or
5;; modify it under the terms of the GNU Lesser General Public
6;; License as published by the Free Software Foundation; either
7;; version 2 of the License, or (at your option) any later version.
8;;
9;; This library is distributed in the hope that it will be useful,
10;; but WITHOUT ANY WARRANTY; without even the implied warranty of
11;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12;; Lesser General Public License for more details.
13;;
14;; You should have received a copy of the GNU Lesser General Public
15;; License along with this library; if not, write to the Free Software
16;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
ae37d096 18;; $Id: gobject.lisp,v 1.25 2004-12-28 20:29:05 espen Exp $
560af5c5 19
20(in-package "GLIB")
21
22
2176a9c7 23;;;; Metaclass used for subclasses of gobject
24
25(eval-when (:compile-toplevel :load-toplevel :execute)
26 (defclass gobject-class (ginstance-class)
27 ())
28
29 (defmethod validate-superclass ((class gobject-class)
30 (super pcl::standard-class))
31; (subtypep (class-name super) 'gobject)
32 t))
33
34(defclass direct-property-slot-definition (direct-virtual-slot-definition)
35 ((pname :reader slot-definition-pname :initarg :pname)
36 (readable :initform t :reader slot-readable-p :initarg :readable)
37 (writable :initform t :reader slot-writable-p :initarg :writable)
38 (construct :initform nil :initarg :construct)))
39
40(defclass effective-property-slot-definition (effective-virtual-slot-definition)
41 ((pname :reader slot-definition-pname :initarg :pname)
42 (readable :reader slot-readable-p :initarg :readable)
43 (writable :reader slot-writable-p :initarg :writable)
44 (construct :initarg :construct)));)
45
46(defbinding %object-ref () pointer
47 (location pointer))
48
49(defbinding %object-unref () nil
50 (location pointer))
51
52(defmethod reference-foreign ((class gobject-class) location)
53 (declare (ignore class))
54 (%object-ref location))
55
56(defmethod unreference-foreign ((class gobject-class) location)
57 (declare (ignore class))
58 (%object-unref location))
59
60
61; (defbinding object-class-install-param () nil
62; (class pointer)
63; (id unsigned-int)
64; (parameter parameter))
65
66; (defbinding object-class-find-param-spec () parameter
67; (class pointer)
68; (name string))
69
70(defun signal-name-to-string (name)
71 (substitute #\_ #\- (string-downcase (string name))))
72
73
74(defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
75 (case (getf initargs :allocation)
76 (:property (find-class 'direct-property-slot-definition))
77 (t (call-next-method))))
78
79(defmethod effective-slot-definition-class ((class gobject-class) &rest initargs)
80 (case (getf initargs :allocation)
81 (:property (find-class 'effective-property-slot-definition))
82 (t (call-next-method))))
83
84(defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds)
eeda1c2d 85 (if (typep (first direct-slotds) 'direct-property-slot-definition)
2176a9c7 86 (nconc
87 (list :pname (signal-name-to-string
88 (most-specific-slot-value direct-slotds 'pname))
89 :readable (most-specific-slot-value direct-slotds 'readable)
90 :writable (most-specific-slot-value direct-slotds 'writable)
91 :construct (most-specific-slot-value direct-slotds 'construct))
92 (call-next-method))
93 (call-next-method)))
94
95
96(defmethod initialize-internal-slot-functions ((slotd effective-property-slot-definition))
97 (let* ((type (slot-definition-type slotd))
98 (pname (slot-definition-pname slotd))
99 (type-number (find-type-number type)))
eeda1c2d 100 (when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd))
2176a9c7 101 (setf
eeda1c2d 102 (slot-value slotd 'getter)
103 (let ((reader nil))
104 #'(lambda (object)
105 (unless reader
ae37d096 106 (setq reader (reader-function type))) ;(type-from-number type-number))))
eeda1c2d 107 (let ((gvalue (gvalue-new type-number)))
108 (%object-get-property object pname gvalue)
109 (unwind-protect
110 (funcall reader gvalue +gvalue-value-offset+)
111 (gvalue-free gvalue t)))))))
2176a9c7 112
eeda1c2d 113 (when (and (not (slot-boundp slotd 'setter)) (slot-writable-p slotd))
2176a9c7 114 (setf
eeda1c2d 115 (slot-value slotd 'setter)
116 (let ((writer nil))
117 #'(lambda (value object)
118 (unless writer
ae37d096 119 (setq writer (writer-function type))) ;(type-from-number type-number))))
eeda1c2d 120 (let ((gvalue (gvalue-new type-number)))
121 (funcall writer value gvalue +gvalue-value-offset+)
122 (%object-set-property object pname gvalue)
123 (gvalue-free gvalue t)
124 value))))))
125
2176a9c7 126 (call-next-method))
127
128
129;;;; Super class for all classes in the GObject type hierarchy
130
560af5c5 131(eval-when (:compile-toplevel :load-toplevel :execute)
c8c48a4c 132 (defclass gobject (ginstance)
560af5c5 133 ()
2176a9c7 134 (:metaclass gobject-class)
9adccb27 135 (:alien-name "GObject")))
136
eeda1c2d 137
138(defun initial-add (object function initargs key pkey)
139 (loop
140 as (initarg value . rest) = initargs then rest
141 do (cond
142 ((eq initarg key) (funcall function object value))
143 ((eq initarg pkey) (mapc #'(lambda (value)
144 (funcall function object value))
145 value)))
146 while rest))
147
148(defun initial-apply-add (object function initargs key pkey)
149 (initial-add object #'(lambda (object value)
150 (apply function object (mklist value)))
151 initargs key pkey))
152
153
82747bbd 154(defmethod initialize-instance ((object gobject) &rest initargs)
040579dd 155 (unless (slot-boundp object 'location)
156 ;; Extract initargs which we should pass directly to the GObeject
157 ;; constructor
158 (let* ((slotds (class-slots (class-of object)))
159 (args (when initargs
160 (loop
161 as (key value . rest) = initargs then rest
162 as slotd = (find-if
163 #'(lambda (slotd)
164 (member key (slot-definition-initargs slotd)))
165 slotds)
166 when (and (typep slotd 'effective-property-slot-definition)
167 (slot-value slotd 'construct))
168 collect (progn
169 (remf initargs key)
170 (list
171 (slot-definition-pname slotd)
172 (slot-definition-type slotd)
173 value))
174 while rest))))
175 (if args
176 (let* ((string-size (size-of 'string))
177 (string-writer (writer-function 'string))
178 (string-destroy (destroy-function 'string))
179 (params (allocate-memory
180 (* (length args) (+ string-size +gvalue-size+)))))
9adccb27 181 (loop
040579dd 182 for (pname type value) in args
9adccb27 183 as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
040579dd 184 do (funcall string-writer pname tmp)
185 (gvalue-init (sap+ tmp string-size) type value))
186 (unwind-protect
187 (setf
188 (slot-value object 'location)
189 (%gobject-newv (type-number-of object) (length args) params))
190 (loop
191 repeat (length args)
192 as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
193 do (funcall string-destroy tmp)
194 (gvalue-unset (sap+ tmp string-size)))
195 (deallocate-memory params)))
8755b1a5 196 (setf
197 (slot-value object 'location)
040579dd 198 (%gobject-new (type-number-of object))))))
8755b1a5 199
4d83a8a6 200 (apply #'call-next-method object initargs))
201
202
1dbf4216 203(defmethod instance-finalizer ((instance gobject))
204 (let ((location (proxy-location instance)))
205 #'(lambda ()
206 (remove-cached-instance location)
1dbf4216 207 (%object-unref location))))
208
9adccb27 209
d4b21b08 210(defbinding (%gobject-new "g_object_new") () pointer
a9044181 211 (type type-number)
212 (nil null))
560af5c5 213
9adccb27 214(defbinding (%gobject-newv "g_object_newv") () pointer
4d83a8a6 215 (type type-number)
216 (n-parameters unsigned-int)
9adccb27 217 (params pointer))
de8516ca 218
219
d4b21b08 220
323d4265 221;;;; Property stuff
560af5c5 222
26b133ed 223(defbinding %object-set-property () nil
c8c48a4c 224 (object gobject)
225 (name string)
226 (value gvalue))
86d9d6ab 227
26b133ed 228(defbinding %object-get-property () nil
c8c48a4c 229 (object gobject)
230 (name string)
a9044181 231 (value gvalue))
86d9d6ab 232
26b133ed 233(defbinding %object-notify () nil
c8c48a4c 234 (object gobject)
235 (name string))
86d9d6ab 236
26b133ed 237(defbinding object-freeze-notify () nil
a9044181 238 (object gobject))
86d9d6ab 239
26b133ed 240(defbinding object-thaw-notify () nil
a9044181 241 (object gobject))
86d9d6ab 242
26b133ed 243(defbinding %object-set-qdata-full () nil
86d9d6ab 244 (object gobject)
245 (id quark)
246 (data unsigned-long)
247 (destroy-marshal pointer))
248
a9044181 249
250;;;; User data
251
86d9d6ab 252(defun (setf object-data) (data object key &key (test #'eq))
253 (%object-set-qdata-full
254 object (quark-from-object key :test test)
0f134a29 255 (register-user-data data) (callback %destroy-user-data))
86d9d6ab 256 data)
257
26b133ed 258(defbinding %object-get-qdata () unsigned-long
86d9d6ab 259 (object gobject)
260 (id quark))
261
262(defun object-data (object key &key (test #'eq))
263 (find-user-data
264 (%object-get-qdata object (quark-from-object key :test test))))
265
266
d4b21b08 267;;;;
268
323d4265 269(defbinding %object-class-list-properties () pointer
d4b21b08 270 (class pointer)
271 (n-properties unsigned-int :out))
272
9c03a07c 273
274(defun %map-params (params length type inherited-p)
275 (if inherited-p
9adccb27 276 (map-c-vector 'list #'identity params 'param length)
9c03a07c 277 (let ((properties ()))
9adccb27 278 (map-c-vector 'list
9c03a07c 279 #'(lambda (param)
280 (when (eql (param-owner-type param) type)
281 (push param properties)))
282 params 'param length)
283 (nreverse properties))))
284
285(defun query-object-class-properties (type &optional inherited-p)
286 (let* ((type-number (find-type-number type))
287 (class (type-class-ref type-number)))
288 (unwind-protect
289 (multiple-value-bind (array length)
290 (%object-class-list-properties class)
291 (unwind-protect
292 (%map-params array length type-number inherited-p)
293 (deallocate-memory array)))
294; (type-class-unref type-number)
295 )))
d4b21b08 296
297
298(defun default-slot-name (name)
299 (intern (substitute #\- #\_ (string-upcase (string-upcase name)))))
300
301(defun default-slot-accessor (class-name slot-name type)
302 (intern
303 (format
304 nil "~A-~A~A" class-name slot-name
4d83a8a6 305 (if (eq type 'boolean) "-P" ""))))
d4b21b08 306
323d4265 307
eeda1c2d 308(defun slot-definition-from-property (class property &optional args)
9c03a07c 309 (with-slots (name flags value-type documentation) property
310 (let* ((slot-name (default-slot-name name))
eeda1c2d 311 (slot-type (or (getf args :type) (type-from-number value-type) value-type))
9c03a07c 312 (accessor (default-slot-accessor class slot-name slot-type)))
313
314 `(,slot-name
315 :allocation :property :pname ,name
eeda1c2d 316
eeda1c2d 317 ,@(cond
ae37d096 318 ((find :unbound args) (list :unbound (getf args :unbound))))
9c03a07c 319
320 ;; accessors
321 ,@(cond
322 ((and
323 (member :writable flags) (member :readable flags)
324 (not (member :construct-only flags)))
325 (list :accessor accessor))
326 ((and (member :writable flags) (not (member :construct-only flags)))
327 (list :writer `(setf ,accessor)))
328 ((member :readable flags)
329 (list :reader accessor)))
330
331 ;; readable/writable/construct
332 ,@(when (or (not (member :writable flags))
333 (member :construct-only flags))
334 '(:writable nil))
335 ,@(when (not (member :readable flags))
336 '(:readable nil))
337 ,@(when (or (member :construct flags)
338 (member :construct-only flags))
339 '(:construct t))
340
341 ;; initargs
342 ,@(when (or (member :construct flags)
343 (member :construct-only flags)
344 (member :writable flags))
345 (list :initarg (intern (string slot-name) "KEYWORD")))
346
347 :type ,slot-type
348 :documentation ,documentation))))
349
350
351(defun slot-definitions (class properties slots)
352 (loop
9c03a07c 353 for property in properties
eeda1c2d 354 as slot = (or
355 (find (param-name property) slots
356 :key #'(lambda (slot) (getf (rest slot) :pname))
357 :test #'string=)
358 (find (param-name property) slots
359 :key #'first :test #'string-equal))
360 do (cond
361 ((not slot)
362 (push (slot-definition-from-property class property) slots))
363 ((getf (rest slot) :merge)
364 (setf
365 (rest slot)
366 (rest (slot-definition-from-property class property (rest slot)))))))
9c03a07c 367 (delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots))
368
369
370(defun expand-gobject-type (type &optional options (metaclass 'gobject-class))
371 (let ((supers (cons (supertype type) (implements type)))
372 (class (type-from-number type))
373 (slots (getf options :slots)))
374 `(defclass ,class ,supers
375 ,(slot-definitions class (query-object-class-properties type) slots)
376 (:metaclass ,metaclass)
377 (:alien-name ,(find-type-name type)))))
323d4265 378
d4b21b08 379
9c03a07c 380(register-derivable-type 'gobject "GObject" 'expand-gobject-type)
ae37d096 381
382
383;;; Pseudo type for gobject instances which have their reference count
384;;; increased by the returning function
385
386(defmethod alien-type ((type (eql 'referenced)) &rest args)
387 (declare (ignore type args))
388 (alien-type 'gobject))
389
390(defmethod from-alien-form (form (type (eql 'referenced)) &rest args)
391 (declare (ignore type))
392 (destructuring-bind (type) args
393 (if (subtypep type 'gobject)
394 (let ((instance (make-symbol "INSTANCE")))
395 `(let ((,instance ,(from-alien-form form type)))
396 (when ,instance
397 (%object-unref (proxy-location ,instance)))
398 ,instance))
399 (error "~A is not a subclass of GOBJECT" type))))
400
401(export 'referenced)