r2732: *** empty log message ***
[uffi.git] / src-main / strings.cl
diff --git a/src-main/strings.cl b/src-main/strings.cl
new file mode 100644 (file)
index 0000000..f4e0e03
--- /dev/null
@@ -0,0 +1,193 @@
+;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
+;;;; *************************************************************************
+;;;; FILE IDENTIFICATION
+;;;;
+;;;; Name:          strings.cl
+;;;; Purpose:       UFFI source to handle strings, cstring and foreigns
+;;;; Programmer:    Kevin M. Rosenberg
+;;;; Date Started:  Feb 2002
+;;;;
+;;;; $Id: strings.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)
+
+
+(def-constant +null-cstring-pointer+
+    #+cmu nil
+    #+allegro 0
+    #+lispworks (fli:make-pointer :address 0 :type '(:unsigned :char))
+    #-(or cmu allegro lispworks) nil
+)
+
+(defmacro convert-from-cstring (obj)
+  "Converts a string from a c-call. Same as convert-from-foreign-string, except
+that LW/CMU automatically converts strings from c-calls."
+  #+cmu obj
+  #+lispworks obj
+  #+allegro 
+  (let ((stored (gensym)))
+    `(let ((,stored ,obj))
+       (if (zerop ,stored)
+          nil
+        (values (excl:native-to-string ,stored)))))
+  )
+
+(defmacro convert-to-cstring (obj)
+  #+cmu obj
+  #+lispworks obj
+  #+allegro
+  `(if (null ,obj)
+    0
+    (values (excl:string-to-native ,obj)))
+  )
+
+(defmacro free-cstring (obj)
+  #+cmu (declare (ignore obj))
+  #+lispworks (declare (ignore obj))
+  #+allegro
+  `(unless (zerop obj)
+     (ff:free-fobject ,obj))
+  )
+
+(defmacro with-cstring ((cstring lisp-string) &body body)
+  #+cmu
+  `(let ((,cstring ,lisp-string)) ,@body) 
+  #+lispworks
+  `(let ((,cstring ,lisp-string)) ,@body) 
+  #+allegro
+  (let ((acl-native (gensym)))
+    `(excl:with-native-string (,acl-native ,lisp-string)
+       (let ((,cstring (if ,lisp-string ,acl-native 0)))
+        ,@body)))
+  )
+
+(defmacro with-cstrings (bindings &rest body)
+  (if bindings
+      `(with-cstring ,(car bindings)
+       (with-cstrings ,(cdr bindings)
+         ,@body))
+      `(progn ,@body)))
+
+;;; Foreign string functions
+
+(defmacro convert-to-foreign-string (obj)
+  #+lispworks
+  `(if (null ,obj)
+       +null-cstring-pointer+
+    (fli:convert-to-foreign-string ,obj))
+  #+allegro
+  `(if (null ,obj)
+       0
+     (values (excl:string-to-native ,obj)))
+  #+cmu
+  (let ((size (gensym))
+       (storage (gensym))
+       (i (gensym)))
+    `(etypecase ,obj
+      (null 
+       (alien:sap-alien (system:int-sap 0) (* (alien:unsigned 8))))
+      (string
+       (let* ((,size (length ,obj))
+             (,storage (alien:make-alien (alien:unsigned 8) (1+ ,size))))
+        (setq ,storage (alien:cast ,storage (* (alien:unsigned 8))))
+        (locally
+            (declare (optimize (speed 3) (safety 0)))
+          (dotimes (,i ,size)
+            (declare (fixnum ,i))
+            (setf (alien:deref ,storage ,i) (char-code (char ,obj ,i))))
+          (setf (alien:deref ,storage ,size) 0))
+        ,storage))))
+      )
+
+
+;; Either length or null-terminated-p must be non-nil
+(defmacro convert-from-foreign-string (obj &key
+                                          length
+                                          (null-terminated-p t))
+  #+allegro
+  `(if (zerop ,obj)
+       nil
+     (values (excl:native-to-string
+             ,obj 
+             ,@(if length (list :length length) (values))
+             :truncate (not ,null-terminated-p))))
+  #+lispworks
+  `(if (fli:null-pointer-p ,obj)
+       nil
+     (fli:convert-from-foreign-string 
+      ,obj
+      ,@(if length (list :length length) (values))
+      :null-terminated-p ,null-terminated-p
+      :external-format '(:latin-1 :eol-style :lf)))      
+  #+cmu
+  `(if (null-pointer-p ,obj)
+    nil
+    (cmucl-naturalize-cstring (alien:alien-sap ,obj)
+     :length ,length
+     :null-terminated-p ,null-terminated-p))
+  )
+
+
+
+(defmacro allocate-foreign-string (size &key (unsigned t))
+  #+cmu
+  (let ((array-def (gensym)))
+    `(let ((,array-def (list 'alien:array 'c-call:char ,size)))
+       (eval `(alien:cast (alien:make-alien ,,array-def) 
+                         ,(if ,unsigned 
+                              '(* (alien:unsigned 8))
+                            '(* (alien:signed 8)))))))
+  #+lispworks
+  `(fli:allocate-foreign-object :type 
+                               ,(if unsigned 
+                                    ''(:unsigned :char) 
+                                  :char)
+                               :nelems ,size)
+  #+allegro
+  (declare (ignore unsigned))
+  #+allegro
+  `(ff:allocate-fobject :char :c ,size)
+  )
+
+(defmacro with-foreign-string ((foreign-string lisp-string) &body body)
+  (let ((result (gensym)))
+    `(let* ((,foreign-string (convert-to-foreign-string ,lisp-string))
+           (,result (progn ,@body)))
+      (declare (dynamic-extent ,foreign-string))
+      (free-foreign-object ,foreign-string)
+      ,result)))
+
+
+;; Modified from CMUCL's source to handle non-null terminated strings
+#+cmu
+(defun cmucl-naturalize-cstring (sap &key 
+                                          length
+                                          (null-terminated-p t))
+  (declare (type system:system-area-pointer sap))
+  (locally
+      (declare (optimize (speed 3) (safety 0)))
+    (let ((null-terminated-length
+          (when null-terminated-p
+            (loop
+                for offset of-type fixnum upfrom 0
+                until (zerop (system:sap-ref-8 sap offset))
+                finally (return offset)))))
+      (if length
+         (if (and null-terminated-length
+                  (> (the fixnum length) (the fixnum null-terminated-length)))
+             (setq length null-terminated-length))
+       (setq length null-terminated-length)))
+    (let ((result (make-string length)))
+      (kernel:copy-from-system-area sap 0
+                                   result (* vm:vector-data-offset
+                                             vm:word-bits)
+                                   (* length vm:byte-bits))
+      result)))