Major cleanup of ffi abstraction layer

[clg] / glib / gobject.lisp

diff --git a/glib/gobject.lisp b/glib/gobject.lisp
index 8f9b611c7e571baae356570d4fc94668410a3734..9b33b4370d20b9ee92add31ca9dbc893a7358f94 100644 (file)
--- a/glib/gobject.lisp
+++ b/glib/gobject.lisp
@@ -1,5 +1,5 @@
 ;; Common Lisp bindings for GTK+ v2.0
 ;; 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
 ;;
 ;; This library is free software; you can redistribute it and/or
 ;; modify it under the terms of the GNU Lesser General Public


@@ -15,109 +15,140 @@
 ;; License along with this library; if not, write to the Free Software
 ;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 ;; 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.2 2000/08/23 21:40:38 espen Exp $
+;; $Id: gobject.lisp,v 1.17 2004/11/06 21:39:58 espen Exp $

 
 (in-package "GLIB")
 
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
 
 (in-package "GLIB")
 
 
 (eval-when (:compile-toplevel :load-toplevel :execute)

-  (defclass gobject (gtype)
+  (defclass gobject (ginstance)

     ()
     ()

-    (:metaclass gtype-class)
-    (:alien-name "GObject"))
-
-  (defclass gobject-class (gtype-class)))
-
-
-;;;; Reference counting for gobject
-
-;; Specializing reference-instance and unreference-instance on gobject
-;; is not really necessary but done for efficiency
-
-(defmethod reference-instance ((object gobject))
-  (%object-ref object)
-  object)
-
-(defmethod unreference-instance ((object gobject))
-  (%object-unref object))
-
-(deftype-method alien-ref gobject (type-spec)
-  (declare (ignore type-spec))
-  '%object-ref)
-
-(deftype-method alien-unref gobject (type-spec)
-  (declare (ignore type-spec))
-  '%object-unref)
-
-(define-foreign %object-ref () pointer
-  (object (or gobject pointer)))
-
-(define-foreign %object-unref () nil
-  (object (or gobject pointer)))
-
-
-;; Parameter stuff not yet implemented
-
-; (define-foreign object-set-param () nil
-;   (object gobject)
-;   (name string)
-;   (value gvalue))
+    (:metaclass ginstance-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))))
+
+
+(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))
+           (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)))))
+  
+  (%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))
+
+
+(def-callback weak-notify (c-call:void (data c-call:int) (location system-area-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))

 
 

-; (define-foreign object-get-param () nil
-;   (object gobject)
-;   (name string)
-;   (value gvalue :out))
+(defbinding (%gobject-new "g_object_new") () pointer
+  (type type-number)
+  (nil null))

 
 

-; (define-foreign object-queue-param-changed () nil
-;   (object gobject)
-;   (name string))
+(defbinding (%gobject-newv "g_object_newv") () pointer
+  (type type-number)
+  (n-parameters unsigned-int)
+  (params pointer))

 
 
 
 

-;;;; User data mechanism

 
 

-(declaim (fixnum *user-data-count*))
+;;;; Property stuff

 
 

-(defvar *user-data* (make-hash-table))
-(defvar *user-data-count* 0)
+(defbinding %object-set-property () nil
+  (object gobject)
+  (name string)
+  (value gvalue))

 
 

-;; Until the callback mechanism is moved to glib, the value of
-;; *destroy-marshal* is set in gtkobject.lisp
-(defvar *destroy-marshal* nil)
+(defbinding %object-get-property () nil
+  (object gobject)
+  (name string)
+  (value gvalue))

 
 

-(defun register-user-data (object &optional destroy-function)
-  (check-type destroy-function (or null symbol function))
-;  (incf *user-data-count*)
-  (setq *user-data-count* (the fixnum (1+ *user-data-count*)))
-  (setf
-   (gethash *user-data-count* *user-data*)
-   (cons object destroy-function))
-  *user-data-count*)
+(defbinding %object-notify () nil
+  (object gobject)
+  (name string))

 
 

-(defun find-user-data (id)
-  (check-type id fixnum)
-  (multiple-value-bind (user-data p) (gethash id *user-data*)
-    (values (car user-data) p)))
+(defbinding object-freeze-notify () nil
+  (object gobject))

 
 

-(defun destroy-user-data (id)
-  (check-type id fixnum)
-  (let ((user-data (gethash id *user-data*)))
-    (when (cdr user-data)
-      (funcall (cdr user-data) (car user-data))))
-  (remhash id *user-data*))
+(defbinding object-thaw-notify () nil
+  (object gobject))

 
 

-(define-foreign %object-set-qdata-full () nil
+(defbinding %object-set-qdata-full () nil

   (object gobject)
   (id quark)
   (data unsigned-long)
   (destroy-marshal pointer))
 
   (object gobject)
   (id quark)
   (data unsigned-long)
   (destroy-marshal pointer))
 

+
+;;;; User data
+

 (defun (setf object-data) (data object key &key (test #'eq))
   (%object-set-qdata-full
    object (quark-from-object key :test test)
 (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) *destroy-marshal*)
+   (register-user-data data) (callback %destroy-user-data))

   data)
 
   data)
 

-(define-foreign %object-get-qdata () unsigned-long
+(defbinding %object-get-qdata () unsigned-long

   (object gobject)              
   (id quark))
 
   (object gobject)              
   (id quark))
 


@@ -127,31 +158,228 @@ (defun object-data (object key &key (test #'eq))
 
 
 
 
 
 

-;;;; Methods for gobject-class
+;;;; Metaclass used for subclasses of gobject

 
 

-(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))
+;(eval-when (:compile-toplevel :load-toplevel :execute)
+  (defclass gobject-class (ginstance-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)));)

 
 

+(defbinding %object-ref () pointer
+  (location pointer))

 
 

-; (define-foreign object-class-install-param () nil
+(defbinding %object-unref () nil
+  (location pointer))
+
+(defmethod reference-foreign ((class gobject-class) location)
+  (declare (ignore class))
+  (%object-ref location))
+
+(defmethod unreference-foreign ((class gobject-class) location)
+  (declare (ignore class))
+  (%object-unref location))
+
+
+; (defbinding object-class-install-param () nil

 ;   (class pointer)
 ;   (id unsigned-int)
 ;   (parameter parameter))
 
 ;   (class pointer)
 ;   (id unsigned-int)
 ;   (parameter parameter))
 

-; (define-foreign object-class-find-param-spec () parameter
+; (defbinding object-class-find-param-spec () parameter

 ;   (class pointer)
 ;   (name string))
 
 ;   (class pointer)
 ;   (name string))
 

+(defun signal-name-to-string (name)
+  (substitute #\_ #\- (string-downcase (string name))))
+
+
+(defmethod direct-slot-definition-class ((class gobject-class) &rest initargs)
+  (case (getf initargs :allocation)
+    (:property (find-class 'direct-property-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))
+    (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)
+      (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)))
+
+
+(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)))
+    (unless (slot-boundp slotd 'reader-function)
+      (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))))))
+    
+    (unless (slot-boundp slotd 'writer-function)
+      (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)
+      (setf 
+       (slot-value slotd 'boundp-function)
+       #'(lambda (object)
+          (declare (ignore object))
+          t))))
+  (call-next-method))
+
+
+(defmethod validate-superclass ((class gobject-class)
+                               (super pcl::standard-class))
+;  (subtypep (class-name super) 'gobject)
+  t)
+
+
+
+;;;;
+
+(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)
+          (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)
+  (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))
+          (accessor (default-slot-accessor class slot-name slot-type)))
+      
+      `(,slot-name
+       :allocation :property :pname ,name
+       
+       ;; 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
+       ,@(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 
+   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))
+  (delete-if #'(lambda (slot) (getf (rest slot) :ignore)) slots))
+
+
+(defun expand-gobject-type (type &optional options (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)))))
+
+
+(register-derivable-type 'gobject "GObject" 'expand-gobject-type)