;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 2000 Espen S. Johnsen <esj@stud.cs.uit.no>
+;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
;;
;; This library is free software; you can redistribute it and/or
;; modify it under the terms of the GNU Lesser General Public
;; License along with this library; if not, write to the Free Software
;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-;; $Id: gtype.lisp,v 1.8 2001/04/29 20:17:07 espen Exp $
+;; $Id: gtype.lisp,v 1.31 2005/04/03 17:14:38 espen Exp $
(in-package "GLIB")
(use-prefix "g")
-
-;;;;
+;; Initialize the glib type system
+(defbinding type-init () nil)
+(type-init)
(deftype type-number () '(unsigned 32))
+(deftype gtype () 'symbol)
+
+(defmethod alien-type ((type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ (alien-type 'type-number))
+
+(defmethod size-of ((type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ (size-of 'type-number))
+
+(defmethod to-alien-form (gtype (type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ `(find-type-number ,gtype t))
+
+(defmethod to-alien-function ((type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ #'(lambda (gtype)
+ (find-type-number gtype t)))
+
+(defmethod from-alien-form (type-number (type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ `(type-from-number ,type-number))
+
+(defmethod from-alien-function ((type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ #'(lambda (type-number)
+ (type-from-number type-number)))
+
+(defmethod writer-function ((type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ (let ((writer (writer-function 'type-number)))
+ #'(lambda (gtype location &optional (offset 0))
+ (funcall writer (find-type-number gtype t) location offset))))
+
+(defmethod reader-function ((type (eql 'gtype)) &rest args)
+ (declare (ignore type args))
+ (let ((reader (reader-function 'type-number)))
+ #'(lambda (location &optional (offset 0))
+ (type-from-number (funcall reader location offset)))))
+
+
(eval-when (:compile-toplevel :load-toplevel :execute)
- (defclass type-query (alien-structure)
+ (defclass type-query (struct)
((type-number :allocation :alien :type type-number)
(name :allocation :alien :type string)
(class-size :allocation :alien :type unsigned-int)
(instance-size :allocation :alien :type unsigned-int))
- (:metaclass proxy-class)))
+ (:metaclass struct-class)))
-(defbinding ("g_type_name" alien-type-name) (type) (static string)
- ((find-type-number type) type-number))
-
-(defbinding %type-from-name () type-number
- (name string))
-
-(defbinding type-parent () type-number
- (type type-number))
-
-(defbinding %type-query () nil
- (type type-number)
- (query type-query))
-
-(defun type-query (type)
- (let ((query (make-instance 'type-query)))
- (%type-query (find-type-number type) query)
- query))
+(defbinding type-query (type) nil
+ ((find-type-number type t) type-number)
+ ((make-instance 'type-query) type-query :return))
(defun type-instance-size (type)
(slot-value (type-query type) 'instance-size))
(defun type-class-size (type)
(slot-value (type-query type) 'class-size))
-(defbinding type-class-ref () pointer
- (type type-number))
+(defbinding type-class-ref (type) pointer
+ ((find-type-number type t) type-number))
-(defbinding type-class-unref () nil
- (type type-number))
+(defbinding type-class-unref (type) nil
+ ((find-type-number type t) type-number))
-(defbinding type-class-peek () pointer
- (type type-number))
+(defbinding type-class-peek (type) pointer
+ ((find-type-number type t) type-number))
-(defbinding type-create-instance (type) pointer
- ((find-type-number type) type-number))
-(defbinding type-free-instance () nil
- (instance pointer))
+;;;; Mapping between lisp types and glib types
+(defvar *registered-types* ())
+(defvar *registered-type-aliases* ())
+(defvar *lisp-type-to-type-number* (make-hash-table))
+(defvar *type-number-to-lisp-type* (make-hash-table))
-(defvar *type-to-number-hash* (make-hash-table))
-(defvar *number-to-type-hash* (make-hash-table))
-
-(defun type-number-from-alien-name (name &optional (error t))
- (if (string= name "invalid")
- 0
- (let ((type-number (%type-from-name name)))
- (cond
- ((and (zerop type-number) error)
- (error "Invalid alien type name: ~A" name))
- ((zerop type-number) nil)
- (t type-number)))))
-
-(defun (setf alien-type-name) (alien-name type)
- (let ((type-name (ensure-type-name type))
- (type-number (type-number-from-alien-name alien-name)))
- (setf (gethash type-number *number-to-type-hash*) type-name)
- (setf (gethash type-name *type-to-number-hash*) type-number)))
-
-(defun (setf find-type-number) (type-number type)
- (setf (gethash (ensure-type-name type) *type-to-number-hash*) type-number))
+(defbinding %type-from-name () type-number
+ (name string))
-(defun find-type-number (type)
+(defun type-number-from-glib-name (name &optional (error-p t))
+ (let ((type-number (%type-from-name name)))
+ (cond
+ ((not (zerop type-number)) type-number)
+ (error-p (error "Invalid gtype name: ~A" name)))))
+
+(defun register-type (type id)
+ (pushnew (cons type id) *registered-types* :key #'car)
+ (let ((type-number
+ (typecase id
+ (string (type-number-from-glib-name id))
+ (symbol (funcall id)))))
+ (setf (gethash type *lisp-type-to-type-number*) type-number)
+ (setf (gethash type-number *type-number-to-lisp-type*) type)
+ type-number))
+
+(defun register-type-alias (type alias)
+ (pushnew (cons type alias) *registered-type-aliases* :key #'car)
+ (setf
+ (gethash type *lisp-type-to-type-number*)
+ (find-type-number alias t)))
+
+(defun reinitialize-all-types ()
+ (clrhash *lisp-type-to-type-number*)
+ (clrhash *type-number-to-lisp-type*)
+ (type-init) ; initialize the glib type system
+ (mapc #'(lambda (type)
+ (register-type (car type) (cdr type)))
+ *registered-types*)
+ (mapc #'(lambda (type)
+ (register-type-alias (car type) (cdr type)))
+ *registered-type-aliases*))
+
+(pushnew 'reinitialize-all-types
+ #+cmu *after-save-initializations*
+ #+sbcl *init-hooks*)
+
+#+cmu
+(pushnew 'system::reinitialize-global-table ; we shouldn't have to do this?
+ *after-save-initializations*)
+
+
+(defun find-type-number (type &optional error-p)
(etypecase type
(integer type)
- (symbol (gethash type *type-to-number-hash*))
- (pcl::class (gethash (class-name type) *type-to-number-hash*))))
+ (string (type-number-from-glib-name type error-p))
+ (symbol
+ (or
+ (gethash type *lisp-type-to-type-number*)
+ (and error-p (error "Type not registered: ~A" type))))
+ (class (find-type-number (class-name type) error-p))))
-(defun type-from-number (type-number)
- (gethash type-number *number-to-type-hash*))
+(defun type-from-number (type-number &optional error)
+ (multiple-value-bind (type found)
+ (gethash type-number *type-number-to-lisp-type*)
+ (when (and error (not found))
+ (let ((name (find-foreign-type-name type-number)))
+ (if name
+ (error "Type number not registered: ~A (~A)" type-number name)
+ (error "Invalid type number: ~A" type-number))))
+ type))
+
+(defbinding (find-foreign-type-name "g_type_name") (type) (copy-of string)
+ ((find-type-number type t) type-number))
(defun type-number-of (object)
- (find-type-number (type-of object)))
-
-(defun alien-function (name return-type &rest arg-types)
- (let ((alien
- (alien::%heap-alien
- (alien::make-heap-alien-info
- :type (alien::parse-alien-type
- `(function ,@(cons return-type arg-types)))
- :sap-form (system:foreign-symbol-address name)))))
- #'(lambda (&rest args)
- (apply #'alien:alien-funcall alien args))))
-
-
-(defun type-init (name &optional init-fname)
- (funcall
- (alien-function
- (or
- init-fname
- (default-alien-fname (format nil "~A_get_type" name)))
- '(unsigned 32))))
-
-
-;;;; Superclass for wrapping types in the glib type system
+ (find-type-number (type-of object) t))
(eval-when (:compile-toplevel :load-toplevel :execute)
- (defclass ginstance (proxy)
- ()
- (:metaclass proxy-class)
- (:size 4 #|(size-of 'pointer|#)))
-
-(defmethod initialize-proxy ((instance ginstance) &rest initargs &key location)
- (declare (ignore initargs))
- (setf
- (slot-value instance 'location)
- (funcall (ginstance-class-ref (class-of instance)) location))
- (call-next-method))
-
-(defmethod instance-finalizer ((instance ginstance))
- (let ((location (proxy-location instance))
- (unref (ginstance-class-unref (class-of instance))))
- (declare (type system-area-pointer location))
- #'(lambda ()
- (funcall unref location)
- (remove-cached-instance location))))
-
-(defun %type-of-ginstance (location)
- (let ((class (sap-ref-sap location 0)))
- (type-from-number (sap-ref-unsigned class 0))))
-
-(deftype-method translate-from-alien
- ginstance (type-spec location &optional weak-ref)
- (declare (ignore type-spec))
- `(let ((location ,location))
- (unless (null-pointer-p location)
- (ensure-proxy-instance
- (%type-of-ginstance location) location ,weak-ref))))
-
-(deftype-method translate-to-alien
- ginstance (type-spec object &optional weak-ref)
- (declare (ignore type-spec))
- (if weak-ref
- `(proxy-location ,object)
- `(let ((object ,object))
- (funcall
- (ginstance-class-ref (class-of object)) (proxy-location object)))))
-
-(deftype-method unreference-alien ginstance (type-spec location)
- (declare (ignore type-spec))
- `(let* ((location ,location)
- (class (find-class (%type-of-ginstance location))))
- (funcall (ginstance-class-unref class) location)))
+ (defvar *type-initializers* ())
+ (defun %find-types-in-library (pathname prefixes ignore)
+ (let ((process (run-program
+ "/usr/bin/nm" (list "--defined-only" "-D" (namestring (truename pathname)))
+ :output :stream :wait nil)))
+ (unwind-protect
+ (loop
+ as symbol = (let ((line (read-line (process-output process) nil)))
+ (when line (subseq line 11)))
+ while symbol
+ when (and
+ (> (length symbol) 9)
+ (or
+ (not prefixes)
+ (some #'(lambda (prefix)
+ (and
+ (> (length symbol) (length prefix))
+ (string= prefix symbol :end2 (length prefix))))
+ (mklist prefixes)))
+ (string= "_get_type" symbol :start2 (- (length symbol) 9))
+ (not (member symbol ignore :test #'string=)))
+ collect symbol)
+ (process-close process)))))
+
+
+(defmacro init-types-in-library (filename &key prefix ignore)
+ (let ((names (%find-types-in-library filename prefix ignore)))
+ `(progn
+ ,@(mapcar #'(lambda (name)
+ `(progn
+ (defbinding (,(intern name) ,name) () type-number)
+ (,(intern name))
+ (pushnew ',(intern name) *type-initializers*)))
+ names))))
+
+(defun find-type-init-function (type-number)
+ (loop
+ for type-init in *type-initializers*
+ when (= type-number (funcall type-init))
+ do (return type-init)))
+
+(defun register-type-as (type-number)
+ (or
+ (find-type-init-function type-number)
+ (find-foreign-type-name type-number)
+ (error "Unknown type-number: ~A" type-number)))
+
+(defun default-type-init-name (type)
+ (find-symbol (format nil "~A_~A_get_type"
+ (package-prefix *package*)
+ (substitute #\_ #\- (string-downcase type)))))
(eval-when (:compile-toplevel :load-toplevel :execute)
(defclass ginstance-class (proxy-class)
- ((ref :reader ginstance-class-ref)
- (unref :reader ginstance-class-unref))))
-
+ ()))
-(defmethod shared-initialize ((class ginstance-class) names
- &rest initargs
- &key name alien-name size
- ref unref type-init)
- (declare (ignore initargs names))
- (call-next-method)
+(defmethod shared-initialize ((class ginstance-class) names &rest initargs &key name gtype)
+ (declare (ignore names))
(let* ((class-name (or name (class-name class)))
- (type-number
- (cond
- ((and alien-name type-init)
- (error
- "Specify either :type-init or :alien-name for class ~A"
- class-name))
- (alien-name (type-number-from-alien-name (first alien-name)))
- (type-init (type-init class-name (first type-init)))
- (t
- (or
- (type-number-from-alien-name
- (default-alien-type-name class-name) nil)
- (type-init class-name))))))
- (setf (find-type-number class) type-number)
- (unless size
- (setf
- (slot-value class 'size)
- (type-instance-size (find-type-number class-name))))
- (when ref
- (setf
- (slot-value class 'ref)
- (alien-function (first ref) 'system-area-pointer 'system-area-pointer)))
- (when unref
- (setf
- (slot-value class 'unref)
- (alien-function (first unref) 'void 'system-area-pointer)))))
-
-(defmethod shared-initialize :after ((class ginstance-class) names
- &rest initargs)
- (declare (ignore names initargs))
- (unless (slot-boundp class 'ref)
- (setf
- (slot-value class 'ref)
- (ginstance-class-ref (most-specific-proxy-superclass class))))
- (unless (slot-boundp class 'unref)
- (setf
- (slot-value class 'unref)
- (ginstance-class-unref (most-specific-proxy-superclass class)))))
-
-
-(defmethod validate-superclass
- ((class ginstance-class) (super pcl::standard-class))
+ (type-number
+ (or
+ (find-type-number class-name)
+ (register-type class-name
+ (or (first gtype) (default-type-init-name class-name))))))
+ (if (getf initargs :size)
+ (call-next-method)
+ (let ((size (type-instance-size type-number)))
+ (apply #'call-next-method class names :size (list size) initargs)))))
+
+
+(defmethod validate-superclass ((class ginstance-class) (super standard-class))
(subtypep (class-name super) 'ginstance))
-;;;; Initializing type numbers
-
-(setf (alien-type-name 'invalid) "invalid")
-(setf (alien-type-name 'char) "gchar")
-(setf (alien-type-name 'unsigned-char) "guchar")
-(setf (alien-type-name 'boolean) "gboolean")
-(setf (alien-type-name 'int) "gint")
-(setf (alien-type-name 'unsigned-int) "guint")
-(setf (alien-type-name 'long) "glong")
-(setf (alien-type-name 'unsigned-long) "gulong")
-(setf (alien-type-name 'single-float) "gfloat")
-(setf (alien-type-name 'double-float) "gdouble")
-(setf (alien-type-name 'string) "GString")
-(setf (find-type-number 'fixnum) (find-type-number 'int))
+;;;; Superclass for wrapping types in the glib type system
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+ (defclass ginstance (proxy)
+ ((class :allocation :alien :type pointer))
+ (:metaclass proxy-class)))
+
+(defun %type-number-of-ginstance (location)
+ (let ((class (sap-ref-sap location 0)))
+ (sap-ref-32 class 0)))
+
+(defmethod ensure-proxy-instance ((class ginstance-class) location)
+ (declare (ignore class))
+ (let ((class (labels ((find-known-class (type-number)
+ (or
+ (find-class (type-from-number type-number) nil)
+ (unless (zerop type-number)
+ (find-known-class (type-parent type-number))))))
+ (find-known-class (%type-number-of-ginstance location)))))
+ (if class
+ (make-instance class :location (reference-foreign class location))
+ (error "Object at ~A has an unkown type number: ~A"
+ location (%type-number-of-ginstance location)))))
+
+(defmethod copy-from-alien-form (location (class ginstance-class) &rest args)
+ (declare (ignore location class args))
+ (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."))
+
+(defmethod copy-from-alien-function ((class ginstance-class) &rest args)
+ (declare (ignore class args))
+ (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."))
+
+(defmethod reader-function ((class ginstance-class) &rest args)
+ (declare (ignore args))
+ #'(lambda (location &optional (offset 0))
+ (ensure-proxy-instance class (sap-ref-sap location offset))))
+
+
+;;;; Registering fundamental types
+
+(register-type 'nil "void")
+(register-type 'pointer "gpointer")
+(register-type 'char "gchar")
+(register-type 'unsigned-char "guchar")
+(register-type 'boolean "gboolean")
+(register-type 'int "gint")
+(register-type-alias 'integer 'int)
+(register-type-alias 'fixnum 'int)
+(register-type 'unsigned-int "guint")
+(register-type 'long "glong")
+(register-type 'unsigned-long "gulong")
+(register-type 'single-float "gfloat")
+(register-type 'double-float "gdouble")
+(register-type 'pathname "gchararray")
+(register-type 'string "gchararray")
+
+
+;;;; Introspection of type information
+
+(defvar *derivable-type-info* (make-hash-table))
+
+(defun register-derivable-type (type id expander &optional dependencies)
+ (register-type type id)
+ (let ((type-number (register-type type id)))
+ (setf
+ (gethash type-number *derivable-type-info*)
+ (list expander dependencies))))
+
+(defun find-type-info (type)
+ (dolist (super (cdr (type-hierarchy type)))
+ (let ((info (gethash super *derivable-type-info*)))
+ (return-if info))))
+
+(defun expand-type-definition (type forward-p options)
+ (let ((expander (first (find-type-info type))))
+ (funcall expander (find-type-number type t) forward-p options)))
+
+(defbinding type-parent (type) type-number
+ ((find-type-number type t) type-number))
+
+(defun supertype (type)
+ (type-from-number (type-parent type)))
+
+(defbinding %type-interfaces (type) pointer
+ ((find-type-number type t) type-number)
+ (n-interfaces unsigned-int :out))
+
+(defun type-interfaces (type)
+ (multiple-value-bind (array length) (%type-interfaces type)
+ (unwind-protect
+ (map-c-vector 'list #'identity array 'type-number length)
+ (deallocate-memory array))))
+
+(defun implements (type)
+ (mapcar #'type-from-number (type-interfaces type)))
+
+(defun type-hierarchy (type)
+ (let ((type-number (find-type-number type t)))
+ (unless (= type-number 0)
+ (cons type-number (type-hierarchy (type-parent type-number))))))
+
+(defbinding (type-is-p "g_type_is_a") (type super) boolean
+ ((find-type-number type) type-number)
+ ((find-type-number super) type-number))
+
+(defbinding %type-children () pointer
+ (type-number type-number)
+ (num-children unsigned-int :out))
+
+(defun map-subtypes (function type &optional prefix)
+ (let ((type-number (find-type-number type t)))
+ (multiple-value-bind (array length) (%type-children type-number)
+ (unwind-protect
+ (map-c-vector
+ 'nil
+ #'(lambda (type-number)
+ (when (or
+ (not prefix)
+ (string-prefix-p prefix (find-foreign-type-name type-number)))
+ (funcall function type-number))
+ (map-subtypes function type-number prefix))
+ array 'type-number length)
+ (deallocate-memory array)))))
+
+(defun find-types (prefix)
+ (let ((type-list nil))
+ (maphash
+ #'(lambda (type-number expander)
+ (declare (ignore expander))
+ (map-subtypes
+ #'(lambda (type-number)
+ (pushnew type-number type-list))
+ type-number prefix))
+ *derivable-type-info*)
+ type-list))
+
+(defun find-type-dependencies (type)
+ (let ((list-dependencies (second (find-type-info type))))
+ (when list-dependencies
+ (funcall list-dependencies (find-type-number type t)))))
+
+(defun %sort-types-topologicaly (types)
+ (let ((partial-sorted
+ (sort
+ (mapcar
+ #'(lambda (type)
+ (cons type (remove-if #'(lambda (dep)
+ (not (find dep types)))
+ (find-type-dependencies type))))
+ types)
+ #'(lambda (type1 type2) (type-is-p type2 type1)) :key #'car))
+ (sorted ()))
+
+ (loop
+ as tmp = partial-sorted then (or (rest tmp) partial-sorted)
+ while tmp
+ do (destructuring-bind (type . dependencies) (first tmp)
+ (cond
+ ((every #'(lambda (dep)
+ (assoc dep sorted))
+ dependencies)
+ (push (cons type nil) sorted) ; no forward definition needed
+ (setq partial-sorted (delete type partial-sorted :key #'first)))
+ ((some #'(lambda (dep)
+ (find type (find-type-dependencies dep)))
+ dependencies)
+ (push (cons type t) sorted) ; forward definition needed
+ (setq partial-sorted (delete type partial-sorted :key #'first))))))
+ (nreverse sorted)))
+
+
+(defun expand-type-definitions (prefix &optional args)
+ (flet ((type-options (type-number)
+ (let ((name (find-foreign-type-name type-number)))
+ (cdr (assoc name args :test #'string=)))))
+
+ (let ((type-list
+ (delete-if
+ #'(lambda (type-number)
+ (let ((name (find-foreign-type-name type-number)))
+ (or
+ (getf (type-options type-number) :ignore)
+ (find-if
+ #'(lambda (options)
+ (and
+ (string-prefix-p (first options) name)
+ (getf (cdr options) :ignore-prefix)
+ (not (some
+ #'(lambda (exception)
+ (string= name exception))
+ (getf (cdr options) :except)))))
+ args))))
+ (find-types prefix))))
+
+ (dolist (type-number type-list)
+ (let ((name (find-foreign-type-name type-number)))
+ (register-type
+ (getf (type-options type-number) :type (default-type-name name))
+ (register-type-as type-number))))
+
+ (let ((sorted-type-list (%sort-types-topologicaly type-list)))
+ `(progn
+ ,@(mapcar
+ #'(lambda (pair)
+ (destructuring-bind (type . forward-p) pair
+ (expand-type-definition type forward-p (type-options type))))
+ sorted-type-list)
+ ,@(mapcar
+ #'(lambda (pair)
+ (destructuring-bind (type . forward-p) pair
+ (when forward-p
+ (expand-type-definition type nil (type-options type)))))
+ sorted-type-list))))))
+
+(defmacro define-types-by-introspection (prefix &rest args)
+ (expand-type-definitions prefix args))
+
+
+;;;; Initialize all non static types in GObject
+
+(init-types-in-library #.(concatenate 'string (pkg-config:pkg-variable "glib-2.0" "libdir") "/libgobject-2.0.so"))