r2732: *** empty log message ***
[uffi.git] / src-main / objects.cl
diff --git a/src-main/objects.cl b/src-main/objects.cl
new file mode 100644 (file)
index 0000000..d9af1dc
--- /dev/null
@@ -0,0 +1,144 @@
+;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
+;;;; *************************************************************************
+;;;; FILE IDENTIFICATION
+;;;;
+;;;; Name:          objects.cl
+;;;; Purpose:       UFFI source to handle objects and pointers
+;;;; Programmer:    Kevin M. Rosenberg
+;;;; Date Started:  Feb 2002
+;;;;
+;;;; $Id: objects.cl,v 1.1 2002/09/16 17:54:30 kevin Exp $
+;;;;
+;;;; This file, part of UFFI, is Copyright (c) 2002 by Kevin M. Rosenberg
+;;;;
+;;;; 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 &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))
+      (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)
+      )
+  ))
+
+(defmacro free-foreign-object (obj)
+  #+cmu
+  `(alien:free-alien ,obj)
+  #+lispworks
+  `(fli:free-foreign-object ,obj)
+  #+allegro
+  `(ff:free-fobject ,obj)
+  )
+
+(defmacro null-pointer-p (obj)
+  #+lispworks `(fli:null-pointer-p ,obj)
+  #+allegro `(zerop ,obj)
+  #+cmu   `(alien:null-alien ,obj)
+  )
+
+(defmacro size-of-foreign-type (type)
+  #+lispworks `(fli:size-of ,type)
+  #+allegro `(ff:sizeof-fobject ,type)
+  #+cmu   `(alien:alien-size ,type)
+  #+clisp   `(values (ffi:size-of ,type))
+  )
+
+
+(defmacro make-null-pointer (type)
+  #+(or allegro cmu) (declare (ignore type))
+  
+  #+cmu `(system:int-sap 0)
+  #+allegro 0
+  #+lispworks `(fli:make-pointer :address 0 :type ,type)
+  )
+
+(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
+  )
+
+(defmacro deref-pointer (ptr type)
+  "Returns a object pointed"
+  #+(or cmu lispworks) (declare (ignore type))
+  #+cmu  `(alien:deref ,ptr)
+  #+lispworks `(fli:dereference ,ptr)
+  #+allegro `(ff:fslot-value-typed ,(convert-from-uffi-type type :deref) :c ,ptr)
+)
+
+#+lispworks ;; with LW, deref is a character
+(defmacro ensure-char-character (obj)
+  obj
+  )
+
+#+(or allegro cmu)
+(defmacro ensure-char-character (obj)
+  `(code-char ,obj)
+  )
+  
+#+lispworks
+(defmacro ensure-char-integer (obj)
+ `(char-code ,obj))
+
+#+(or allegro cmu)
+(defmacro ensure-char-integer (obj)
+  obj
+  ) ;; (* :char) dereference is already an integer
+
+(defmacro pointer-address (obj)
+  #+cmu
+  `(system:sap-int (alien:alien-sap ,obj))
+  #+lispworks
+  `(fli:pointer-address ,obj)
+  #+allegro
+  obj
+  )
+
+;; TYPE is evaluated.
+(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)
+  )
+
+
+(defmacro with-foreign-objects (bindings &rest body)
+  (if bindings
+      `(with-foreign-object ,(car bindings)
+       (with-foreign-objects ,(cdr bindings)
+         ,@body))
+      `(progn ,@body)))
+
+           
+