1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: aggregates.lisp
6 ;;;; Purpose: UFFI source to handle aggregate types
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Feb 2002
12 ;;;; This file, part of UFFI, is Copyright (c) 2005 by Kevin M. Rosenberg
14 ;;;; *************************************************************************
18 (defmacro def-enum (enum-name args &key (separator-string "#"))
19 "Creates a constants for a C type enum list, symbols are created
20 in the created in the current package. The symbol is the concatenation
21 of the enum-name name, separator-string, and field-name"
25 (declare (fixnum counter))
27 (let ((name (if (listp arg) (car arg) arg))
28 (value (if (listp arg)
30 (setq counter (cadr arg))
35 (setq name (intern (concatenate 'string
36 (symbol-name enum-name)
39 (push `(uffi:def-constant ,name ,value) constants)))
40 (setf cmds (append '(progn)
41 #+allegro `((ff:def-foreign-type ,enum-name :int))
42 #+lispworks `((fli:define-c-typedef ,enum-name :int))
43 #+(or cmu scl) `((alien:def-alien-type ,enum-name alien:signed))
44 #+sbcl `((sb-alien:define-alien-type ,enum-name sb-alien:signed))
45 #+digitool `((def-mcl-type ,enum-name :integer))
46 #+openmcl `((ccl::def-foreign-type ,enum-name :int))
47 (nreverse constants)))
51 (defmacro def-array-pointer (name-array type)
53 `(ff:def-foreign-type ,name-array
54 (:array ,(convert-from-uffi-type type :array)))
56 `(fli:define-c-typedef ,name-array
57 (:c-array ,(convert-from-uffi-type type :array)))
59 `(alien:def-alien-type ,name-array
60 (* ,(convert-from-uffi-type type :array)))
62 `(sb-alien:define-alien-type ,name-array
63 (* ,(convert-from-uffi-type type :array)))
65 `(def-mcl-type ,name-array '(:array ,type))
67 `(ccl::def-foreign-type ,name-array (:array ,(convert-from-uffi-type type :array)))
70 (defun process-struct-fields (name fields &optional (variant nil))
72 (dolist (field fields)
73 (let* ((field-name (car field))
75 (def (append (list field-name)
76 (if (eq type :pointer-self)
77 #+(or cmu scl) `((* (alien:struct ,name)))
78 #+sbcl `((* (sb-alien:struct ,name)))
79 #+(or openmcl digitool) `((:* (:struct ,name)))
80 #+lispworks `((:pointer ,name))
81 #-(or cmu sbcl scl openmcl digitool lispworks) `((* ,name))
82 `(,(convert-from-uffi-type type :struct))))))
84 (push (list def) processed)
85 (push def processed))))
86 (nreverse processed)))
89 (defmacro def-struct (name &rest fields)
91 `(alien:def-alien-type ,name (alien:struct ,name ,@(process-struct-fields name fields)))
93 `(sb-alien:define-alien-type ,name (sb-alien:struct ,name ,@(process-struct-fields name fields)))
95 `(ff:def-foreign-type ,name (:struct ,@(process-struct-fields name fields)))
97 `(fli:define-c-struct ,name ,@(process-struct-fields name fields))
99 `(ccl:defrecord ,name ,@(process-struct-fields name fields))
101 `(ccl::def-foreign-type
103 (:struct ,name ,@(process-struct-fields name fields)))
107 (defmacro get-slot-value (obj type slot)
108 #+(or lispworks cmu sbcl scl) (declare (ignore type))
110 `(ff:fslot-value-typed ,type :c ,obj ,slot)
112 `(fli:foreign-slot-value ,obj ,slot)
114 `(alien:slot ,obj ,slot)
116 `(sb-alien:slot ,obj ,slot)
117 #+(or openmcl digitool)
118 `(ccl:pref ,obj ,(read-from-string (format nil ":~a.~a" (keyword type) (keyword slot))))
121 #+(or openmcl digitool)
122 (defmacro set-slot-value (obj type slot value) ;use setf to set values
123 `(setf (ccl:pref ,obj ,(read-from-string (format nil ":~a.~a" (keyword type) (keyword slot)))) ,value))
125 #+(or openmcl digitool)
126 (defsetf get-slot-value set-slot-value)
129 (defmacro get-slot-pointer (obj type slot)
130 #+(or lispworks cmu sbcl scl) (declare (ignore type))
132 `(ff:fslot-value-typed ,type :c ,obj ,slot)
134 `(fli:foreign-slot-pointer ,obj ,slot)
136 `(alien:slot ,obj ,slot)
138 `(sb-alien:slot ,obj ,slot)
140 `(ccl:%int-to-ptr (+ (ccl:%ptr-to-int ,obj) (the fixnum (ccl:field-info ,type ,slot))))
142 `(let ((field (ccl::%find-foreign-record-type-field ,type ,slot)))
143 (ccl:%int-to-ptr (+ (ccl:%ptr-to-int ,obj) (the fixnum (ccl::foreign-record-field-offset field)))))
146 ;; necessary to eval at compile time for openmcl to compile convert-from-foreign-usb8
148 (eval-when (:compile-toplevel :load-toplevel :execute)
149 ;; so we could allow '(:array :long) or deref with other type like :long only
150 #+(or openmcl digitool)
151 (defun array-type (type)
154 (let ((type-list (if (eq (car type) 'quote) (nth 1 type) type)))
155 (when (and (listp type-list) (eq (car type-list) :array))
156 (setf result (cadr type-list)))))
160 (defmacro deref-array (obj type i)
161 "Returns a field from a row"
162 #+(or lispworks cmu sbcl scl) (declare (ignore type))
163 #+(or cmu scl) `(alien:deref ,obj ,i)
164 #+sbcl `(sb-alien:deref ,obj ,i)
165 #+lispworks `(fli:dereference ,obj :index ,i :copy-foreign-object nil)
166 #+allegro `(ff:fslot-value-typed (quote ,(convert-from-uffi-type type :type)) :c ,obj ,i)
168 (let* ((array-type (array-type type))
169 (local-type (convert-from-uffi-type array-type :allocation))
170 (element-size-in-bits (ccl::%foreign-type-or-record-size local-type :bits)))
171 (ccl::%foreign-access-form
173 (ccl::%foreign-type-or-record local-type)
174 `(* ,i ,element-size-in-bits)
177 (let* ((array-type (array-type type))
178 (local-type (convert-from-uffi-type array-type :allocation))
179 (accessor (first (macroexpand `(ccl:pref obj ,local-type)))))
182 (* (the fixnum ,i) ,(size-of-foreign-type local-type))))
185 ; this expands to the %set-xx functions which has different params than %put-xx
187 (defmacro deref-array-set (obj type i value)
188 (let* ((array-type (array-type type))
189 (local-type (convert-from-uffi-type array-type :allocation))
190 (accessor (first (macroexpand `(ccl:pref obj ,local-type))))
191 (settor (first (macroexpand `(setf (,accessor obj ,local-type) value)))))
194 (* (the fixnum ,i) ,(size-of-foreign-type local-type))
198 (defsetf deref-array deref-array-set)
200 (defmacro def-union (name &rest fields)
202 `(ff:def-foreign-type ,name (:union ,@(process-struct-fields name fields)))
204 `(fli:define-c-union ,name ,@(process-struct-fields name fields))
206 `(alien:def-alien-type ,name (alien:union ,name ,@(process-struct-fields name fields)))
208 `(sb-alien:define-alien-type ,name (sb-alien:union ,name ,@(process-struct-fields name fields)))
210 `(ccl:defrecord ,name (:variant ,@(process-struct-fields name fields t)))
212 `(ccl::def-foreign-type nil
213 (:union ,name ,@(process-struct-fields name fields)))
218 (defun convert-from-foreign-usb8 (s len)
219 (declare (optimize (speed 3) (space 0) (safety 0) (compilation-speed 0))
221 (let ((a (make-array len :element-type '(unsigned-byte 8))))
224 (setf (aref a i) (uffi:deref-array s '(:array :unsigned-byte) i)))))
227 (eval-when (:compile-toplevel :load-toplevel :execute)
228 (sb-ext:without-package-locks
229 (defvar *system-copy-fn* (if (fboundp (intern "COPY-FROM-SYSTEM-AREA" "SB-KERNEL"))
230 (intern "COPY-FROM-SYSTEM-AREA" "SB-KERNEL")
231 (intern "COPY-UB8-FROM-SYSTEM-AREA" "SB-KERNEL")))
232 (defconstant +system-copy-offset+ (if (fboundp (intern "COPY-FROM-SYSTEM-AREA" "SB-KERNEL"))
233 (* sb-vm:vector-data-offset sb-vm:n-word-bits)
235 (defconstant +system-copy-multiplier+ (if (fboundp (intern "COPY-FROM-SYSTEM-AREA" "SB-KERNEL"))
241 (defun convert-from-foreign-usb8 (s len)
242 (let ((sap (sb-alien:alien-sap s)))
243 (declare (type sb-sys:system-area-pointer sap))
245 (declare (optimize (speed 3) (safety 0)))
246 (let ((result (make-array len :element-type '(unsigned-byte 8))))
247 (funcall *system-copy-fn* sap 0 result +system-copy-offset+
248 (* len +system-copy-multiplier+))
252 (defun convert-from-foreign-usb8 (s len)
253 (let ((sap (alien:alien-sap s)))
254 (declare (type system:system-area-pointer sap))
256 (declare (optimize (speed 3) (safety 0)))
257 (let ((result (make-array len :element-type '(unsigned-byte 8))))
258 (kernel:copy-from-system-area sap 0
259 result (* vm:vector-data-offset
261 (* len vm:byte-bits))