strings.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          strings.lisp
   6 ;;;; Purpose:       Strings utility functions for KMRCL package
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  Apr 2000
   9 ;;;;
  10 ;;;; $Id: strings.lisp,v 1.52 2003/08/12 06:37:53 kevin Exp $
  11 ;;;;
  12 ;;;; This file, part of KMRCL, is Copyright (c) 2002 by Kevin M. Rosenberg
  13 ;;;;
  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 ;;;; *************************************************************************
  18
  19
  20 (in-package #:kmrcl)
  21
  22 ;;; Strings
  23
  24 (defmacro string-append (outputstr &rest args)
  25   `(setq ,outputstr (concatenate 'string ,outputstr ,@args)))
  26
  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))
  30
  31 (defun count-string-words (str)
  32   (declare (simple-string str)
  33            (optimize (speed 3) (safety 0) (space 0)))
  34   (let ((n-words 0)
  35         (in-word nil))
  36     (declare (fixnum n-words))
  37     (do* ((len (length str))
  38           (i 0 (1+ i)))
  39         ((= i len) n-words)
  40       (declare (fixnum i))
  41       (if (alphanumericp (schar str i))
  42           (unless in-word
  43             (incf n-words)
  44             (setq in-word t))
  45         (setq in-word nil)))))
  46
  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)))
  52        ((= i max) nil)
  53     (declare (fixnum i))
  54     (when (char= char (schar string i)) (return i))))
  55
  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)))
  60        ((= i max) nil)
  61     (declare (fixnum i))
  62     (when (char/= char (schar string i)) (return i))))
  63
  64 (defun delimited-string-to-list (string &optional (separator #\space)
  65                                                   skip-terminal)
  66   "split a string with delimiter"
  67   (declare (optimize (speed 3) (safety 0) (space 0) (compilation-speed 0))
  68            (type string string)
  69            (type character separator))
  70   (do* ((len (length string))
  71         (output '())
  72         (pos 0)
  73         (end (position-char separator string pos len)
  74              (position-char separator string pos len)))
  75        ((null end)
  76         (if (< pos len)
  77             (push (subseq string pos) output)
  78             (when (or (not skip-terminal) (zerop len))
  79               (push "" output)))
  80         (nreverse output))
  81     (declare (type fixnum pos len)
  82              (type (or null fixnum) end))
  83     (push (subseq string pos end) output)
  84     (setq pos (1+ end))))
  85
  86
  87 (defun list-to-delimited-string (list &optional (separator " "))
  88   (format nil (concatenate 'string "~{~A~^" (string separator) "~}") list))
  89
  90 (defun string-invert (str)
  91   "Invert case of a string"
  92   (declare (optimize (speed 3) (compilation-speed 0) (debug 0) (safety 0))
  93            (simple-string str))
  94   (let ((up nil) (down nil))
  95     (block skip
  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)))
  99                   ((lower-case-p char)
 100                    (if up   (return-from skip str) (setf down t)))))
 101       (if up (string-downcase str) (string-upcase str)))))
 102
 103 (defun add-sql-quotes (s)
 104   (substitute-string-for-char s #\' "''"))
 105
 106 (defun escape-backslashes (s)
 107   (substitute-string-for-char s #\\ "\\\\"))
 108
 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))))
 112
 113 (defun string-substitute (string substring replacement-string)
 114   "String substitute by Larry Hunter. Obtained from Google"
 115   (let ((substring-length (length substring))
 116         (last-end 0)
 117         (new-string ""))
 118     (do ((next-start
 119           (search substring string)
 120           (search substring string :start2 last-end)))
 121         ((null next-start)
 122          (concatenate 'string new-string (subseq string last-end)))
 123       (setq new-string
 124         (concatenate 'string
 125           new-string
 126           (subseq string last-end next-start)
 127           replacement-string))
 128       (setq last-end (+ next-start substring-length)))))
 129
 130 (defun string-trim-last-character (s)
 131   "Return the string less the last character"
 132   (let ((len (length s)))
 133     (if (plusp len)
 134         (subseq s 0 (1- len))
 135         s)))
 136
 137 (defun nstring-trim-last-character (s)
 138   "Return the string less the last character"
 139   (let ((len (length s)))
 140     (if (plusp len)
 141         (nsubseq s 0 (1- len))
 142         s)))
 143
 144 (defun string-hash (str &optional (bitmask 65535))
 145   (let ((hash 0))
 146     (declare (fixnum hash)
 147              (simple-string str))
 148     (dotimes (i (length str))
 149       (declare (fixnum i))
 150       (setq hash (+ hash (char-code (char str i)))))
 151     (logand hash bitmask)))
 152
 153 (defun is-string-empty (str)
 154   (zerop (length str)))
 155
 156 (defun is-char-whitespace (c)
 157   (declare (character c) (optimize (speed 3) (safety 0)))
 158   (or (char= c #\Space) (char= c #\Tab) (char= c #\Return)
 159       (char= c #\Linefeed)))
 160
 161 (defun is-string-whitespace (str)
 162   "Return t if string is all whitespace"
 163   (every #'is-char-whitespace str))
 164
 165 (defun replaced-string-length (str repl-alist)
 166   (declare (simple-string str)
 167            (optimize (speed 3) (safety 0) (space 0)))
 168     (do* ((i 0 (1+ i))
 169           (orig-len (length str))
 170           (new-len orig-len))
 171          ((= i orig-len) new-len)
 172       (declare (fixnum i orig-len new-len))
 173       (let* ((c (char str i))
 174              (match (assoc c repl-alist :test #'char=)))
 175         (declare (character c))
 176         (when match
 177           (incf new-len (1- (length
 178                              (the simple-string (cdr match)))))))))
 179
 180 (defun substitute-chars-strings (str repl-alist)
 181   "Replace all instances of a chars with a string. repl-alist is an assoc
 182 list of characters and replacement strings."
 183   (declare (simple-string str)
 184            (optimize (speed 3) (safety 0) (space 0)))
 185   (do* ((orig-len (length str))
 186         (new-string (make-string (replaced-string-length str repl-alist)))
 187         (spos 0 (1+ spos))
 188         (dpos 0))
 189       ((>= spos orig-len)
 190        new-string)
 191     (declare (fixnum spos dpos) (simple-string new-string))
 192     (let* ((c (char str spos))
 193            (match (assoc c repl-alist :test #'char=)))
 194       (declare (character c))
 195       (if match
 196           (let* ((subst (cdr match))
 197                  (len (length subst)))
 198             (declare (fixnum len)
 199                      (simple-string subst))
 200             (dotimes (j len)
 201               (declare (fixnum j))
 202               (setf (char new-string dpos) (char subst j))
 203               (incf dpos)))
 204         (progn
 205           (setf (char new-string dpos) c)
 206           (incf dpos))))))
 207
 208 (defun escape-xml-string (string)
 209   "Escape invalid XML characters"
 210   (substitute-chars-strings string '((#\& . "&amp;") (#\< . "&lt;"))))
 211
 212 (defun make-usb8-array (len)
 213   (make-array len :element-type '(unsigned-byte 8)))
 214
 215 (defun usb8-array-to-string (vec)
 216   (declare (type (simple-array (unsigned-byte 8) (*)) vec))
 217   (let* ((len (length vec))
 218          (str (make-string len)))
 219     (declare (fixnum len)
 220              (simple-string str)
 221              (optimize (speed 3)))
 222     (do ((i 0 (1+ i)))
 223         ((= i len) str)
 224       (declare (fixnum i))
 225       (setf (schar str i) (code-char (aref vec i))))))
 226
 227 (defun string-to-usb8-array (str)
 228   (declare (simple-string str))
 229   (let* ((len (length str))
 230          (vec (make-usb8-array len)))
 231     (declare (fixnum len)
 232              (type (simple-array (unsigned-byte 8) (*)) vec)
 233              (optimize (speed 3)))
 234     (do ((i 0 (1+ i)))
 235         ((= i len) vec)
 236       (declare (fixnum i))
 237       (setf (aref vec i) (char-code (schar str i))))))
 238
 239 (defun concat-separated-strings (separator &rest lists)
 240   (format nil (concatenate 'string "~{~A~^" (string separator) "~}")
 241           (append-sublists lists)))
 242
 243 (defun only-null-list-elements-p (lst)
 244   (or (null lst) (every #'null lst)))
 245
 246 (defun print-separated-strings (strm separator &rest lists)
 247   (declare (optimize (speed 3) (safety 0) (space 0) (debug 0)
 248                      (compilation-speed 0)))
 249   (do* ((rest-lists lists (cdr rest-lists))
 250         (list (car rest-lists) (car rest-lists))
 251         (last-list (only-null-list-elements-p (cdr rest-lists))
 252                    (only-null-list-elements-p (cdr rest-lists))))
 253        ((null rest-lists) strm)
 254     (do* ((lst list (cdr lst))
 255           (elem (car lst) (car lst))
 256           (last-elem (null (cdr lst)) (null (cdr lst))))
 257          ((null lst))
 258       (write-string elem strm)
 259       (unless (and last-elem last-list)
 260         (write-string separator strm)))))
 261
 262 (defun prefixed-fixnum-string (num pchar len)
 263   "Outputs a string of LEN digit with an optional initial character PCHAR.
 264 Leading zeros are present."
 265   (declare (optimize (speed 3) (safety 0) (space 0))
 266            (type fixnum num len))
 267   (when pchar
 268     (incf len))
 269   (do* ((zero-code (char-code #\0))
 270         (result (make-string len :initial-element #\0))
 271         (minus? (minusp num))
 272         (val (if minus? (- num) num)
 273              (nth-value 0 (floor val 10)))
 274         (pos (1- len) (1- pos))
 275         (mod (mod val 10) (mod val 10)))
 276       ((or (zerop val) (minusp pos))
 277        (when pchar
 278          (setf (schar result 0) pchar))
 279        (when minus? (setf (schar result (if pchar 1 0)) #\-))
 280        result)
 281     (declare (fixnum val mod zero-code pos) (simple-string result))
 282     (setf (schar result pos) (code-char (+ zero-code mod)))))
 283
 284 (defun integer-string (num len)
 285   "Outputs a string of LEN digit with an optional initial character PCHAR.
 286 Leading zeros are present."
 287   (declare (optimize (speed 3) (safety 0) (space 0))
 288            (type fixnum len)
 289            (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)
 294              (nth-value 0 (floor val 10)))
 295         (pos (1- len) (1- pos))
 296         (mod (mod val 10) (mod val 10)))
 297       ((or (zerop val) (minusp pos))
 298        (when minus? (setf (schar result 0) #\-))
 299        result)
 300     (declare (fixnum mod zero-code pos) (simple-string result) (integer val))
 301     (setf (schar result pos) (code-char (+ zero-code mod)))))
 302
 303 (defun fast-string-search (substr str substr-length startpos endpos)
 304   "Optimized search for a substring in a simple-string"
 305   (declare (simple-string substr str)
 306            (fixnum substr-length startpos endpos)
 307            (optimize (speed 3) (space 0) (safety 0)))
 308   (do* ((pos startpos (1+ pos))
 309         (lastpos (- endpos substr-length)))
 310        ((> pos lastpos) nil)
 311     (declare (fixnum pos lastpos))
 312     (do ((i 0 (1+ i)))
 313         ((= i substr-length)
 314          (return-from fast-string-search pos))
 315       (declare (fixnum i))
 316       (unless (char= (schar str (+ i pos)) (schar substr i))
 317         (return nil)))))
 318
 319 (defun string-delimited-string-to-list (str substr)
 320   "splits a string delimited by substr into a list of strings"
 321   (declare (simple-string str substr)
 322            (optimize (speed 3) (safety 0) (space 0) (compilation-speed 0)
 323                      (debug 0)))
 324   (do* ((substr-len (length substr))
 325         (strlen (length str))
 326         (output '())
 327         (pos 0)
 328         (end (fast-string-search substr str substr-len pos strlen)
 329              (fast-string-search substr str substr-len pos strlen)))
 330        ((null end)
 331         (when (< pos strlen)
 332           (push (subseq str pos) output))
 333         (nreverse output))
 334     (declare (fixnum strlen substr-len pos)
 335              (type (or fixnum null) end))
 336     (push (subseq str pos end) output)
 337     (setq pos (+ end substr-len))))
 338
 339 (defun string-to-list-skip-delimiter (str &optional (delim #\space))
 340   "Return a list of strings, delimited by spaces, skipping spaces."
 341   (declare (simple-string str)
 342            (optimize (speed 0) (space 0) (safety 0)))
 343   (do* ((results '())
 344         (end (length str))
 345         (i (position-not-char delim str 0 end)
 346            (position-not-char delim str j end))
 347         (j (when i (position-char delim str i end))
 348            (when i (position-char delim str i end))))
 349        ((or (null i) (null j))
 350         (when (and i (< i end))
 351           (push (subseq str i end) results))
 352         (nreverse results))
 353     (declare (fixnum end)
 354              (type (or fixnum null) i j))
 355     (push (subseq str i j) results)))
 356
 357 (defun string-starts-with (start str)
 358   (and (>= (length str) (length start))
 359        (string-equal start str :end2 (length start))))
 360
 361 (defun count-string-char (s c)
 362   "Return a count of the number of times a character appears in a string"
 363   (declare (simple-string s)
 364            (character c)
 365            (optimize (speed 3) (safety 0)))
 366   (do ((len (length s))
 367        (i 0 (1+ i))
 368        (count 0))
 369       ((= i len) count)
 370     (declare (fixnum i len count))
 371     (when (char= (schar s i) c)
 372       (incf count))))
 373
 374 (defun count-string-char-if (pred s)
 375   "Return a count of the number of times a predicate is true
 376 for characters in a string"
 377   (declare (simple-string s)
 378            (type (or function symbol) pred)
 379            (optimize (speed 3) (safety 0) (space 0)))
 380   (do ((len (length s))
 381        (i 0 (1+ i))
 382        (count 0))
 383       ((= i len) count)
 384     (declare (fixnum i len count))
 385     (when (funcall pred (schar s i))
 386       (incf count))))
 387
 388
 389 ;;; URL Encoding
 390
 391 (defun non-alphanumericp (ch)
 392   (not (alphanumericp ch)))
 393
 394 (defvar +hex-chars+ "0123456789ABCDEF")
 395 (declaim (type simple-string +hex-chars+))
 396
 397 (defun hexchar (n)
 398   (declare (type (integer 0 15) n))
 399   (schar +hex-chars+ n))
 400
 401 (defconstant +char-code-lower-a+ (char-code #\a))
 402 (defconstant +char-code-upper-a+ (char-code #\A))
 403 (defconstant +char-code-0+ (char-code #\0))
 404 (declaim (type fixnum +char-code-0+ +char-code-upper-a+
 405                +char-code-0))
 406
 407 (defun charhex (ch)
 408   "convert hex character to decimal"
 409   (let ((code (char-code (char-upcase ch))))
 410     (declare (fixnum ch))
 411     (if (>= code +char-code-upper-a+)
 412         (+ 10 (- code +char-code-upper-a+))
 413         (- code +char-code-0+))))
 414
 415 (defun uriencode-string (query)
 416   "Escape non-alphanumeric characters for URI fields"
 417   (declare (simple-string query)
 418            (optimize (speed 3) (safety 0) (space 0)))
 419   (do* ((count (count-string-char-if #'non-alphanumericp query))
 420         (len (length query))
 421         (new-len (+ len (* 2 count)))
 422         (str (make-string new-len))
 423         (spos 0 (1+ spos))
 424         (dpos 0 (1+ dpos)))
 425       ((= spos len) str)
 426     (declare (fixnum count len new-len spos dpos)
 427              (simple-string str))
 428     (let ((ch (schar query spos)))
 429       (if (non-alphanumericp ch)
 430           (let ((c (char-code ch)))
 431             (setf (schar str dpos) #\%)
 432             (incf dpos)
 433             (setf (schar str dpos) (hexchar (logand (ash c -4) 15)))
 434             (incf dpos)
 435             (setf (schar str dpos) (hexchar (logand c 15))))
 436         (setf (schar str dpos) ch)))))
 437
 438 (defun uridecode-string (query)
 439   "Unescape non-alphanumeric characters for URI fields"
 440   (declare (simple-string query)
 441            (optimize (speed 3) (safety 0) (space 0)))
 442   (do* ((count (count-string-char query #\%))
 443         (len (length query))
 444         (new-len (- len (* 2 count)))
 445         (str (make-string new-len))
 446         (spos 0 (1+ spos))
 447         (dpos 0 (1+ dpos)))
 448       ((= spos len) str)
 449     (declare (fixnum count len new-len spos dpos)
 450              (simple-string str))
 451     (let ((ch (schar query spos)))
 452       (if (char= #\% ch)
 453           (let ((c1 (charhex (schar query (1+ spos))))
 454                 (c2 (charhex (schar query (+ spos 2)))))
 455             (declare (fixnum c1 c2))
 456             (setf (schar str dpos)
 457                   (code-char (logior c2 (ash c1 4))))
 458             (incf spos 2))
 459         (setf (schar str dpos) ch)))))
 460
 461
 462
 463 (eval-when (:compile-toplevel :load-toplevel :execute)
 464   (defvar +unambigous-charset+
 465     "abcdefghjkmnpqrstuvwxyz123456789ABCDEFGHJKLMNPQSRTUVWXYZ")
 466   (defconstant +unambigous-length+ (length +unambigous-charset+)))
 467
 468 (defun random-char (&optional (set :lower-alpha))
 469   (ecase set
 470     (:lower-alpha
 471      (code-char (+ +char-code-lower-a+ (random 26))))
 472     (:lower-alphanumeric
 473      (let ((n (random 36)))
 474        (if (>= n 26)
 475            (code-char (+ +char-code-0+ (- n 26)))
 476          (code-char (+ +char-code-lower-a+ n)))))
 477     (:upper-alpha
 478      (code-char (+ +char-code-upper-a+ (random 26))))
 479     (:unambigous
 480      (schar +unambigous-charset+ (random +unambigous-length+)))
 481     (:upper-lower-alpha
 482      (let ((n (random 52)))
 483        (if (>= n 26)
 484            (code-char (+ +char-code-upper-a+ (- n 26)))
 485          (code-char (+ +char-code-lower-a+ n)))))))
 486
 487
 488 (defun random-string (&key (length 10) (set :lower-alpha))
 489   "Returns a random lower-case string."
 490   (declare (optimize (speed 3)))
 491   (let ((s (make-string length)))
 492     (declare (simple-string s))
 493     (dotimes (i length s)
 494       (setf (schar s i) (random-char set)))))
 495
 496
 497 (defun first-char (s)
 498   (declare (simple-string s))
 499   (when (and (stringp s) (plusp (length s)))
 500     (schar s 0)))
 501
 502 (defun last-char (s)
 503   (declare (simple-string s))
 504   (when (stringp s)
 505     (let ((len (length s)))
 506       (when (plusp len))
 507       (schar s (1- len)))))
 508
 509 (defun ensure-string (v)
 510   (typecase v
 511     (string v)
 512     (character (string v))
 513     (symbol (symbol-name v))
 514     (otherwise (write-to-string v))))
 515
 516 (defun string-right-trim-one-char (char str)
 517   (declare (simple-string str))
 518   (let* ((len (length str))
 519          (last (1- len)))
 520     (declare (fixnum len last))
 521     (if (char= char (schar str last))
 522         (subseq str 0 last)
 523       str)))
 524
 525
 526 (defun string-strip-ending (str endings)
 527   (if (stringp endings)
 528       (setq endings (list endings)))
 529   (let ((len (length str)))
 530     (dolist (ending endings str)
 531       (when (and (>= len (length ending))
 532                  (string-equal ending
 533                                (subseq str (- len
 534                                               (length ending)))))
 535         (return-from string-strip-ending
 536           (subseq str 0 (- len (length ending))))))))
 537
 538
 539 (defun string-maybe-shorten (str maxlen)
 540   (let ((len (length str)))
 541     (if (<= len maxlen)
 542         str
 543       (concatenate 'string (subseq str 0 (- maxlen 3)) "..."))))
 544
 545
 546 (defun shrink-vector (str size)
 547   #+allegro
 548   (excl::.primcall 'sys::shrink-svector str size)
 549   #+cmu
 550   (lisp::shrink-vector str size)
 551   #+lispworks
 552   (system::shrink-vector$vector str size)
 553   #+sbcl
 554   (sb-kernel:shrink-vector str size)
 555   #+scl
 556   (common-lisp::shrink-vector str size)
 557   #-(or allegro cmu lispworks sbcl scl)
 558   (setq str (subseq str 0 size))
 559   str)
 560
 561 (defun lex-string (string &key (whitespace '(#\space #\newline)))
 562   "Separates a string at whitespace and returns a list of strings"
 563   (flet ((is-sep (char) (member char whitespace :test #'char=)))
 564     (let ((tokens nil))
 565       (do* ((token-start
 566              (position-if-not #'is-sep string)
 567              (when token-end
 568                (position-if-not #'is-sep string :start (1+ token-end))))
 569             (token-end
 570              (when token-start
 571                (position-if #'is-sep string :start token-start))
 572              (when token-start
 573                (position-if #'is-sep string :start token-start))))
 574            ((null token-start) (nreverse tokens))
 575         (push (subseq string token-start token-end) tokens)))))
 576
 577 (defun split-alphanumeric-string (string)
 578   "Separates a string at any non-alphanumeric chararacter"
 579   (flet ((is-sep (char) (non-alphanumericp char)))
 580     (let ((tokens nil))
 581       (do* ((token-start
 582              (position-if-not #'is-sep string)
 583              (when token-end
 584                (position-if-not #'is-sep string :start (1+ token-end))))
 585             (token-end
 586              (when token-start
 587                (position-if #'is-sep string :start token-start))
 588              (when token-start
 589                (position-if #'is-sep string :start token-start))))
 590            ((null token-start) (nreverse tokens))
 591         (push (subseq string token-start token-end) tokens)))))
 592
 593