chiark / gitweb /
Build instructions updated for SBCL with native C callback support
[clg] / glib / ffi.lisp
index ca6bd5822b8f245931fe4296315c7ef81d986d47..630181c3ca6f2e6bf89aa1b518b895fa65c58500 100644 (file)
@@ -1,21 +1,26 @@
-;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 1999-2005 Espen S. Johnsen <espen@users.sf.net>
+;; Common Lisp bindings for GTK+ v2.x
+;; Copyright 1999-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: ffi.lisp,v 1.19 2005/04/17 21:49:19 espen Exp $
+;; $Id: ffi.lisp,v 1.24 2006/02/19 19:17:45 espen Exp $
 
 (in-package "GLIB")
 
@@ -184,7 +189,10 @@ (defun mkbinding (name return-type &rest arg-types)
          (%heap-alien
           (make-heap-alien-info
            :type (parse-alien-type ftype #+sbcl nil)
-           :sap-form (foreign-symbol-address name))))
+           :sap-form (let ((address (foreign-symbol-address name)))
+                       (etypecase address
+                         (integer (int-sap address))
+                         (system-area-pointer address))))))
         (translate-arguments (mapcar #'to-alien-function arg-types))
         (translate-return-value (from-alien-function return-type))
         (cleanup-arguments (mapcar #'cleanup-function arg-types)))
@@ -197,33 +205,66 @@ (defun mkbinding (name return-type &rest arg-types)
          (mapc #'funcall cleanup-arguments args)))))
 
 
-(defmacro defcallback (name (return-type &rest args) &body body)
-  (let ((def-callback #+cmu'alien:def-callback 
-                     #+sbcl'sb-alien:define-alien-function))
-    `(,def-callback ,name 
-         (,(alien-type return-type) 
-         ,@(mapcar #'(lambda (arg)
-                       (destructuring-bind (name type) arg
-                         `(,name ,(alien-type type))))
-                   args))
-       ,(to-alien-form 
-        `(let (,@(delete nil
-                    (mapcar #'(lambda (arg)
-                                (destructuring-bind (name type) arg
-                                  (let ((from-alien 
-                                         (from-alien-form name type)))
-                                    (unless (eq name from-alien)
-                                      `(,name ,from-alien)))))
-                     args)))
-           ,@body)
-        return-type))))
 
-#+sbcl
-(defun callback (af)
-  (sb-alien:alien-function-sap af))
+;;;; C callbacks
+
+(defmacro define-callback (name return-type args &body body)
+  (let ((define-callback 
+         #+cmu'alien:def-callback                    
+         #+(and sbcl alien-callbacks)'sb-alien::define-alien-callback
+         #+(and sbcl (not alien-callbacks))'sb-alien:define-alien-function))
+    (multiple-value-bind (doc declaration body)
+       (cond
+        ((and (stringp (first body)) (eq (cadr body) 'declare))
+         (values (first body) (second body) (cddr body)))
+        ((stringp (first body))
+         (values (first body) nil (rest body)))
+        ((eq (caar body) 'declare)
+         (values nil (first body) (rest body)))
+        (t (values nil nil body)))
+      `(,define-callback ,name 
+        #+(and sbcl alien-callbacks),(alien-type return-type) 
+         (#+(or cmu (and sbcl (not alien-callbacks))),(alien-type return-type)
+        ,@(mapcar #'(lambda (arg)
+                      (destructuring-bind (name type) arg
+                        `(,name ,(alien-type type))))
+                  args))
+        ,@(when doc (list doc))
+        ,(to-alien-form 
+          `(let (,@(loop
+                    for (name type) in args
+                    as from-alien-form = (callback-from-alien-form name type)
+                    collect `(,name ,from-alien-form)))
+             ,@(when declaration (list declaration))
+             (unwind-protect
+                 (progn ,@body)              
+             ,@(loop 
+                for (name type) in args
+                do (callback-cleanup-form name type))))
+
+        return-type)))))
+
+(defun callback-address (callback)
+  #+cmu(alien::callback-trampoline callback)
+  #+(and sbcl (not alien-callbacks))(sb-alien:alien-function-sap callback)
+  #+(and sbcl alien-callbacks)(sb-alien:alien-sap callback))
 
 #+sbcl
-(deftype callback () 'sb-alien:alien-function)
+(deftype callback () 
+  #-alien-callbacks'sb-alien:alien-function
+  #+alien-callbacks'sb-alien:alien)
+
+
+;;; These are for backward compatibility
+
+(defmacro defcallback (name (return-type &rest args) &body body)
+  `(define-callback ,name ,return-type ,args ,@body))
+
+#-cmu
+(defun callback (callback)
+  (callback-address callback))
+
+
 
 ;;;; Definitons and translations of fundamental types
 
@@ -251,6 +292,8 @@ (def-type-method to-alien-form (form))
 (def-type-method from-alien-form (form))
 (def-type-method cleanup-form (form)
   "Creates a form to clean up after the alien call has finished.")
+(def-type-method callback-from-alien-form (form))
+(def-type-method callback-cleanup-form (form))
 
 (def-type-method to-alien-function ())
 (def-type-method from-alien-function ())
@@ -322,6 +365,13 @@ (defmethod cleanup-function ((type t) &rest args)
   (declare (ignore type args))
   #'identity)
 
+(defmethod callback-from-alien-form (form (type t) &rest args)
+  (apply #'copy-from-alien-form form type args))
+
+(defmethod callback-cleanup-form (form (type t) &rest args)
+  (declare (ignore form type args))
+  nil)
+
 (defmethod destroy-function ((type t) &rest args)
   (declare (ignore type args))
   #'(lambda (location &optional offset)
@@ -339,7 +389,6 @@ (defmethod copy-from-alien-form  (form (type t) &rest args)
 (defmethod copy-from-alien-function  ((type t) &rest args)
   (apply #'from-alien-function type args))
 
-
 (defmethod alien-type ((type (eql 'signed-byte)) &rest args)
   (declare (ignore type))
   (destructuring-bind (&optional (size '*)) args
@@ -381,13 +430,17 @@ (defmethod reader-function ((type (eql 'signed-byte)) &rest args)
   (destructuring-bind (&optional (size '*)) args
     (let ((size (if (eq size '*) +bits-of-int+ size)))
       (ecase size
-       (8 #'(lambda (sap &optional (offset 0)) 
+       (8 #'(lambda (sap &optional (offset 0) weak-p) 
+              (declare (ignore weak-p))
               (signed-sap-ref-8 sap offset)))
-       (16 #'(lambda (sap &optional (offset 0)) 
+       (16 #'(lambda (sap &optional (offset 0) weak-p)
+               (declare (ignore weak-p))
                (signed-sap-ref-16 sap offset)))
-       (32 #'(lambda (sap &optional (offset 0)) 
+       (32 #'(lambda (sap &optional (offset 0) weak-p) 
+               (declare (ignore weak-p)) 
                (signed-sap-ref-32 sap offset)))
-       (64 #'(lambda (sap &optional (offset 0))
+       (64 #'(lambda (sap &optional (offset 0) weak-p) 
+               (declare (ignore weak-p))
                (signed-sap-ref-64 sap offset)))))))
 
 (defmethod alien-type ((type (eql 'unsigned-byte)) &rest args)
@@ -423,13 +476,17 @@ (defmethod reader-function ((type (eql 'unsigned-byte)) &rest args)
   (destructuring-bind (&optional (size '*)) args
     (let ((size (if (eq size '*) +bits-of-int+ size)))
       (ecase size
-       (8 #'(lambda (sap &optional (offset 0)) 
+       (8 #'(lambda (sap &optional (offset 0) weak-p)
+              (declare (ignore weak-p))
               (sap-ref-8 sap offset)))
-       (16 #'(lambda (sap &optional (offset 0)) 
+       (16 #'(lambda (sap &optional (offset 0) weak-p)
+               (declare (ignore weak-p)) 
                (sap-ref-16 sap offset)))
-       (32 #'(lambda (sap &optional (offset 0)) 
+       (32 #'(lambda (sap &optional (offset 0) weak-p)
+               (declare (ignore weak-p)) 
                (sap-ref-32 sap offset)))
-       (64 #'(lambda (sap &optional (offset 0))
+       (64 #'(lambda (sap &optional (offset 0) weak-p)
+               (declare (ignore weak-p))
                (sap-ref-64 sap offset)))))))
   
   
@@ -483,7 +540,8 @@ (defmethod writer-function ((type (eql 'single-float)) &rest args)
 
 (defmethod reader-function ((type (eql 'single-float)) &rest args)
   (declare (ignore type args))
-  #'(lambda (sap &optional (offset 0)) 
+  #'(lambda (sap &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (sap-ref-single sap offset)))
 
 
@@ -511,7 +569,8 @@ (defmethod writer-function ((type (eql 'double-float)) &rest args)
 
 (defmethod reader-function ((type (eql 'double-float)) &rest args)
   (declare (ignore type args))
-  #'(lambda (sap &optional (offset 0)) 
+  #'(lambda (sap &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (sap-ref-double sap offset)))
 
 
@@ -530,7 +589,8 @@ (defmethod writer-function ((type (eql 'base-char)) &rest args)
 
 (defmethod reader-function ((type (eql 'base-char)) &rest args)
   (declare (ignore type args))
-  #'(lambda (location &optional (offset 0))
+  #'(lambda (location &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (code-char (sap-ref-8 location offset))))
 
 
@@ -624,7 +684,8 @@ (defmethod writer-function ((type (eql 'string)) &rest args)
 
 (defmethod reader-function ((type (eql 'string)) &rest args)
   (declare (ignore type args))
-  #'(lambda (location &optional (offset 0))
+  #'(lambda (location &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (unless (null-pointer-p (sap-ref-sap location offset))
        #+cmu(%naturalize-c-string (sap-ref-sap location offset))
        #+sbcl(%naturalize-utf8-string (sap-ref-sap location offset)))))
@@ -686,7 +747,8 @@ (defmethod writer-function ((type (eql 'pathname)) &rest args)
 (defmethod reader-function ((type (eql 'pathname)) &rest args)
   (declare (ignore type args))
   (let ((string-reader (reader-function 'string)))
-  #'(lambda (location &optional (offset 0))
+  #'(lambda (location &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (let ((string (funcall string-reader location offset)))
        (when string
          (parse-namestring string))))))
@@ -733,7 +795,8 @@ (defmethod writer-function ((type (eql 'boolean)) &rest args)
 (defmethod reader-function ((type (eql 'boolean)) &rest args)
   (declare (ignore type))
   (let ((reader (apply #'reader-function 'signed-byte args)))
-  #'(lambda (location &optional (offset 0))
+  #'(lambda (location &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (not (zerop (funcall reader location offset))))))
 
 
@@ -785,7 +848,8 @@ (defmethod writer-function ((type (eql 'system-area-pointer)) &rest args)
 
 (defmethod reader-function ((type (eql 'system-area-pointer)) &rest args)
   (declare (ignore type args))
-  #'(lambda (location &optional (offset 0))
+  #'(lambda (location &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (sap-ref-sap location offset)))
 
 
@@ -856,20 +920,20 @@ (defmethod alien-type ((type (eql 'callback)) &rest args)
   (declare (ignore type args))
   (alien-type 'pointer))
 
+#+nil
 (defmethod size-of ((type (eql 'callback)) &rest args)
   (declare (ignore type args))
   (size-of 'pointer))
 
 (defmethod to-alien-form (callback (type (eql 'callback)) &rest args)
   (declare (ignore type args))
-  #+cmu `(callback ,callback)
-  #+sbcl `(sb-alien:alien-function-sap ,callback))
+  `(callback-address ,callback))
 
 (defmethod to-alien-function ((type (eql 'callback)) &rest args)
   (declare (ignore type args))
-  #+cmu #'(lambda (callback) (callback callback))
-  #+sbcl #'sb-alien:alien-function-sap)
+  #'callback-address)
 
+#+nil(
 #+cmu
 (defun find-callback (pointer)
   (find pointer alien::*callbacks* :key #'callback-trampoline :test #'sap=))
@@ -895,7 +959,8 @@ (defmethod reader-function ((type (eql 'callback)) &rest args)
   (declare (ignore type args))
   (let ((reader (reader-function 'pointer))
        (from-alien (from-alien-function 'callback)))
-  #'(lambda (location &optional (offset 0))
+  #'(lambda (location &optional (offset 0) weak-p)
+      (declare (ignore weak-p))
       (let ((pointer (funcall reader location offset)))
        (unless (null-pointer-p pointer)
          (funcall from-alien pointer))))))
@@ -903,3 +968,4 @@ (defmethod reader-function ((type (eql 'callback)) &rest args)
 (defmethod unbound-value ((type (eql 'callback)) &rest args)
   (declare (ignore type args))
   (values t nil))
+)
\ No newline at end of file