r2908: *** empty log message ***
[uffi.git] / src / objects.cl
index 6167636a7fb1c57a36f9893215788d0ddb73bdf4..0323da9232f24db7763a23abe3b398e0087c894b 100644 (file)
@@ -1,4 +1,4 @@
-;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
+;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
 ;;;; *************************************************************************
 ;;;; FILE IDENTIFICATION
 ;;;;
@@ -7,38 +7,57 @@
 ;;;; Programmer:    Kevin M. Rosenberg
 ;;;; Date Started:  Feb 2002
 ;;;;
-;;;; Copyright (c) 2002 Kevin M. Rosenberg
+;;;; $Id: objects.cl,v 1.26 2002/09/30 09:08:48 kevin Exp $
 ;;;;
-;;;; $Id: objects.cl,v 1.2 2002/03/10 00:11:47 kevin Exp $
+;;;; This file, part of UFFI, is Copyright (c) 2002 by Kevin M. Rosenberg
 ;;;;
-;;;; This file is part of the UFFI. 
-;;;;
-;;;; UFFI is free software; you can redistribute it and/or modify
-;;;; it under the terms of the GNU General Public License (version 2) as
-;;;; published by the Free Software Foundation.
-;;;;
-;;;; UFFI is distributed in the hope that it will be useful,
-;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;;;; GNU General Public License for more details.
-;;;;
-;;;; You should have received a copy of the GNU General Public License
-;;;; along with UFFI; if not, write to the Free Software
-;;;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+;;;; UFFI users are granted the rights to distribute and use this software
+;;;; as governed by the terms of the Lisp Lesser GNU Public License
+;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
 ;;;; *************************************************************************
 
 (declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
 (in-package :uffi)
 
-(defmacro allocate-foreign-object (type)
-  #+cmu
-  `(alien:make-alien ,(convert-from-uffi-type type :allocation))
-  #+lispworks
-  `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate))
-  #+allegro
-  `(ff:allocate-fobject ',(convert-from-uffi-type type :allocate) :c)
+(defun size-of-foreign-type (type)
+  #+lispworks (fli:size-of type)
+  #+allegro (ff:sizeof-fobject type)
+  #+cmu  (ash (eval `(alien:alien-size ,type)) -3) ;; convert from bits to bytes
+  #+clisp (values (ffi:size-of type))
+  #+(and mcl (not openmcl))
+  (let ((mcl-type (ccl:find-mactype type nil t)))
+    (if mcl-type 
+       (ccl::mactype-record-size mcl-type)
+      (ccl::record-descriptor-length (ccl:find-record-descriptor type t t)))) ;error if not a record
+  #+openmcl (ccl::%foreign-type-or-record-size type :bytes)
   )
 
+
+(defmacro allocate-foreign-object (type &optional (size :unspecified))
+  "Allocates an instance of TYPE. If size is specified, then allocate
+an array of TYPE with size SIZE. The TYPE parameter is evaluated."
+  (if (eq size :unspecified)
+      (progn
+       #+cmu
+       `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation))
+       #+lispworks
+       `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate))
+       #+allegro
+       `(ff:allocate-fobject ,(convert-from-uffi-type type :allocate) :c)
+       #+mcl
+       `(new-ptr ,(size-of-foreign-type (convert-from-uffi-type type :allocation)))
+       )
+      (progn
+       #+cmu
+       `(alien:make-alien ,(convert-from-uffi-type (eval type) :allocation) ,size)
+       #+lispworks
+       `(fli:allocate-foreign-object :type ',(convert-from-uffi-type type :allocate) :nelems ,size)
+       #+allegro
+       `(ff:allocate-fobject '(:array ,(convert-from-uffi-type (eval type) :allocate) ,(eval size)) :c)
+       #+mcl
+       `(new-ptr (* ,size ,(size-of-foreign-type (convert-from-uffi-type type :allocation))))
+       )))
+
 (defmacro free-foreign-object (obj)
   #+cmu
   `(alien:free-alien ,obj)
   `(fli:free-foreign-object ,obj)
   #+allegro
   `(ff:free-fobject ,obj)
+  #+mcl
+  `(dispose-ptr ,obj)
   )
 
 (defmacro null-pointer-p (obj)
   #+lispworks `(fli:null-pointer-p ,obj)
   #+allegro `(zerop ,obj)
   #+cmu   `(alien:null-alien ,obj)
+  #+mcl   `(ccl:%null-ptr-p ,obj)
   )
 
-(def-constant +null-c-string-pointer+
-    #+cmu nil
-    #+allegro 0
-    #+lispworks (fli:make-pointer :address 0 :type '(:unsigned :char)))
-
 (defmacro make-null-pointer (type)
-  #+(or allegro cmu) (declare (ignore type))
+  #+(or allegro cmu mcl) (declare (ignore type))
   
   #+cmu `(system:int-sap 0)
   #+allegro 0
-  #+lispworks `(fli:make-pointer :address 0 :type ',type)
+  #+lispworks `(fli:make-pointer :address 0 :type ,type)
+  #+mcl `(ccl:%null-ptr)
+  )
+
+(defmacro char-array-to-pointer (obj)
+  #+cmu `(alien:cast ,obj (* (alien:unsigned 8)))
+  #+lispworks `(fli:make-pointer :type '(:unsigned :char)
+                               :address (fli:pointer-address ,obj))
+  #+allegro obj
+  #+mcl obj
   )
 
 (defmacro deref-pointer (ptr type)
   "Returns a object pointed"
-  #+(or lispworks cmu) (declare (ignore type))
+  #+(or cmu lispworks) (declare (ignore type))
   #+cmu  `(alien:deref ,ptr)
   #+lispworks `(fli:dereference ,ptr)
-  #+allegro `(ff:fslot-value-typed ,type :c ,ptr)
+  #+allegro `(ff:fslot-value-typed ,(convert-from-uffi-type type :deref) :c ,ptr)
+  #+mcl `(ccl:pref ,ptr ,(convert-from-uffi-type type :deref))
   )
 
+#+mcl
+(defmacro deref-pointer-set (ptr type value)
+  `(setf (ccl:pref ,ptr ,(convert-from-uffi-type type :deref)) ,value))
+
+#+mcl
+(defsetf deref-pointer deref-pointer-set)
+
+#+(or lispworks (and mcl (not openmcl))) ;; with LW, deref is a character
+(defmacro ensure-char-character (obj)
+  obj)
+
+#+(or allegro cmu openmcl)
+(defmacro ensure-char-character (obj)
+  `(code-char ,obj))
+  
+#+(or lispworks (and mcl (not openmcl)))
+(defmacro ensure-char-integer (obj)
+ `(char-code ,obj))
+
+#+(or allegro cmu openmcl)
+(defmacro ensure-char-integer (obj)
+  obj)
+
 (defmacro pointer-address (obj)
   #+cmu
   `(system:sap-int (alien:alien-sap ,obj))
   `(fli:pointer-address ,obj)
   #+allegro
   obj
+  #+mcl
+  `(ccl:%ptr-to-int ,obj)  
+  )
+
+;; TYPE is evaluated.
+#-mcl
+(defmacro with-foreign-object ((var type) &rest body)
+  #-(or cmu lispworks) ; default version
+  `(let ((,var (allocate-foreign-object ,type)))
+    (unwind-protect
+        (progn ,@body)
+      (free-foreign-object ,var)))
+  #+cmu
+  (let ((obj (gensym)))
+    `(alien:with-alien ((,obj ,(convert-from-uffi-type (eval type) :allocate)))
+       (let ((,var (alien:addr ,obj)))
+        ,@body)))
+  #+lispworks
+  `(fli:with-dynamic-foreign-objects ((,var ,(convert-from-uffi-type
+                                             (eval type) :allocate)))
+    ,@body)
   )
+
+#-mcl
+(defmacro with-foreign-objects (bindings &rest body)
+  (if bindings
+      `(with-foreign-object ,(car bindings)
+       (with-foreign-objects ,(cdr bindings)
+         ,@body))
+      `(progn ,@body)))
+
+#+mcl
+(defmacro with-foreign-objects (bindings &rest body)
+  (let ((params nil) type count)
+    (dolist (spec (reverse bindings)) ;keep order - macroexpands to let*
+      (setf type (convert-from-uffi-type (eval (nth 1 spec)) :allocate))
+      (setf count 1)
+      (when (and (listp type) (eq (first type) :array))
+        (setf count (nth 2 type))
+        (unless (integerp count) (error "Invalid size for array: ~a" type))
+        (setf type (nth 1 type)))
+      (push (list (first spec) (* count (size-of-foreign-type type))) params))
+    `(ccl:%stack-block ,params ,@body)))
+                                
+#+mcl
+(defmacro with-foreign-object ((var type) &rest body)
+  `(with-foreign-objects ((,var ,type)) 
+     ,@body))
+