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: gtype.lisp,v 1.61 2007-02-23 12:53:08 espen Exp $
29 ;; Initialize the glib type system
30 (defbinding type-init () nil)
33 (eval-when (:compile-toplevel :load-toplevel :execute)
34 (defbinding (bitsize-of-gtype "bitsize_of_gtype") () unsigned-int))
36 (deftype type-number () `(unsigned-byte ,(bitsize-of-gtype)))
38 (deftype gtype () 'symbol)
40 (define-type-method alien-type ((type gtype))
41 (declare (ignore type))
42 (alien-type 'type-number))
44 (define-type-method size-of ((type gtype) &key (inlined t))
45 (assert-inlined type inlined)
46 (size-of 'type-number))
48 (define-type-method to-alien-form ((type gtype) gtype &optional copy-p)
49 (declare (ignore type copy-p))
50 `(find-type-number ,gtype t))
52 (define-type-method to-alien-function ((type gtype) &optional copy-p)
53 (declare (ignore type copy-p))
55 (find-type-number gtype t)))
57 (define-type-method from-alien-form ((type gtype) form &key ref)
58 (declare (ignore type ref))
59 `(type-from-number ,form))
61 (define-type-method from-alien-function ((type gtype) &key ref)
62 (declare (ignore type ref))
63 #'(lambda (type-number)
64 (type-from-number type-number)))
66 (define-type-method writer-function ((type gtype) &key temp (inlined t))
67 (declare (ignore temp))
68 (assert-inlined type inlined)
69 (let ((writer (writer-function 'type-number)))
70 #'(lambda (gtype location &optional (offset 0))
71 (funcall writer (find-type-number gtype t) location offset))))
73 (define-type-method reader-function ((type gtype) &key ref (inlined t))
74 (declare (ignore ref))
75 (assert-inlined type inlined)
76 (let ((reader (reader-function 'type-number)))
77 #'(lambda (location &optional (offset 0))
78 (type-from-number (funcall reader location offset)))))
81 (eval-when (:compile-toplevel :load-toplevel :execute)
82 (defclass type-query (struct)
83 ((type-number :allocation :alien :type type-number)
84 (name :allocation :alien :type (copy-of string))
85 (class-size :allocation :alien :type unsigned-int)
86 (instance-size :allocation :alien :type unsigned-int))
87 (:metaclass struct-class)))
90 (defbinding type-query (type) nil
91 ((find-type-number type t) type-number)
92 ((make-instance 'type-query) type-query :in/return))
94 (defun type-instance-size (type)
95 (slot-value (type-query type) 'instance-size))
97 (defun type-class-size (type)
98 (slot-value (type-query type) 'class-size))
100 (defbinding type-class-ref (type) pointer
101 ((find-type-number type t) type-number))
103 (defbinding type-class-unref () nil
106 (defbinding type-class-peek (type) pointer
107 ((find-type-number type t) type-number))
111 ;;;; Mapping between lisp types and glib types
113 (defvar *registered-types* ())
114 (defvar *registered-type-aliases* ())
115 (defvar *registered-static-types* ())
116 (defvar *lisp-type-to-type-number* (make-hash-table))
117 (defvar *type-number-to-lisp-type* (make-hash-table))
119 (defbinding %type-from-name () type-number
122 (defun type-number-from-glib-name (name &optional (error-p t))
123 (let ((type-number (%type-from-name name)))
125 ((not (zerop type-number)) type-number)
126 (error-p (error "Invalid gtype name: ~A" name)))))
128 (defun type-from-glib-name (name)
129 (type-from-number (type-number-from-glib-name name) t))
131 (defun register-type (type id)
133 ((find-type-number type))
134 ((not id) (warn "Can't register type with no foreign id: ~A" type))
136 (pushnew (cons type id) *registered-types* :key #'car)
139 (string (type-number-from-glib-name id))
140 (symbol (funcall id)))))
141 (setf (gethash type *lisp-type-to-type-number*) type-number)
142 (setf (gethash type-number *type-number-to-lisp-type*) type)
145 (defun register-type-alias (type alias)
146 (pushnew (cons type alias) *registered-type-aliases* :key #'car)
148 (gethash type *lisp-type-to-type-number*)
149 (find-type-number alias t)))
151 (defun reinitialize-all-types ()
152 (clrhash *lisp-type-to-type-number*)
153 (clrhash *type-number-to-lisp-type*)
154 (type-init) ; initialize the glib type system
155 (mapc #'(lambda (type)
156 (register-type (car type) (cdr type)))
158 (mapc #'(lambda (type)
159 (apply #'register-new-type type))
160 (reverse *registered-static-types*))
161 (mapc #'(lambda (type)
162 (register-type-alias (car type) (cdr type)))
163 *registered-type-aliases*))
165 (pushnew 'reinitialize-all-types
166 #+cmu *after-save-initializations*
168 #+clisp custom:*init-hooks*)
171 (pushnew 'system::reinitialize-global-table ; we shouldn't have to do this?
172 *after-save-initializations*)
175 (defun find-type-number (type &optional error-p)
178 (string (type-number-from-glib-name type error-p))
181 (gethash type *lisp-type-to-type-number*)
182 (and error-p (error "Type not registered: ~A" type))))
183 (class (find-type-number (class-name type) error-p))))
185 (defun type-from-number (type-number &optional error)
186 (multiple-value-bind (type found)
187 (gethash type-number *type-number-to-lisp-type*)
190 (let ((name (find-foreign-type-name type-number)))
192 ((and name (not (= (type-number-from-glib-name name nil) type-number)))
193 ;; This is a hack because GdkEvent seems to be registered
195 (type-from-number (type-number-from-glib-name name)))
197 (error "Type number not registered: ~A (~A)" type-number name))
199 (error "Invalid type number: ~A" type-number)))))))
201 (defbinding (find-foreign-type-name "g_type_name") (type) (copy-of string)
202 ((find-type-number type t) type-number))
204 (defun type-number-of (object)
205 (find-type-number (type-of object) t))
207 (eval-when (:compile-toplevel :load-toplevel :execute)
208 (defvar *type-initializers* ())
209 (defun %find-types-in-library (pathname prefixes ignore)
214 (list #-darwin"--defined-only" #-darwin"-D" "-g" #+darwin"-f"
215 #+darwin"-s" #+darwin"__TEXT" #+darwin"__text"
216 (namestring (truename pathname)))
217 :output :stream :wait nil)))
221 #+(or cmu sbcl) (process-output process)
224 as symbol = (when line
225 (let ((pos (position #\Space line :from-end t)))
226 #-darwin(subseq line (1+ pos))
228 (when (char= (char line (1- pos)) #\T)
229 (subseq line (+ pos 2)))))
232 symbol (> (length symbol) 9)
233 (not (char= (char symbol 0) #\_))
236 (some #'(lambda (prefix)
238 (> (length symbol) (length prefix))
239 (string= prefix symbol :end2 (length prefix))))
241 (string= "_get_type" symbol :start2 (- (length symbol) 9))
242 (not (member symbol ignore :test #'string=)))
244 (#+(or cmu sbcl)process-close
249 (defmacro init-types-in-library (filename &key prefix ignore)
250 (let ((names (%find-types-in-library filename prefix ignore)))
252 ,@(mapcar #'(lambda (name)
254 (defbinding (,(intern name) ,name) () type-number)
256 (pushnew ',(intern name) *type-initializers*)))
259 (defun find-type-init-function (type-number)
261 for type-init in *type-initializers*
262 when (= type-number (funcall type-init))
263 do (return type-init)))
265 (defun register-type-as (type-number)
267 (find-type-init-function type-number)
268 (find-foreign-type-name type-number)
269 (error "Unknown type-number: ~A" type-number)))
271 (defun default-type-init-name (type)
272 (find-symbol (format nil "~A_~A_get_type"
273 (package-prefix *package*)
274 (substitute #\_ #\- (string-downcase type)))))
277 (eval-when (:compile-toplevel :load-toplevel :execute)
278 (defclass type-info (struct)
279 ((class-size :allocation :alien :type (unsigned 16) :initarg :class-size)
280 (base-init :allocation :alien :type pointer)
281 (base-finalize :allocation :alien :type pointer)
282 (class-init :allocation :alien :type pointer)
283 (class-finalize :allocation :alien :type pointer)
284 (class-data :allocation :alien :type pointer)
285 (instance-size :allocation :alien :type (unsigned 16)
286 :initarg :instance-size)
287 (n-preallocs :allocation :alien :type (unsigned 16))
288 (instance-init :allocation :alien :type pointer)
289 (value-table :allocation :alien :type pointer))
290 (:metaclass struct-class)))
292 (defbinding %type-register-static () type-number
293 (parent-type type-number)
298 (defun register-new-type (type parent &optional foreign-name)
299 (let ((parent-info (type-query parent)))
300 (with-slots ((parent-number type-number) class-size instance-size) parent-info
302 (%type-register-static
304 (or foreign-name (default-alien-type-name type))
305 (make-instance 'type-info :class-size class-size :instance-size instance-size))))
306 (pushnew (list type parent foreign-name) *registered-static-types* :key #'car)
307 (setf (gethash type *lisp-type-to-type-number*) type-number)
308 (setf (gethash type-number *type-number-to-lisp-type*) type)
313 ;;;; Metaclass for subclasses of ginstance
315 (eval-when (:compile-toplevel :load-toplevel :execute)
316 (defclass ginstance-class (proxy-class)
317 ((gtype :initarg :gtype :initform nil :reader ginstance-class-gtype))))
320 (defun update-size (class)
321 (let ((type-number (find-type-number class)))
323 ((not (foreign-size-p class))
324 (setf (foreign-size class) (type-instance-size type-number)))
326 (foreign-size-p class)
327 (not (= (type-instance-size type-number) (foreign-size class))))
328 (warn "Size mismatch for class ~A" class)))))
331 (defmethod finalize-inheritance ((class ginstance-class))
333 #+clisp(call-next-method)
334 (let* ((class-name (class-name class))
335 (super (most-specific-proxy-superclass class))
337 (first (ginstance-class-gtype class))
338 (default-alien-type-name class-name)))
341 (find-type-number class-name)
345 (type-number-from-glib-name gtype nil))
346 (register-type class-name gtype)
347 (register-new-type class-name (class-name super) gtype))))
348 (type-class-ref type-number)
352 (supertype type-number)
353 (not (eq (class-name super) (supertype type-number))))
354 (warn "Super class mismatch between CLOS and GObject for ~A"
357 #-clisp(call-next-method))
360 (defmethod shared-initialize ((class ginstance-class) names &rest initargs)
361 (declare (ignore names initargs))
363 (when (class-finalized-p class)
364 (update-size class)))
367 (defmethod validate-superclass ((class ginstance-class) (super standard-class))
368 (subtypep (class-name super) 'ginstance))
371 ;;;; Superclass for wrapping types in the glib type system
373 (eval-when (:compile-toplevel :load-toplevel :execute)
374 (defclass ginstance (ref-counted-object)
375 (;(class :allocation :alien :type pointer :offset 0)
377 (:metaclass proxy-class)
378 (:size #.(size-of 'pointer))))
380 (defun ref-type-number (location &optional offset)
381 (declare (ignore location offset)))
383 (setf (symbol-function 'ref-type-number) (reader-function 'type-number))
385 (defun %type-number-of-ginstance (location)
386 (let ((class (ref-pointer location)))
387 (ref-type-number class)))
389 (defmethod make-proxy-instance :around ((class ginstance-class) location
391 (declare (ignore class))
392 (let ((class (labels ((find-known-class (type-number)
394 (find-class (type-from-number type-number) nil)
395 (unless (zerop type-number)
396 (find-known-class (type-parent type-number))))))
397 (find-known-class (%type-number-of-ginstance location)))))
398 ;; Note that chancing the class argument should not alter "the
399 ;; ordered set of applicable methods" as specified in the
402 (apply #'call-next-method class location initargs)
403 (error "Object at ~A has an unkown type number: ~A"
404 location (%type-number-of-ginstance location)))))
407 ;;;; Registering fundamental types
409 (register-type 'nil "void")
410 (register-type 'pointer "gpointer")
411 (register-type 'char "gchar")
412 (register-type 'unsigned-char "guchar")
413 (register-type 'boolean "gboolean")
414 (register-type 'int "gint")
415 (register-type-alias 'integer 'int)
416 (register-type-alias 'fixnum 'int)
417 (register-type 'unsigned-int "guint")
418 (register-type 'long "glong")
419 (register-type 'unsigned-long "gulong")
420 (register-type 'single-float "gfloat")
421 (register-type 'double-float "gdouble")
422 (register-type 'pathname "gchararray")
423 (register-type 'string "gchararray")
426 ;;;; Introspection of type information
428 (defvar *derivable-type-info* (make-hash-table))
430 (defun register-derivable-type (type id expander &optional dependencies)
431 (register-type type id)
432 (let ((type-number (register-type type id)))
434 (gethash type-number *derivable-type-info*)
435 (list expander dependencies))))
437 (defun find-type-info (type)
438 (dolist (super (cdr (type-hierarchy type)))
439 (let ((info (gethash super *derivable-type-info*)))
442 (defun expand-type-definition (type forward-p options)
443 (let ((expander (first (find-type-info type))))
444 (funcall expander (find-type-number type t) forward-p options)))
447 (defbinding type-parent (type) type-number
448 ((find-type-number type t) type-number))
450 (defun supertype (type)
451 (type-from-number (type-parent type)))
453 (defbinding %type-interfaces (type) pointer
454 ((find-type-number type t) type-number)
455 (n-interfaces unsigned-int :out))
457 (defun type-interfaces (type)
458 (multiple-value-bind (array length) (%type-interfaces type)
460 (map-c-vector 'list #'identity array 'type-number length)
461 (deallocate-memory array))))
463 (defun implements (type)
464 (mapcar #'type-from-number (type-interfaces type)))
466 (defun type-hierarchy (type)
467 (let ((type-number (find-type-number type t)))
468 (unless (= type-number 0)
469 (cons type-number (type-hierarchy (type-parent type-number))))))
471 (defbinding (type-is-p "g_type_is_a") (type super) boolean
472 ((find-type-number type) type-number)
473 ((find-type-number super) type-number))
475 (defbinding %type-children () pointer
476 (type-number type-number)
477 (num-children unsigned-int :out))
479 (defun map-subtypes (function type &optional prefix)
480 (let ((type-number (find-type-number type t)))
481 (multiple-value-bind (array length) (%type-children type-number)
485 #'(lambda (type-number)
488 (string-prefix-p prefix (find-foreign-type-name type-number)))
489 (funcall function type-number))
490 (map-subtypes function type-number prefix))
491 array 'type-number length)
492 (deallocate-memory array)))))
494 (defun find-types (prefix)
495 (let ((type-list nil))
497 #'(lambda (type-number expander)
498 (declare (ignore expander))
500 #'(lambda (type-number)
501 (pushnew type-number type-list))
503 *derivable-type-info*)
506 (defun find-type-dependencies (type &optional options)
507 (let ((find-dependencies (second (find-type-info type))))
508 (when find-dependencies
510 (mapcar #'find-type-number
511 (funcall find-dependencies (find-type-number type t) options))))))
514 ;; The argument is a list where each elements is on the form
515 ;; (type . dependencies). This function will not handle indirect
516 ;; dependencies and types depending on them selve.
517 (defun sort-types-topologicaly (unsorted)
518 (flet ((depend-p (type1)
519 (find-if #'(lambda (type2)
521 ;; If a type depends a subtype it has to be
523 (not (type-is-p (car type2) (car type1)))
524 (find (car type2) (cdr type1))))
529 nconc (multiple-value-bind (sorted remaining)
532 (or (not (cdr type)) (not (depend-p type))))
536 ;; We have a circular dependency which have to
544 (not (type-is-p (car type) dep))
545 (not (find dep unsorted :key #'car))))
549 (error "Couldn't resolve circular dependency"))
550 (setq unsorted (delete selected unsorted))
553 (setq unsorted remaining)
556 ;; Mark types which have to be forward defined
559 as (type . dependencies) = (first tmp)
560 collect (cons type (and
562 (find-if #'(lambda (type)
563 (find (car type) dependencies))
568 (defun expand-type-definitions (prefix &optional args)
569 (flet ((type-options (type-number)
570 (let ((name (find-foreign-type-name type-number)))
571 (cdr (assoc name args :test #'string=)))))
575 #'(lambda (type-number)
576 (let ((name (find-foreign-type-name type-number)))
578 (getf (type-options type-number) :ignore)
582 (string-prefix-p (first options) name)
583 (getf (cdr options) :ignore-prefix)
585 #'(lambda (exception)
586 (string= name exception))
587 (getf (cdr options) :except)))))
589 (find-types prefix))))
591 (dolist (type-number type-list)
592 (let ((name (find-foreign-type-name type-number)))
594 (getf (type-options type-number) :type (default-type-name name))
595 (register-type-as type-number))))
597 ;; This is needed for some unknown reason to get type numbers right
598 (mapc #'find-type-dependencies type-list)
600 (let ((sorted-type-list
601 #+clisp (mapcar #'list type-list)
603 (sort-types-topologicaly
606 (cons type (find-type-dependencies type (type-options type))))
611 (destructuring-bind (type . forward-p) pair
612 (expand-type-definition type forward-p (type-options type))))
616 (destructuring-bind (type . forward-p) pair
618 (expand-type-definition type nil (type-options type)))))
619 sorted-type-list))))))
621 (defmacro define-types-by-introspection (prefix &rest args)
622 (expand-type-definitions prefix args))
624 (defexport define-types-by-introspection (prefix &rest args)
625 (list-autoexported-symbols (expand-type-definitions prefix args)))
628 ;;;; Initialize all non static types in GObject
630 (init-types-in-library #.(concatenate 'string (pkg-config:pkg-variable "glib-2.0" "libdir") "/libgobject-2.0." asdf:*dso-extension*))