chiark / gitweb /
Made toggle reference depend on glib2.8
[clg] / glib / gtype.lisp
index 9006d32f4c570649e0afe37e324f2cb37ef252be..6b9d31eeecf1e994f7530932eafe45ccf054cde9 100644 (file)
@@ -1,21 +1,26 @@
-;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 2000-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
+;; Common Lisp bindings for GTK+ v2.x
+;; Copyright 2000-2005 Espen S. Johnsen <espen@users.sf.net>
 ;;
-;; This library is free software; you can redistribute it and/or
-;; modify it under the terms of the GNU Lesser General Public
-;; License as published by the Free Software Foundation; either
-;; version 2 of the License, or (at your option) any later version.
+;; Permission is hereby granted, free of charge, to any person obtaining
+;; a copy of this software and associated documentation files (the
+;; "Software"), to deal in the Software without restriction, including
+;; without limitation the rights to use, copy, modify, merge, publish,
+;; distribute, sublicense, and/or sell copies of the Software, and to
+;; permit persons to whom the Software is furnished to do so, subject to
+;; the following conditions:
 ;;
-;; This library is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-;; Lesser General Public License for more details.
+;; The above copyright notice and this permission notice shall be
+;; included in all copies or substantial portions of the Software.
 ;;
-;; You should have received a copy 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
+;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-;; $Id: gtype.lisp,v 1.26 2005-02-10 00:20:02 espen Exp $
+;; $Id: gtype.lisp,v 1.37 2006-02-02 17:56:09 espen Exp $
 
 (in-package "GLIB")
 
@@ -99,62 +104,91 @@ (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))
-          (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))
+(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 gtype 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)))))
-    (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*)
-    (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) (copy-of string)
+      (gethash type-number *type-number-to-lisp-type*)
+    (if found
+       type
+      (let ((name (find-foreign-type-name type-number)))
+       (cond
+        ((and name (not (= (type-number-from-glib-name name nil) type-number)))
+         ;; This is a hack because GdkEvent seems to be registered
+         ;; multiple times
+         (type-from-number (type-number-from-glib-name name)))
+        ((and error name)
+         (error "Type number not registered: ~A (~A)" type-number name))
+        ((and error)
+         (error "Invalid type number: ~A" type-number)))))))
+
+(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))
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
-  (defun %find-types-in-library (pathname prefix ignore)
+  (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)))
@@ -164,44 +198,109 @@   (defun %find-types-in-library (pathname prefix ignore)
                         (when line (subseq line 11)))                    
           while symbol
           when (and
-                (> (length symbol) (length prefix))
-                (string= prefix symbol :end2 (length prefix))
-                (search "_get_type" symbol)
+                (> (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)
+(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))))
+                       (,(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 type-info (struct)
+    ((class-size :allocation :alien :type (unsigned 16) :initarg :class-size)
+     (base-init :allocation :alien :type pointer)
+     (base-finalize :allocation :alien :type pointer)
+     (class-init :allocation :alien :type pointer)
+     (class-finalize :allocation :alien :type pointer)
+     (class-data :allocation :alien :type pointer)
+     (instance-size :allocation :alien :type (unsigned 16) 
+                   :initarg :instance-size)
+     (n-preallocs :allocation :alien :type (unsigned 16))
+     (instance-init :allocation :alien :type pointer)
+     (value-table :allocation :alien :type pointer))
+    (:metaclass struct-class)))
+
+(defbinding %type-register-static () type-number
+  (parent-type type-number)
+  (name string)
+  (info type-info)
+  (0 unsigned-int))
+
+(defun register-new-type (type parent &optional foreign-name)
+  (let ((parent-info (type-query parent)))
+    (with-slots ((parent-number type-number) class-size instance-size) parent-info
+      (let ((type-number 
+            (%type-register-static 
+             parent-number
+             (or foreign-name (default-alien-type-name type))
+             (make-instance 'type-info :class-size class-size :instance-size instance-size))))
+       (setf (gethash type *lisp-type-to-type-number*) type-number)
+       (setf (gethash type-number *type-number-to-lisp-type*) type)
+       type-number))))
+
 
 
 ;;;; Metaclass for subclasses of ginstance
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defclass ginstance-class (proxy-class)
-    ()))
+    ((gtype :initarg :gtype :initform nil :reader ginstance-class-gtype))))
 
 
-(defmethod shared-initialize ((class ginstance-class) names
-                             &rest initargs &key name alien-name)
-  (declare (ignore names))
-  (let* ((class-name (or name (class-name class)))
+(defmethod finalize-inheritance ((class ginstance-class))
+  (call-next-method)
+  (let* ((class-name (class-name class))
+        (super (most-specific-proxy-superclass class))
+        (gtype (or 
+                (first (ginstance-class-gtype class))
+                (default-alien-type-name class-name)))
         (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)))))
+         (or 
+          (find-type-number class-name)
+          (if (or (symbolp gtype) (type-number-from-glib-name gtype nil))
+              (register-type class-name gtype)
+            (register-new-type class-name (class-name super) gtype)))))
+    (unless (eq (class-name super) (supertype type-number))
+      (warn "~A is the super type for ~A in the gobject type system."
+       (supertype type-number) class-name))
+
+    (unless (slot-boundp class 'size)
+      (setf (slot-value class 'size) (type-instance-size type-number)))))
 
 
 (defmethod validate-superclass ((class ginstance-class) (super standard-class))
@@ -215,17 +314,22 @@   (defclass ginstance (proxy)
     ((class :allocation :alien :type pointer))
     (:metaclass proxy-class)))
 
-(defun %type-of-ginstance (location)
+(defun %type-number-of-ginstance (location)
   (let ((class (sap-ref-sap location 0)))
-    (type-from-number (sap-ref-32 class 0))))
+    (sap-ref-32 class 0)))
 
 (defmethod ensure-proxy-instance ((class ginstance-class) location)
   (declare (ignore class))
-  (let ((class (find-class (%type-of-ginstance location))))
+  (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))
-      ;; TODO: (make-instance 'ginstance ...)
-      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))
@@ -248,8 +352,9 @@ (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 'integer 'int)
+(register-type-alias 'fixnum 'int)
 (register-type 'unsigned-int "guint")
 (register-type 'long "glong")
 (register-type 'unsigned-long "gulong")
@@ -320,7 +425,7 @@ (defun map-subtypes (function type &optional prefix)
           #'(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)
@@ -374,14 +479,14 @@ (defun %sort-types-topologicaly (types)
 
 
 (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
@@ -397,10 +502,10 @@ (defun expand-type-definitions (prefix &optional 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)))
+         (register-type-as type-number))))
 
      (let ((sorted-type-list (%sort-types-topologicaly type-list)))
        `(progn