src/strings.cl

   1 ;;;; -*- Mode: ANSI-Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          strings.cl
   6 ;;;; Purpose:       UFFI source to handle strings, cstring and foreigns
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Feb 2002
   9 ;;;;
  10 ;;;; $Id: strings.cl,v 1.9 2002/03/21 04:05:15 kevin Exp $
  11 ;;;;
  12 ;;;; This file, part of UFFI, is Copyright (c) 2002 by Kevin M. Rosenberg
  13 ;;;;
  14 ;;;; UFFI users are granted the rights to distribute and use this software
  15 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  16 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  17 ;;;; *************************************************************************
  18
  19 (declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
  20 (in-package :uffi)
  21
  22
  23 (def-constant +null-cstring-pointer+
  24     #+cmu nil
  25     #+allegro 0
  26     #+lispworks (fli:make-pointer :address 0 :type '(:unsigned :char)))
  27
  28 (defmacro convert-from-cstring (obj)
  29   "Converts a string from a c-call. Same as convert-from-foreign-string, except
  30 that CMU automatically converts strings from c-calls."
  31   #+cmu obj
  32   #+lispworks
  33   (let ((stored (gensym)))
  34     `(let ((,stored ,obj))
  35        (if (fli:null-pointer-p ,stored)
  36            nil
  37          (fli:convert-from-foreign-string ,stored))))
  38   #+allegro
  39   (let ((stored (gensym)))
  40     `(let ((,stored ,obj))
  41        (if (zerop ,stored)
  42            nil
  43          (values (excl:native-to-string ,stored)))))
  44   )
  45
  46 (defmacro convert-to-cstring (obj)
  47   #+lispworks
  48   `(if (null ,obj)
  49     +null-cstring-pointer+
  50     (fli:convert-to-foreign-string ,obj))
  51   #+allegro
  52   `(if (null ,obj)
  53     0
  54     (values (excl:string-to-native ,obj)))
  55   #+cmu
  56   (declare (ignore obj))
  57   )
  58
  59 (defmacro free-cstring (obj)
  60   #+lispworks
  61   `(unless (fli:null-pointer-p ,obj)
  62      (fli:free-foreign-object ,obj))
  63   #+allegro
  64   `(unless (zerop obj)
  65      (ff:free-fobject ,obj))
  66   #+cmu
  67   (declare (ignore obj))
  68   )
  69
  70 ;; Either length or null-terminated-p must be non-nil
  71 (defmacro convert-from-foreign-string (obj &key
  72                                            length
  73                                            (null-terminated-p t))
  74   #+allegro
  75   `(if (zerop ,obj)
  76        nil
  77      (values (excl:native-to-string
  78               ,obj
  79               ,@(if length (list :length length) (values))
  80               :truncate (not ,null-terminated-p))))
  81   #+lispworks
  82   `(if (fli:null-pointer-p ,obj)
  83        nil
  84      (fli:convert-from-foreign-string
  85       ,obj
  86       ,@(if length (list :length length) (values))
  87       :null-terminated-p ,null-terminated-p
  88       :external-format '(:latin-1 :eol-style :lf)))
  89   #+cmu
  90   `(cmucl-naturalize-cstring (alien:alien-sap ,obj)
  91                               :length ,length
  92                               :null-terminated-p ,null-terminated-p)
  93   )
  94
  95 (defmacro convert-to-foreign-string (obj)
  96   #+lispworks
  97   `(if (null ,obj)
  98        +null-cstring-pointer+
  99     (fli:convert-to-foreign-string ,obj))
 100   #+allegro
 101   `(if (null ,obj)
 102        0
 103      (values (excl:string-to-native ,obj)))
 104   #+cmu
 105   (let ((size (gensym))
 106         (storage (gensym))
 107         (i (gensym)))
 108     `(when (stringp ,obj)
 109        (let* ((,size (length ,obj))
 110               (,storage (alien:make-alien (alien:unsigned 8) (1+ ,size))))
 111          (setq ,storage (alien:cast ,storage (* (alien:unsigned 8))))
 112          (locally
 113              (declare (optimize (speed 3) (safety 0)))
 114            (dotimes (,i ,size)
 115              (declare (fixnum ,i))
 116              (setf (alien:deref ,storage ,i) (char-code (char ,obj ,i))))
 117            (setf (alien:deref ,storage ,size) 0))
 118          ,storage)))
 119   )
 120
 121
 122 (defmacro allocate-foreign-string (size &key (unsigned t))
 123   #+cmu
 124   (let ((array-def (gensym)))
 125     `(let ((,array-def (list 'alien:array 'c-call:char ,size)))
 126        (eval `(alien:cast (alien:make-alien ,,array-def)
 127                           ,(if ,unsigned
 128                                '(* (alien:unsigned 8))
 129                              '(* (alien:signed 8)))))))
 130   #+lispworks
 131   `(fli:allocate-foreign-object :type
 132                                 ,(if unsigned
 133                                      ''(:unsigned :char)
 134                                    :char)
 135                                 :nelems ,size)
 136   #+allegro
 137   (declare (ignore unsigned))
 138   #+allegro
 139   `(ff:allocate-fobject :char :c ,size)
 140   )
 141
 142 (defmacro with-foreign-string ((foreign-string lisp-string) &body body)
 143   (let ((result (gensym)))
 144     `(let* ((,foreign-string (convert-to-foreign-string ,lisp-string))
 145             (,result (progn ,@body)))
 146       (declare (dynamic-extent ,foreign-string))
 147       (free-foreign-object ,foreign-string)
 148       ,result)))
 149
 150 (defmacro with-cstring ((cstring lisp-string) &body body)
 151   #+cmu
 152   `(let ((,cstring ,lisp-string)) ,@body)
 153   #+allegro
 154   (let ((acl-native (gensym)))
 155     `(excl:with-native-string (,acl-native ,lisp-string)
 156        (let ((,cstring (if ,lisp-string ,acl-native 0)))
 157          ,@body)))
 158   #+lispworks
 159   (let ((result (gensym)))
 160     `(let* ((,cstring (convert-to-cstring ,lisp-string))
 161             (,result (progn ,@body)))
 162        (fli:free-foreign-object ,cstring)
 163        ,result))
 164   )
 165
 166
 167
 168 ;; Modified from CMUCL's source to handle non-null terminated strings
 169 #+cmu
 170 (defun cmucl-naturalize-cstring (sap &key
 171                                            length
 172                                            (null-terminated-p t))
 173   (declare (type system:system-area-pointer sap))
 174   (locally
 175       (declare (optimize (speed 3) (safety 0)))
 176     (let ((null-terminated-length
 177            (when null-terminated-p
 178              (loop
 179                  for offset of-type fixnum upfrom 0
 180                  until (zerop (system:sap-ref-8 sap offset))
 181                  finally (return offset)))))
 182       (if length
 183           (if (and null-terminated-length
 184                    (> (the fixnum length) (the fixnum null-terminated-length)))
 185               (setq length null-terminated-length))
 186         (setq length null-terminated-length)))
 187     (let ((result (make-string length)))
 188       (kernel:copy-from-system-area sap 0
 189                                     result (* vm:vector-data-offset
 190                                               vm:word-bits)
 191                                     (* length vm:byte-bits))
 192       result)))