r5255: *** empty log message ***
[uffi.git] / 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: objects.lisp,v 1.15 2003/07/08 12:37:21 kevin Exp $
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 (defun size-of-foreign-type (type)
22   #+lispworks (fli:size-of type)
23   #+allegro (ff:sizeof-fobject type)
24   #+(or cmu scl)  (ash (eval `(alien:alien-size ,type)) -3) ;; convert from bits to bytes
25   #+sbcl  (ash (eval `(sb-alien:alien-size ,type)) -3) ;; convert from bits to bytes
26   #+clisp (values (ffi:size-of type))
27   #+(and mcl (not openmcl))
28   (let ((mcl-type (ccl:find-mactype type nil t)))
29     (if mcl-type 
30         (ccl::mactype-record-size mcl-type)
31       (ccl::record-descriptor-length (ccl:find-record-descriptor type t t)))) ;error if not a record
32   #+openmcl (ccl::%foreign-type-or-record-size type :bytes)
33   )
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 char-array-to-pointer (obj)
96   #+(or cmu scl) `(alien:cast ,obj (* (alien:unsigned 8)))
97   #+sbcl `(sb-alien:cast ,obj (* (sb-alien:unsigned 8)))
98   #+lispworks `(fli:make-pointer :type '(:unsigned :char)
99                                 :address (fli:pointer-address ,obj))
100   #+allegro obj
101   #+mcl obj
102   )
103
104 (defmacro deref-pointer (ptr type)
105   "Returns a object pointed"
106   #+(or cmu sbcl lispworks scl) (declare (ignore type))
107   #+(or cmu scl)  `(alien:deref ,ptr)
108   #+sbcl  `(sb-alien:deref ,ptr)
109   #+lispworks `(fli:dereference ,ptr)
110   #+allegro `(ff:fslot-value-typed (quote ,(convert-from-uffi-type type :deref)) :c ,ptr)
111   #+mcl `(ccl:pref ,ptr ,(convert-from-uffi-type type :deref))
112   )
113
114 #+mcl
115 (defmacro deref-pointer-set (ptr type value)
116   `(setf (ccl:pref ,ptr ,(convert-from-uffi-type type :deref)) ,value))
117
118 #+mcl
119 (defsetf deref-pointer deref-pointer-set)
120
121 #+(or lispworks (and mcl (not openmcl))) ;; with LW, deref is a character
122 (defmacro ensure-char-character (obj)
123   obj)
124
125 #+(or allegro cmu sbcl scl openmcl)
126 (defmacro ensure-char-character (obj)
127   `(code-char ,obj))
128   
129 #+(or lispworks (and mcl (not openmcl)))
130 (defmacro ensure-char-integer (obj)
131  `(char-code ,obj))
132
133 #+(or allegro cmu sbcl scl openmcl)
134 (defmacro ensure-char-integer (obj)
135   obj)
136
137 (defmacro pointer-address (obj)
138   #+(or cmu scl)
139   `(system:sap-int (alien:alien-sap ,obj))
140   #+sbcl
141   `(sb-sys:sap-int (sb-alien:alien-sap ,obj))
142   #+lispworks
143   `(fli:pointer-address ,obj)
144   #+allegro
145   obj
146   #+mcl
147   `(ccl:%ptr-to-int ,obj)  
148   )
149
150 ;; TYPE is evaluated.
151 #-mcl
152 (defmacro with-foreign-object ((var type) &rest body)
153   #-(or cmu sbcl lispworks scl) ; default version
154   `(let ((,var (allocate-foreign-object ,type)))
155     (unwind-protect
156          (progn ,@body)
157       (free-foreign-object ,var)))
158   #+(or cmu scl)
159   (let ((obj (gensym)))
160     `(alien:with-alien ((,obj ,(convert-from-uffi-type (eval type) :allocate)))
161        (let ((,var (alien:addr ,obj)))
162          ,@body)))
163   #+sbcl
164   (let ((obj (gensym)))
165     `(sb-alien:with-alien ((,obj ,(convert-from-uffi-type (eval type) :allocate)))
166        (let ((,var (sb-alien:addr ,obj)))
167          ,@body)))
168   #+lispworks
169   `(fli:with-dynamic-foreign-objects ((,var ,(convert-from-uffi-type
170                                               (eval type) :allocate)))
171     ,@body)
172   )
173
174 #-mcl
175 (defmacro with-foreign-objects (bindings &rest body)
176   (if bindings
177       `(with-foreign-object ,(car bindings)
178         (with-foreign-objects ,(cdr bindings)
179           ,@body))
180       `(progn ,@body)))
181
182 #+mcl
183 (defmacro with-foreign-objects (bindings &rest body)
184   (let ((params nil) type count)
185     (dolist (spec (reverse bindings)) ;keep order - macroexpands to let*
186       (setf type (convert-from-uffi-type (eval (nth 1 spec)) :allocate))
187       (setf count 1)
188       (when (and (listp type) (eq (first type) :array))
189         (setf count (nth 2 type))
190         (unless (integerp count) (error "Invalid size for array: ~a" type))
191         (setf type (nth 1 type)))
192       (push (list (first spec) (* count (size-of-foreign-type type))) params))
193     `(ccl:%stack-block ,params ,@body)))
194                                  
195 #+mcl
196 (defmacro with-foreign-object ((var type) &rest body)
197   `(with-foreign-objects ((,var ,type)) 
198      ,@body))
199