chiark / gitweb /
Changes necessary to allow saving of core images with clg.
[clg] / glib / gtype.lisp
index 6cab228055ca2352c8914ce9b6576e5cef398cbf..33c8baf62feddbff52db586236a1e537bf627900 100644 (file)
 ;; 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.13 2001-11-12 22:24:29 espen Exp $
+;; $Id: gtype.lisp,v 1.27 2005-03-06 17:26:23 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 (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 %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 t) 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))
@@ -61,87 +99,156 @@ (defbinding type-class-peek (type) pointer
 
 ;;;; Mapping between lisp types and glib types
 
-(defvar *type-to-number-hash* (make-hash-table))
-(defvar *number-to-type-hash* (make-hash-table))
-
-(defun register-type (type id)
-  (let ((type-number
-        (etypecase id
-          (integer id)
-          (string (find-type-number id t)))))
-    (setf (gethash type *type-to-number-hash*) type-number)
-    (setf (gethash type-number *number-to-type-hash*) type)
-    type-number))
+(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))
 
 (defbinding %type-from-name () type-number
   (name string))
 
-(defun find-type-number (type &optional error)
+(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)
-    (string
-     (let ((type-number (%type-from-name type)))
-       (cond
-       ((and (zerop type-number) error)
-        (error "Invalid alien type name: ~A" type))
-       ((zerop type-number) nil)
-       (t type-number))))
+    (string (type-number-from-glib-name type error-p))
     (symbol
-     (let ((type-number (gethash type *type-to-number-hash*)))
-       (or
-       type-number
-       (and error (error "Type not registered: ~A" type)))))
-    (pcl::class (find-type-number (class-name type) error))))
+     (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 &optional error)
   (multiple-value-bind (type found)
-      (gethash type-number *number-to-type-hash*)
+      (gethash type-number *type-number-to-lisp-type*)
     (when (and error (not found))
-      (let ((name (find-type-name type-number)))
+      (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))
 
-(defun type-from-name (name)
-  (etypecase name
-    (string (type-from-number (find-type-number name t)))))
-
-(defbinding (find-type-name "g_type_name") (type) string
+(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) t))
 
-(defun init-type (init)
-  (mapc
-   #'(lambda (fname)
-       (funcall (mkbinding fname 'type-number)))
-   (mklist init)))
-
-(defun %init-types-in-library (pathname ignore)
-  (let ((process (ext:run-program
-                 "nm" (list "-D" (namestring (truename pathname)))
-                 :output :stream :wait nil))
-       (fnames ()))
-    (labels ((read-symbols ()
-              (let ((line (read-line (ext:process-output process) nil)))
-                (when line
-                  (let ((symbol (subseq line 11)))
-                    (when (and
-                           (search "_get_type" symbol)
-                           (not (member symbol ignore :test #'string=)))
-                      (push symbol fnames)))
-                  (read-symbols)))))
-      (read-symbols)
-      (ext:process-close process)
-      `(init-type ',fnames))))
-
-(defmacro init-types-in-library (filename &key ignore)
-  (%init-types-in-library
-   (format nil "~A/~A" user::gtk-library-path filename) ignore))
+(eval-when (:compile-toplevel :load-toplevel :execute)
+  (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)
+  (or
+   (loop
+    for type-init in *type-initializers*
+    when (= type-number (funcall type-init))
+    do (return type-init))
+   (error "Can't find init function for type number ~D" type-number)))
+
+(defun default-type-init-name (type)
+  (find-symbol (format nil "~A_~A_get_type" 
+               (package-prefix *package*)
+               (substitute #\_ #\- (string-downcase type)))))
+
+
+
+;;;; Metaclass for subclasses of ginstance
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+  (defclass ginstance-class (proxy-class)
+    ()))
 
 
+(defmethod shared-initialize ((class ginstance-class) names &key name gtype)
+  (declare (ignore names))
+  (let* ((class-name (or name (class-name class)))
+        (type-number 
+         (or 
+          (find-type-number class-name)
+          (register-type class-name 
+            (or (first gtype) (default-type-init-name class-name))))))
+    (call-next-method)
+    (when (slot-boundp class 'size)
+      (setf (slot-value class 'size) (type-instance-size type-number)))))
+
+
+(defmethod validate-superclass ((class ginstance-class) (super standard-class))
+  (subtypep (class-name super) 'ginstance))
+
 
 ;;;; Superclass for wrapping types in the glib type system
 
@@ -152,91 +259,67 @@   (defclass ginstance (proxy)
 
 (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))))
-
-
+    (type-from-number (sap-ref-32 class 0))))
 
-;;;; Metaclass for subclasses of ginstance
+(defmethod ensure-proxy-instance ((class ginstance-class) location)
+  (declare (ignore class))
+  (let ((class (find-class (%type-of-ginstance location))))
+    (if class
+       (make-instance class :location (reference-foreign class location))
+      ;; TODO: (make-instance 'ginstance ...)
+      location)))
 
-(eval-when (:compile-toplevel :load-toplevel :execute)
-  (defclass ginstance-class (proxy-class)))
+(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 shared-initialize ((class ginstance-class) names
-                             &rest initargs &key name alien-name
-                             size ref unref)
-  (declare (ignore initargs names))
-  (let* ((class-name (or name (class-name class)))
-        (type-number
-         (find-type-number
-          (or (first alien-name) (default-alien-type-name class-name)) t)))
-    (register-type class-name type-number)
-    (let ((size (or size (type-instance-size type-number))))
-      (declare (special size))
-      (call-next-method)))
-
-  (when ref
-    (let ((ref (mkbinding (first ref) 'pointer 'pointer)))
-      (setf
-       (slot-value class 'copy)
-       #'(lambda (type location)
-          (declare (ignore type))
-          (funcall ref location)))))     
-  (when unref
-    (let ((unref (mkbinding (first unref) 'nil 'pointer)))
-      (setf
-       (slot-value class 'free)
-       #'(lambda (type location)
-          (declare (ignore type))
-          (funcall unref location))))))
-
-
-(defmethod validate-superclass
-    ((class ginstance-class) (super pcl::standard-class))
-  (subtypep (class-name super) 'ginstance))
+(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 'fixnum "gint")
 (register-type 'int "gint")
+(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)
+(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*) expander)))
+    (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 options)
-  (let ((expander (find-type-info type)))
-    (funcall expander (find-type-number type t) options)))
+(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))
@@ -244,6 +327,19 @@ (defbinding type-parent (type) 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)
@@ -261,12 +357,12 @@ (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-array
+         (map-c-vector
           'nil
           #'(lambda (type-number)
               (when (or
                      (not prefix)
-                     (string-prefix-p prefix (find-type-name type-number)))
+                     (string-prefix-p prefix (find-foreign-type-name type-number)))
                 (funcall function type-number))
               (map-subtypes function type-number prefix))
           array 'type-number length)
@@ -284,58 +380,88 @@ (defun find-types (prefix)
      *derivable-type-info*)
     type-list))
 
-(defun %sort-types-topologicaly (unsorted)
-  (let ((sorted ()))
-    (loop while unsorted do
-      (dolist (type unsorted)
-       (let ((dependencies (rest (type-hierarchy type))))
+(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
-          ((null dependencies)
-           (push type sorted)
-           (setq unsorted (delete type unsorted)))
-          (t
-           (unless (dolist (dep dependencies)
-                     (when (find type (rest (type-hierarchy dep)))
-                       (error "Cyclic type dependencie"))
-                     (return-if (find dep unsorted)))
-             (push type sorted)
-             (setq unsorted (delete type unsorted))))))))
+          ((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-type-name type-number)))
 (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-type-name 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)))
+                       (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-type-name type-number)))
+       (let ((name (find-foreign-type-name type-number)))
         (register-type
          (getf (type-options type-number) :type (default-type-name name))
-         type-number)))
-    
-     `(progn
-       ,@(mapcar
-          #'(lambda (type)
-              (expand-type-definition type (type-options type)))
-          (%sort-types-topologicaly type-list))))))
+         (find-type-init-function 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"))