Remove old CVS $Id$ keyword
[uffi.git] / src / primitives.lisp
index 6147753d8847a874b1afe7238d6b2666d199ad37..66a0a7c7e845ecf7fb5f6993d4c25c1c83ab58f3 100644 (file)
@@ -2,31 +2,25 @@
 ;;;; *************************************************************************
 ;;;; FILE IDENTIFICATION
 ;;;;
-;;;; Name:          primitives.cl
+;;;; Name:          primitives.lisp
 ;;;; Purpose:       UFFI source to handle immediate types
 ;;;; Programmer:    Kevin M. Rosenberg
 ;;;; Date Started:  Feb 2002
 ;;;;
-;;;; $Id: primitives.lisp,v 1.2 2002/10/01 17:05:29 kevin Exp $
+;;;; This file, part of UFFI, is Copyright (c) 2002-2010 by Kevin M. Rosenberg
 ;;;;
-;;;; 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)
+(in-package #:uffi)
 
-#+mcl
+#+(or openmcl digitool)
 (defvar *keyword-package* (find-package "KEYWORD"))
 
-#+mcl
+#+(or openmcl digitool)
 ; MCL and OpenMCL expect a lot of FFI elements to be keywords (e.g. struct field names in OpenMCL)
 ; So this provides a function to convert any quoted symbols to keywords.
 (defun keyword (obj)
-  (cond ((keywordp obj) 
+  (cond ((keywordp obj)
          obj)
         ((null obj)
          nil)
          (keyword (cadr obj)))
         ((stringp obj)
          (intern obj *keyword-package*))
-        (t 
+        (t
          obj)))
 
 ; Wrapper for unexported function we have to use
-#+(and mcl (not openmcl))
+#+digitool
 (defmacro def-mcl-type (name type)
   `(ccl::def-mactype ,(keyword name) (ccl:find-mactype ,type)))
 
@@ -54,9 +48,9 @@
 (defmacro def-type (name type)
   "Generates a (deftype) statement for CL. Currently, only CMUCL
 supports takes advantage of this optimization."
-  #+(or lispworks allegro mcl cormanlisp)  (declare (ignore type))
-  #+(or lispworks allegro mcl cormanlisp) `(deftype ,name () t)
-  #+cmu
+  #+(or lispworks allegro openmcl digitool cormanlisp)  (declare (ignore type))
+  #+(or lispworks allegro openmcl digitool cormanlisp) `(deftype ,name () t)
+  #+(or cmu scl)
   `(deftype ,name () '(alien:alien ,(convert-from-uffi-type type :declare)))
   #+sbcl
   `(deftype ,name () '(sb-alien:alien ,(convert-from-uffi-type type :declare)))
@@ -65,30 +59,31 @@ supports takes advantage of this optimization."
 (defmacro null-char-p (val)
   "Returns T if character is NULL"
   `(zerop ,val))
-      
+
 (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))
+  #+(or cmu scl) `(alien:def-alien-type ,name ,(convert-from-uffi-type type :type))
+  #+sbcl `(sb-alien:define-alien-type ,name ,(convert-from-uffi-type type :type))
   #+cormanlisp `(ct:defctype ,name ,(convert-from-uffi-type type :type))
-  #+mcl
+  #+(or openmcl digitool)
   (let ((mcl-type (convert-from-uffi-type type :type)))
     (unless (or (keywordp mcl-type) (consp mcl-type))
       (setf mcl-type `(quote ,mcl-type)))
-    #+(and mcl (not openmcl))
+    #+digitool
     `(def-mcl-type ,(keyword name) ,mcl-type)
     #+openmcl
-    `(ccl::def-foreign-type ,(keyword name) ,mcl-type))  
+    `(ccl::def-foreign-type ,(keyword name) ,mcl-type))
   )
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
-  (defvar +type-conversion-hash+ (make-hash-table :size 20))
-  #+(or cmu sbcl) (defvar +cmu-def-type-hash+ (make-hash-table :size 20))
+  (defvar +type-conversion-hash+ (make-hash-table :size 20 :test #'eq))
+  #+(or cmu sbcl scl) (defvar *cmu-def-type-hash*
+                        (make-hash-table :size 20 :test #'eq))
   )
 
-#+cmu
-(defconstant +cmu-def-type-list+
+#+(or cmu scl)
+(defvar *cmu-sbcl-def-type-list*
     '((:char . (alien:signed 8))
       (:unsigned-char . (alien:unsigned 8))
       (:byte . (alien:signed 8))
@@ -97,14 +92,20 @@ supports takes advantage of this optimization."
       (:unsigned-short . (alien:unsigned 16))
       (:int . (alien:signed 32))
       (:unsigned-int . (alien:unsigned 32))
-      (:long . (alien:signed 32))
-      (:unsigned-long . (alien:unsigned 32))
+      #-x86-64 (:long . (alien:signed 32))
+      #-x86-64 (:unsigned-long . (alien:unsigned 32))
+      #+x86-64 (:long . (alien:signed 64))
+      #+x86-64 (:unsigned-long . (alien:unsigned 64))
+      (:long-long (alien:signed 64))
+      (:unsigned-long-long (alien:unsigned 64))
       (:float . alien:single-float)
       (:double . alien:double-float)
+      (:void . t)
       )
   "Conversions in CMUCL for def-foreign-type are different than in def-function")
+
 #+sbcl
-(defconstant +cmu-def-type-list+
+(defvar *cmu-sbcl-def-type-list*
     '((:char . (sb-alien:signed 8))
       (:unsigned-char . (sb-alien:unsigned 8))
       (:byte . (sb-alien:signed 8))
@@ -113,83 +114,102 @@ supports takes advantage of this optimization."
       (: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))
+      #-x86-64 (:long . (sb-alien:signed 32))
+      #-x86-64 (:unsigned-long . (sb-alien:unsigned 32))
+      #+x86-64 (:long . (sb-alien:signed 64))
+      #+x86-64 (:unsigned-long . (sb-alien:unsigned 64))
+      (:long-long (sb-alien:signed 64))
+      (:unsigned-long-long (sb-alien:unsigned 64))
       (:float . sb-alien:single-float)
       (:double . sb-alien:double-float)
+      (:void . t)
       )
   "Conversions in SBCL for def-foreign-type are different than in def-function")
 
-(defparameter +type-conversion-list+ nil)
+(defvar *type-conversion-list* nil)
 
-#+cmu
-(setq +type-conversion-list+
-    '((* . *) (:void . c-call:void) 
-      (:short . c-call:short)
+#+(or cmu scl)
+(setq *type-conversion-list*
+    '((* . *) (:void . c-call:void)
       (:pointer-void . (* t))
       (:cstring . c-call:c-string)
-      (:char . c-call:char) 
+      (:char . c-call:char)
       (:unsigned-char . (alien:unsigned 8))
       (:byte . (alien:signed 8))
       (:unsigned-byte . (alien:unsigned 8))
-      (:short . c-call:unsigned-short) 
+      (:short . c-call:short)
       (:unsigned-short . c-call:unsigned-short)
-      (:int . alien:integer) (:unsigned-int . c-call:unsigned-int) 
+      (:int . alien:integer) (:unsigned-int . c-call:unsigned-int)
       (:long . c-call:long) (:unsigned-long . c-call:unsigned-long)
+      (:long-long . c-call:long-long)
+      (:unsigned-long-long . c-call:unsigned-long-long)
       (:float . c-call:float) (:double . c-call:double)
       (:array . alien:array)))
 
 #+sbcl
-(setq +type-conversion-list+
-    '((* . *) (:void . void) 
-      (:short . short)
+(setq *type-conversion-list*
+    '((* . *) (:void . sb-alien:void)
       (:pointer-void . (* t))
-      (:cstring . c-string)
-      (:char . char) 
+      #-sb-unicode(:cstring . sb-alien:c-string)
+      #+sb-unicode(:cstring . sb-alien:utf8-string)
+      (:char . sb-alien: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)))
+      (:short . sb-alien:short)
+      (:unsigned-short . sb-alien:unsigned-short)
+      (:int . sb-alien:int) (:unsigned-int . sb-alien:unsigned-int)
+      (:long . sb-alien:long) (:unsigned-long . sb-alien:unsigned-long)
+      (:long-long . sb-alien:long-long)
+      (:unsigned-long-long . sb-alien:unsigned-long-long)
+      (:float . sb-alien:float) (:double . sb-alien:double)
+      (:array . sb-alien:array)))
 
 #+(or allegro cormanlisp)
-(setq +type-conversion-list+
+(setq *type-conversion-list*
     '((* . *) (:void . :void)
       (:short . :short)
       (:pointer-void . (* :void))
       (:cstring . (* :unsigned-char))
       (:byte . :char)
-      (:unsigned-byte . :unsigned-byte)
+      (:unsigned-byte . :unsigned-char)
       (:char . :char)
       (:unsigned-char . :unsigned-char)
-      (:int . :int) (:unsigned-int . :unsigned-int) 
+      (:int . :int) (:unsigned-int . :unsigned-int)
       (:long . :long) (:unsigned-long . :unsigned-long)
       (:float . :float) (:double . :double)
       (:array . :array)))
 
+#+(or allegro cormanlisp)
+(push 'uffi:no-long-long cl:*features*)
+
 #+lispworks
-(setq +type-conversion-list+
-    '((* . :pointer) (:void . :void) 
+(setq *type-conversion-list*
+    '((* . :pointer) (:void . :void)
       (:short . :short)
       (:pointer-void . (:pointer :void))
-      (: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))
+      (:cstring . (:reference-pass (:ef-mb-string :external-format
+                                    (:latin-1 :eol-style :lf))
+                   :allow-null t))
+      (:cstring-returning . (:reference (:ef-mb-string :external-format
+                                         (:latin-1 :eol-style :lf))
+                             :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))
+      #+lispworks6 (:long-long . :int64)
+      #+lispworks6 (:unsigned-long-long . :uint64)
       (:float . :float) (:double . :double)
       (:array . :c-array)))
 
-#+(and mcl (not openmcl))
-(setq +type-conversion-list+
+#+(and lispworks (not lispworks6))
+(push 'uffi:no-long-long cl:*features*)
+
+#+digitool
+(setq *type-conversion-list*
      '((* . :pointer) (:void . :void)
        (:short . :short) (:unsigned-short . :unsigned-short)
        (:pointer-void . :pointer)
@@ -201,9 +221,11 @@ supports takes advantage of this optimization."
        (:long . :long) (:unsigned-long . :unsigned-long)
        (:float . :single-float) (:double . :double-float)
        (:array . :array)))
+#+digitool
+(push 'uffi:no-long-long cl:*features*)
 
 #+openmcl
-(setq +type-conversion-list+
+(setq *type-conversion-list*
      '((* . :address) (:void . :void)
        (:short . :short) (:unsigned-short . :unsigned-short)
        (:pointer-void . :address)
@@ -217,19 +239,19 @@ supports takes advantage of this optimization."
        (:float . :single-float) (:double . :double-float)
        (:array . :array)))
 
-(dolist (type +type-conversion-list+)
+(dolist (type *type-conversion-list*)
   (setf (gethash (car type) +type-conversion-hash+) (cdr type)))
 
-#+(or cmu sbcl)
-(dolist (type +cmu-def-type-list+)
-  (setf (gethash (car type) +cmu-def-type-hash+) (cdr type)))
+#+(or cmu sbcl scl)
+(dolist (type *cmu-sbcl-def-type-list*)
+  (setf (gethash (car type) *cmu-def-type-hash*) (cdr type)))
 
 (defun basic-convert-from-uffi-type (type)
   (let ((found-type (gethash type +type-conversion-hash+)))
     (if found-type
-       found-type
-      #-mcl type
-      #+mcl (keyword type))))
+        found-type
+      #-(or openmcl digitool) type
+      #+(or openmcl digitool) (keyword type))))
 
 (defun %convert-from-uffi-type (type context)
   "Converts from a uffi type to an implementation specific type"
@@ -237,37 +259,41 @@ supports takes advantage of this optimization."
       (cond
        #+(or allegro cormanlisp)
        ((and (or (eq context :routine) (eq context :return))
-            (eq type :cstring))
-       (setq type '((* :char) integer)))
-       #+(or cmu sbcl)
+             (eq type :cstring))
+        (setq type '((* :char) integer)))
+       #+(or cmu sbcl scl)
        ((eq context :type)
-       (let ((cmu-type (gethash type +cmu-def-type-hash+)))
-         (if cmu-type
-             cmu-type
-             (basic-convert-from-uffi-type type))))
+        (let ((cmu-type (gethash type *cmu-def-type-hash*)))
+          (if cmu-type
+              cmu-type
+              (basic-convert-from-uffi-type type))))
        #+lispworks
        ((and (eq context :return)
-            (eq type :cstring))
-       (basic-convert-from-uffi-type :cstring-returning))
-       #+(and mcl (not openmcl))
+             (eq type :cstring))
+        (basic-convert-from-uffi-type :cstring-returning))
+       #+digitool
        ((and (eq type :void) (eq context :return)) nil)
        (t
-       (basic-convert-from-uffi-type type)))
+        (basic-convert-from-uffi-type type)))
     (let ((sub-type (car type)))
       (case sub-type
-       (cl:quote
-        (convert-from-uffi-type (cadr type) context))
-       (:struct-pointer
-        #+mcl `(:* (:struct ,(%convert-from-uffi-type (cadr type) :struct)))
-        #-mcl (%convert-from-uffi-type (list '* (cadr type)) :struct)
-        )
-       (:struct
-        #+mcl `(:struct ,(%convert-from-uffi-type (cadr type) :struct))
-        #-mcl (%convert-from-uffi-type (cadr type) :struct)
-        )
-       (t
-        (cons (%convert-from-uffi-type (first type) context) 
-              (%convert-from-uffi-type (rest type) context)))))))
+        (cl:quote
+         (convert-from-uffi-type (cadr type) context))
+        (:struct-pointer
+         #+(or openmcl digitool) `(:* (:struct ,(%convert-from-uffi-type (cadr type) :struct)))
+         #-(or openmcl digitool) (%convert-from-uffi-type (list '* (cadr type)) :struct)
+         )
+        (:struct
+         #+(or openmcl digitool) `(:struct ,(%convert-from-uffi-type (cadr type) :struct))
+         #-(or openmcl digitool) (%convert-from-uffi-type (cadr type) :struct)
+         )
+       (:union
+        #+(or openmcl digitool) `(:union ,(%convert-from-uffi-type (cadr type) :union))
+        #-(or openmcl digitool) (%convert-from-uffi-type (cadr type) :union)
+        )
+       (t
+        (cons (%convert-from-uffi-type (first type) context)
+              (%convert-from-uffi-type (rest type) context)))))))
 
 (defun convert-from-uffi-type (type context)
   (let ((result (%convert-from-uffi-type type context)))
@@ -276,9 +302,26 @@ supports takes advantage of this optimization."
      #+openmcl
      ((eq (car result) :address)
       (if (eq context :struct)
-         (append '(:*) (cdr result))
-       :address))
-     #+(and mcl (not openmcl))
+          (append '(:*) (cdr result))
+        :address))
+     #+digitool
      ((and (eq (car result) :pointer) (eq context :allocation) :pointer))
      (t result))))
 
+(eval-when (:compile-toplevel :load-toplevel :execute)
+  (when (char= #\a (schar (symbol-name '#:a) 0))
+    (pushnew :uffi-lowercase-reader *features*))
+  (when (not (string= (symbol-name '#:a)
+                      (symbol-name '#:A)))
+    (pushnew :uffi-case-sensitive *features*)))
+
+(defun make-lisp-name (name)
+  (let ((converted (substitute #\- #\_ name)))
+     (intern
+      #+uffi-case-sensitive converted
+      #+(and (not uffi-lowercase-reader) (not uffi-case-sensitive)) (string-upcase converted)
+      #+(and uffi-lowercase-reader (not uffi-case-sensitive)) (string-downcase converted))))
+
+(eval-when (:compile-toplevel :load-toplevel :execute)
+  (setq cl:*features* (delete :uffi-lowercase-reader *features*))
+  (setq cl:*features* (delete :uffi-case-sensitive *features*)))