r2385: *** empty log message ***
[uffi.git] / src / primitives.cl
index c5c64502ce241ce64bf4b2b62fe58e7b4f476231..c10766416a0ee348599e604e66f4ea2b56abc0c2 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,74 +7,60 @@
 ;;;; Programmer:    Kevin M. Rosenberg
 ;;;; Date Started:  Feb 2002
 ;;;;
-;;;; Copyright (c) 2002 Kevin M. Rosenberg
+;;;; $Id: primitives.cl,v 1.22 2002/08/23 15:28:52 kevin Exp $
 ;;;;
-;;;; $Id: primitives.cl,v 1.1 2002/03/10 21:48:50 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 def-constant (name value)
+(defmacro def-constant (name value &key (export nil))
   "Macro to define a constant and to export it"
   `(eval-when (:compile-toplevel :load-toplevel :execute)
      (defconstant ,name ,value)
-     (export ',name)))
+     ,(when export (list 'export `(quote ,name)))
+    ',name))
 
-(defmacro uffi-declare (type name)
-  "Generates a declare statement for CL. Currently, only CMUCL
-supports this."
-  #+(or lispworks allegro)
-  (declare (ignore type name))
-  #+cmu
-  `(declare (type (alien ,type) ,name))
-  )
-
-(defmacro slot-type (type)
+(defmacro def-type (name type)
+  "Generates a (deftype) statement for CL. Currently, only CMUCL
+supports takes advantage of this optimization."
   #+(or lispworks allegro)
   (declare (ignore type))
   #+(or lispworks allegro)
-  t
-  #+cmu `'(alien:alien ,type))
+  `(deftype ,name () t)
+  #+cmu
+  `(deftype ,name () '(alien:alien ,(convert-from-uffi-type type :declare)))
+  #+sbcl
+  `(deftype ,name () '(sb-alien:alien ,(convert-from-uffi-type type :declare)))
+  )
 
 (defmacro null-char-p (val)
-  `(if (or (eql ,val 0)
-          (eq ,val #\Null))
-      t
-    nil))
-
+  "Returns T if character is NULL"
+  `(zerop ,val))
       
-(defmacro def-type (name type)
+(defmacro def-foreign-type (name type)
   #+lispworks `(fli:define-c-typedef ,name ,(convert-from-uffi-type type :type))
   #+allegro `(ff:def-foreign-type ,name ,(convert-from-uffi-type type :type))
   #+cmu `(alien:def-alien-type ,name ,(convert-from-uffi-type type :type))
+  #+sbcl `(sb-alien:def-alien-type ,name ,(convert-from-uffi-type type :type))
   )
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defvar +type-conversion-hash+ (make-hash-table :size 20))
-  #+cmu (defvar +cmu-def-type-hash+ (make-hash-table :size 20))
+  #+(or cmu sbcl) (defvar +cmu-def-type-hash+ (make-hash-table :size 20))
   )
 
 #+cmu
 (defconstant +cmu-def-type-list+
     '((:char . (alien:signed 8))
       (:unsigned-char . (alien:unsigned 8))
-      (:byte . (alien:unsigned 8))
+      (:byte . (alien:signed 8))
+      (:unsigned-byte . (alien:unsigned 8))
       (:short . (alien:signed 16))
       (:unsigned-short . (alien:unsigned 16))
       (:int . (alien:signed 32))
@@ -83,41 +69,86 @@ supports this."
       (:unsigned-long . (alien:unsigned 32))
       (:float . alien:single-float)
       (:double . alien:double-float)
-      ))
+      )
+  "Conversions in CMUCL for def-foreign-type are different than in def-function")
+#+sbcl
+(defconstant +cmu-def-type-list+
+    '((:char . (sb-alien:signed 8))
+      (:unsigned-char . (sb-alien:unsigned 8))
+      (:byte . (sb-alien:signed 8))
+      (:unsigned-byte . (sb-alien:unsigned 8))
+      (:short . (sb-alien:signed 16))
+      (:unsigned-short . (sb-alien:unsigned 16))
+      (:int . (sb-alien:signed 32))
+      (:unsigned-int . (sb-alien:unsigned 32))
+      (:long . (sb-alien:signed 32))
+      (:unsigned-long . (sb-alien:unsigned 32))
+      (:float . sb-alien:single-float)
+      (:double . sb-alien:double-float)
+      )
+  "Conversions in SBCL for def-foreign-type are different than in def-function")
+
+(defparameter +type-conversion-list+ nil)
 
 #+cmu
-(defconstant +type-conversion-list+
+(setq +type-conversion-list+
     '((* . *) (:void . c-call:void) 
       (:short . c-call:short)
       (:pointer-void . (* t))
-      (:cstring . c-call:cstring)
+      (:cstring . c-call:c-string)
       (:char . c-call:char) 
       (:unsigned-char . (alien:unsigned 8))
-      (:byte . (alien:unsigned 8))
+      (:byte . (alien:signed 8))
+      (:unsigned-byte . (alien:unsigned 8))
+      (:short . c-call:unsigned-short) 
+      (:unsigned-short . c-call:unsigned-short)
       (:int . alien:integer) (:unsigned-int . c-call:unsigned-int) 
       (:long . c-call:long) (:unsigned-long . c-call:unsigned-long)
       (:float . c-call:float) (:double . c-call:double)
       (:array . alien:array)))
+
+#+sbcl
+(setq +type-conversion-list+
+    '((* . *) (:void . void) 
+      (:short . short)
+      (:pointer-void . (* t))
+      (:cstring . c-string)
+      (:char . char) 
+      (:unsigned-char . (sb-alien:unsigned 8))
+      (:byte . (sb-alien:signed 8))
+      (:unsigned-byte . (sb-alien:unsigned 8))
+      (:short . unsigned-short) 
+      (:unsigned-short . unsigned-short)
+      (:int . integer) (:unsigned-int . unsigned-int) 
+      (:long . long) (:unsigned-long . unsigned-long)
+      (:float . float) (:double . double)
+      (:array . array)))
+
 #+allegro
-(defconstant +type-conversion-list+
+(setq +type-conversion-list+
     '((* . *) (:void . :void)
       (:short . :short)
       (:pointer-void . (* :void))
-      (:cstring . (* :char))
+      (:cstring . (* :unsigned-char))
+      (:byte . :char)
+      (:unsigned-byte . :unsigned-byte)
       (:char . :char)
       (:unsigned-char . :unsigned-char)
-      (:byte . :byte)
       (:int . :int) (:unsigned-int . :unsigned-int) 
       (:long . :long) (:unsigned-long . :unsigned-long)
       (:float . :float) (:double . :double)
       (:array . :array)))
 #+lispworks
-(defconstant +type-conversion-list+
+(setq +type-conversion-list+
     '((* . :pointer) (:void . :void) 
       (:short . :short)
       (:pointer-void . (:pointer :void))
-      (:cstring . (:pointer :char))
-      (:char . :char) 
+      (:cstring . (:reference-pass (:ef-mb-string :external-format :latin-1)
+                                  :allow-null t))
+      (:cstring-returning . (:reference (:ef-mb-string :external-format :latin-1) :allow-null t))
+      (:byte . :byte)
+      (:unsigned-byte . (:unsigned :byte))
+      (:char . :char)
       (:unsigned-char . (:unsigned :char))
       (:int . :int) (:unsigned-int . (:unsigned :int))
       (:long . :long) (:unsigned-long . (:unsigned :long))
@@ -127,12 +158,15 @@ supports this."
 (dolist (type +type-conversion-list+)
   (setf (gethash (car type) +type-conversion-hash+) (cdr type)))
 
-#+cmu
+#+(or cmu sbcl)
 (dolist (type +cmu-def-type-list+)
   (setf (gethash (car type) +cmu-def-type-hash+) (cdr type)))
 
-(defun ph (&optional (os *standard-output*))
-  (maphash #'(lambda (k v) (format os "~&~S => ~S" k v)) +type-conversion-hash+))
+(defun basic-convert-from-uffi-type (type)
+  (let ((found-type (gethash type +type-conversion-hash+)))
+    (if found-type
+       found-type
+       type)))
 
 (defun convert-from-uffi-type (type context)
   "Converts from a uffi type to an implementation specific type"
@@ -142,22 +176,20 @@ supports this."
        ((and (or (eq context :routine) (eq context :return))
             (eq type :cstring))
        (setq type '((* :char) integer)))
-       #+cmu 
+       #+(or cmu sbcl)
        ((eq context :type)
        (let ((cmu-type (gethash type +cmu-def-type-hash+)))
          (if cmu-type
              cmu-type
-           (let ((found-type (gethash type +type-conversion-hash+)))
-             (if found-type
-                 found-type
-               type)))))
+             (basic-convert-from-uffi-type type))))
+       #+lispworks
+       ((and (eq context :return)
+            (eq type :cstring))
+       (basic-convert-from-uffi-type :cstring-returning))
        (t
-       (let ((found-type (gethash type +type-conversion-hash+)))
-         (if found-type
-             found-type
-           type))))
-    (cons (convert-from-uffi-type (first type) context) 
-         (convert-from-uffi-type (rest type) context))))
+       (basic-convert-from-uffi-type type)))
+      (cons (convert-from-uffi-type (first type) context) 
+           (convert-from-uffi-type (rest type) context))))