src/primitives.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          primitives.lisp
   6 ;;;; Purpose:       UFFI source to handle immediate types
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Feb 2002
   9 ;;;;
  10 ;;;; This file, part of UFFI, is Copyright (c) 2002-2010 by Kevin M. Rosenberg
  11 ;;;;
  12 ;;;; *************************************************************************
  13
  14 (in-package #:uffi)
  15
  16 #+(or openmcl digitool)
  17 (defvar *keyword-package* (find-package "KEYWORD"))
  18
  19 #+(or openmcl digitool)
  20 ; MCL and OpenMCL expect a lot of FFI elements to be keywords (e.g. struct field names in OpenMCL)
  21 ; So this provides a function to convert any quoted symbols to keywords.
  22 (defun keyword (obj)
  23   (cond ((keywordp obj)
  24          obj)
  25         ((null obj)
  26          nil)
  27         ((symbolp obj)
  28          (intern (symbol-name obj) *keyword-package*))
  29         ((and (listp obj) (eq (car obj) 'cl:quote))
  30          (keyword (cadr obj)))
  31         ((stringp obj)
  32          (intern obj *keyword-package*))
  33         (t
  34          obj)))
  35
  36 ; Wrapper for unexported function we have to use
  37 #+digitool
  38 (defmacro def-mcl-type (name type)
  39   `(ccl::def-mactype ,(keyword name) (ccl:find-mactype ,type)))
  40
  41 (defmacro def-constant (name value &key (export nil))
  42   "Macro to define a constant and to export it"
  43   `(eval-when (:compile-toplevel :load-toplevel :execute)
  44      (defconstant ,name ,value)
  45      ,(when export (list 'export `(quote ,name)))
  46     ',name))
  47
  48 (defmacro def-type (name type)
  49   "Generates a (deftype) statement for CL. Currently, only CMUCL
  50 supports takes advantage of this optimization."
  51   #+(or lispworks allegro openmcl digitool cormanlisp)  (declare (ignore type))
  52   #+(or lispworks allegro openmcl digitool cormanlisp) `(deftype ,name () t)
  53   #+(or cmu scl)
  54   `(deftype ,name () '(alien:alien ,(convert-from-uffi-type type :declare)))
  55   #+sbcl
  56   `(deftype ,name () '(sb-alien:alien ,(convert-from-uffi-type type :declare)))
  57   )
  58
  59 (defmacro null-char-p (val)
  60   "Returns T if character is NULL"
  61   `(zerop ,val))
  62
  63 (defmacro def-foreign-type (name type)
  64   #+lispworks `(fli:define-c-typedef ,name ,(convert-from-uffi-type type :type))
  65   #+allegro `(ff:def-foreign-type ,name ,(convert-from-uffi-type type :type))
  66   #+(or cmu scl) `(alien:def-alien-type ,name ,(convert-from-uffi-type type :type))
  67   #+sbcl `(sb-alien:define-alien-type ,name ,(convert-from-uffi-type type :type))
  68   #+cormanlisp `(ct:defctype ,name ,(convert-from-uffi-type type :type))
  69   #+(or openmcl digitool)
  70   (let ((mcl-type (convert-from-uffi-type type :type)))
  71     (unless (or (keywordp mcl-type) (consp mcl-type))
  72       (setf mcl-type `(quote ,mcl-type)))
  73     #+digitool
  74     `(def-mcl-type ,(keyword name) ,mcl-type)
  75     #+openmcl
  76     `(ccl::def-foreign-type ,(keyword name) ,mcl-type))
  77   )
  78
  79 (eval-when (:compile-toplevel :load-toplevel :execute)
  80   (defvar +type-conversion-hash+ (make-hash-table :size 20 :test #'eq))
  81   #+(or cmu sbcl scl) (defvar *cmu-def-type-hash*
  82                         (make-hash-table :size 20 :test #'eq))
  83   )
  84
  85 #+(or cmu scl)
  86 (defvar *cmu-sbcl-def-type-list*
  87     '((:char . (alien:signed 8))
  88       (:unsigned-char . (alien:unsigned 8))
  89       (:byte . (alien:signed 8))
  90       (:unsigned-byte . (alien:unsigned 8))
  91       (:short . (alien:signed 16))
  92       (:unsigned-short . (alien:unsigned 16))
  93       (:int . (alien:signed 32))
  94       (:unsigned-int . (alien:unsigned 32))
  95       #-x86-64 (:long . (alien:signed 32))
  96       #-x86-64 (:unsigned-long . (alien:unsigned 32))
  97       #+x86-64 (:long . (alien:signed 64))
  98       #+x86-64 (:unsigned-long . (alien:unsigned 64))
  99       (:long-long (alien:signed 64))
 100       (:unsigned-long-long (alien:unsigned 64))
 101       (:float . alien:single-float)
 102       (:double . alien:double-float)
 103       (:void . t)
 104       )
 105   "Conversions in CMUCL for def-foreign-type are different than in def-function")
 106
 107 #+sbcl
 108 (defvar *cmu-sbcl-def-type-list*
 109     '((:char . (sb-alien:signed 8))
 110       (:unsigned-char . (sb-alien:unsigned 8))
 111       (:byte . (sb-alien:signed 8))
 112       (:unsigned-byte . (sb-alien:unsigned 8))
 113       (:short . (sb-alien:signed 16))
 114       (:unsigned-short . (sb-alien:unsigned 16))
 115       (:int . (sb-alien:signed 32))
 116       (:unsigned-int . (sb-alien:unsigned 32))
 117       #-x86-64 (:long . (sb-alien:signed 32))
 118       #-x86-64 (:unsigned-long . (sb-alien:unsigned 32))
 119       #+x86-64 (:long . (sb-alien:signed 64))
 120       #+x86-64 (:unsigned-long . (sb-alien:unsigned 64))
 121       (:long-long (sb-alien:signed 64))
 122       (:unsigned-long-long (sb-alien:unsigned 64))
 123       (:float . sb-alien:single-float)
 124       (:double . sb-alien:double-float)
 125       (:void . t)
 126       )
 127   "Conversions in SBCL for def-foreign-type are different than in def-function")
 128
 129 (defvar *type-conversion-list* nil)
 130
 131 #+(or cmu scl)
 132 (setq *type-conversion-list*
 133     '((* . *) (:void . c-call:void)
 134       (:pointer-void . (* t))
 135       (:cstring . c-call:c-string)
 136       (:char . c-call:char)
 137       (:unsigned-char . (alien:unsigned 8))
 138       (:byte . (alien:signed 8))
 139       (:unsigned-byte . (alien:unsigned 8))
 140       (:short . c-call:short)
 141       (:unsigned-short . c-call:unsigned-short)
 142       (:int . alien:integer) (:unsigned-int . c-call:unsigned-int)
 143       (:long . c-call:long) (:unsigned-long . c-call:unsigned-long)
 144       (:long-long . c-call:long-long)
 145       (:unsigned-long-long . c-call:unsigned-long-long)
 146       (:float . c-call:float) (:double . c-call:double)
 147       (:array . alien:array)))
 148
 149 #+sbcl
 150 (setq *type-conversion-list*
 151     '((* . *) (:void . sb-alien:void)
 152       (:pointer-void . (* t))
 153       #-sb-unicode(:cstring . sb-alien:c-string)
 154       #+sb-unicode(:cstring . sb-alien:utf8-string)
 155       (:char . sb-alien:char)
 156       (:unsigned-char . (sb-alien:unsigned 8))
 157       (:byte . (sb-alien:signed 8))
 158       (:unsigned-byte . (sb-alien:unsigned 8))
 159       (:short . sb-alien:short)
 160       (:unsigned-short . sb-alien:unsigned-short)
 161       (:int . sb-alien:int) (:unsigned-int . sb-alien:unsigned-int)
 162       (:long . sb-alien:long) (:unsigned-long . sb-alien:unsigned-long)
 163       (:long-long . sb-alien:long-long)
 164       (:unsigned-long-long . sb-alien:unsigned-long-long)
 165       (:float . sb-alien:float) (:double . sb-alien:double)
 166       (:array . sb-alien:array)))
 167
 168 #+(or allegro cormanlisp)
 169 (setq *type-conversion-list*
 170     '((* . *) (:void . :void)
 171       (:short . :short)
 172       (:pointer-void . (* :void))
 173       (:cstring . (* :unsigned-char))
 174       (:byte . :char)
 175       (:unsigned-byte . :unsigned-char)
 176       (:char . :char)
 177       (:unsigned-char . :unsigned-char)
 178       (:int . :int) (:unsigned-int . :unsigned-int)
 179       (:long . :long) (:unsigned-long . :unsigned-long)
 180       (:float . :float) (:double . :double)
 181       (:array . :array)))
 182
 183 #+(or allegro cormanlisp)
 184 (push 'uffi:no-long-long cl:*features*)
 185
 186 #+lispworks
 187 (setq *type-conversion-list*
 188     '((* . :pointer) (:void . :void)
 189       (:short . :short)
 190       (:pointer-void . (:pointer :void))
 191       (:cstring . (:reference-pass (:ef-mb-string :external-format
 192                                     (:latin-1 :eol-style :lf))
 193                    :allow-null t))
 194       (:cstring-returning . (:reference (:ef-mb-string :external-format
 195                                          (:latin-1 :eol-style :lf))
 196                              :allow-null t))
 197       (:byte . :byte)
 198       (:unsigned-byte . (:unsigned :byte))
 199       (:char . :char)
 200       (:unsigned-char . (:unsigned :char))
 201       (:int . :int) (:unsigned-int . (:unsigned :int))
 202       (:long . :long) (:unsigned-long . (:unsigned :long))
 203       #+lispworks6 (:long-long . :int64)
 204       #+lispworks6 (:unsigned-long-long . :uint64)
 205       (:float . :float) (:double . :double)
 206       (:array . :c-array)))
 207
 208 #+(and lispworks (not lispworks6))
 209 (push 'uffi:no-long-long cl:*features*)
 210
 211 #+digitool
 212 (setq *type-conversion-list*
 213      '((* . :pointer) (:void . :void)
 214        (:short . :short) (:unsigned-short . :unsigned-short)
 215        (:pointer-void . :pointer)
 216        (:cstring . :string)
 217        (:char . :character)
 218        (:unsigned-char . :unsigned-byte)
 219        (:byte . :signed-byte) (:unsigned-byte . :unsigned-byte)
 220        (:int . :long) (:unsigned-int . :unsigned-long)
 221        (:long . :long) (:unsigned-long . :unsigned-long)
 222        (:float . :single-float) (:double . :double-float)
 223        (:array . :array)))
 224 #+digitool
 225 (push 'uffi:no-long-long cl:*features*)
 226
 227 #+openmcl
 228 (setq *type-conversion-list*
 229      '((* . :address) (:void . :void)
 230        (:short . :short) (:unsigned-short . :unsigned-short)
 231        (:pointer-void . :address)
 232        (:cstring . :address)
 233        (:char . :signed-char)
 234        (:unsigned-char . :unsigned-char)
 235        (:byte . :signed-byte) (:unsigned-byte . :unsigned-byte)
 236        (:int . :int) (:unsigned-int . :unsigned-int)
 237        (:long . :long) (:unsigned-long . :unsigned-long)
 238        (:long-long . :signed-doubleword) (:unsigned-long-long . :unsigned-doubleword)
 239        (:float . :single-float) (:double . :double-float)
 240        (:array . :array)))
 241
 242 (dolist (type *type-conversion-list*)
 243   (setf (gethash (car type) +type-conversion-hash+) (cdr type)))
 244
 245 #+(or cmu sbcl scl)
 246 (dolist (type *cmu-sbcl-def-type-list*)
 247   (setf (gethash (car type) *cmu-def-type-hash*) (cdr type)))
 248
 249 (defun basic-convert-from-uffi-type (type)
 250   (let ((found-type (gethash type +type-conversion-hash+)))
 251     (if found-type
 252         found-type
 253       #-(or openmcl digitool) type
 254       #+(or openmcl digitool) (keyword type))))
 255
 256 (defun %convert-from-uffi-type (type context)
 257   "Converts from a uffi type to an implementation specific type"
 258   (if (atom type)
 259       (cond
 260        #+(or allegro cormanlisp)
 261        ((and (or (eq context :routine) (eq context :return))
 262              (eq type :cstring))
 263         (setq type '((* :char) integer)))
 264        #+(or cmu sbcl scl)
 265        ((eq context :type)
 266         (let ((cmu-type (gethash type *cmu-def-type-hash*)))
 267           (if cmu-type
 268               cmu-type
 269               (basic-convert-from-uffi-type type))))
 270        #+lispworks
 271        ((and (eq context :return)
 272              (eq type :cstring))
 273         (basic-convert-from-uffi-type :cstring-returning))
 274        #+digitool
 275        ((and (eq type :void) (eq context :return)) nil)
 276        (t
 277         (basic-convert-from-uffi-type type)))
 278     (let ((sub-type (car type)))
 279       (case sub-type
 280         (cl:quote
 281          (convert-from-uffi-type (cadr type) context))
 282         (:struct-pointer
 283          #+(or openmcl digitool) `(:* (:struct ,(%convert-from-uffi-type (cadr type) :struct)))
 284          #-(or openmcl digitool) (%convert-from-uffi-type (list '* (cadr type)) :struct)
 285          )
 286         (:struct
 287          #+(or openmcl digitool) `(:struct ,(%convert-from-uffi-type (cadr type) :struct))
 288          #-(or openmcl digitool) (%convert-from-uffi-type (cadr type) :struct)
 289          )
 290        (:union
 291         #+(or openmcl digitool) `(:union ,(%convert-from-uffi-type (cadr type) :union))
 292         #-(or openmcl digitool) (%convert-from-uffi-type (cadr type) :union)
 293         )
 294        (t
 295         (cons (%convert-from-uffi-type (first type) context)
 296               (%convert-from-uffi-type (rest type) context)))))))
 297
 298 (defun convert-from-uffi-type (type context)
 299   (let ((result (%convert-from-uffi-type type context)))
 300     (cond
 301      ((atom result) result)
 302      #+openmcl
 303      ((eq (car result) :address)
 304       (if (eq context :struct)
 305           (append '(:*) (cdr result))
 306         :address))
 307      #+digitool
 308      ((and (eq (car result) :pointer) (eq context :allocation) :pointer))
 309      (t result))))
 310
 311 (eval-when (:compile-toplevel :load-toplevel :execute)
 312   (when (char= #\a (schar (symbol-name '#:a) 0))
 313     (pushnew :uffi-lowercase-reader *features*))
 314   (when (not (string= (symbol-name '#:a)
 315                       (symbol-name '#:A)))
 316     (pushnew :uffi-case-sensitive *features*)))
 317
 318 (defun make-lisp-name (name)
 319   (let ((converted (substitute #\- #\_ name)))
 320      (intern
 321       #+uffi-case-sensitive converted
 322       #+(and (not uffi-lowercase-reader) (not uffi-case-sensitive)) (string-upcase converted)
 323       #+(and uffi-lowercase-reader (not uffi-case-sensitive)) (string-downcase converted))))
 324
 325 (eval-when (:compile-toplevel :load-toplevel :execute)
 326   (setq cl:*features* (delete :uffi-lowercase-reader *features*))
 327   (setq cl:*features* (delete :uffi-case-sensitive *features*)))