src/objects.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          objects.lisp
   6 ;;;; Purpose:       UFFI source to handle objects and pointers
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Feb 2002
   9 ;;;;
  10 ;;;; $Id$
  11 ;;;;
  12 ;;;; This file, part of UFFI, is Copyright (c) 2002-2005 by Kevin M. Rosenberg
  13 ;;;;
  14 ;;;; *************************************************************************
  15
  16 (in-package #:uffi)
  17
  18 (eval-when (:compile-toplevel :load-toplevel :execute)
  19   (defun size-of-foreign-type (type)
  20     #+lispworks (fli:size-of type)
  21     #+allegro (ff:sizeof-fobject type)
  22     #+(or cmu scl)  (ash (eval `(alien:alien-size ,type)) -3) ;; convert from bits to bytes
  23     #+sbcl  (ash (eval `(sb-alien:alien-size ,type)) -3) ;; convert from bits to bytes
  24     #+clisp (values (ffi:size-of type))
  25     #+digitool
  26     (let ((mcl-type (ccl:find-mactype type nil t)))
  27       (if mcl-type
  28           (ccl::mactype-record-size mcl-type)
  29           (ccl::record-descriptor-length (ccl:find-record-descriptor type t t)))) ;error if not a record
  30     #+openmcl (ccl::%foreign-type-or-record-size type :bytes)
  31     ))
  32
  33 (defmacro allocate-foreign-object (type &optional (size :unspecified))
  34   "Allocates an instance of TYPE. If size is specified, then allocate
  35 an array of TYPE with size SIZE. The TYPE parameter is evaluated."
  36   (if (eq size :unspecified)
  37       (progn
  38         #+(or cmu scl)
  39         `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation))
  40         #+sbcl
  41         `(sb-alien:make-alien ,(convert-from-uffi-type (eval type) :allocation))
  42         #+lispworks
  43         `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate))
  44         #+allegro
  45         `(ff:allocate-fobject ',(convert-from-uffi-type type :allocate) :c)
  46         #+(or openmcl digitool)
  47         `(new-ptr ,(size-of-foreign-type (convert-from-uffi-type type :allocation)))
  48         )
  49       (progn
  50         #+(or cmu scl)
  51         `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation) ,size)
  52         #+sbcl
  53         `(sb-alien:make-alien ,(convert-from-uffi-type (eval type) :allocation) ,size)
  54         #+lispworks
  55         `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate) :nelems ,size)
  56         #+allegro
  57         `(ff:allocate-fobject (list :array (quote ,(convert-from-uffi-type type :allocate)) ,size) :c)
  58         #+(or openmcl digitool)
  59         `(new-ptr (* ,size ,(size-of-foreign-type (convert-from-uffi-type type :allocation))))
  60         )))
  61
  62 (defmacro free-foreign-object (obj)
  63   #+(or cmu scl)
  64   `(alien:free-alien ,obj)
  65   #+sbcl
  66   `(sb-alien:free-alien ,obj)
  67   #+lispworks
  68   `(fli:free-foreign-object ,obj)
  69   #+allegro
  70   `(ff:free-fobject ,obj)
  71   #+(or openmcl digitool)
  72   `(dispose-ptr ,obj)
  73   )
  74
  75 (defmacro null-pointer-p (obj)
  76   #+lispworks `(fli:null-pointer-p ,obj)
  77   #+allegro `(zerop ,obj)
  78   #+(or cmu scl)   `(alien:null-alien ,obj)
  79   #+sbcl   `(sb-alien:null-alien ,obj)
  80   #+(or openmcl digitool)   `(ccl:%null-ptr-p ,obj)
  81   )
  82
  83 (defmacro make-null-pointer (type)
  84   #+(or allegro openmcl digitool) (declare (ignore type))
  85   #+(or cmu scl) `(alien:sap-alien (system:int-sap 0) (* ,(convert-from-uffi-type (eval type) :type)))
  86   #+sbcl `(sb-alien:sap-alien (sb-sys:int-sap 0) (* ,(convert-from-uffi-type (eval type) :type)))
  87   #+lispworks `(fli:make-pointer :address 0 :type (quote ,(convert-from-uffi-type (eval type) :type)))
  88   #+allegro 0
  89   #+(or openmcl digitool) `(ccl:%null-ptr)
  90   )
  91
  92 (defmacro make-pointer (addr type)
  93   #+(or allegro openmcl digitool) (declare (ignore type))
  94   #+(or cmu scl) `(alien:sap-alien (system:int-sap ,addr) (* ,(convert-from-uffi-type (eval type) :type)))
  95   #+sbcl `(sb-alien:sap-alien (sb-sys:int-sap ,addr) (* ,(convert-from-uffi-type (eval type) :type)))
  96   #+lispworks `(fli:make-pointer :address ,addr :type (quote ,(convert-from-uffi-type (eval type) :type)))
  97   #+allegro addr
  98   #+(or openmcl digitool) `(ccl:%int-to-ptr ,addr)
  99   )
 100
 101
 102 (defmacro char-array-to-pointer (obj)
 103   #+(or cmu scl) `(alien:cast ,obj (* (alien:unsigned 8)))
 104   #+sbcl `(sb-alien:cast ,obj (* (sb-alien:unsigned 8)))
 105   #+lispworks `(fli:make-pointer :type '(:unsigned :char)
 106                                 :address (fli:pointer-address ,obj))
 107   #+allegro obj
 108   #+(or openmcl digitool) obj
 109   )
 110
 111 (defmacro deref-pointer (ptr type)
 112   "Returns a object pointed"
 113   #+(or cmu sbcl lispworks scl) (declare (ignore type))
 114   #+(or cmu scl)  `(alien:deref ,ptr)
 115   #+sbcl  `(sb-alien:deref ,ptr)
 116   #+lispworks `(fli:dereference ,ptr)
 117   #+allegro `(ff:fslot-value-typed (quote ,(convert-from-uffi-type type :deref)) :c ,ptr)
 118   #+(or openmcl digitool) `(ccl:pref ,ptr ,(convert-from-uffi-type type :deref))
 119   )
 120
 121 #+digitool
 122 (defmacro deref-pointer-set (ptr type value)
 123   `(setf (ccl:pref ,ptr ,(convert-from-uffi-type type :deref)) ,value))
 124
 125 #+digitool
 126 (defsetf deref-pointer deref-pointer-set)
 127
 128 (defmacro ensure-char-character (obj)
 129   #+(or digitool) obj
 130   #+(or allegro cmu sbcl scl openmcl) `(code-char ,obj)
 131   ;; lispworks varies whether deref'ing array vs. slot access of a char
 132   #+lispworks `(if (characterp ,obj) ,obj (code-char ,obj)))
 133
 134 (defmacro ensure-char-integer (obj)
 135   #+(or digitool) `(char-code ,obj)
 136   #+(or allegro cmu sbcl scl openmcl) obj
 137   ;; lispworks varies whether deref'ing array vs. slot access of a char
 138   #+lispworks
 139   `(if (integerp ,obj) ,obj (char-code ,obj)))
 140
 141 (defmacro ensure-char-storable (obj)
 142   #+(or digitool (and lispworks (not lispworks5))) obj
 143   #+(or allegro cmu lispworks5 openmcl sbcl scl)
 144   `(char-code ,obj))
 145
 146 (defmacro pointer-address (obj)
 147   #+(or cmu scl)
 148   `(system:sap-int (alien:alien-sap ,obj))
 149   #+sbcl
 150   `(sb-sys:sap-int (sb-alien:alien-sap ,obj))
 151   #+lispworks
 152   `(fli:pointer-address ,obj)
 153   #+allegro
 154   obj
 155   #+(or openmcl digitool)
 156   `(ccl:%ptr-to-int ,obj)
 157   )
 158
 159 ;; TYPE is evaluated.
 160 #-(or openmcl digitool)
 161 (defmacro with-foreign-object ((var type) &rest body)
 162   #-(or cmu sbcl lispworks scl) ; default version
 163   `(let ((,var (allocate-foreign-object ,type)))
 164     (unwind-protect
 165          (progn ,@body)
 166       (free-foreign-object ,var)))
 167   #+(or cmu scl)
 168   (let ((obj (gensym))
 169         (ctype (convert-from-uffi-type (eval type) :allocate)))
 170     (if (and (consp ctype) (eq 'array (car ctype)))
 171         `(alien:with-alien ((,obj ,ctype))
 172           (let* ((,var ,obj))
 173             ,@body))
 174         `(alien:with-alien ((,obj ,ctype))
 175           (let* ((,var (alien:addr ,obj)))
 176             ,@body))))
 177   #+sbcl
 178   (let ((obj (gensym))
 179         (ctype (convert-from-uffi-type (eval type) :allocate)))
 180     (if (and (consp ctype) (eq 'array (car ctype)))
 181         `(sb-alien:with-alien ((,obj ,ctype))
 182           (let* ((,var ,obj))
 183             ,@body))
 184         `(sb-alien:with-alien ((,obj ,ctype))
 185           (let* ((,var (sb-alien:addr ,obj)))
 186             ,@body))))
 187   #+lispworks
 188   `(fli:with-dynamic-foreign-objects ((,var ,(convert-from-uffi-type
 189                                               (eval type) :allocate)))
 190     ,@body)
 191   )
 192
 193 #-(or openmcl digitool)
 194 (defmacro with-foreign-objects (bindings &rest body)
 195   (if bindings
 196       `(with-foreign-object ,(car bindings)
 197         (with-foreign-objects ,(cdr bindings)
 198           ,@body))
 199       `(progn ,@body)))
 200
 201 #+(or openmcl digitool)
 202 (defmacro with-foreign-objects (bindings &rest body)
 203   (let ((params nil) type count)
 204     (dolist (spec (reverse bindings)) ;keep order - macroexpands to let*
 205       (setf type (convert-from-uffi-type (eval (nth 1 spec)) :allocate))
 206       (setf count 1)
 207       (when (and (listp type) (eq (first type) :array))
 208         (setf count (nth 2 type))
 209         (unless (integerp count) (error "Invalid size for array: ~a" type))
 210         (setf type (nth 1 type)))
 211       (push (list (first spec) (* count (size-of-foreign-type type))) params))
 212     `(ccl:%stack-block ,params ,@body)))
 213
 214 #+(or openmcl digitool)
 215 (defmacro with-foreign-object ((var type) &rest body)
 216   `(with-foreign-objects ((,var ,type))
 217      ,@body))
 218
 219 #+lispworks
 220 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 221   `(fli:with-coerced-pointer (,binding-name
 222                           :type ',(convert-from-uffi-type (eval type) :type))
 223       ,pointer
 224     ,@body))
 225
 226 #+(or cmu scl sbcl)
 227 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 228   `(let ((,binding-name
 229           (#+(or cmu scl) alien:cast
 230            #+sbcl sb-alien:cast
 231            ,pointer (* ,(convert-from-uffi-type (eval type) :type)))))
 232     ,@body))
 233
 234 #+(or allegro openmcl)
 235 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 236   (declare (ignore type))
 237   `(let ((,binding-name ,pointer))
 238     ,@body))
 239
 240 #-(or lispworks cmu scl sbcl allegro openmcl)
 241 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 242   (declare (ignore binding-name pointer type body))
 243   '(error "WITH-CAST-POINTER not (yet) implemented for ~A"
 244           (lisp-implementation-type)))
 245
 246 #+(or allegro openmcl)
 247 (defun convert-external-name (name)
 248   "Add an underscore to NAME if necessary for the ABI."
 249   #+(or macosx darwinppc-target) (concatenate 'string "_" name)
 250   #-(or macosx darwinppc-target) name)
 251
 252 ;; unchanged from main primitives.lisp
 253 (defun make-lisp-name (name)
 254   (let ((converted (substitute #\- #\_ name)))
 255      (intern
 256       #+uffi-case-sensitive converted
 257       #+(and (not uffi-lowercase-reader) (not uffi-case-sensitive)) (string-upcase converted)
 258       #+(and uffi-lowercase-reader (not uffi-case-sensitive)) (string-downcase converted))))
 259
 260 (defmacro def-foreign-var (names type module)
 261   #-lispworks (declare (ignore module))
 262   (let ((foreign-name (if (atom names) names (first names)))
 263         (lisp-name (if (atom names) (make-lisp-name names) (second names)))
 264         #-allegro
 265         (var-type (convert-uffi-type type :type)))
 266     #+(or cmu scl)
 267     `(alien:def-alien-variable (,foreign-name ,lisp-name) ,var-type)
 268     #+sbcl
 269     `(sb-alien:define-alien-variable (,foreign-name ,lisp-name) ,var-type)
 270     #+allegro
 271     `(define-symbol-macro ,lisp-name
 272       (ff:fslot-value-typed (quote ,(convert-from-uffi-type type :deref))
 273                             :c (ff:get-entry-point ,(convert-external-name foreign-name))))
 274     #+lispworks
 275     `(progn
 276       (fli:define-foreign-variable (,lisp-name ,foreign-name)
 277                                     :accessor :address-of
 278                                     :type ,var-type
 279                                     :module ,module)
 280       (define-symbol-macro ,lisp-name (fli:dereference (,lisp-name)
 281                                                         :copy-foreign-object nil)))
 282     #+openmcl
 283     `(define-symbol-macro ,lisp-name
 284        (deref-pointer (ccl:foreign-symbol-address
 285                        ,(convert-external-name foreign-name)) ,var-type))
 286     #-(or allegro cmu scl sbcl lispworks openmcl)
 287     `(define-symbol-macro ,lisp-name
 288       '(error "DEF-FOREIGN-VAR not (yet) defined for ~A"
 289         (lisp-implementation-type)))))
 290
 291
 292 ;;; Define a special variable, like DEFVAR, that will be initialized
 293 ;;; to a pointer which may need to be reset when a saved image is
 294 ;;; loaded.  This is needed for OpenMCL, which sets pointers to "dead
 295 ;;; macptrs" when a saved image is loaded.
 296 ;; This may possibly be needed for sbcl's SAVE-LISP-AND-DIE
 297 (defmacro def-pointer-var (name value &optional doc)
 298   #-openmcl `(defvar ,name ,value ,@(if doc (list doc)))
 299   #+openmcl `(ccl::defloadvar ,name ,value ,doc))