X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/clg/blobdiff_plain/2176a9c737407c97be00bab66df443f0685f1058..266ca870fe9634f59ea740e2a5ba62eb30adf5ca:/glib/gobject.lisp

diff --git a/glib/gobject.lisp b/glib/gobject.lisp
index 4005672..0014b4d 100644
--- a/glib/gobject.lisp
+++ b/glib/gobject.lisp
@@ -15,7 +15,7 @@
 ;; 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: gobject.lisp,v 1.19 2004-11-07 15:58:08 espen Exp $
+;; $Id: gobject.lisp,v 1.33 2005-02-27 15:14:38 espen Exp $
 
 (in-package "GLIB")
 
@@ -26,8 +26,7 @@ (eval-when (:compile-toplevel :load-toplevel :execute)
   (defclass gobject-class (ginstance-class)
     ())
 
-  (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))
 
@@ -41,7 +40,14 @@ (defclass effective-property-slot-definition (effective-virtual-slot-definition)
   ((pname :reader slot-definition-pname :initarg :pname)
    (readable :reader slot-readable-p :initarg :readable)
    (writable :reader slot-writable-p :initarg :writable)
-   (construct :initarg :construct)));)
+   (construct :initarg :construct)))
+
+(defclass direct-user-data-slot-definition (direct-virtual-slot-definition)
+  ())
+
+(defclass effective-user-data-slot-definition (effective-virtual-slot-definition)
+  ())
+
 
 (defbinding %object-ref () pointer
   (location pointer))
@@ -74,15 +80,17 @@ (defun signal-name-to-string (name)
 (defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
   (case (getf initargs :allocation)
     (:property (find-class 'direct-property-slot-definition))
+    (:user-data (find-class 'direct-user-data-slot-definition))
     (t (call-next-method))))
 
 (defmethod effective-slot-definition-class ((class gobject-class) &rest initargs)
   (case (getf initargs :allocation)
     (:property (find-class 'effective-property-slot-definition))
+    (:user-data (find-class 'effective-user-data-slot-definition))
     (t (call-next-method))))
 
 (defmethod compute-effective-slot-definition-initargs ((class gobject-class) direct-slotds)
-  (if (eq (most-specific-slot-value direct-slotds 'allocation) :property)
+  (if (typep (first direct-slotds) 'direct-property-slot-definition)
       (nconc 
        (list :pname (signal-name-to-string 
 		     (most-specific-slot-value direct-slotds 'pname))
@@ -97,42 +105,51 @@ (defmethod initialize-internal-slot-functions ((slotd effective-property-slot-de
   (let* ((type (slot-definition-type slotd))
 	 (pname (slot-definition-pname slotd))
 	 (type-number (find-type-number type)))
-    (unless (slot-boundp slotd 'reader-function)
+    (when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd))
       (setf 
-       (slot-value slotd 'reader-function)
-       (if (slot-readable-p slotd)
-	   (let () ;(reader (reader-function (type-from-number type-number))))
-	     #'(lambda (object)
-		 (let ((gvalue (gvalue-new type-number)))
-		   (%object-get-property object pname gvalue)
-		   (unwind-protect
-			(funcall #|reader|# (reader-function (type-from-number type-number))  gvalue +gvalue-value-offset+)
-		     (gvalue-free gvalue t)))))
-	   #'(lambda (value object)
-	       (error "Slot is not readable: ~A" (slot-definition-name slotd))))))
+       (slot-value slotd 'getter)
+       (let ((reader nil)) ;(reader-function type)))
+	 #'(lambda (object)
+	     (unless reader
+	       (setq reader (reader-function type)))
+	     (let ((gvalue (gvalue-new type-number)))
+	       (%object-get-property object pname gvalue)
+	       (unwind-protect
+		 (funcall reader  gvalue +gvalue-value-offset+)
+		 (gvalue-free gvalue t)))))))
     
-    (unless (slot-boundp slotd 'writer-function)
+    (when (and (not (slot-boundp slotd 'setter)) (slot-writable-p slotd))
       (setf 
-       (slot-value slotd 'writer-function)
-       (if (slot-writable-p slotd)
-	   (let ();; (writer (writer-function (type-from-number type-number)))
-;; 		 (destroy (destroy-function (type-from-number type-number))))
-	     #'(lambda (value object)
-		 (let ((gvalue (gvalue-new type-number)))
-		   (funcall #|writer|# (writer-function (type-from-number type-number)) value gvalue +gvalue-value-offset+)
-		   (%object-set-property object pname gvalue)
-;		   (funcall #|destroy|#(destroy-function (type-from-number type-number)) gvalue +gvalue-value-offset+)
-		   (gvalue-free gvalue t)
-		   value)))
- 	   #'(lambda (value object)
- 	       (error "Slot is not writable: ~A" (slot-definition-name slotd))))))
-    
-    (unless (slot-boundp slotd 'boundp-function)
+       (slot-value slotd 'setter)
+       (let ((writer nil)) ;(writer-function type)))
+	 #'(lambda (value object)
+	     (unless writer
+	       (setq writer (writer-function type)))
+	     (let ((gvalue (gvalue-new type-number)))
+	       (funcall writer value gvalue +gvalue-value-offset+)
+	       (%object-set-property object pname gvalue)
+	       (gvalue-free gvalue t)
+	       value))))))
+
+  (call-next-method))
+
+(defmethod initialize-internal-slot-functions ((slotd effective-user-data-slot-definition))
+  (let ((slot-name (slot-definition-name slotd)))
+    (unless (slot-boundp slotd 'getter)
+      (setf 
+       (slot-value slotd 'getter)
+       #'(lambda (object)
+	   (prog1 (user-data object slot-name)))))
+    (unless (slot-boundp slotd 'setter)
+      (setf 
+       (slot-value slotd 'setter)
+       #'(lambda (value object)
+	   (setf (user-data object slot-name) value))))
+    (unless (slot-boundp slotd 'boundp)
       (setf 
-       (slot-value slotd 'boundp-function)
+       (slot-value slotd 'boundp)
        #'(lambda (object)
-	   (declare (ignore object))
-	   t))))
+	   (user-data-p object slot-name)))))
   (call-next-method))
 
 
@@ -144,80 +161,79 @@   (defclass gobject (ginstance)
     (:metaclass gobject-class)
     (:alien-name "GObject")))
 
-(defmethod print-object ((instance gobject) stream)
-  (print-unreadable-object (instance stream :type t :identity nil)
-    (if (slot-boundp instance 'location)
-	(format stream "at 0x~X" (sap-int (proxy-location instance)))
-      (write-string "(destroyed)" stream))))
+
+(defun initial-add (object function initargs key pkey)
+  (loop 
+   as (initarg value . rest) = initargs then rest
+   do (cond
+       ((eq initarg key) (funcall function object value))
+       ((eq initarg pkey) (mapc #'(lambda (value)
+				    (funcall function object value))
+				value)))
+       while rest))
+
+(defun initial-apply-add (object function initargs key pkey)
+  (initial-add object #'(lambda (object value)
+			  (apply function object (mklist value)))
+	       initargs key pkey))
 
 
 (defmethod initialize-instance ((object gobject) &rest initargs)
-  ;; Extract initargs which we should pass directly to the GObeject
-  ;; constructor
-  (let* ((slotds (class-slots (class-of object)))
-	 (args (loop 
-		as tmp = initargs then (cddr tmp) while tmp
-		as key = (first tmp)
-		as value = (second tmp)
-		as slotd = (find-if
-			    #'(lambda (slotd)
-				(member key (slot-definition-initargs slotd)))
-			    slotds)
-		when (and (typep slotd 'effective-property-slot-definition)
-			  (slot-value slotd 'construct))
-		collect (progn 
-			  (remf initargs key)
-			  (list 
-			   (slot-definition-pname slotd)
-			   (slot-definition-type slotd)
-			   value)))))
-    (if args
-	(let* ((string-size (size-of 'string))
-	       (string-writer (writer-function 'string))
-	       (string-destroy (destroy-function 'string))
-	       (params (allocate-memory 
-			(* (length args) (+ string-size +gvalue-size+)))))
-	  (loop
-	   for (pname type value) in args
-	   as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
-	   do (funcall string-writer pname tmp)
-	   (gvalue-init (sap+ tmp string-size) type value))
-	  (unwind-protect
-	       (setf  
-		(slot-value object 'location) 
-		(%gobject-newv (type-number-of object) (length args) params))
+  (unless (slot-boundp object 'location)
+    ;; Extract initargs which we should pass directly to the GObeject
+    ;; constructor
+    (let* ((slotds (class-slots (class-of object)))
+	   (args (when initargs
+		   (loop 
+		    as (key value . rest) = initargs then rest
+		    as slotd = (find-if
+				#'(lambda (slotd)
+				    (member key (slot-definition-initargs slotd)))
+				slotds)
+		    when (and (typep slotd 'effective-property-slot-definition)
+			      (slot-value slotd 'construct))
+		    collect (progn 
+			      (remf initargs key)
+			      (list 
+			       (slot-definition-pname slotd)
+			       (slot-definition-type slotd)
+			       value))
+		    while rest))))
+      (if args
+	  (let* ((string-size (size-of 'string))
+		 (string-writer (writer-function 'string))
+		 (string-destroy (destroy-function 'string))
+		 (params (allocate-memory 
+			  (* (length args) (+ string-size +gvalue-size+)))))
 	    (loop
-	     repeat (length args)
+	     for (pname type value) in args
 	     as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
-	     do (funcall string-destroy tmp)
-	     (gvalue-unset (sap+ tmp string-size)))
-	    (deallocate-memory params)))
+	     do (funcall string-writer pname tmp)
+	     (gvalue-init (sap+ tmp string-size) type value))
+	    (unwind-protect
+		(setf  
+		 (slot-value object 'location) 
+		 (%gobject-newv (type-number-of object) (length args) params))
+	      (loop
+	       repeat (length args)
+	       as tmp = params then (sap+ tmp (+ string-size +gvalue-size+))
+	       do (funcall string-destroy tmp)
+	       (gvalue-unset (sap+ tmp string-size)))
+	      (deallocate-memory params)))
 	(setf  
 	 (slot-value object 'location) 
-	 (%gobject-new (type-number-of object)))))
+	 (%gobject-new (type-number-of object))))))
 
-  (%object-weak-ref object)
   (apply #'call-next-method object initargs))
 
 
-(defmethod initialize-instance :around ((object gobject) &rest initargs)
-  (declare (ignore initargs))
-  (call-next-method)
-  (%object-weak-ref object))
+(defmethod instance-finalizer ((instance gobject))
+  (let ((location (proxy-location instance)))
+    #'(lambda ()
+	(remove-cached-instance location)
+	(%object-unref location))))
 
 
-(defcallback weak-notify (nil (data int) (location pointer))
-  (let ((object (find-cached-instance location)))
-    (when object
-;;       (warn "~A being finalized by the GObject system while still in existence in lisp" object)
-      (slot-makunbound object 'location)
-      (remove-cached-instance location))))
-
-(defbinding %object-weak-ref (object) nil
-  (object gobject)
-  ((callback weak-notify) pointer)
-  (0 unsigned-int))
-
 (defbinding (%gobject-new "g_object_new") () pointer
   (type type-number)
   (nil null))
@@ -251,28 +267,51 @@ (defbinding object-freeze-notify () nil
 (defbinding object-thaw-notify () nil
   (object gobject))
 
+
+;;;; User data
+
 (defbinding %object-set-qdata-full () nil
   (object gobject)
   (id quark)
   (data unsigned-long)
   (destroy-marshal pointer))
 
+(defcallback user-data-destroy-func (nil (id unsigned-int))
+  (destroy-user-data id))
 
-;;;; User data
+(export 'user-data-destroy-func)
 
-(defun (setf object-data) (data object key &key (test #'eq))
-  (%object-set-qdata-full
-   object (quark-from-object key :test test)
-   (register-user-data data) (callback %destroy-user-data))
+(defun (setf user-data) (data object key)
+  (%object-set-qdata-full object (quark-intern key)
+   (register-user-data data) (callback user-data-destroy-func))
   data)
 
+;; deprecated
+(defun (setf object-data) (data object key &key (test #'eq))
+  (assert (eq test #'eq))
+  (setf (user-data object key) data))
+
 (defbinding %object-get-qdata () unsigned-long
   (object gobject)		 
   (id quark))
 
+(defun user-data (object key)
+  (find-user-data (%object-get-qdata object (quark-intern key))))
+
+;; deprecated
 (defun object-data (object key &key (test #'eq))
-  (find-user-data
-   (%object-get-qdata object (quark-from-object key :test test))))
+  (assert (eq test #'eq))
+  (user-data object key))
+
+(defun user-data-p (object key)
+  (user-data-exists-p (%object-get-qdata object (quark-intern key))))
+
+(defbinding %object-steal-qdata () unsigned-long
+  (object gobject)		 
+  (id quark))
+
+(defun unset-user-data (object key)
+  (destroy-user-data (%object-steal-qdata object (quark-intern key))))
 
 
 ;;;;
@@ -299,9 +338,10 @@ (defun query-object-class-properties (type &optional inherited-p)
     (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)
       )))
 
@@ -316,14 +356,17 @@ (defun default-slot-accessor (class-name slot-name type)
     (if (eq type 'boolean) "-P" ""))))
 
 
-(defun slot-definition-from-property (class property)
+(defun slot-definition-from-property (class property &optional slot-name args)
   (with-slots (name flags value-type documentation) property
-    (let* ((slot-name (default-slot-name name))
-	   (slot-type (or (type-from-number value-type) value-type))
+    (let* ((slot-name (or slot-name (default-slot-name name)))
+	   (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))))
 	
 	;; accessors
 	,@(cond
@@ -347,10 +390,15 @@ (defun slot-definition-from-property (class property)
 	    '(:construct t))
 	
 	;; initargs
-	,@(when (or (member :construct flags)
-		    (member :construct-only flags)
-		    (member :writable flags))
-	    (list :initarg (intern (string slot-name) "KEYWORD")))
+	,@(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))))
@@ -358,27 +406,61 @@ (defun slot-definition-from-property (class property)
 
 (defun slot-definitions (class properties slots)
   (loop 
-   with manual-slots = slots
    for property in properties
-   unless (find-if 
-	   #'(lambda (slot)
-	       (destructuring-bind (name &rest args) slot
-		 (or 
-		  (equal (param-name property) (getf args :pname))
-		  (eq (default-slot-name (param-name property)) name))))
-	   manual-slots)
-   do (push (slot-definition-from-property class property) slots))
+   as slot = (or
+	      (find (param-name property) slots 
+	       :key #'(lambda (slot) (getf (rest slot) :pname)) 
+	       :test #'string=)
+	      (find (param-name property) slots 
+	       :key #'first :test #'string-equal))
+   do (cond
+       ((not slot) 
+	(push (slot-definition-from-property class property) slots))
+       ((getf (rest slot) :merge)
+	(setf 
+	 (rest slot) 
+	 (rest (slot-definition-from-property class property (first slot) (rest slot)))))))
   (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)
+       ,(unless forward-p
+	  (slot-definitions class (query-object-class-properties type) slots))
       (:metaclass ,metaclass)
       (:alien-name ,(find-type-name 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 'gobject-dependencies)
+
+
+;;; Pseudo type for gobject instances which have their reference count
+;;; increased by the returning function
+
+(defmethod alien-type ((type (eql 'referenced)) &rest args)
+  (declare (ignore type args))
+  (alien-type 'gobject))
+
+(defmethod from-alien-form (form (type (eql 'referenced)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (type) args
+    (if (subtypep type 'gobject)
+	(let ((instance (make-symbol "INSTANCE")))
+	  `(let ((,instance ,(from-alien-form form type)))
+	     (when ,instance
+	       (%object-unref (proxy-location ,instance)))
+	     ,instance))
+      (error "~A is not a subclass of GOBJECT" type))))
 
-(register-derivable-type 'gobject "GObject" 'expand-gobject-type)
+(export 'referenced)