r10584: * tests/objects.lisp: Rename from pointers.lisp.
[uffi.git] / src / objects.lisp
index 51a9ce5977ecaab6929502dc3588ca3938d62d08..e9a2024112ec409b26c136a3deda65020ba8ca16 100644 (file)
@@ -2,12 +2,12 @@
 ;;;; *************************************************************************
 ;;;; FILE IDENTIFICATION
 ;;;;
-;;;; Name:          objects.cl
+;;;; Name:          objects.lisp
 ;;;; Purpose:       UFFI source to handle objects and pointers
 ;;;; Programmer:    Kevin M. Rosenberg
 ;;;; Date Started:  Feb 2002
 ;;;;
-;;;; $Id: objects.lisp,v 1.12 2003/05/30 18:46:45 kevin Exp $
+;;;; $Id$
 ;;;;
 ;;;; This file, part of UFFI, is Copyright (c) 2002 by Kevin M. Rosenberg
 ;;;;
 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
 ;;;; *************************************************************************
 
-(declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
-(in-package :uffi)
-
-(defun size-of-foreign-type (type)
-  #+lispworks (fli:size-of type)
-  #+allegro (ff:sizeof-fobject type)
-  #+(or cmu scl)  (ash (eval `(alien:alien-size ,type)) -3) ;; convert from bits to bytes
-  #+sbcl  (ash (eval `(sb-alien:alien-size ,type)) -3) ;; convert from bits to bytes
-  #+clisp (values (ffi:size-of type))
-  #+(and mcl (not openmcl))
-  (let ((mcl-type (ccl:find-mactype type nil t)))
-    (if mcl-type 
-       (ccl::mactype-record-size mcl-type)
-      (ccl::record-descriptor-length (ccl:find-record-descriptor type t t)))) ;error if not a record
-  #+openmcl (ccl::%foreign-type-or-record-size type :bytes)
-  )
-
+(in-package #:uffi)
 
+(eval-when (:compile-toplevel :load-toplevel :execute)
+  (defun size-of-foreign-type (type)
+    #+lispworks (fli:size-of type)
+    #+allegro (ff:sizeof-fobject type)
+    #+(or cmu scl)  (ash (eval `(alien:alien-size ,type)) -3) ;; convert from bits to bytes
+    #+sbcl  (ash (eval `(sb-alien:alien-size ,type)) -3) ;; convert from bits to bytes
+    #+clisp (values (ffi:size-of type))
+    #+(and mcl (not openmcl))
+    (let ((mcl-type (ccl:find-mactype type nil t)))
+      (if mcl-type 
+         (ccl::mactype-record-size mcl-type)
+         (ccl::record-descriptor-length (ccl:find-record-descriptor type t t)))) ;error if not a record
+    #+openmcl (ccl::%foreign-type-or-record-size type :bytes)
+    ))
+  
 (defmacro allocate-foreign-object (type &optional (size :unspecified))
   "Allocates an instance of TYPE. If size is specified, then allocate
 an array of TYPE with size SIZE. The TYPE parameter is evaluated."
@@ -93,6 +92,16 @@ an array of TYPE with size SIZE. The TYPE parameter is evaluated."
   #+mcl `(ccl:%null-ptr)
   )
 
+(defmacro make-pointer (addr type)
+  #+(or allegro mcl) (declare (ignore type))
+  #+(or cmu scl) `(alien:sap-alien (system:int-sap ,addr) (* ,(convert-from-uffi-type (eval type) :type)))
+  #+sbcl `(sb-alien:sap-alien (sb-sys:int-sap ,addr) (* ,(convert-from-uffi-type (eval type) :type)))
+  #+lispworks `(fli:make-pointer :address ,addr :type (quote ,(convert-from-uffi-type (eval type) :type)))
+  #+allegro addr
+  #+mcl `(ccl:%int-to-ptr ,addr)
+  )
+
+
 (defmacro char-array-to-pointer (obj)
   #+(or cmu scl) `(alien:cast ,obj (* (alien:unsigned 8)))
   #+sbcl `(sb-alien:cast ,obj (* (sb-alien:unsigned 8)))
@@ -112,33 +121,27 @@ an array of TYPE with size SIZE. The TYPE parameter is evaluated."
   #+mcl `(ccl:pref ,ptr ,(convert-from-uffi-type type :deref))
   )
 
-#+mcl
+#+(and mcl (not openmcl))
 (defmacro deref-pointer-set (ptr type value)
   `(setf (ccl:pref ,ptr ,(convert-from-uffi-type type :deref)) ,value))
 
-#+mcl
+#+(and mcl (not openmcl))
 (defsetf deref-pointer deref-pointer-set)
 
-#+(or (and mcl (not openmcl))) ;; with LW, deref is a character
 (defmacro ensure-char-character (obj)
-  obj)
-
-#+(or allegro lispworks cmu sbcl scl openmcl)
-(defmacro ensure-char-character (obj)
-  `(code-char ,obj))
+  #+(or (and mcl (not openmcl))) obj
+  #+(or allegro cmu sbcl scl openmcl) `(code-char ,obj)
+  ;; lispworks varies whether deref'ing array vs. slot access of a char
+  #+lispworks
+  `(if (characterp ,obj) ,obj (code-char ,obj)))
   
-#+(or lispworks (and mcl (not openmcl)))
 (defmacro ensure-char-integer (obj)
- `(char-code ,obj))
+  #+(or (and mcl (not openmcl))) `(char-code ,obj)
+  #+(or allegro cmu sbcl scl openmcl) obj)
 
-#+(or allegro cmu sbcl scl openmcl)
-(defmacro ensure-char-integer (obj)
-  obj)
-
-;; Returns the numeric value of a byte at a pointer
-;; Highly optimized
-(defmacro byte-value-at-pointer (ptr)
-  )
+(defmacro ensure-char-storable (obj)
+  #+(or lispworks (and mcl (not openmcl))) obj
+  #+(or allegro cmu sbcl scl openmcl) `(char-code ,obj))
 
 (defmacro pointer-address (obj)
   #+(or cmu scl)
@@ -162,15 +165,25 @@ an array of TYPE with size SIZE. The TYPE parameter is evaluated."
         (progn ,@body)
       (free-foreign-object ,var)))
   #+(or cmu scl)
-  (let ((obj (gensym)))
-    `(alien:with-alien ((,obj ,(convert-from-uffi-type (eval type) :allocate)))
-       (let ((,var (alien:addr ,obj)))
-        ,@body)))
+  (let ((obj (gensym))
+       (ctype (convert-from-uffi-type (eval type) :allocate)))
+    (if (and (consp ctype) (eq 'array (car ctype)))
+       `(alien:with-alien ((,obj ,ctype))
+         (let* ((,var ,obj))
+           ,@body))
+       `(alien:with-alien ((,obj ,ctype))
+         (let* ((,var (alien:addr ,obj)))
+           ,@body))))
   #+sbcl
-  (let ((obj (gensym)))
-    `(sb-alien:with-alien ((,obj ,(convert-from-uffi-type (eval type) :allocate)))
-       (let ((,var (sb-alien:addr ,obj)))
-        ,@body)))
+  (let ((obj (gensym))
+       (ctype (convert-from-uffi-type (eval type) :allocate)))
+    (if (and (consp ctype) (eq 'array (car ctype)))
+       `(sb-alien:with-alien ((,obj ,ctype))
+         (let* ((,var ,obj))
+           ,@body))
+       `(sb-alien:with-alien ((,obj ,ctype))
+         (let* ((,var (sb-alien:addr ,obj)))
+           ,@body))))
   #+lispworks
   `(fli:with-dynamic-foreign-objects ((,var ,(convert-from-uffi-type
                                              (eval type) :allocate)))
@@ -203,3 +216,61 @@ an array of TYPE with size SIZE. The TYPE parameter is evaluated."
   `(with-foreign-objects ((,var ,type)) 
      ,@body))
 
+#+lispworks
+(defmacro with-cast-pointer ((binding-name pointer type) &body body)
+  `(fli:with-coerced-pointer (,binding-name
+                          :type ',(convert-from-uffi-type (eval type) :type))
+      ,pointer
+    ,@body))
+
+#+(or cmu scl sbcl)
+(defmacro with-cast-pointer ((binding-name pointer type) &body body)
+  `(let ((,binding-name
+          (#+(or cmu scl) alien:cast
+           #+sbcl sb-alien:cast
+           ,pointer (* ,(convert-from-uffi-type (eval type) :type)))))
+    ,@body))
+
+#+(or allegro openmcl)
+(defmacro with-cast-pointer ((binding-name pointer type) &body body)
+  (declare (ignore type))
+  `(let ((,binding-name ,pointer))
+    ,@body))
+
+#-(or lispworks cmu scl sbcl allegro openmcl)
+(defmacro with-cast-pointer ((binding-name pointer type) &body body)
+  (declare (ignore binding-name pointer type body))
+  '(error "WITH-CAST-POINTER not (yet) implemented for ~A"
+          (lisp-implementation-type)))
+
+(defmacro def-foreign-var (names type module)
+  #-lispworks (declare (ignore module))
+  (let ((foreign-name (if (atom names) names (first names)))
+        (lisp-name (if (atom names) (make-lisp-name names) (second names)))
+        #-allegro
+        (var-type (convert-from-uffi-type type :type)))
+    #+(or cmu scl)
+    `(alien:def-alien-variable (,foreign-name ,lisp-name) ,var-type)
+    #+sbcl
+    `(sb-alien:define-alien-variable (,foreign-name ,lisp-name) ,var-type)
+    #+allegro
+    `(define-symbol-macro ,lisp-name
+      (ff:fslot-value-typed (quote ,(convert-from-uffi-type type :deref))
+                            :c (ff:get-entry-point ,foreign-name)))
+    #+lispworks
+    `(progn
+      (fli:define-foreign-variable (,lisp-name ,foreign-name)
+                                    :accessor :address-of
+                                    :type ,var-type
+                                    :module ,module)
+      (define-symbol-macro ,lisp-name (fli:dereference (,lisp-name)
+                                                        :copy-foreign-object nil)))
+    #+(and openmcl darwinppc-target)
+    (setf foreign-name (concatenate 'string "_" foreign-name))
+    #+openmcl
+    `(define-symbol-macro ,lisp-name
+       (deref-pointer (ccl:foreign-symbol-address ,foreign-name) ,var-type))
+    #-(or allegro cmu scl sbcl lispworks openmcl)
+    `(define-symbol-macro ,lisp-name
+      '(error "DEF-FOREIGN-VAR not (yet) defined for ~A"
+        (lisp-implementation-type)))))