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

diff --git a/glib/gobject.lisp b/glib/gobject.lisp
index 015f29b..0014b4d 100644
--- a/glib/gobject.lisp
+++ b/glib/gobject.lisp
@@ -1,5 +1,5 @@
 ;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 2000 Espen S. Johnsen <espejohn@online.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
@@ -15,90 +15,452 @@
 ;; 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.1 2000-08-14 16:44:30 espen Exp $
+;; $Id: gobject.lisp,v 1.33 2005-02-27 15:14:38 espen Exp $
 
 (in-package "GLIB")
 
 
+;;;; Metaclass used for subclasses of gobject
+
 (eval-when (:compile-toplevel :load-toplevel :execute)
-  (defclass gobject (gtype)
-    ()
-    (:metaclass gtype-class)
-    (:alien-name "GObject"))
+  (defclass gobject-class (ginstance-class)
+    ())
+
+  (defmethod validate-superclass ((class gobject-class) (super standard-class))
+;  (subtypep (class-name super) 'gobject)
+    t))
 
-  (defclass gobject-class (gtype-class)))
+(defclass direct-property-slot-definition (direct-virtual-slot-definition)
+  ((pname :reader slot-definition-pname :initarg :pname)
+   (readable :initform t :reader slot-readable-p :initarg :readable)
+   (writable :initform t :reader slot-writable-p :initarg :writable)
+   (construct :initform nil :initarg :construct)))
 
+(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)))
 
-;;;; Methods for gobject
+(defclass direct-user-data-slot-definition (direct-virtual-slot-definition)
+  ())
 
-;; Specializing reference-instance and unreference-instance on gobject
-;; is not really necessary but done for efficiency
+(defclass effective-user-data-slot-definition (effective-virtual-slot-definition)
+  ())
 
-(defmethod reference-instance ((object gobject))
-  (%object-ref object)
-  object)
 
-(defmethod unreference-instance ((object gobject))
-  (%object-unref object))
+(defbinding %object-ref () pointer
+  (location pointer))
 
-(deftype-method alien-ref gobject (type-spec)
-  (declare (ignore type-spec))
-  '%object-ref)
+(defbinding %object-unref () nil
+  (location pointer))
 
-(deftype-method alien-unref gobject (type-spec)
-  (declare (ignore type-spec))
-  '%object-unref)
+(defmethod reference-foreign ((class gobject-class) location)
+  (declare (ignore class))
+  (%object-ref location))
 
-(define-foreign %object-ref () pointer
-  (object (or gobject pointer)))
+(defmethod unreference-foreign ((class gobject-class) location)
+  (declare (ignore class))
+  (%object-unref location))
 
-(define-foreign %object-unref () nil
-  (object (or gobject pointer)))
 
+; (defbinding object-class-install-param () nil
+;   (class pointer)
+;   (id unsigned-int)
+;   (parameter parameter))
+
+; (defbinding object-class-find-param-spec () parameter
+;   (class pointer)
+;   (name string))
 
-;; Parameter stuff not yet implemented
+(defun signal-name-to-string (name)
+  (substitute #\_ #\- (string-downcase (string name))))
 
-; (define-foreign object-set-param () nil
-;   (object gobject)
-;   (name string)
-;   (value gvalue))
 
-; (define-foreign object-get-param () nil
-;   (object gobject)
-;   (name string)
-;   (value gvalue :out))
+(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))))
 
-; (define-foreign object-queue-param-changed () nil
-;   (object gobject)
-;   (name string))
+(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 (typep (first direct-slotds) 'direct-property-slot-definition)
+      (nconc 
+       (list :pname (signal-name-to-string 
+		     (most-specific-slot-value direct-slotds 'pname))
+	     :readable (most-specific-slot-value direct-slotds 'readable)
+	     :writable (most-specific-slot-value direct-slotds 'writable)
+	     :construct (most-specific-slot-value direct-slotds 'construct))
+       (call-next-method))
+    (call-next-method)))
 
 
-;;;; Methods for gobject-class
+(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)))
+    (when (and (not (slot-boundp slotd 'getter)) (slot-readable-p slotd))
+      (setf 
+       (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)))))))
+    
+    (when (and (not (slot-boundp slotd 'setter)) (slot-writable-p slotd))
+      (setf 
+       (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))))))
 
-(defmethod shared-initialize ((class gobject-class) names &rest initargs
-			      &key type-init name)
-  (declare (ignore initargs names))
-  (let ((alien
-	 (alien::%heap-alien
-	  (alien::make-heap-alien-info
-	   :type (alien::parse-alien-type '(function (unsigned 32)))
-	   :sap-form (system:foreign-symbol-address
-		      (or
-		       (first type-init)
-		       (default-alien-func-name
-			 (format
-			  nil "~A_get_type" (or name (class-name class))))))))))
-    (alien:alien-funcall alien))
   (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)
+       #'(lambda (object)
+	   (user-data-p object slot-name)))))
+  (call-next-method))
 
-; (define-foreign object-class-install-param () nil
-;   (class pointer)
-;   (id unsigned-int)
-;   (parameter parameter))
 
-; (define-foreign object-class-find-param-spec () parameter
-;   (class pointer)
-;   (name string))
+;;;; Super class for all classes in the GObject type hierarchy
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+  (defclass gobject (ginstance)
+    ()
+    (:metaclass gobject-class)
+    (:alien-name "GObject")))
+
+
+(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)
+  (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
+	     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))
+	      (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))))))
+
+  (apply #'call-next-method object initargs))
+
+
+(defmethod instance-finalizer ((instance gobject))
+  (let ((location (proxy-location instance)))
+    #'(lambda ()
+	(remove-cached-instance location)
+	(%object-unref location))))
+
+
+(defbinding (%gobject-new "g_object_new") () pointer
+  (type type-number)
+  (nil null))
+
+(defbinding (%gobject-newv "g_object_newv") () pointer
+  (type type-number)
+  (n-parameters unsigned-int)
+  (params pointer))
+
+
+
+;;;; Property stuff
+
+(defbinding %object-set-property () nil
+  (object gobject)
+  (name string)
+  (value gvalue))
+
+(defbinding %object-get-property () nil
+  (object gobject)
+  (name string)
+  (value gvalue))
+
+(defbinding %object-notify () nil
+  (object gobject)
+  (name string))
+
+(defbinding object-freeze-notify () nil
+  (object gobject))
+
+(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))
+
+(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 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))
+  (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))))
+
+
+;;;;
+
+(defbinding %object-class-list-properties () pointer
+  (class pointer)
+  (n-properties unsigned-int :out))
+
+
+(defun %map-params (params length type inherited-p)
+  (if inherited-p
+      (map-c-vector 'list #'identity params 'param length)
+    (let ((properties ()))
+      (map-c-vector 'list 
+       #'(lambda (param)
+	   (when (eql (param-owner-type param) type)
+	     (push param properties)))
+       params 'param length)
+      (nreverse properties))))
+
+(defun query-object-class-properties (type &optional inherited-p)
+  (let* ((type-number (find-type-number type))
+	 (class (type-class-ref type-number)))
+    (unwind-protect
+	 (multiple-value-bind (array length)
+	     (%object-class-list-properties class)
+	   (unless (null-pointer-p array)
+	     (unwind-protect
+		 (%map-params array length type-number inherited-p)
+	       (deallocate-memory array))))
+;      (type-class-unref type-number)
+      )))
+
+
+(defun default-slot-name (name)
+  (intern (substitute #\- #\_ (string-upcase (string-upcase name)))))
+
+(defun default-slot-accessor (class-name slot-name type)
+  (intern
+   (format
+    nil "~A-~A~A" class-name slot-name
+    (if (eq type 'boolean) "-P" ""))))
+
+
+(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) '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
+	   ((and
+	     (member :writable flags) (member :readable flags)
+	     (not (member :construct-only flags)))
+	    (list :accessor accessor))
+	   ((and (member :writable flags) (not (member :construct-only flags)))
+	    (list :writer `(setf ,accessor)))
+	   ((member :readable flags)
+	    (list :reader accessor)))
+
+	;; readable/writable/construct
+	,@(when (or (not (member :writable flags))
+		    (member :construct-only flags))
+	    '(:writable nil))
+	,@(when (not (member :readable flags))
+	    '(:readable nil))
+	,@(when (or (member :construct flags) 
+		    (member :construct-only flags))
+	    '(:construct t))
+	
+	;; initargs
+	,@(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))))
+
+
+(defun slot-definitions (class properties slots)
+  (loop 
+   for property in properties
+   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 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
+       ,(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))))
 
+(export 'referenced)