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 by Kevin M. Rosenberg
  13 ;;;;
  14 ;;;; UFFI users are granted the rights to distribute and use this software
  15 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  16 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  17 ;;;; *************************************************************************
  18
  19 (in-package #:uffi)
  20
  21 (eval-when (:compile-toplevel :load-toplevel :execute)
  22   (defun size-of-foreign-type (type)
  23     #+lispworks (fli:size-of type)
  24     #+allegro (ff:sizeof-fobject type)
  25     #+(or cmu scl)  (ash (eval `(alien:alien-size ,type)) -3) ;; convert from bits to bytes
  26     #+sbcl  (ash (eval `(sb-alien:alien-size ,type)) -3) ;; convert from bits to bytes
  27     #+clisp (values (ffi:size-of type))
  28     #+(and mcl (not openmcl))
  29     (let ((mcl-type (ccl:find-mactype type nil t)))
  30       (if mcl-type
  31           (ccl::mactype-record-size mcl-type)
  32           (ccl::record-descriptor-length (ccl:find-record-descriptor type t t)))) ;error if not a record
  33     #+openmcl (ccl::%foreign-type-or-record-size type :bytes)
  34     ))
  35
  36 (defmacro allocate-foreign-object (type &optional (size :unspecified))
  37   "Allocates an instance of TYPE. If size is specified, then allocate
  38 an array of TYPE with size SIZE. The TYPE parameter is evaluated."
  39   (if (eq size :unspecified)
  40       (progn
  41         #+(or cmu scl)
  42         `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation))
  43         #+sbcl
  44         `(sb-alien:make-alien ,(convert-from-uffi-type (eval type) :allocation))
  45         #+lispworks
  46         `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate))
  47         #+allegro
  48         `(ff:allocate-fobject ',(convert-from-uffi-type type :allocate) :c)
  49         #+mcl
  50         `(new-ptr ,(size-of-foreign-type (convert-from-uffi-type type :allocation)))
  51         )
  52       (progn
  53         #+(or cmu scl)
  54         `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation) ,size)
  55         #+sbcl
  56         `(sb-alien:make-alien ,(convert-from-uffi-type (eval type) :allocation) ,size)
  57         #+lispworks
  58         `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate) :nelems ,size)
  59         #+allegro
  60         `(ff:allocate-fobject (list :array (quote ,(convert-from-uffi-type type :allocate)) ,size) :c)
  61         #+mcl
  62         `(new-ptr (* ,size ,(size-of-foreign-type (convert-from-uffi-type type :allocation))))
  63         )))
  64
  65 (defmacro free-foreign-object (obj)
  66   #+(or cmu scl)
  67   `(alien:free-alien ,obj)
  68   #+sbcl
  69   `(sb-alien:free-alien ,obj)
  70   #+lispworks
  71   `(fli:free-foreign-object ,obj)
  72   #+allegro
  73   `(ff:free-fobject ,obj)
  74   #+mcl
  75   `(dispose-ptr ,obj)
  76   )
  77
  78 (defmacro null-pointer-p (obj)
  79   #+lispworks `(fli:null-pointer-p ,obj)
  80   #+allegro `(zerop ,obj)
  81   #+(or cmu scl)   `(alien:null-alien ,obj)
  82   #+sbcl   `(sb-alien:null-alien ,obj)
  83   #+mcl   `(ccl:%null-ptr-p ,obj)
  84   )
  85
  86 (defmacro make-null-pointer (type)
  87   #+(or allegro mcl) (declare (ignore type))
  88   #+(or cmu scl) `(alien:sap-alien (system:int-sap 0) (* ,(convert-from-uffi-type (eval type) :type)))
  89   #+sbcl `(sb-alien:sap-alien (sb-sys:int-sap 0) (* ,(convert-from-uffi-type (eval type) :type)))
  90   #+lispworks `(fli:make-pointer :address 0 :type (quote ,(convert-from-uffi-type (eval type) :type)))
  91   #+allegro 0
  92   #+mcl `(ccl:%null-ptr)
  93   )
  94
  95 (defmacro make-pointer (addr type)
  96   #+(or allegro mcl) (declare (ignore type))
  97   #+(or cmu scl) `(alien:sap-alien (system:int-sap ,addr) (* ,(convert-from-uffi-type (eval type) :type)))
  98   #+sbcl `(sb-alien:sap-alien (sb-sys:int-sap ,addr) (* ,(convert-from-uffi-type (eval type) :type)))
  99   #+lispworks `(fli:make-pointer :address ,addr :type (quote ,(convert-from-uffi-type (eval type) :type)))
 100   #+allegro addr
 101   #+mcl `(ccl:%int-to-ptr ,addr)
 102   )
 103
 104
 105 (defmacro char-array-to-pointer (obj)
 106   #+(or cmu scl) `(alien:cast ,obj (* (alien:unsigned 8)))
 107   #+sbcl `(sb-alien:cast ,obj (* (sb-alien:unsigned 8)))
 108   #+lispworks `(fli:make-pointer :type '(:unsigned :char)
 109                                 :address (fli:pointer-address ,obj))
 110   #+allegro obj
 111   #+mcl obj
 112   )
 113
 114 (defmacro deref-pointer (ptr type)
 115   "Returns a object pointed"
 116   #+(or cmu sbcl lispworks scl) (declare (ignore type))
 117   #+(or cmu scl)  `(alien:deref ,ptr)
 118   #+sbcl  `(sb-alien:deref ,ptr)
 119   #+lispworks `(fli:dereference ,ptr)
 120   #+allegro `(ff:fslot-value-typed (quote ,(convert-from-uffi-type type :deref)) :c ,ptr)
 121   #+mcl `(ccl:pref ,ptr ,(convert-from-uffi-type type :deref))
 122   )
 123
 124 #+(and mcl (not openmcl))
 125 (defmacro deref-pointer-set (ptr type value)
 126   `(setf (ccl:pref ,ptr ,(convert-from-uffi-type type :deref)) ,value))
 127
 128 #+(and mcl (not openmcl))
 129 (defsetf deref-pointer deref-pointer-set)
 130
 131 (defmacro ensure-char-character (obj)
 132   #+(or (and mcl (not openmcl))) obj
 133   #+(or allegro cmu sbcl scl openmcl) `(code-char ,obj)
 134   ;; lispworks varies whether deref'ing array vs. slot access of a char
 135   #+lispworks
 136   `(if (characterp ,obj) ,obj (code-char ,obj)))
 137
 138 (defmacro ensure-char-integer (obj)
 139   #+(or (and mcl (not openmcl))) `(char-code ,obj)
 140   #+(or allegro cmu sbcl scl openmcl) obj
 141   #+lispworks
 142   ;; lispworks varies whether deref'ing array vs. slot access of a char
 143   #+lispworks
 144   `(if (integerp ,obj) ,obj (char-code ,obj)))
 145
 146 (defmacro ensure-char-storable (obj)
 147   #+(or lispworks (and mcl (not openmcl))) obj
 148   #+(or allegro cmu sbcl scl openmcl) `(char-code ,obj))
 149
 150 (defmacro pointer-address (obj)
 151   #+(or cmu scl)
 152   `(system:sap-int (alien:alien-sap ,obj))
 153   #+sbcl
 154   `(sb-sys:sap-int (sb-alien:alien-sap ,obj))
 155   #+lispworks
 156   `(fli:pointer-address ,obj)
 157   #+allegro
 158   obj
 159   #+mcl
 160   `(ccl:%ptr-to-int ,obj)
 161   )
 162
 163 ;; TYPE is evaluated.
 164 #-mcl
 165 (defmacro with-foreign-object ((var type) &rest body)
 166   #-(or cmu sbcl lispworks scl) ; default version
 167   `(let ((,var (allocate-foreign-object ,type)))
 168     (unwind-protect
 169          (progn ,@body)
 170       (free-foreign-object ,var)))
 171   #+(or cmu scl)
 172   (let ((obj (gensym))
 173         (ctype (convert-from-uffi-type (eval type) :allocate)))
 174     (if (and (consp ctype) (eq 'array (car ctype)))
 175         `(alien:with-alien ((,obj ,ctype))
 176           (let* ((,var ,obj))
 177             ,@body))
 178         `(alien:with-alien ((,obj ,ctype))
 179           (let* ((,var (alien:addr ,obj)))
 180             ,@body))))
 181   #+sbcl
 182   (let ((obj (gensym))
 183         (ctype (convert-from-uffi-type (eval type) :allocate)))
 184     (if (and (consp ctype) (eq 'array (car ctype)))
 185         `(sb-alien:with-alien ((,obj ,ctype))
 186           (let* ((,var ,obj))
 187             ,@body))
 188         `(sb-alien:with-alien ((,obj ,ctype))
 189           (let* ((,var (sb-alien:addr ,obj)))
 190             ,@body))))
 191   #+lispworks
 192   `(fli:with-dynamic-foreign-objects ((,var ,(convert-from-uffi-type
 193                                               (eval type) :allocate)))
 194     ,@body)
 195   )
 196
 197 #-mcl
 198 (defmacro with-foreign-objects (bindings &rest body)
 199   (if bindings
 200       `(with-foreign-object ,(car bindings)
 201         (with-foreign-objects ,(cdr bindings)
 202           ,@body))
 203       `(progn ,@body)))
 204
 205 #+mcl
 206 (defmacro with-foreign-objects (bindings &rest body)
 207   (let ((params nil) type count)
 208     (dolist (spec (reverse bindings)) ;keep order - macroexpands to let*
 209       (setf type (convert-from-uffi-type (eval (nth 1 spec)) :allocate))
 210       (setf count 1)
 211       (when (and (listp type) (eq (first type) :array))
 212         (setf count (nth 2 type))
 213         (unless (integerp count) (error "Invalid size for array: ~a" type))
 214         (setf type (nth 1 type)))
 215       (push (list (first spec) (* count (size-of-foreign-type type))) params))
 216     `(ccl:%stack-block ,params ,@body)))
 217
 218 #+mcl
 219 (defmacro with-foreign-object ((var type) &rest body)
 220   `(with-foreign-objects ((,var ,type))
 221      ,@body))
 222
 223 #+lispworks
 224 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 225   `(fli:with-coerced-pointer (,binding-name
 226                           :type ',(convert-from-uffi-type (eval type) :type))
 227       ,pointer
 228     ,@body))
 229
 230 #+(or cmu scl sbcl)
 231 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 232   `(let ((,binding-name
 233           (#+(or cmu scl) alien:cast
 234            #+sbcl sb-alien:cast
 235            ,pointer (* ,(convert-from-uffi-type (eval type) :type)))))
 236     ,@body))
 237
 238 #+(or allegro openmcl)
 239 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 240   (declare (ignore type))
 241   `(let ((,binding-name ,pointer))
 242     ,@body))
 243
 244 #-(or lispworks cmu scl sbcl allegro openmcl)
 245 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
 246   (declare (ignore binding-name pointer type body))
 247   '(error "WITH-CAST-POINTER not (yet) implemented for ~A"
 248           (lisp-implementation-type)))
 249
 250 (defmacro def-foreign-var (names type module)
 251   #-lispworks (declare (ignore module))
 252   (let ((foreign-name (if (atom names) names (first names)))
 253         (lisp-name (if (atom names) (make-lisp-name names) (second names)))
 254         #-allegro
 255         (var-type (convert-from-uffi-type type :type)))
 256     #+(or cmu scl)
 257     `(alien:def-alien-variable (,foreign-name ,lisp-name) ,var-type)
 258     #+sbcl
 259     `(sb-alien:define-alien-variable (,foreign-name ,lisp-name) ,var-type)
 260     #+allegro
 261     `(define-symbol-macro ,lisp-name
 262       (ff:fslot-value-typed (quote ,(convert-from-uffi-type type :deref))
 263                             :c (ff:get-entry-point ,foreign-name)))
 264     #+lispworks
 265     `(progn
 266       (fli:define-foreign-variable (,lisp-name ,foreign-name)
 267                                     :accessor :address-of
 268                                     :type ,var-type
 269                                     :module ,module)
 270       (define-symbol-macro ,lisp-name (fli:dereference (,lisp-name)
 271                                                         :copy-foreign-object nil)))
 272     #+(and openmcl darwinppc-target)
 273     (setf foreign-name (concatenate 'string "_" foreign-name))
 274     #+openmcl
 275     `(define-symbol-macro ,lisp-name
 276        (deref-pointer (ccl:foreign-symbol-address ,foreign-name) ,var-type))
 277     #-(or allegro cmu scl sbcl lispworks openmcl)
 278     `(define-symbol-macro ,lisp-name
 279       '(error "DEF-FOREIGN-VAR not (yet) defined for ~A"
 280         (lisp-implementation-type)))))