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) 2002 by Kevin M. Rosenberg
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 ;;;; *************************************************************************
21 (defmacro def-enum (enum-name args &key (separator-string "#"))
22 "Creates a constants for a C type enum list, symbols are created
23 in the created in the current package. The symbol is the concatenation
24 of the enum-name name, separator-string, and field-name"
28 (declare (fixnum counter))
30 (let ((name (if (listp arg) (car arg) arg))
31 (value (if (listp arg)
33 (setq counter (cadr arg))
38 (setq name (intern (concatenate 'string
39 (symbol-name enum-name)
42 (push `(uffi:def-constant ,name ,value) constants)))
43 (setf cmds (append '(progn)
44 #+allegro `((ff:def-foreign-type ,enum-name :int))
45 #+lispworks `((fli:define-c-typedef ,enum-name :int))
46 #+(or cmu scl) `((alien:def-alien-type ,enum-name alien:signed))
47 #+sbcl `((sb-alien:define-alien-type ,enum-name sb-alien:signed))
48 #+(and mcl (not openmcl)) `((def-mcl-type ,enum-name :integer))
49 #+openmcl `((ccl::def-foreign-type ,enum-name :int))
50 (nreverse constants)))
54 (defmacro def-array-pointer (name-array type)
56 `(ff:def-foreign-type ,name-array
57 (:array ,(convert-from-uffi-type type :array)))
59 `(fli:define-c-typedef ,name-array
60 (:c-array ,(convert-from-uffi-type type :array)))
62 `(alien:def-alien-type ,name-array
63 (* ,(convert-from-uffi-type type :array)))
65 `(sb-alien:define-alien-type ,name-array
66 (* ,(convert-from-uffi-type type :array)))
67 #+(and mcl (not openmcl))
68 `(def-mcl-type ,name-array '(:array ,type))
70 `(ccl::def-foreign-type ,name-array (:array ,(convert-from-uffi-type type :array)))
73 (defun process-struct-fields (name fields &optional (variant nil))
75 (dolist (field fields)
76 (let* ((field-name (car field))
78 (def (append (list field-name)
79 (if (eq type :pointer-self)
80 #+(or cmu scl) `((* (alien:struct ,name)))
81 #+sbcl `((* (sb-alien:struct ,name)))
82 #+mcl `((:* (:struct ,name)))
83 #+lispworks `((:pointer ,name))
84 #-(or cmu sbcl scl mcl lispworks) `((* ,name))
85 `(,(convert-from-uffi-type type :struct))))))
87 (push (list def) processed)
88 (push def processed))))
89 (nreverse processed)))
92 (defmacro def-struct (name &rest fields)
94 `(alien:def-alien-type ,name (alien:struct ,name ,@(process-struct-fields name fields)))
96 `(sb-alien:define-alien-type ,name (sb-alien:struct ,name ,@(process-struct-fields name fields)))
98 `(ff:def-foreign-type ,name (:struct ,@(process-struct-fields name fields)))
100 `(fli:define-c-struct ,name ,@(process-struct-fields name fields))
101 #+(and mcl (not openmcl))
102 `(ccl:defrecord ,name ,@(process-struct-fields name fields))
104 `(ccl::def-foreign-type
106 (:struct ,name ,@(process-struct-fields name fields)))
110 (defmacro get-slot-value (obj type slot)
111 #+(or lispworks cmu sbcl scl) (declare (ignore type))
113 `(ff:fslot-value-typed ,type :c ,obj ,slot)
115 `(fli:foreign-slot-value ,obj ,slot)
117 `(alien:slot ,obj ,slot)
119 `(sb-alien:slot ,obj ,slot)
121 `(ccl:pref ,obj ,(read-from-string (format nil ":~a.~a" (keyword type) (keyword slot))))
125 (defmacro set-slot-value (obj type slot value) ;use setf to set values
126 `(setf (ccl:pref ,obj ,(read-from-string (format nil ":~a.~a" (keyword type) (keyword slot)))) ,value))
129 (defsetf get-slot-value set-slot-value)
132 (defmacro get-slot-pointer (obj type slot)
133 #+(or lispworks cmu sbcl scl) (declare (ignore type))
135 `(ff:fslot-value-typed ,type :c ,obj ,slot)
137 `(fli:foreign-slot-pointer ,obj ,slot)
139 `(alien:slot ,obj ,slot)
141 `(sb-alien:slot ,obj ,slot)
142 #+(and mcl (not openmcl))
143 `(ccl:%int-to-ptr (+ (ccl:%ptr-to-int ,obj) (the fixnum (ccl:field-info ,type ,slot))))
145 `(let ((field (ccl::%find-foreign-record-type-field ,type ,slot)))
146 (ccl:%int-to-ptr (+ (ccl:%ptr-to-int ,obj) (the fixnum (ccl::foreign-record-field-offset field)))))
149 ; so we could allow '(:array :long) or deref with other type like :long only
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 scl) (declare (ignore type))
163 #+(or cmu scl) `(alien:deref (the (alien:alien ,(convert-from-uffi-type type :declare)) ,obj) ,i)
164 #+sbcl `(sb-alien:deref (the (sb-alien:alien ,(convert-from-uffi-type type :declare)) ,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)
176 #+(and mcl (not openmcl))
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
186 #+(and mcl (not openmcl))
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))
197 #+(and mcl (not openmcl))
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)))
209 #+(and mcl (not openmcl))
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)))