chiark / gitweb /
Added with-gvalue macro
[clg] / glib / gtype.lisp
index 9cd231991cea62e33c4a2f72a7bb1fef8f75cada..70f9eeb95cecd02b8280fb214c86dff55b83c41c 100644 (file)
@@ -1,5 +1,5 @@
 ;; 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.9 2001-04-30 11:25:25 espen Exp $
+;; $Id: gtype.lisp,v 1.19 2004-11-07 01:21:04 espen Exp $
 
 (in-package "GLIB")
 
 (use-prefix "g")
 
-
-;;;; 
+;; Initialize the glib type system
+(defbinding type-init () nil)
+(type-init)
 
 (deftype type-number () '(unsigned 32))
 
 (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)))
-
-
-(defbinding ("g_type_name" alien-type-name) (type) (static string)
-  ((find-type-number type) type-number))
-
-(defbinding %type-from-name () type-number
-  (name string))
+    (:metaclass struct-class)))
 
-(defbinding type-parent () type-number
-  (type type-number))
 
 (defbinding %type-query () nil
   (type type-number)
@@ -50,7 +42,7 @@ (defbinding %type-query () nil
 
 (defun type-query (type)
   (let ((query (make-instance 'type-query)))
-    (%type-query (find-type-number type) query)
+    (%type-query (find-type-number type t) query)
     query))
 
 (defun type-instance-size (type)
@@ -59,187 +51,298 @@ (defun type-instance-size (type)
 (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 *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))
-
-(defun find-type-number (type)
+(defun register-type (type id)
+  (let ((type-number
+        (etypecase id
+          (integer id)
+          (string (find-type-number id t))
+          (symbol (gethash id *type-to-number-hash*)))))
+    (setf (gethash type *type-to-number-hash*) type-number)
+    (unless (symbolp id)
+      (setf (gethash type-number *number-to-type-hash*) type))
+    type-number))
+
+(defbinding %type-from-name () type-number
+  (name string))
+
+(defun find-type-number (type &optional error)
   (etypecase type
     (integer type)
-    (symbol (gethash type *type-to-number-hash*))
-    (pcl::class (gethash (class-name type) *type-to-number-hash*))))
+    (string
+     (let ((type-number (%type-from-name type)))
+       (cond
+       ((and (zerop type-number) error)
+        (error "Invalid gtype name: ~A" type))
+       ((zerop type-number) nil)
+       (t type-number))))
+    (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))))
  
-(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 *number-to-type-hash*)
+    (when (and error (not found))
+      (let ((name (find-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
+  ((find-type-number type t) type-number))
 
 (defun type-number-of (object)
-  (find-type-number (type-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 prefix 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
+                           (> (length symbol) (length prefix))
+                           (string= prefix symbol :end2 (length prefix))
+                           (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 (prefix "") ignore)
+  (%init-types-in-library filename prefix ignore))
 
-(defun type-init (name &optional init-fname)
-  (funcall
-   (mkbinding
-    (or init-fname (default-alien-fname (format nil "~A_get_type" name)))
-    'type-number)))
 
 
 ;;;; Superclass for wrapping types in the glib type system
 
 (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))))
+    ((class :allocation :alien :type pointer))
+    (:metaclass proxy-class)))
 
 (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)))
+    (type-from-number (sap-ref-32 class 0))))
 
+(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)))
 
 
 ;;;; Metaclass for subclasses of ginstance
 
 (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)
-
+                             &rest initargs &key name alien-name)
+  (declare (ignore 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)
+    (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))
+
+
+;;;; Registering fundamental types
+
+(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 'unsigned-int "guint")
+(register-type 'long "glong")
+(register-type 'unsigned-long "gulong")
+(register-type 'single-float "gfloat")
+(register-type 'double-float "gdouble")
+(register-type 'string "gchararray")
+
+
+;;;; 
+
+(defvar *derivable-type-info* (make-hash-table))
+
+(defun register-derivable-type (type id expander)
+  (register-type type id)
+  (let ((type-number (register-type type id)))
+    (setf (gethash type-number *derivable-type-info*) expander)))
+
+(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)))
+
+(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-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 %sort-types-topologicaly (unsorted)
+  (let ((sorted ()))
+    (loop while unsorted do
+      (dolist (type unsorted)
+       (let ((dependencies
+              (append (rest (type-hierarchy type)) (type-interfaces type))))
          (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)))
+          ((null dependencies)
+           (push type sorted)
+           (setq unsorted (delete type unsorted)))
           (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)
-       (mkbinding (first ref) 'pointer 'pointer)))
-    (when unref
-      (setf
-       (slot-value class 'unref)
-       (mkbinding (first unref) 'nil '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))
-  (subtypep (class-name super) 'ginstance))
+           (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))))))))
+    (nreverse sorted)))
+
+
+(defun expand-type-definitions (prefix &optional args)
+ (flet ((type-options (type-number)
+          (let ((name (find-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)))
+                (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-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))))))
+
+(defmacro define-types-by-introspection (prefix &rest args)
+  (expand-type-definitions prefix args))
+
 
 
-;;;; 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))