chiark / gitweb /
Custom types are now re-registered when a saved image is loaded
[clg] / glib / gtype.lisp
index bd23dba0c52b066350c5fa04bb0770a357023fe5..f4862115587f422c62d2b728d5fd8921b3f75405 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.28 2005/03/11 10:56:58 espen Exp $
+;; $Id: gtype.lisp,v 1.51 2006/04/18 11:42:20 espen Exp $
 
 (in-package "GLIB")
 
@@ -25,46 +30,47 @@ (use-prefix "g")
 (defbinding type-init () nil)
 (type-init)
 
-(deftype type-number () '(unsigned 32))
+(deftype type-number () 'unsigned-long)
 
 (deftype gtype () 'symbol)
 
-(defmethod alien-type ((type (eql 'gtype)) &rest args)
-  (declare (ignore type args))
+(define-type-method alien-type ((type gtype))
+  (declare (ignore type))
   (alien-type 'type-number))
 
-(defmethod size-of ((type (eql 'gtype)) &rest args)
-  (declare (ignore type args))
+(define-type-method size-of ((type gtype))
+  (declare (ignore type))
   (size-of 'type-number))
 
-(defmethod to-alien-form (gtype (type (eql 'gtype)) &rest args)
-  (declare (ignore type args))
+(define-type-method to-alien-form ((type gtype) gtype)
+  (declare (ignore type))
   `(find-type-number ,gtype t)) 
 
-(defmethod to-alien-function ((type (eql 'gtype)) &rest args)
-  (declare (ignore type args))
+(define-type-method to-alien-function ((type gtype))
+  (declare (ignore type))
   #'(lambda (gtype)
       (find-type-number gtype t)))
 
-(defmethod from-alien-form (type-number (type (eql 'gtype)) &rest args)
-  (declare (ignore type args))
+(define-type-method from-alien-form ((type gtype) type-number)
+  (declare (ignore type))
   `(type-from-number ,type-number)) 
 
-(defmethod from-alien-function ((type (eql 'gtype)) &rest args)
-  (declare (ignore type args))
+(define-type-method from-alien-function ((type gtype))
+  (declare (ignore type))
   #'(lambda (type-number)
       (type-from-number type-number)))
 
-(defmethod writer-function ((type (eql 'gtype)) &rest args)
-  (declare (ignore type args))
+(define-type-method writer-function ((type gtype))
+  (declare (ignore type))
   (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))
+(define-type-method reader-function ((type gtype))
+  (declare (ignore type))
   (let ((reader (reader-function 'type-number)))
-    #'(lambda (location &optional (offset 0))
+    #'(lambda (location &optional (offset 0) weak-p)
+       (declare (ignore weak-p))
        (type-from-number (funcall reader location offset)))))
 
 
@@ -101,6 +107,7 @@ (defbinding type-class-peek (type) pointer
 
 (defvar *registered-types* ())
 (defvar *registered-type-aliases* ())
+(defvar *registered-static-types* ())
 (defvar *lisp-type-to-type-number* (make-hash-table))
 (defvar *type-number-to-lisp-type* (make-hash-table))
 
@@ -136,6 +143,9 @@ (defun reinitialize-all-types ()
   (mapc #'(lambda (type) 
            (register-type (car type) (cdr type)))
        *registered-types*)
+  (mapc #'(lambda (type) 
+               (apply #'register-new-type type))
+       *registered-static-types*)
   (mapc #'(lambda (type) 
            (register-type-alias (car type) (cdr type)))
        *registered-type-aliases*))
@@ -162,12 +172,18 @@ (defun find-type-number (type &optional error-p)
 (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))
+    (if found
+       type
       (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))
+       (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))
@@ -184,7 +200,8 @@   (defun %find-types-in-library (pathname prefixes ignore)
       (unwind-protect
          (loop 
           as symbol = (let ((line (read-line (process-output process) nil)))
-                        (when line (subseq line 11)))                    
+                        (when line 
+                          (subseq line (1+ (position #\Space line :from-end t)))))
           while symbol
           when (and
                 (> (length symbol) 9)
@@ -229,25 +246,91 @@ (defun default-type-init-name (type)
                (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))))
+       (pushnew (list type parent foreign-name) *registered-static-types* :key #'car)
+       (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 &key name gtype)
-  (declare (ignore names))
-  (let* ((class-name (or name (class-name class)))
-        (type-number 
+(defun update-size (class)
+  (let ((type-number (find-type-number class)))
+    (cond
+     ((not (slot-boundp class 'size))
+      (setf (slot-value class 'size) (type-instance-size type-number)))
+     ((and 
+       (slot-boundp class 'size) 
+       (not (= (type-instance-size type-number) (slot-value class 'size))))
+      (warn "Size mismatch for class ~A" class)))))
+
+
+(defmethod finalize-inheritance ((class ginstance-class))
+  (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
          (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)))))
+          (let ((type-number
+                 (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))))
+            (type-class-ref type-number)
+            type-number))))
+    (when (and
+          (supertype type-number) 
+          (not (eq (class-name super) (supertype type-number))))
+      (warn "Super class mismatch between CLOS and GObject for ~A"
+       class-name)))
+  (update-size class)
+  (call-next-method))
+
+
+(defmethod shared-initialize ((class ginstance-class) names &rest initargs)
+  (declare (ignore initargs))
+  (call-next-method)
+  (when (class-finalized-p class)
+    (update-size class)))
 
 
 (defmethod validate-superclass ((class ginstance-class) (super standard-class))
@@ -258,33 +341,57 @@ (defmethod validate-superclass ((class ginstance-class) (super standard-class))
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defclass ginstance (proxy)
-    ((class :allocation :alien :type pointer))
-    (:metaclass proxy-class)))
+    (;(class :allocation :alien :type pointer :offset 0)
+     )
+    (:metaclass proxy-class)
+    (:size #.(size-of 'pointer))))
 
-(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)
+(defmethod make-proxy-instance :around ((class ginstance-class) location &rest initargs)
   (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)))))
+    ;; Note that chancing the class argument must not alter "the
+    ;; ordered set of applicable methods" as specified in the
+    ;; Hyperspec
     (if class
-       (make-instance class :location (reference-foreign class location))
-      ;; TODO: (make-instance 'ginstance ...)
-      location)))
-
-(defmethod copy-from-alien-form (location (class ginstance-class) &rest args)
-  (declare (ignore location class args))
+       (apply #'call-next-method class location initargs)
+      (error "Object at ~A has an unkown type number: ~A"
+       location (%type-number-of-ginstance location)))))
+
+(defmethod make-proxy-instance ((class ginstance-class) location &rest initargs)
+  (declare (ignore initargs))
+  (reference-foreign class location)
+  ;; Since we make an explicit reference to the foreign object, we
+  ;; always have to release it when the proxy is garbage collected
+  ;; and therefor ignore the weak-p argument.
+  (call-next-method class location :weak nil))
+
+(defmethod invalidate-instance ((instance ginstance))
+  (declare (ignore instance))
+  ;; A ginstance should never be invalidated since it is ref counted
+  nil)
+
+(define-type-method copy-from-alien-form ((type ginstance) location)
+  (declare (ignore location type))
   (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))  
+(define-type-method copy-from-alien-function ((type ginstance))
+  (declare (ignore type))  
   (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))))
+(define-type-method reader-function ((type ginstance))
+  (let ((class (type-expand type)))
+    #'(lambda (location &optional (offset 0) weak-p)
+       (declare (ignore weak-p))
+       (ensure-proxy-instance class (sap-ref-sap location offset)))))
 
 
 ;;;; Registering fundamental types
@@ -295,6 +402,7 @@ (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")