1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: objects.lisp
6 ;;;; Purpose: UFFI source to handle objects and pointers
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Feb 2002
12 ;;;; This file, part of UFFI, is Copyright (c) 2002-2005 by Kevin M. Rosenberg
14 ;;;; *************************************************************************
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))
26 (let ((mcl-type (ccl:find-mactype type nil t)))
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)
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)
39 `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation))
41 `(sb-alien:make-alien ,(convert-from-uffi-type (eval type) :allocation))
43 `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate))
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)))
51 `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation) ,size)
53 `(sb-alien:make-alien ,(convert-from-uffi-type (eval type) :allocation) ,size)
55 `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate) :nelems ,size)
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))))
62 (defmacro free-foreign-object (obj)
64 `(alien:free-alien ,obj)
66 `(sb-alien:free-alien ,obj)
68 `(fli:free-foreign-object ,obj)
70 `(ff:free-fobject ,obj)
71 #+(or openmcl digitool)
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)
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)))
89 #+(or openmcl digitool) `(ccl:%null-ptr)
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)))
98 #+(or openmcl digitool) `(ccl:%int-to-ptr ,addr)
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))
108 #+(or openmcl digitool) obj
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))
122 (defmacro deref-pointer-set (ptr type value)
123 `(setf (ccl:pref ,ptr ,(convert-from-uffi-type type :deref)) ,value))
126 (defsetf deref-pointer deref-pointer-set)
128 (defmacro ensure-char-character (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)))
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
139 `(if (integerp ,obj) ,obj (char-code ,obj)))
141 (defmacro ensure-char-storable (obj)
142 #+(or digitool (and lispworks (not lispworks5))) obj
143 #+(or allegro cmu lispworks5 openmcl sbcl scl)
146 (defmacro pointer-address (obj)
148 `(system:sap-int (alien:alien-sap ,obj))
150 `(sb-sys:sap-int (sb-alien:alien-sap ,obj))
152 `(fli:pointer-address ,obj)
155 #+(or openmcl digitool)
156 `(ccl:%ptr-to-int ,obj)
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)))
166 (free-foreign-object ,var)))
169 (ctype (convert-from-uffi-type (eval type) :allocate)))
170 (if (and (consp ctype) (eq 'array (car ctype)))
171 `(alien:with-alien ((,obj ,ctype))
174 `(alien:with-alien ((,obj ,ctype))
175 (let* ((,var (alien:addr ,obj)))
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))
184 `(sb-alien:with-alien ((,obj ,ctype))
185 (let* ((,var (sb-alien:addr ,obj)))
188 `(fli:with-dynamic-foreign-objects ((,var ,(convert-from-uffi-type
189 (eval type) :allocate)))
193 #-(or openmcl digitool)
194 (defmacro with-foreign-objects (bindings &rest body)
196 `(with-foreign-object ,(car bindings)
197 (with-foreign-objects ,(cdr bindings)
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))
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)))
214 #+(or openmcl digitool)
215 (defmacro with-foreign-object ((var type) &rest body)
216 `(with-foreign-objects ((,var ,type))
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))
227 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
228 `(let ((,binding-name
229 (#+(or cmu scl) alien:cast
231 ,pointer (* ,(convert-from-uffi-type (eval type) :type)))))
234 #+(or allegro openmcl)
235 (defmacro with-cast-pointer ((binding-name pointer type) &body body)
236 (declare (ignore type))
237 `(let ((,binding-name ,pointer))
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)))
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)
252 (defmacro def-foreign-var (names type module)
253 #-lispworks (declare (ignore module))
254 (let ((foreign-name (if (atom names) names (first names)))
255 (lisp-name (if (atom names) (make-lisp-name names) (second names)))
257 (var-type (convert-from-uffi-type type :type)))
259 `(alien:def-alien-variable (,foreign-name ,lisp-name) ,var-type)
261 `(sb-alien:define-alien-variable (,foreign-name ,lisp-name) ,var-type)
263 `(define-symbol-macro ,lisp-name
264 (ff:fslot-value-typed (quote ,(convert-from-uffi-type type :deref))
265 :c (ff:get-entry-point ,(convert-external-name foreign-name))))
268 (fli:define-foreign-variable (,lisp-name ,foreign-name)
269 :accessor :address-of
272 (define-symbol-macro ,lisp-name (fli:dereference (,lisp-name)
273 :copy-foreign-object nil)))
275 `(define-symbol-macro ,lisp-name
276 (deref-pointer (ccl:foreign-symbol-address
277 ,(convert-external-name foreign-name)) ,var-type))
278 #-(or allegro cmu scl sbcl lispworks openmcl)
279 `(define-symbol-macro ,lisp-name
280 '(error "DEF-FOREIGN-VAR not (yet) defined for ~A"
281 (lisp-implementation-type)))))
284 ;;; Define a special variable, like DEFVAR, that will be initialized
285 ;;; to a pointer which may need to be reset when a saved image is
286 ;;; loaded. This is needed for OpenMCL, which sets pointers to "dead
287 ;;; macptrs" when a saved image is loaded.
288 ;; This may possibly be needed for sbcl's SAVE-LISP-AND-DIE
289 (defmacro def-pointer-var (name value &optional doc)
290 #-openmcl `(defvar ,name ,value ,@(if doc (list doc)))
291 #+openmcl `(ccl::defloadvar ,name ,value ,doc))