chiark / gitweb /
Changes required by SBCL 0.9.8
[clg] / glib / gtype.lisp
CommitLineData
112ac1d3 1;; Common Lisp bindings for GTK+ v2.x
2;; Copyright 2000-2005 Espen S. Johnsen <espen@users.sf.net>
560af5c5 3;;
112ac1d3 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:
560af5c5 11;;
112ac1d3 12;; The above copyright notice and this permission notice shall be
13;; included in all copies or substantial portions of the Software.
560af5c5 14;;
112ac1d3 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.
22
348f82de 23;; $Id: gtype.lisp,v 1.42 2006-02-06 22:58:35 espen Exp $
560af5c5 24
25(in-package "GLIB")
26
27(use-prefix "g")
28
e0349dbd 29;; Initialize the glib type system
30(defbinding type-init () nil)
31(type-init)
560af5c5 32
33(deftype type-number () '(unsigned 32))
34
e74cfcab 35(deftype gtype () 'symbol)
36
37(defmethod alien-type ((type (eql 'gtype)) &rest args)
38 (declare (ignore type args))
39 (alien-type 'type-number))
40
41(defmethod size-of ((type (eql 'gtype)) &rest args)
42 (declare (ignore type args))
43 (size-of 'type-number))
44
45(defmethod to-alien-form (gtype (type (eql 'gtype)) &rest args)
46 (declare (ignore type args))
47 `(find-type-number ,gtype t))
48
49(defmethod to-alien-function ((type (eql 'gtype)) &rest args)
50 (declare (ignore type args))
51 #'(lambda (gtype)
52 (find-type-number gtype t)))
53
54(defmethod from-alien-form (type-number (type (eql 'gtype)) &rest args)
55 (declare (ignore type args))
63752532 56 `(type-from-number ,type-number))
e74cfcab 57
58(defmethod from-alien-function ((type (eql 'gtype)) &rest args)
59 (declare (ignore type args))
60 #'(lambda (type-number)
63752532 61 (type-from-number type-number)))
e74cfcab 62
63(defmethod writer-function ((type (eql 'gtype)) &rest args)
73572c12 64 (declare (ignore type args))
e74cfcab 65 (let ((writer (writer-function 'type-number)))
66 #'(lambda (gtype location &optional (offset 0))
67 (funcall writer (find-type-number gtype t) location offset))))
68
69(defmethod reader-function ((type (eql 'gtype)) &rest args)
73572c12 70 (declare (ignore type args))
e74cfcab 71 (let ((reader (reader-function 'type-number)))
3005806e 72 #'(lambda (location &optional (offset 0) weak-p)
73 (declare (ignore weak-p))
63752532 74 (type-from-number (funcall reader location offset)))))
e74cfcab 75
76
93aa67db 77(eval-when (:compile-toplevel :load-toplevel :execute)
d4b21b08 78 (defclass type-query (struct)
93aa67db 79 ((type-number :allocation :alien :type type-number)
80 (name :allocation :alien :type string)
81 (class-size :allocation :alien :type unsigned-int)
82 (instance-size :allocation :alien :type unsigned-int))
d168bafd 83 (:metaclass struct-class)))
93aa67db 84
85
e74cfcab 86(defbinding type-query (type) nil
87 ((find-type-number type t) type-number)
88 ((make-instance 'type-query) type-query :return))
93aa67db 89
90(defun type-instance-size (type)
91 (slot-value (type-query type) 'instance-size))
92
93(defun type-class-size (type)
94 (slot-value (type-query type) 'class-size))
560af5c5 95
d4b21b08 96(defbinding type-class-ref (type) pointer
97 ((find-type-number type t) type-number))
560af5c5 98
d4b21b08 99(defbinding type-class-unref (type) nil
100 ((find-type-number type t) type-number))
93aa67db 101
d4b21b08 102(defbinding type-class-peek (type) pointer
103 ((find-type-number type t) type-number))
93aa67db 104
560af5c5 105
d4b21b08 106;;;; Mapping between lisp types and glib types
560af5c5 107
dfa4f314 108(defvar *registered-types* ())
109(defvar *registered-type-aliases* ())
110(defvar *lisp-type-to-type-number* (make-hash-table))
111(defvar *type-number-to-lisp-type* (make-hash-table))
d4b21b08 112
113(defbinding %type-from-name () type-number
114 (name string))
115
dfa4f314 116(defun type-number-from-glib-name (name &optional (error-p t))
117 (let ((type-number (%type-from-name name)))
118 (cond
119 ((not (zerop type-number)) type-number)
120 (error-p (error "Invalid gtype name: ~A" name)))))
121
122(defun register-type (type id)
123 (pushnew (cons type id) *registered-types* :key #'car)
124 (let ((type-number
125 (typecase id
126 (string (type-number-from-glib-name id))
127 (symbol (funcall id)))))
128 (setf (gethash type *lisp-type-to-type-number*) type-number)
129 (setf (gethash type-number *type-number-to-lisp-type*) type)
130 type-number))
131
132(defun register-type-alias (type alias)
133 (pushnew (cons type alias) *registered-type-aliases* :key #'car)
134 (setf
135 (gethash type *lisp-type-to-type-number*)
136 (find-type-number alias t)))
137
138(defun reinitialize-all-types ()
139 (clrhash *lisp-type-to-type-number*)
140 (clrhash *type-number-to-lisp-type*)
141 (type-init) ; initialize the glib type system
142 (mapc #'(lambda (type)
143 (register-type (car type) (cdr type)))
144 *registered-types*)
145 (mapc #'(lambda (type)
146 (register-type-alias (car type) (cdr type)))
147 *registered-type-aliases*))
148
149(pushnew 'reinitialize-all-types
150 #+cmu *after-save-initializations*
151 #+sbcl *init-hooks*)
152
153#+cmu
154(pushnew 'system::reinitialize-global-table ; we shouldn't have to do this?
155 *after-save-initializations*)
156
157
158(defun find-type-number (type &optional error-p)
560af5c5 159 (etypecase type
160 (integer type)
dfa4f314 161 (string (type-number-from-glib-name type error-p))
d4b21b08 162 (symbol
dfa4f314 163 (or
164 (gethash type *lisp-type-to-type-number*)
165 (and error-p (error "Type not registered: ~A" type))))
166 (class (find-type-number (class-name type) error-p))))
560af5c5 167
4de90d10 168(defun type-from-number (type-number &optional error)
169 (multiple-value-bind (type found)
dfa4f314 170 (gethash type-number *type-number-to-lisp-type*)
e7dbc3bf 171 (if found
172 type
dfa4f314 173 (let ((name (find-foreign-type-name type-number)))
e7dbc3bf 174 (cond
cd859052 175 ((and name (not (= (type-number-from-glib-name name nil) type-number)))
e7dbc3bf 176 ;; This is a hack because GdkEvent seems to be registered
177 ;; multiple times
178 (type-from-number (type-number-from-glib-name name)))
179 ((and error name)
180 (error "Type number not registered: ~A (~A)" type-number name))
181 ((and error)
182 (error "Invalid type number: ~A" type-number)))))))
560af5c5 183
dfa4f314 184(defbinding (find-foreign-type-name "g_type_name") (type) (copy-of string)
d4b21b08 185 ((find-type-number type t) type-number))
186
187(defun type-number-of (object)
188 (find-type-number (type-of object) t))
189
21299acf 190(eval-when (:compile-toplevel :load-toplevel :execute)
dfa4f314 191 (defvar *type-initializers* ())
192 (defun %find-types-in-library (pathname prefixes ignore)
21299acf 193 (let ((process (run-program
194 "/usr/bin/nm" (list "--defined-only" "-D" (namestring (truename pathname)))
195 :output :stream :wait nil)))
196 (unwind-protect
197 (loop
198 as symbol = (let ((line (read-line (process-output process) nil)))
199 (when line (subseq line 11)))
200 while symbol
201 when (and
dfa4f314 202 (> (length symbol) 9)
203 (or
204 (not prefixes)
205 (some #'(lambda (prefix)
206 (and
207 (> (length symbol) (length prefix))
208 (string= prefix symbol :end2 (length prefix))))
209 (mklist prefixes)))
210 (string= "_get_type" symbol :start2 (- (length symbol) 9))
21299acf 211 (not (member symbol ignore :test #'string=)))
212 collect symbol)
213 (process-close process)))))
214
560af5c5 215
735a29da 216(defmacro init-types-in-library (filename &key prefix ignore)
21299acf 217 (let ((names (%find-types-in-library filename prefix ignore)))
218 `(progn
219 ,@(mapcar #'(lambda (name)
220 `(progn
221 (defbinding (,(intern name) ,name) () type-number)
dfa4f314 222 (,(intern name))
223 (pushnew ',(intern name) *type-initializers*)))
21299acf 224 names))))
225
dfa4f314 226(defun find-type-init-function (type-number)
735a29da 227 (loop
228 for type-init in *type-initializers*
229 when (= type-number (funcall type-init))
230 do (return type-init)))
231
232(defun register-type-as (type-number)
233 (or
234 (find-type-init-function type-number)
235 (find-foreign-type-name type-number)
236 (error "Unknown type-number: ~A" type-number)))
dfa4f314 237
238(defun default-type-init-name (type)
239 (find-symbol (format nil "~A_~A_get_type"
240 (package-prefix *package*)
241 (substitute #\_ #\- (string-downcase type)))))
242
21299acf 243
15cbdefc 244(eval-when (:compile-toplevel :load-toplevel :execute)
245 (defclass type-info (struct)
246 ((class-size :allocation :alien :type (unsigned 16) :initarg :class-size)
247 (base-init :allocation :alien :type pointer)
248 (base-finalize :allocation :alien :type pointer)
249 (class-init :allocation :alien :type pointer)
250 (class-finalize :allocation :alien :type pointer)
251 (class-data :allocation :alien :type pointer)
252 (instance-size :allocation :alien :type (unsigned 16)
253 :initarg :instance-size)
254 (n-preallocs :allocation :alien :type (unsigned 16))
255 (instance-init :allocation :alien :type pointer)
256 (value-table :allocation :alien :type pointer))
257 (:metaclass struct-class)))
258
259(defbinding %type-register-static () type-number
e7dbc3bf 260 (parent-type type-number)
15cbdefc 261 (name string)
262 (info type-info)
263 (0 unsigned-int))
264
92a07e63 265(defun register-new-type (type parent &optional foreign-name)
15cbdefc 266 (let ((parent-info (type-query parent)))
267 (with-slots ((parent-number type-number) class-size instance-size) parent-info
268 (let ((type-number
269 (%type-register-static
270 parent-number
92a07e63 271 (or foreign-name (default-alien-type-name type))
15cbdefc 272 (make-instance 'type-info :class-size class-size :instance-size instance-size))))
273 (setf (gethash type *lisp-type-to-type-number*) type-number)
274 (setf (gethash type-number *type-number-to-lisp-type*) type)
275 type-number))))
276
277
21299acf 278
279;;;; Metaclass for subclasses of ginstance
280
281(eval-when (:compile-toplevel :load-toplevel :execute)
282 (defclass ginstance-class (proxy-class)
6497583a 283 ((gtype :initarg :gtype :initform nil :reader ginstance-class-gtype))))
cd859052 284
285
09f6e237 286(defmethod compute-foreign-size ((class ginstance-class))
287 (type-instance-size (find-type-number (class-name class))))
288
cd859052 289(defmethod finalize-inheritance ((class ginstance-class))
290 (call-next-method)
291 (let* ((class-name (class-name class))
92a07e63 292 (super (most-specific-proxy-superclass class))
6497583a 293 (gtype (or
294 (first (ginstance-class-gtype class))
295 (default-alien-type-name class-name)))
cd859052 296 (type-number
dfa4f314 297 (or
298 (find-type-number class-name)
348f82de 299 (let ((type-number
300 (if (or
301 (symbolp gtype)
302 (type-number-from-glib-name gtype nil))
303 (register-type class-name gtype)
304 (register-new-type class-name (class-name super) gtype))))
305 (type-class-ref type-number)
306 type-number))))
307 (when (and
308 (supertype type-number)
309 (not (eq (class-name super) (supertype type-number))))
92a07e63 310 (warn "~A is the super type for ~A in the gobject type system."
09f6e237 311 (supertype type-number) class-name))))
4de90d10 312
21299acf 313(defmethod validate-superclass ((class ginstance-class) (super standard-class))
314 (subtypep (class-name super) 'ginstance))
315
560af5c5 316
93aa67db 317;;;; Superclass for wrapping types in the glib type system
560af5c5 318
319(eval-when (:compile-toplevel :load-toplevel :execute)
93aa67db 320 (defclass ginstance (proxy)
09f6e237 321 (;(class :allocation :alien :type pointer :offset 0)
322 )
323 (:metaclass proxy-class)
324 (:size #.(size-of 'pointer))))
560af5c5 325
895c9a9e 326(defun %type-number-of-ginstance (location)
93aa67db 327 (let ((class (sap-ref-sap location 0)))
895c9a9e 328 (sap-ref-32 class 0)))
560af5c5 329
8958fa4a 330(defmethod make-proxy-instance :around ((class ginstance-class) location &rest initargs)
d168bafd 331 (declare (ignore class))
895c9a9e 332 (let ((class (labels ((find-known-class (type-number)
333 (or
334 (find-class (type-from-number type-number) nil)
335 (unless (zerop type-number)
336 (find-known-class (type-parent type-number))))))
337 (find-known-class (%type-number-of-ginstance location)))))
8958fa4a 338 ;; Note that chancing the class argument must not alter "the
339 ;; ordered set of applicable methods" as specified in the
340 ;; Hyperspec
d168bafd 341 (if class
8958fa4a 342 (apply #'call-next-method class location initargs)
343 (error "Object at ~A has an unkown type number: ~A"
344 location (%type-number-of-ginstance location)))))
345
346(defmethod make-proxy-instance ((class ginstance-class) location &rest initargs)
347 (declare (ignore initargs))
348 (reference-foreign class location)
349 ;; Since we make an explicit reference to the foreign object, we
350 ;; always have to release it when the proxy is garbage collected
351 ;; and therefor ignore the weak-p argument.
352 (call-next-method class location :weak nil))
353
4a64c16d 354(defmethod invalidate-instance ((instance ginstance))
355 (declare (ignore instance))
356 ;; A ginstance should never be invalidated since it is ref counted
357 nil)
560af5c5 358
9ca5565a 359(defmethod copy-from-alien-form (location (class ginstance-class) &rest args)
360 (declare (ignore location class args))
361 (error "Doing copy-from-alien on a ref. counted class is most certainly an error, but if it really is what you want you should use REFERENCE-FOREIGN on the returned instance instead."))
362
363(defmethod copy-from-alien-function ((class ginstance-class) &rest args)
364 (declare (ignore class args))
365 (error "Doing copy-from-alien on a ref. counted class is most certainly an error, but if it really is what you want you should use REFERENCE-FOREIGN on the returned instance instead."))
366
367(defmethod reader-function ((class ginstance-class) &rest args)
368 (declare (ignore args))
3005806e 369 #'(lambda (location &optional (offset 0) weak-p)
370 (declare (ignore weak-p))
9ca5565a 371 (ensure-proxy-instance class (sap-ref-sap location offset))))
372
560af5c5 373
d4b21b08 374;;;; Registering fundamental types
375
63752532 376(register-type 'nil "void")
d4b21b08 377(register-type 'pointer "gpointer")
378(register-type 'char "gchar")
379(register-type 'unsigned-char "guchar")
380(register-type 'boolean "gboolean")
d4b21b08 381(register-type 'int "gint")
73383a9e 382(register-type-alias 'integer 'int)
dfa4f314 383(register-type-alias 'fixnum 'int)
d4b21b08 384(register-type 'unsigned-int "guint")
385(register-type 'long "glong")
386(register-type 'unsigned-long "gulong")
387(register-type 'single-float "gfloat")
388(register-type 'double-float "gdouble")
a8cb9408 389(register-type 'pathname "gchararray")
4de90d10 390(register-type 'string "gchararray")
d4b21b08 391
392
62f12808 393;;;; Introspection of type information
d4b21b08 394
e77e7713 395(defvar *derivable-type-info* (make-hash-table))
d4b21b08 396
62f12808 397(defun register-derivable-type (type id expander &optional dependencies)
d4b21b08 398 (register-type type id)
e77e7713 399 (let ((type-number (register-type type id)))
62f12808 400 (setf
401 (gethash type-number *derivable-type-info*)
402 (list expander dependencies))))
d4b21b08 403
4de90d10 404(defun find-type-info (type)
405 (dolist (super (cdr (type-hierarchy type)))
e77e7713 406 (let ((info (gethash super *derivable-type-info*)))
4de90d10 407 (return-if info))))
408
62f12808 409(defun expand-type-definition (type forward-p options)
410 (let ((expander (first (find-type-info type))))
411 (funcall expander (find-type-number type t) forward-p options)))
d4b21b08 412
d4b21b08 413(defbinding type-parent (type) type-number
414 ((find-type-number type t) type-number))
415
416(defun supertype (type)
417 (type-from-number (type-parent type)))
418
337933d8 419(defbinding %type-interfaces (type) pointer
420 ((find-type-number type t) type-number)
421 (n-interfaces unsigned-int :out))
422
423(defun type-interfaces (type)
424 (multiple-value-bind (array length) (%type-interfaces type)
425 (unwind-protect
d168bafd 426 (map-c-vector 'list #'identity array 'type-number length)
337933d8 427 (deallocate-memory array))))
428
429(defun implements (type)
430 (mapcar #'type-from-number (type-interfaces type)))
431
d4b21b08 432(defun type-hierarchy (type)
433 (let ((type-number (find-type-number type t)))
434 (unless (= type-number 0)
435 (cons type-number (type-hierarchy (type-parent type-number))))))
436
437(defbinding (type-is-p "g_type_is_a") (type super) boolean
438 ((find-type-number type) type-number)
439 ((find-type-number super) type-number))
440
441(defbinding %type-children () pointer
442 (type-number type-number)
443 (num-children unsigned-int :out))
444
445(defun map-subtypes (function type &optional prefix)
446 (let ((type-number (find-type-number type t)))
447 (multiple-value-bind (array length) (%type-children type-number)
448 (unwind-protect
d168bafd 449 (map-c-vector
d4b21b08 450 'nil
451 #'(lambda (type-number)
452 (when (or
453 (not prefix)
dfa4f314 454 (string-prefix-p prefix (find-foreign-type-name type-number)))
d4b21b08 455 (funcall function type-number))
456 (map-subtypes function type-number prefix))
457 array 'type-number length)
458 (deallocate-memory array)))))
459
460(defun find-types (prefix)
461 (let ((type-list nil))
e77e7713 462 (maphash
463 #'(lambda (type-number expander)
464 (declare (ignore expander))
465 (map-subtypes
466 #'(lambda (type-number)
467 (pushnew type-number type-list))
468 type-number prefix))
469 *derivable-type-info*)
d4b21b08 470 type-list))
471
62f12808 472(defun find-type-dependencies (type)
473 (let ((list-dependencies (second (find-type-info type))))
474 (when list-dependencies
475 (funcall list-dependencies (find-type-number type t)))))
476
477(defun %sort-types-topologicaly (types)
21299acf 478 (let ((partial-sorted
479 (sort
480 (mapcar
481 #'(lambda (type)
482 (cons type (remove-if #'(lambda (dep)
483 (not (find dep types)))
484 (find-type-dependencies type))))
485 types)
486 #'(lambda (type1 type2) (type-is-p type2 type1)) :key #'car))
62f12808 487 (sorted ()))
488
489 (loop
21299acf 490 as tmp = partial-sorted then (or (rest tmp) partial-sorted)
62f12808 491 while tmp
492 do (destructuring-bind (type . dependencies) (first tmp)
d4b21b08 493 (cond
62f12808 494 ((every #'(lambda (dep)
21299acf 495 (assoc dep sorted))
62f12808 496 dependencies)
21299acf 497 (push (cons type nil) sorted) ; no forward definition needed
498 (setq partial-sorted (delete type partial-sorted :key #'first)))
62f12808 499 ((some #'(lambda (dep)
500 (find type (find-type-dependencies dep)))
501 dependencies)
21299acf 502 (push (cons type t) sorted) ; forward definition needed
503 (setq partial-sorted (delete type partial-sorted :key #'first))))))
504 (nreverse sorted)))
d4b21b08 505
506
507(defun expand-type-definitions (prefix &optional args)
dfa4f314 508 (flet ((type-options (type-number)
509 (let ((name (find-foreign-type-name type-number)))
4de90d10 510 (cdr (assoc name args :test #'string=)))))
d4b21b08 511
e77e7713 512 (let ((type-list
513 (delete-if
514 #'(lambda (type-number)
dfa4f314 515 (let ((name (find-foreign-type-name type-number)))
e77e7713 516 (or
517 (getf (type-options type-number) :ignore)
518 (find-if
519 #'(lambda (options)
520 (and
521 (string-prefix-p (first options) name)
80a09c29 522 (getf (cdr options) :ignore-prefix)
523 (not (some
524 #'(lambda (exception)
525 (string= name exception))
526 (getf (cdr options) :except)))))
e77e7713 527 args))))
528 (find-types prefix))))
21299acf 529
e77e7713 530 (dolist (type-number type-list)
dfa4f314 531 (let ((name (find-foreign-type-name type-number)))
e77e7713 532 (register-type
533 (getf (type-options type-number) :type (default-type-name name))
735a29da 534 (register-type-as type-number))))
21299acf 535
536 (let ((sorted-type-list (%sort-types-topologicaly type-list)))
62f12808 537 `(progn
538 ,@(mapcar
21299acf 539 #'(lambda (pair)
540 (destructuring-bind (type . forward-p) pair
541 (expand-type-definition type forward-p (type-options type))))
542 sorted-type-list)
62f12808 543 ,@(mapcar
21299acf 544 #'(lambda (pair)
545 (destructuring-bind (type . forward-p) pair
546 (when forward-p
547 (expand-type-definition type nil (type-options type)))))
62f12808 548 sorted-type-list))))))
e77e7713 549
d4b21b08 550(defmacro define-types-by-introspection (prefix &rest args)
4de90d10 551 (expand-type-definitions prefix args))
21299acf 552
553
554;;;; Initialize all non static types in GObject
555
556(init-types-in-library #.(concatenate 'string (pkg-config:pkg-variable "glib-2.0" "libdir") "/libgobject-2.0.so"))