1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: strings.lisp
6 ;;;; Purpose: Strings utility functions for KMRCL package
7 ;;;; Programmer: Kevin M. Rosenberg
8 ;;;; Date Started: Apr 2000
10 ;;;; $Id: strings.lisp,v 1.36 2003/06/07 05:45:14 kevin Exp $
12 ;;;; This file, part of KMRCL, is Copyright (c) 2002 by Kevin M. Rosenberg
14 ;;;; KMRCL 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 ;;;; *************************************************************************
24 (defmacro string-append (outputstr &rest args)
25 `(setq ,outputstr (concatenate 'string ,outputstr ,@args)))
27 (defun list-to-string (lst)
28 "Converts a list to a string, doesn't include any delimiters between elements"
29 (format nil "~{~A~}" lst))
31 (defun count-string-words (str)
32 (declare (simple-string str)
33 (optimize (speed 3) (safety 0) (space 0)))
36 (declare (fixnum n-words))
37 (do* ((len (length str))
41 (if (alphanumericp (schar str i))
45 (setq in-word nil)))))
47 ;; From Larry Hunter with modifications
48 (defun position-char (char string start max)
49 (declare (optimize (speed 3) (safety 0) (space 0))
50 (fixnum start max) (simple-string string))
51 (do* ((i start (1+ i)))
54 (when (char= char (schar string i)) (return i))))
56 (defun position-not-char (char string start max)
57 (declare (optimize (speed 3) (safety 0) (space 0))
58 (fixnum start max) (simple-string string))
59 (do* ((i start (1+ i)))
62 (when (char/= char (schar string i)) (return i))))
64 (defun delimited-string-to-list (string &optional (separator #\space)
66 "split a string with delimiter"
67 (declare (optimize (speed 3) (safety 0) (space 0) (compilation-speed 0))
69 (type character separator))
70 (do* ((len (length string))
73 (end (position-char separator string pos len)
74 (position-char separator string pos len)))
77 (push (subseq string pos) output)
78 (when (or (not skip-terminal) (zerop len))
81 (declare (type fixnum pos len)
82 (type (or null fixnum) end))
83 (push (subseq string pos end) output)
87 (defun list-to-delimited-string (list &optional (separator " "))
88 (format nil (concatenate 'string "~{~A~^" (string separator) "~}") list))
90 (defun string-invert (str)
91 "Invert case of a string"
92 (declare (optimize (speed 3) (compilation-speed 0) (debug 0) (safety 0))
94 (let ((up nil) (down nil))
96 (loop for char of-type character across str do
97 (cond ((upper-case-p char)
98 (if down (return-from skip str) (setf up t)))
100 (if up (return-from skip str) (setf down t)))))
101 (if up (string-downcase str) (string-upcase str)))))
103 (defun add-sql-quotes (s)
104 (substitute-string-for-char s #\' "''"))
106 (defun escape-backslashes (s)
107 (substitute-string-for-char s #\\ "\\\\"))
109 (defun substitute-string-for-char (procstr match-char subst-str)
110 "Substitutes a string for a single matching character of a string"
111 (substitute-chars-strings procstr (list (cons match-char subst-str))))
113 (defun string-substitute (string substring replacement-string)
114 "String substitute by Larry Hunter. Obtained from Google"
115 (let ((substring-length (length substring))
119 (search substring string)
120 (search substring string :start2 last-end)))
122 (concatenate 'string new-string (subseq string last-end)))
126 (subseq string last-end next-start)
128 (setq last-end (+ next-start substring-length)))))
130 (defun string-trim-last-character (s)
131 "Return the string less the last character"
132 (let ((len (length s)))
134 (subseq s 0 (1- len))
137 (defun nstring-trim-last-character (s)
138 "Return the string less the last character"
139 (let ((len (length s)))
141 (nsubseq s 0 (1- len))
144 (defun string-hash (str &optional (bitmask 65535))
146 (declare (fixnum hash)
148 (dotimes (i (length str))
150 (setq hash (+ hash (char-code (char str i)))))
151 (logand hash bitmask)))
153 (defun string-not-null? (str)
154 (and str (not (zerop (length str)))))
156 (defun whitespace? (c)
157 (declare (character c))
158 (locally (declare (optimize (speed 3) (safety 0)))
159 (or (char= c #\Space) (char= c #\Tab) (char= c #\Return)
160 (char= c #\Linefeed))))
162 (defun not-whitespace? (c)
163 (not (whitespace? c)))
165 (defun string-ws? (str)
166 "Return t if string is all whitespace"
168 (null (find-if #'not-whitespace? str))))
170 (defun replaced-string-length (str repl-alist)
171 (declare (string str))
172 (let* ((orig-len (length str))
174 (declare (fixnum orig-len new-len))
175 (dotimes (i orig-len)
177 (let* ((c (char str i))
178 (match (assoc c repl-alist :test #'char=)))
179 (declare (character c))
181 (incf new-len (1- (length (cdr match)))))))
184 (defun substitute-chars-strings (str repl-alist)
185 "Replace all instances of a chars with a string. repl-alist is an assoc
186 list of characters and replacement strings."
187 (declare (simple-string str))
188 (do* ((orig-len (length str))
189 (new-string (make-string (replaced-string-length str repl-alist)))
194 (declare (fixnum spos dpos) (simple-string new-string))
195 (let* ((c (char str spos))
196 (match (assoc c repl-alist :test #'char=)))
197 (declare (character c))
199 (let* ((subst (cdr match))
200 (len (length subst)))
201 (declare (fixnum len))
204 (setf (char new-string dpos) (char subst j))
207 (setf (char new-string dpos) c)
210 (defun escape-xml-string (string)
211 "Escape invalid XML characters"
212 (substitute-chars-strings string '((#\& . "&") (#\< . "<"))))
214 (defun make-usb8-array (len)
215 (make-array len :adjustable nil
217 :element-type '(unsigned-byte 8)))
219 (defun usb8-array-to-string (vec)
220 (let* ((len (length vec))
221 (str (make-string len)))
222 (declare (fixnum len)
224 (optimize (speed 3)))
227 (setf (schar str i) (code-char (aref vec i))))
230 (defun string-to-usb8-array (str)
231 (let* ((len (length str))
232 (vec (make-usb8-array len)))
233 (declare (fixnum len)
234 (type (array fixnum (*)) vec)
235 (optimize (speed 3)))
238 (setf (aref vec i) (char-code (schar str i))))
241 (defun concat-separated-strings (separator &rest lists)
242 (format nil (concatenate 'string "~{~A~^" (string separator) "~}")
243 (append-sublists lists)))
245 (defun only-null-list-elements-p (lst)
246 (or (null lst) (every #'null lst)))
248 (defun print-separated-strings (strm separator &rest lists)
249 (declare (optimize (speed 3) (safety 0) (space 0) (debug 0)
250 (compilation-speed 0)))
251 (do* ((rest-lists lists (cdr rest-lists))
252 (list (car rest-lists) (car rest-lists))
253 (last-list (only-null-list-elements-p (cdr rest-lists))
254 (only-null-list-elements-p (cdr rest-lists))))
255 ((null rest-lists) strm)
256 (do* ((lst list (cdr lst))
257 (elem (car lst) (car lst))
258 (last-elem (null (cdr lst)) (null (cdr lst))))
260 (write-string elem strm)
261 (unless (and last-elem last-list)
262 (write-string separator strm)))))
264 (defun prefixed-fixnum-string (num pchar len)
265 "Outputs a string of LEN digit with an optional initial character PCHAR.
266 Leading zeros are present."
267 (declare (optimize (speed 3) (safety 0) (space 0))
268 (type fixnum num len))
271 (do* ((zero-code (char-code #\0))
272 (result (make-string len :initial-element #\0))
273 (minus? (minusp num))
274 (val (if minus? (- 0 num) num) (floor (/ val 10)))
275 (pos (1- len) (1- pos))
276 (mod (mod val 10) (mod val 10)))
277 ((or (zerop val) (minusp pos))
279 (setf (schar result 0) pchar))
280 (when minus? (setf (schar result (if pchar 1 0)) #\-))
282 (declare (fixnum val mod zero-code pos) (simple-string result))
283 (setf (schar result pos) (code-char (+ zero-code mod)))))
285 (defun integer-string (num len)
286 "Outputs a string of LEN digit with an optional initial character PCHAR.
287 Leading zeros are present."
288 (declare (optimize (speed 3) (safety 0) (space 0))
289 (type fixnum len) (type integer num))
290 (do* ((zero-code (char-code #\0))
291 (result (make-string len :initial-element #\0))
292 (minus? (minusp num))
293 (val (if minus? (- 0 num) num) (floor (/ val 10)))
294 (pos (1- len) (1- pos))
295 (mod (mod val 10) (mod val 10)))
296 ((or (zerop val) (minusp pos))
297 (when minus? (setf (schar result 0) #\-))
299 (declare (fixnum mod zero-code pos) (simple-string result) (integer val))
300 (setf (schar result pos) (code-char (+ zero-code mod)))))
302 (defun fast-string-search (substr str substr-length startpos endpos)
303 "Optimized search for a substring in a simple-string"
304 (declare (simple-string substr str)
305 (fixnum substr-length startpos endpos)
306 (optimize (speed 3) (space 0) (safety 0)))
307 (do* ((pos startpos (1+ pos))
308 (lastpos (- endpos substr-length)))
309 ((> pos lastpos) nil)
310 (declare (fixnum pos lastpos))
313 (return-from fast-string-search pos))
315 (unless (char= (schar str (+ i pos)) (schar substr i))
318 (defun string-to-list-skip-delimiter (str &optional (delim #\space))
319 "Return a list of strings, delimited by spaces, skipping spaces."
320 (declare (simple-string str)
321 (optimize (speed 0) (space 0) (safety 0)))
324 (i (position-not-char delim str 0 end)
325 (position-not-char delim str j end))
326 (j (when i (position-char delim str i end))
327 (when i (position-char delim str i end))))
328 ((or (null i) (null j))
329 (when (and i (< i end))
330 (push (subseq str i end) results))
332 (declare (fixnum i j end))
333 (push (subseq str i j) results)))