chiark / gitweb /
Major cleanup of ffi abstraction layer
[clg] / glib / glib.lisp
index a34944e484007b8f3e22d3fe1db3e6e4ab683cc5..149d392e82dfe0c687f057179d9cbf006356bf31 100644 (file)
@@ -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: glib.lisp,v 1.8 2001-02-11 20:21:13 espen Exp $
+;; $Id: glib.lisp,v 1.16 2004-11-06 21:39:58 espen Exp $
 
 
 (in-package "GLIB")
@@ -25,15 +25,17 @@ (use-prefix "g")
 
 ;;;; Memory management
 
-(define-foreign ("g_malloc0" allocate-memory) () pointer
+(defbinding (allocate-memory "g_malloc0") () pointer
   (size unsigned-long))
 
-(define-foreign ("g_realloc" reallocate-memory) () pointer
+(defbinding (reallocate-memory "g_realloc") () pointer
   (address pointer)
   (size unsigned-long))
 
-(define-foreign ("g_free" deallocate-memory) () nil
+(defbinding (deallocate-memory "g_free") () nil
   (address pointer))
+;; (defun deallocate-memory (address)
+;;   (declare (ignore address)))
 
 (defun copy-memory (from length &optional (to (allocate-memory length)))
   (kernel:system-area-copy from 0 to 0 (* 8 length))
@@ -46,7 +48,6 @@ (internal *user-data* *user-data-count*)
 
 (declaim (fixnum *user-data-count*))
 
-(defvar *destroy-notify* (system:foreign-symbol-address "destroy_notify"))
 (defvar *user-data* (make-hash-table))
 (defvar *user-data-count* 0)
 
@@ -78,9 +79,9 @@ (internal *quark-counter* *quark-from-object* *quark-to-object*)
 
 (deftype quark () 'unsigned)
 
-;(define-foreign %quark-get-reserved () quark)
+;(defbinding %quark-get-reserved () quark)
 
-(define-foreign %quark-from-string () quark
+(defbinding %quark-from-string () quark
   (string string))
 
 (defvar *quark-counter* 0)
@@ -121,82 +122,109 @@ (defun remove-quark (quark)
 
 ;;;; Linked list (GList)
 
-(deftype glist (type) `(or (null (cons ,type list))))
+(deftype glist (type &key copy) 
+  (declare (ignore copy))
+  `(or (null (cons ,type list))))
 
-(define-foreign ("g_list_append" %glist-append-unsigned) () pointer
+(defbinding (%glist-append-unsigned "g_list_append") () pointer
   (glist pointer)
   (data unsigned))
 
-(define-foreign ("g_list_append" %glist-append-signed) () pointer
+(defbinding (%glist-append-signed "g_list_append") () pointer
   (glist pointer)
   (data signed))
 
-(define-foreign ("g_list_append" %glist-append-sap) () pointer
+(defbinding (%glist-append-sap "g_list_append") () pointer
   (glist pointer)
   (data pointer))
 
-(defmacro glist-append (glist value type-spec)
-  (ecase (first (mklist (translate-type-spec type-spec)))
-    (unsigned `(%glist-append-unsigned ,glist ,value))
-    (signed `(%glist-append-signed ,glist ,value))
-    (system-area-pointer `(%glist-append-sap ,glist ,value))))
-
-(defmacro glist-data (glist type-spec)
-  (ecase (first (mklist (translate-type-spec type-spec)))
-    (unsigned `(sap-ref-unsigned ,glist 0))
-    (signed `(sap-ref-signed ,glist 0))
-    (system-area-pointer `(sap-ref-sap ,glist 0))))
+(defun make-glist (type list)
+  (let ((new-element (ecase (alien-type type)
+                      (system-area-pointer #'%glist-append-sap)
+                      ((signed-byte c-call:short c-call:int c-call:long)
+                       #'%glist-append-signed)
+                      ((unsigned-byte c-call:unsigned-short 
+                        c-call:unsigned-int c-call:unsigned-long)
+                       #'%glist-append-unsigned)))
+       (to-alien (to-alien-function type)))
+    (loop
+     for element in list
+     as glist = (funcall new-element (or glist (make-pointer 0)) 
+                (funcall to-alien element))
+     finally (return glist))))
 
 (defun glist-next (glist)
   (unless (null-pointer-p glist)
-    (sap-ref-sap glist +size-of-sap+)))
+    (sap-ref-sap glist +size-of-pointer+)))
   
-(define-foreign ("g_list_free" glist-free) () nil
+;; Also used for gslists
+(defun map-glist (seqtype function glist element-type)
+  (let ((reader (reader-function element-type)))
+    (case seqtype 
+     ((nil)
+      (loop
+       as tmp = glist then (glist-next tmp)
+       until (null-pointer-p tmp)
+       do (funcall function (funcall reader tmp))))
+     (list
+      (loop
+       as tmp = glist then (glist-next tmp)
+       until (null-pointer-p tmp)
+       collect (funcall function (funcall reader tmp))))
+     (t
+      (coerce 
+       (loop
+       as tmp = glist then (glist-next tmp)
+       until (null-pointer-p tmp)
+       collect (funcall function (funcall reader tmp)))
+       seqtype)))))
+
+(defbinding (glist-free "g_list_free") () nil
   (glist pointer))
 
-(deftype-method translate-type-spec glist (type-spec)
-  (declare (ignore type-spec))
-  (translate-type-spec 'pointer))
 
-(deftype-method size-of glist (type-spec)
-  (declare (ignore type-spec))
+(defmethod alien-type ((type (eql 'glist)) &rest args)
+  (declare (ignore type args))
+  (alien-type 'pointer))
+
+(defmethod size-of ((type (eql 'glist)) &rest args)
+  (declare (ignore type args))
   (size-of 'pointer))
 
-(deftype-method translate-to-alien glist (type-spec list &optional copy)
-  (declare (ignore copy))
-  (let* ((element-type-spec (second (type-expand-to 'glist type-spec)))
-        (to-alien (translate-to-alien element-type-spec 'element t)))
-    `(let ((glist (make-pointer 0))) 
-       (dolist (element ,list glist)
-        (setq glist (glist-append glist ,to-alien ,element-type-spec))))))
-
-(deftype-method translate-from-alien
-    glist (type-spec glist &optional (alloc :reference))
-  (let ((element-type-spec (second (type-expand-to 'glist type-spec))))
-    `(let ((glist ,glist)
-          (list nil))
-       (do ((tmp glist (glist-next tmp)))
-          ((null-pointer-p tmp))
-        (push
-         ,(translate-from-alien
-           element-type-spec `(glist-data tmp ,element-type-spec) alloc)
-         list))
-       ,(when (eq alloc :reference)
-         '(glist-free glist))
-       (nreverse list))))
-
-(deftype-method cleanup-alien glist (type-spec glist &optional copied)
-  (declare (ignore copied))
-  (let* ((element-type-spec (second (type-expand-to 'glist type-spec)))
-        (alien-type-spec (translate-type-spec element-type-spec)))
+(defmethod to-alien-form (list (type (eql 'glist)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type) args    
+    `(make-glist ',element-type ,list)))
+
+(defmethod to-alien-function ((type (eql 'glist)) &rest args)
+  (declare (ignore type args))
+  (destructuring-bind (element-type) args    
+    #'(lambda (list)
+       (make-glist element-type list))))
+
+(defmethod from-alien-form (glist (type (eql 'glist)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type) args
     `(let ((glist ,glist))
-       (unless (null-pointer-p glist)
-        ,(when (eq alien-type-spec 'system-area-pointer)
-           `(do ((tmp glist (glist-next tmp)))
-                ((null-pointer-p tmp))
-              ,(cleanup-alien
-                element-type-spec `(glist-data tmp ,element-type-spec) t)))
-        (glist-free glist)))))
+      (unwind-protect
+          (map-glist 'list #'identity glist ',element-type)
+       (glist-free glist)))))
+
+(defmethod from-alien-function ((type (eql 'glist)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type) args
+    #'(lambda (glist)
+       (unwind-protect
+            (map-glist 'list #'identity glist element-type)
+         (glist-free glist)))))
+
+(defmethod cleanup-form (glist (type (eql 'glist)) &rest args)
+  (declare (ignore type args))
+  `(glist-free ,glist))
+
+(defmethod cleanup-function ((type (eql 'glist)) &rest args)
+  (declare (ignore type args))
+  #'glist-free)
 
 
 
@@ -204,120 +232,163 @@ (deftype-method cleanup-alien glist (type-spec glist &optional copied)
 
 (deftype gslist (type) `(or (null (cons ,type list))))
 
-(define-foreign ("g_slist_prepend" %gslist-prepend-unsigned) () pointer
+(defbinding (%gslist-prepend-unsigned "g_slist_prepend") () pointer
   (gslist pointer)
   (data unsigned))
 
-(define-foreign ("g_slist_prepend" %gslist-prepend-signed) () pointer
+(defbinding (%gslist-prepend-signed "g_slist_prepend") () pointer
   (gslist pointer)
   (data signed))
 
-(define-foreign ("g_slist_prepend" %gslist-prepend-sap) () pointer
+(defbinding (%gslist-prepend-sap "g_slist_prepend") () pointer
   (gslist pointer)
   (data pointer))
 
-(defmacro gslist-prepend (gslist value type-spec)
-  (ecase (first (mklist (translate-type-spec type-spec)))
-    (unsigned `(%gslist-prepend-unsigned ,gslist ,value))
-    (signed `(%gslist-prepend-signed ,gslist ,value))
-    (system-area-pointer `(%gslist-prepend-sap ,gslist ,value))))
-  
-(define-foreign ("g_slist_free" gslist-free) () nil
+(defun make-gslist (type list)
+  (let ((new-element (ecase (alien-type type)
+                      (system-area-pointer #'%gslist-prepend-sap)
+                      ((signed-byte c-call:short c-call:int c-call:long)
+                       #'%gslist-prepend-signed)
+                      ((unsigned-byte c-call:unsigned-short 
+                        c-call:unsigned-int c-call:unsigned-long)
+                       #'%gslist-prepend-unsigned)))
+       (to-alien (to-alien-function type)))
+    (loop
+     for element in (reverse list)
+     as gslist = (funcall new-element (or gslist (make-pointer 0)) 
+                 (funcall to-alien element))
+     finally (return gslist))))
+
+(defbinding (gslist-free "g_slist_free") () nil
   (gslist pointer))
 
-(deftype-method translate-type-spec gslist (type-spec)
-  (declare (ignore type-spec))
-  (translate-type-spec 'pointer))
 
-(deftype-method size-of gslist (type-spec)
-  (declare (ignore type-spec))
+(defmethod alien-type ((type (eql 'gslist)) &rest args)
+  (declare (ignore type args))
+  (alien-type 'pointer))
+
+(defmethod size-of ((type (eql 'gslist)) &rest args)
+  (declare (ignore type args))
   (size-of 'pointer))
 
-(deftype-method translate-to-alien gslist (type-spec list &optional copy)
-  (declare (ignore copy))
-  (let* ((element-type-spec (second (type-expand-to 'gslist type-spec)))
-        (to-alien (translate-to-alien element-type-spec 'element t)))
-    `(let ((gslist (make-pointer 0))) 
-       (dolist (element (reverse ,list) gslist)
-        (setq gslist (gslist-prepend gslist ,to-alien ,element-type-spec))))))
-
-(deftype-method translate-from-alien
-    gslist (type-spec gslist &optional (alloc :reference))
-  (let ((element-type-spec (second (type-expand-to 'gslist type-spec))))
-    `(let ((gslist ,gslist)
-          (list nil))
-       (do ((tmp gslist (glist-next tmp)))
-          ((null-pointer-p tmp))
-        (push
-         ,(translate-from-alien
-           element-type-spec `(glist-data tmp ,element-type-spec) alloc)
-         list))
-       ,(when (eq alloc :reference)
-         '(gslist-free gslist))
-       (nreverse list))))
-
-(deftype-method cleanup-alien gslist (type-spec gslist &optional copied)
-  (declare (ignore copied))
-  (let* ((element-type-spec (second (type-expand-to 'gslist type-spec)))
-        (alien-type-spec (translate-type-spec element-type-spec)))
+(defmethod to-alien-form (list (type (eql 'gslist)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type) args    
+    `(make-sglist ',element-type ,list)))
+
+(defmethod to-alien-function ((type (eql 'gslist)) &rest args)
+  (declare (ignore type args))
+  (destructuring-bind (element-type) args    
+    #'(lambda (list)
+       (make-gslist element-type list))))
+
+(defmethod from-alien-form (gslist (type (eql 'gslist)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type) args
     `(let ((gslist ,gslist))
-       (unless (null-pointer-p gslist)
-        ,(when (eq alien-type-spec 'system-area-pointer)
-           `(do ((tmp gslist (glist-next tmp)))
-                ((null-pointer-p tmp))
-              ,(cleanup-alien
-                element-type-spec `(glist-data tmp ,element-type-spec) t)))
-        (gslist-free gslist)))))
+      (unwind-protect
+          (map-glist 'list #'identity gslist ',element-type)
+       (gslist-free gslist)))))
 
+(defmethod from-alien-function ((type (eql 'gslist)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type) args
+    #'(lambda (gslist)
+       (unwind-protect
+            (map-glist 'list #'identity gslist element-type)
+         (gslist-free gslist)))))
 
+(defmethod cleanup-form (list (type (eql 'gslist)) &rest args)
+  (declare (ignore type args))
+  `(gslist-free ,list))
 
-;;; Vector
+(defmethod cleanup-function ((type (eql 'gslist)) &rest args)
+  (declare (ignore type args))
+  #'gslist-free)
 
-(deftype-method translate-type-spec vector (type-spec)
-  (declare (ignore type-spec))
-  (translate-type-spec 'pointer))
 
-(deftype-method size-of vector (type-spec)
-  (declare (ignore type-spec))
+
+;;; Vector
+
+(defun make-c-vector (type length &optional content location)
+  (let* ((size-of-type (size-of type))
+        (location (or location (allocate-memory (* size-of-type length))))
+        (writer (writer-function type)))
+    (loop
+     for element across content
+     for i from 0 below length
+     as offset = 0 then (+ offset size-of-type)
+     do (funcall writer element location offset))
+    location))
+
+
+(defun map-c-vector (seqtype function location element-type length)
+  (let ((reader (reader-function element-type))
+       (size-of-element (size-of element-type)))
+    (case seqtype 
+     ((nil)
+      (loop
+       for i from 0 below length
+       as offset = 0 then (+ offset size-of-element)
+       do (funcall function (funcall reader location offset))))
+     (list
+      (loop
+       for i from 0 below length
+       as offset = 0 then (+ offset size-of-element)
+       collect (funcall function (funcall reader location offset))))
+     (t
+      (loop
+       with sequence = (make-sequence seqtype length)
+       for i from 0 below length
+       as offset = 0 then (+ offset size-of-element)
+       do (setf 
+          (elt sequence i)
+          (funcall function (funcall reader location offset)))
+       finally (return sequence))))))
+
+
+(defmethod alien-type ((type (eql 'vector)) &rest args)
+  (declare (ignore type args))
+  (alien-type 'pointer))
+
+(defmethod size-of ((type (eql 'vector)) &rest args)
+  (declare (ignore type args))
   (size-of 'pointer))
 
-(deftype-method translate-to-alien vector (type-spec vector &optional copy)
-  (declare (ignore copy))
-  (destructuring-bind (element-type &optional (length '*))
-      (cdr (type-expand-to 'vector type-spec))
-    (let ((element-size (size-of element-type)))
-      `(let ((vector ,vector))
-        (let ((c-vector
-               (allocate-memory
-                ,(if (eq length '*)
-                     `(* ,element-size (length vector))
-                   (* element-size length)))))
-          (dotimes (i ,(if (eq length '*) '(length vector) length) c-vector)
-            (setf
-             (,(sap-ref-fname element-type) c-vector (* i ,element-size))
-             ,(translate-to-alien element-type '(aref vector i) :copy))))))))
-
-(deftype-method translate-from-alien
-    vector (type-spec sap &optional (alloc :reference))
-  (destructuring-bind (element-type &optional (length '*))
-      (cdr (type-expand-to 'vector type-spec))
-    (when (eq length '*)
-      (error "Can't use vectors of variable length as return type"))
-    (let ((element-size (size-of element-type)))
-      `(let ((sap ,sap)
-            (vector (make-array ,length :element-type ',element-type)))
-        (dotimes (i ,length vector)
-          (setf
-           (aref vector i)
-           ,(translate-to-alien
-             element-type
-             `(,(sap-ref-fname element-type) sap (* i ,element-size))
-             alloc)))))))
-
-
-(deftype-method cleanup-alien vector (type-spec sap &optional copied)
-  (declare (ignore type-spec copied))
-  ;; The individual elements also have to be cleaned up to avoid memory leaks,
-  ;; but this is currently not possible because we can't always tell the
-  ;; length of the vector
-  `(deallocate-memory ,sap))
+(defmethod to-alien-form (vector (type (eql 'vector)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type &optional (length '*)) args
+    (if (eq length '*)
+       `(let* ((vector ,vector)
+               (location (sap+
+                          (allocate-memory (+ ,+size-of-int+ 
+                                              (* ,(size-of element-type) 
+                                                 (length vector))))
+                          ,+size-of-int+)))
+         (make-c-vector ',element-type (length vector) vector location)
+         (setf (sap-ref-32 location ,(- +size-of-int+)) (length vector))
+         location)       
+      `(make-c-vector ',element-type ,length ,vector))))
+
+(defmethod from-alien-form (location (type (eql 'vector)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type &optional (length '*)) args
+    (if (eq length '*)
+       (error "Can't use vector of variable size as return type")
+      `(map-c-vector 'vector #'identity ',element-type ',length ,location))))
+
+(defmethod cleanup-form (location (type (eql 'vector)) &rest args)
+  (declare (ignore type))
+  (destructuring-bind (element-type &optional (length '*)) args
+    `(let* ((location ,location)
+           (length ,(if (eq length '*)
+                        `(sap-ref-32 location ,(- +size-of-int+))
+                        length)))
+      (loop
+       with destroy = (destroy-function ',element-type)
+       for i from 0 below length
+       as offset = 0 then (+ offset ,(size-of element-type))
+       do (funcall destroy location offset))
+      (deallocate-memory ,(if (eq length '*) 
+                             `(sap+ location  ,(- +size-of-int+))
+                           'location)))))