chiark / gitweb /
Redesigned proxy initialization protocol
[clg] / glib / gobject.lisp
index b07a620590a712a2230ab5b38fe82d8f4021574e..40ef3ea81940f3ae703a773cd235f9f4f809f15a 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: gobject.lisp,v 1.29 2005-01-30 14:30:30 espen Exp $
+;; $Id: gobject.lisp,v 1.43 2006-02-05 15:38:57 espen Exp $
 
 (in-package "GLIB")
 
@@ -24,10 +29,10 @@ (in-package "GLIB")
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defclass gobject-class (ginstance-class)
-    ())
+    ((instance-slots-p :initform nil
+      :documentation "Non NIL if the class has slots with instance allocation")))
 
-  (defmethod validate-superclass ((class gobject-class)
-                               (super pcl::standard-class))
+  (defmethod validate-superclass ((class gobject-class) (super standard-class))
 ;  (subtypep (class-name super) 'gobject)
     t))
 
@@ -56,6 +61,27 @@ (defbinding %object-ref () pointer
 (defbinding %object-unref () nil
   (location pointer))
 
+#+glib2.8
+(progn
+  (defcallback toggle-ref-callback (nil (data pointer) (location pointer) (last-ref-p boolean))
+    #+debug-ref-counting
+    (if last-ref-p
+       (format t "Object at 0x~8,'0X has no foreign references~%" (sap-int location))
+      (format t "Foreign reference added to object at 0x~8,'0X~%" (sap-int location)))
+    (if last-ref-p
+       (cache-instance (find-cached-instance location) t)
+      (cache-instance (find-cached-instance location) nil)))
+
+  (defbinding %object-add-toggle-ref () pointer
+    (location pointer)
+    ((callback toggle-ref-callback) pointer)
+    (nil null))
+
+  (defbinding %object-remove-toggle-ref () pointer
+    (location pointer)
+    ((callback toggle-ref-callback) pointer)
+    (nil null)))
+
 (defmethod reference-foreign ((class gobject-class) location)
   (declare (ignore class))
   (%object-ref location))
@@ -64,6 +90,16 @@ (defmethod unreference-foreign ((class gobject-class) location)
   (declare (ignore class))
   (%object-unref location))
 
+#+debug-ref-counting
+(progn
+  (defcallback weak-ref-callback (nil (data pointer) (location pointer))
+    (format t "Object at 0x~8,'0X being finalized~%" (sap-int location)))
+  
+  (defbinding %object-weak-ref () pointer
+    (location pointer)
+    ((callback weak-ref-callback) pointer)
+    (nil null)))
+
 
 ; (defbinding object-class-install-param () nil
 ;   (class pointer)
@@ -103,17 +139,16 @@ (defmethod compute-effective-slot-definition-initargs ((class gobject-class) dir
 
 
 (defmethod initialize-internal-slot-functions ((slotd effective-property-slot-definition))
-  (let* ((type (slot-definition-type slotd))
-        (pname (slot-definition-pname slotd))
-        (type-number (find-type-number type)))
+  (let ((type (slot-definition-type slotd))
+       (pname (slot-definition-pname slotd)))
     (when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd))
       (setf 
        (slot-value slotd 'getter)
        (let ((reader nil))
         #'(lambda (object)
             (unless reader
-              (setq reader (reader-function type))) ;(type-from-number type-number))))
-            (let ((gvalue (gvalue-new type-number)))
+              (setq reader (reader-function type)))
+            (let ((gvalue (gvalue-new type)))
               (%object-get-property object pname gvalue)
               (unwind-protect
                 (funcall reader  gvalue +gvalue-value-offset+)
@@ -125,8 +160,8 @@ (defmethod initialize-internal-slot-functions ((slotd effective-property-slot-de
        (let ((writer nil))
         #'(lambda (value object)
             (unless writer
-              (setq writer (writer-function type))) ;(type-from-number type-number))))
-            (let ((gvalue (gvalue-new type-number)))
+              (setq writer (writer-function type)))
+            (let ((gvalue (gvalue-new type)))
               (funcall writer value gvalue +gvalue-value-offset+)
               (%object-set-property object pname gvalue)
               (gvalue-free gvalue t)
@@ -153,6 +188,16 @@ (defmethod initialize-internal-slot-functions ((slotd effective-user-data-slot-d
           (user-data-p object slot-name)))))
   (call-next-method))
 
+(defmethod shared-initialize :after ((class gobject-class) names &rest initargs)
+  (declare (ignore initargs))
+  (when (some #'(lambda (slotd)
+                 (and
+                  (eq (slot-definition-allocation slotd) :instance)
+                  (not (typep slotd 'effective-special-slot-definition))))
+             (class-slots class))
+    (setf (slot-value class 'instance-slots-p) t)))
+
+
 
 ;;;; Super class for all classes in the GObject type hierarchy
 
@@ -160,7 +205,7 @@ (eval-when (:compile-toplevel :load-toplevel :execute)
   (defclass gobject (ginstance)
     ()
     (:metaclass gobject-class)
-    (:alien-name "GObject")))
+    (:gtype "GObject")))
 
 
 (defun initial-add (object function initargs key pkey)
@@ -179,9 +224,26 @@ (defun initial-apply-add (object function initargs key pkey)
               initargs key pkey))
 
 
+(defmethod make-proxy-instance ((class gobject-class) location &rest initargs)
+  (declare (ignore location initargs))
+  (if (slot-value class 'instance-slots-p)
+      (error "An object of class ~A has instance slots and should only be created with MAKE-INSTANCE" class)
+    (call-next-method)))
+
+(defmethod initialize-instance :around ((object gobject) &rest initargs)
+  (declare (ignore initargs))
+  (call-next-method)
+  #+debug-ref-counting(%object-weak-ref (foreign-location object))
+  #+glib2.8
+  (when (slot-value (class-of object) 'instance-slots-p)
+    (with-slots (location) object
+      (%object-add-toggle-ref location)
+      (%object-unref location))))
+
+
 (defmethod initialize-instance ((object gobject) &rest initargs)
   (unless (slot-boundp object 'location)
-    ;; Extract initargs which we should pass directly to the GObeject
+    ;; Extract initargs which we should pass directly to the GObject
     ;; constructor
     (let* ((slotds (class-slots (class-of object)))
           (args (when initargs
@@ -229,10 +291,23 @@ (defmethod initialize-instance ((object gobject) &rest initargs)
 
 
 (defmethod instance-finalizer ((instance gobject))
-  (let ((location (proxy-location instance)))
+  (let ((location (foreign-location instance)))
+    #+glib2.8
+    (if (slot-value (class-of instance) 'instance-slots-p)
+       #'(lambda ()
+           #+debug-ref-counting
+           (format t "Finalizing proxy for 0x~8,'0X~%" (sap-int location))
+           (remove-cached-instance location)
+           (%object-remove-toggle-ref location))
+      #'(lambda ()
+         #+debug-ref-counting
+         (format t "Finalizing proxy for 0x~8,'0X~%" (sap-int location))
+         (remove-cached-instance location)
+         (%object-unref location)))
+    #-glib2.8
     #'(lambda ()
        (remove-cached-instance location)
-       (%object-unref location))))
+         (%object-unref location))))
 
 
 (defbinding (%gobject-new "g_object_new") () pointer
@@ -277,9 +352,14 @@ (defbinding %object-set-qdata-full () nil
   (data unsigned-long)
   (destroy-marshal pointer))
 
+(defcallback user-data-destroy-func (nil (id unsigned-int))
+  (destroy-user-data id))
+
+(export 'user-data-destroy-func)
+
 (defun (setf user-data) (data object key)
   (%object-set-qdata-full object (quark-intern key)
-   (register-user-data data) (callback %destroy-user-data))
+   (register-user-data data) (callback user-data-destroy-func))
   data)
 
 ;; deprecated
@@ -329,14 +409,15 @@ (defun %map-params (params length type inherited-p)
       (nreverse properties))))
 
 (defun query-object-class-properties (type &optional inherited-p)
-  (let* ((type-number (find-type-number type))
+  (let* ((type-number (find-type-number type t))
         (class (type-class-ref type-number)))
     (unwind-protect
         (multiple-value-bind (array length)
             (%object-class-list-properties class)
-          (unwind-protect
-               (%map-params array length type-number inherited-p)
-            (deallocate-memory array)))
+          (unless (null-pointer-p array)
+            (unwind-protect
+                (%map-params array length type-number inherited-p)
+              (deallocate-memory array))))
 ;      (type-class-unref type-number)
       )))
 
@@ -354,14 +435,15 @@ (defun default-slot-accessor (class-name slot-name type)
 (defun slot-definition-from-property (class property &optional slot-name args)
   (with-slots (name flags value-type documentation) property
     (let* ((slot-name (or slot-name (default-slot-name name)))
-          (slot-type (or (getf args :type) (type-from-number value-type) value-type))
+          (slot-type (or (getf args :type) (type-from-number value-type) 'pointer))
           (accessor (default-slot-accessor class slot-name slot-type)))
       
       `(,slot-name
        :allocation :property :pname ,name
 
-       ,@(cond
-          ((find :unbound args) (list :unbound (getf args :unbound))))
+       ,@(when (find :unbound args) (list :unbound (getf args :unbound)))
+       ,@(when (find :getter args) (list :getter (getf args :getter)))
+       ,@(when (find :setter args) (list :setter (getf args :setter)))
        
        ;; accessors
        ,@(cond
@@ -385,12 +467,15 @@ (defun slot-definition-from-property (class property &optional slot-name args)
            '(:construct t))
        
        ;; initargs
-       ,@(when (or (member :construct flags)
-                   (member :construct-only flags)
-                   (member :writable flags))
-           (list :initarg (intern (string slot-name) "KEYWORD")))
-       ,@(cond
-          ((find :initarg args) (list :initarg (getf args :initarg))))
+       ,@(if (find :initarg args)
+             (let ((initarg (getf args :initarg)))
+               (etypecase initarg
+                 (null ())
+                 (symbol `(:initarg ,initarg))))
+           (when (or (member :construct flags)
+                     (member :construct-only flags)
+                     (member :writable flags))
+             (list :initarg (intern (string slot-name) "KEYWORD"))))
        
        :type ,slot-type
        :documentation ,documentation))))
@@ -415,17 +500,26 @@ (defun slot-definitions (class properties slots)
   (delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots))
 
 
-(defun expand-gobject-type (type &optional options (metaclass 'gobject-class))
+(defun expand-gobject-type (type forward-p options &optional (metaclass 'gobject-class))
   (let ((supers (cons (supertype type) (implements type)))
        (class  (type-from-number type))
        (slots (getf options :slots)))    
     `(defclass ,class ,supers
-      ,(slot-definitions class (query-object-class-properties type) slots)
-      (:metaclass ,metaclass)
-      (:alien-name ,(find-type-name type)))))
+        ,(unless forward-p
+           (slot-definitions class (query-object-class-properties type) slots))
+        (:metaclass ,metaclass)
+        (:gtype ,(register-type-as type)))))
+
+(defun gobject-dependencies (type)
+  (delete-duplicates 
+   (cons
+    (supertype type)
+    (append 
+     (type-interfaces type)
+     (mapcar #'param-value-type (query-object-class-properties type))))))
 
 
-(register-derivable-type 'gobject "GObject" 'expand-gobject-type)
+(register-derivable-type 'gobject "GObject" 'expand-gobject-type 'gobject-dependencies)
 
 
 ;;; Pseudo type for gobject instances which have their reference count
@@ -442,7 +536,7 @@ (defmethod from-alien-form (form (type (eql 'referenced)) &rest args)
        (let ((instance (make-symbol "INSTANCE")))
          `(let ((,instance ,(from-alien-form form type)))
             (when ,instance
-              (%object-unref (proxy-location ,instance)))
+              (%object-unref (foreign-location ,instance)))
             ,instance))
       (error "~A is not a subclass of GOBJECT" type))))