1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: UFFI -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: strings.lisp
6 ;;;; Purpose: UFFI source to handle strings, cstring and foreigns
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Feb 2002
10 ;;;; This file, part of UFFI, is Copyright (c) 2002-2010 by Kevin M. Rosenberg
11 ;;;; *************************************************************************
16 (def-pointer-var +null-cstring-pointer+
17 #+(or cmu sbcl scl) nil
19 #+lispworks (fli:make-pointer :address 0 :type '(:unsigned :char))
20 #+(or openmcl digitool) (ccl:%null-ptr)
23 (defmacro convert-from-cstring (obj)
24 "Converts a string from a c-call. Same as convert-from-foreign-string, except
25 that LW/CMU automatically converts strings from c-calls."
26 #+(or cmu sbcl lispworks scl) obj
28 (let ((stored (gensym)))
29 `(let ((,stored ,obj))
33 (excl:native-to-string
36 (if *default-external-format*
37 (map-normalized-external-format
38 *default-external-format*)
40 #+(or openmcl digitool)
41 (let ((stored (gensym)))
42 `(let ((,stored ,obj))
43 (if (ccl:%null-ptr-p ,stored)
45 (values (ccl:%get-cstring ,stored)))))
48 (defmacro convert-to-cstring (obj)
49 #+(or cmu sbcl scl lispworks) obj
51 (let ((stored (gensym)))
52 `(let ((,stored ,obj))
55 (values (excl:string-to-native
58 (if *default-external-format*
59 (map-normalized-external-format
60 *default-external-format*)
62 #+(or openmcl digitool)
63 (let ((stored (gensym)))
64 `(let ((,stored ,obj))
66 +null-cstring-pointer+
67 (let ((ptr (new-ptr (1+ (length ,stored)))))
68 (ccl::%put-cstring ptr ,stored)
72 (defmacro free-cstring (obj)
73 #+(or cmu sbcl scl lispworks) (declare (ignore obj))
75 (let ((stored (gensym)))
76 `(let ((,stored ,obj))
77 (unless (zerop ,stored)
78 (ff:free-fobject ,stored))))
79 #+(or openmcl digitool)
80 (let ((stored (gensym)))
81 `(let ((,stored ,obj))
82 (unless (ccl:%null-ptr-p ,stored)
83 (dispose-ptr ,stored))))
86 (defmacro with-cstring ((cstring lisp-string) &body body)
87 #+(or cmu sbcl scl lispworks)
88 `(let ((,cstring ,lisp-string)) ,@body)
90 (let ((acl-native (gensym))
91 (stored-lisp-string (gensym)))
92 `(let ((,stored-lisp-string ,lisp-string))
93 (excl:with-native-string (,acl-native ,stored-lisp-string
95 (if *default-external-format*
96 (map-normalized-external-format
97 *default-external-format*)
99 (let ((,cstring (if ,stored-lisp-string ,acl-native 0)))
101 #+(or openmcl digitool)
102 (let ((stored-lisp-string (gensym)))
103 `(let ((,stored-lisp-string ,lisp-string))
104 (if (stringp ,stored-lisp-string)
105 (ccl:with-encoded-cstrs
106 (or *default-external-format* :iso-8859-1)
107 ((,cstring ,stored-lisp-string))
109 (let ((,cstring +null-cstring-pointer+))
113 (defmacro with-cstrings (bindings &rest body)
115 `(with-cstring ,(car bindings)
116 (with-cstrings ,(cdr bindings)
120 ;;; Foreign string functions
122 (defmacro convert-to-foreign-string (obj &optional external-format)
124 (let ((stored (gensym "STR-"))
126 `(let ((,stored ,obj)
127 (,ef (map-normalized-external-format
128 (or external-format *default-external-format*))))
130 +null-cstring-pointer+
131 (fli:convert-to-foreign-string
133 :external-format ,ef))))
135 (let ((stored (gensym "STR-"))
137 `(let ((,stored ,obj)
138 (,ef (map-normalized-external-format
139 (or external-format *default-external-format*))))
142 (values (excl:string-to-native ,stored :external-format
143 (or ,ef :default))))))
145 (let ((size (gensym))
147 (stored-obj (gensym))
149 `(let ((,stored-obj ,obj))
150 (etypecase ,stored-obj
152 (alien:sap-alien (system:int-sap 0) (* (alien:unsigned 8))))
154 (let* ((,size (length ,stored-obj))
155 (,storage (alien:make-alien (alien:unsigned 8) (1+ ,size))))
156 (setq ,storage (alien:cast ,storage (* (alien:unsigned 8))))
158 (declare (optimize (speed 3) (safety 0)))
160 (declare (fixnum ,i))
161 (setf (alien:deref ,storage ,i)
162 (char-code (char ,stored-obj ,i))))
163 (setf (alien:deref ,storage ,size) 0))
166 (let ((size (gensym))
168 (stored-obj (gensym))
170 `(let ((,stored-obj ,obj))
171 (etypecase ,stored-obj
173 (sb-alien:sap-alien (sb-sys:int-sap 0) (* (sb-alien:unsigned 8))))
175 (let* ((,size (length ,stored-obj))
176 (,storage (sb-alien:make-alien (sb-alien:unsigned 8) (1+ ,size))))
177 (setq ,storage (sb-alien:cast ,storage (* (sb-alien:unsigned 8))))
179 (declare (optimize (speed 3) (safety 0)))
181 (declare (fixnum ,i))
182 (setf (sb-alien:deref ,storage ,i)
183 (char-code (char ,stored-obj ,i))))
184 (setf (sb-alien:deref ,storage ,size) 0))
186 #+(or openmcl digitool)
187 (let ((stored-obj (gensym)))
188 `(let ((,stored-obj ,obj))
189 (if (null ,stored-obj)
190 +null-cstring-pointer+
191 (let ((ptr (new-ptr (1+ (length ,stored-obj)))))
192 (ccl::%put-cstring ptr ,stored-obj)
196 ;; Either length or null-terminated-p must be non-nil
197 (defmacro convert-from-foreign-string (obj &key
200 (null-terminated-p t))
202 (let ((stored-obj (gensym "STR-"))
204 `(let ((,stored-obj ,obj)
205 (,ef (map-normalized-external-format
206 (or ,external-format *default-external-format*))))
207 (if (zerop ,stored-obj)
211 (excl:native-to-string
213 ,@(when length (list :length length))
214 :truncate (not ,null-terminated-p)
215 :external-format ,ef))
216 (fast-native-to-string ,stored-obj ,length)))))
218 (let ((stored-obj (gensym "STR-"))
220 `(let ((,stored-obj ,obj)
221 (,ef (map-normalized-external-format
222 (or ,external-format *default-external-format*))))
223 (if (fli:null-pointer-p ,stored-obj)
226 (fli:convert-from-foreign-string
228 ,@(when length (list :length length))
229 :null-terminated-p ,null-terminated-p
230 :external-format (list ,ef))
231 (fast-native-to-string ,stored-obj ,length)))))
233 (let ((stored-obj (gensym)))
234 `(let ((,stored-obj ,obj))
235 (if (null-pointer-p ,stored-obj)
237 (cmucl-naturalize-cstring (alien:alien-sap ,stored-obj)
239 :null-terminated-p ,null-terminated-p))))
242 (let ((stored-obj (gensym "STR-"))
244 `(let ((,stored-obj ,obj)
245 (,ef (map-normalized-external-format
246 (or ,external-format *default-external-format*))))
247 (if (null-pointer-p ,stored-obj)
250 (sb-alien::c-string-to-string (sb-alien:alien-sap ,stored-obj)
252 (sbcl-naturalize-cstring (sb-alien:alien-sap ,stored-obj)
254 :null-terminated-p ,null-terminated-p)))))
255 #+(or openmcl digitool)
256 (declare (ignore null-terminated-p))
257 #+(or openmcl digitool)
258 (let ((stored-obj (gensym "STR-"))
260 `(let ((,stored-obj ,obj)
261 (,ef (map-normalized-external-format
262 (or ,external-format *default-external-format*))))
263 (if (ccl:%null-ptr-p ,stored-obj)
265 #+digitool (ccl:%get-cstring
267 ,@(if length (list length) nil))
270 (ccl::%get-utf-8-cstring ,stored-obj))
272 (ccl::%get-native-utf-16-cstring ,stored-obj))
275 `((ccl:%str-from-ptr ,stored-obj ,length))
276 `((ccl:%get-cstring ,stored-obj))))))))
280 (defmacro allocate-foreign-string (size &key (unsigned t))
282 (let ((array-def (gensym)))
283 `(let ((,array-def (list 'alien:array 'c-call:char ,size)))
284 (eval `(alien:cast (alien:make-alien ,,array-def)
286 '(* (alien:unsigned 8))
287 '(* (alien:signed 8)))))))
290 `(alien:make-alien ,(if unsigned
296 `(sb-alien:make-alien ,(if unsigned
297 '(sb-alien:unsigned 8)
298 '(sb-alien:signed 8))
302 `(fli:allocate-foreign-object :type
308 (declare (ignore unsigned))
310 `(ff:allocate-fobject :char :c ,size)
311 #+(or openmcl digitool)
312 (declare (ignore unsigned))
313 #+(or openmcl digitool)
317 (defun foreign-string-length (foreign-string)
318 #+allegro `(ff:foreign-strlen ,foreign-string)
321 until (char= (deref-array ,foreign-string '(:array :unsigned-char) size) #\Null)
323 finally return size))
326 (defmacro with-foreign-string ((foreign-string lisp-string) &body body)
327 (let ((result (gensym)))
328 `(let* ((,foreign-string (convert-to-foreign-string ,lisp-string))
329 (,result (progn ,@body)))
330 (declare (dynamic-extent ,foreign-string))
331 (free-foreign-object ,foreign-string)
334 (defmacro with-foreign-strings (bindings &body body)
335 `(with-foreign-string ,(car bindings)
337 `((with-foreign-strings ,(cdr bindings) ,@body))
340 ;; Modified from CMUCL's source to handle non-null terminated strings
342 (defun cmucl-naturalize-cstring (sap &key length (null-terminated-p t))
343 (declare (type system:system-area-pointer sap))
345 (declare (optimize (speed 3) (safety 0)))
346 (let ((null-terminated-length
347 (when null-terminated-p
349 for offset of-type fixnum upfrom 0
350 until (zerop (system:sap-ref-8 sap offset))
351 finally (return offset)))))
353 (if (and null-terminated-length
354 (> (the fixnum length) (the fixnum null-terminated-length)))
355 (setq length null-terminated-length))
356 (setq length null-terminated-length)))
357 (let ((result (make-string length)))
358 (kernel:copy-from-system-area sap 0
359 result (* vm:vector-data-offset
361 (* length vm:byte-bits))
365 ;; kernel:copy-from-system-area doesn't work like it does on CMUCL or SBCL,
366 ;; so have to iteratively copy from sap
367 (defun cmucl-naturalize-cstring (sap &key length (null-terminated-p t))
368 (declare (type system:system-area-pointer sap))
370 (declare (optimize (speed 3) (safety 0)))
371 (let ((null-terminated-length
372 (when null-terminated-p
374 for offset of-type fixnum upfrom 0
375 until (zerop (system:sap-ref-8 sap offset))
376 finally (return offset)))))
378 (if (and null-terminated-length
379 (> (the fixnum length) (the fixnum null-terminated-length)))
380 (setq length null-terminated-length))
381 (setq length null-terminated-length)))
382 (let ((result (make-string length)))
384 (declare (type fixnum i))
385 (setf (char result i) (code-char (system:sap-ref-8 sap i))))
388 #+(and sbcl (not sb-unicode))
389 (defun sbcl-naturalize-cstring (sap &key length (null-terminated-p t))
390 (declare (type sb-sys:system-area-pointer sap)
391 (type (or null fixnum) length))
393 (declare (optimize (speed 3) (safety 0)))
394 (let ((null-terminated-length
395 (when null-terminated-p
397 for offset of-type fixnum upfrom 0
398 until (zerop (sb-sys:sap-ref-8 sap offset))
399 finally (return offset)))))
401 (if (and null-terminated-length
402 (> (the fixnum length) (the fixnum null-terminated-length)))
403 (setq length null-terminated-length))
404 (setq length null-terminated-length)))
405 (let ((result (make-string length)))
406 (funcall *system-copy-fn* sap 0 result +system-copy-offset+
407 (* length +system-copy-multiplier+))
410 #+(and sbcl sb-unicode)
411 (defun sbcl-naturalize-cstring (sap &key length (null-terminated-p t))
412 (declare (type sb-sys:system-area-pointer sap)
413 (type (or null fixnum) length))
415 (declare (optimize (speed 3) (safety 0)))
418 (let ((casted (sb-alien:cast (sb-alien:sap-alien sap (* char))
419 #+sb-unicode sb-alien:utf8-string
420 #-sb-unicode sb-alien:c-string)))
422 (copy-seq (subseq casted 0 length))
425 (let ((result (make-string length)))
426 ;; this will not work in sb-unicode
427 (funcall *system-copy-fn* sap 0 result +system-copy-offset+
428 (* length +system-copy-multiplier+))
432 (eval-when (:compile-toplevel :load-toplevel :execute)
433 (def-function "strlen"
434 ((str (* :unsigned-char)))
435 :returning :unsigned-int))
437 (def-type char-ptr-def (* :unsigned-char))
439 #+(or (and allegro (not ics)) (and lispworks (not lispworks5) (not lispworks6)))
440 (defun fast-native-to-string (s len)
441 (declare (optimize (speed 3) (space 0) (safety 0) (compilation-speed 0))
442 (type char-ptr-def s))
443 (let* ((len (or len (strlen s)))
444 (str (make-string len)))
445 (declare (fixnum len)
446 (type (simple-array #+lispworks base-char
447 #-lispworks (signed-byte 8) (*)) str))
450 (uffi:deref-array s '(:array :char) i)))))
452 #+(or (and allegro ics) lispworks5 lispworks6)
453 (defun fast-native-to-string (s len)
454 (declare (optimize (speed 3) (space 0) (safety 0) (compilation-speed 0))
455 (type char-ptr-def s))
456 (let* ((len (or len (strlen s)))
457 (str (make-string len)))
459 (setf (schar str i) (code-char (uffi:deref-array s '(:array :unsigned-byte) i))))))