clqr-strings.tex

   1 % Copyright (C) 2008 Bert Burgemeister
   2 %
   3 % Permission is granted to copy, distribute and/or modify this
   4 % document under the terms of the GNU Free Documentation License,
   5 % Version 1.2 or any later version published by the Free Software
   6 % Foundation; with no Invariant Sections, no Front-Cover Texts and
   7 % no Back-Cover Texts. For details see file COPYING.
   8 %
   9
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11 \section{Strings}
  12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  13 Strings can as well be manipulated by array and sequence functions,
  14 see pages \pageref{section:Sequences} and \pageref{section:Arrays}.
  15
  16 \begin{LIST}{1cm}
  17
  18
  19   \IT{\arrGOO{(\FU*{STRINGP} \VAR{ foo})\\
  20       (\FU*{SIMPLE-STRING-P} \VAR{ foo})}{\}}}
  21   Return \retval{\T} if \VAR{foo} is of type
  22   \kwd{string} or \kwd{simple-string}, resp.
  23
  24   \IT{(\xorGOO{\FU*{STRING=}\\\FU*{STRING-EQUAL}}{\}} \VAR{foo}
  25     \VAR{bar}
  26     \orGOO{\kwd{:start1} \VAR{ start-foo}\DF{\LIT{0}}\\
  27       \kwd{:end1} \VAR{ end-foo}\DF{\LIT{\NIL}}\\
  28       \kwd{:start2} \VAR{ start-bar}\DF{\LIT{0}}\\
  29       \kwd{:end2} \VAR{ end-bar}\DF{\LIT{\NIL}}}{\}})}
  30   Return \retval{\T} if
  31   subsequences of \VAR{foo} and \VAR{bar} are equal. Obey/ignore,
  32   resp., case.
  33
  34   \IT{(\xorGOO{\FU*{STRING/=}\\\FU{STRING\boldmath$>$}\\
  35       \FU{STRING\boldmath$>=$}\\\FU{STRING\boldmath$<$}\\
  36       \FU{STRING\boldmath$<=$}}{\}} \VAR{foo} \VAR{bar}
  37     \orGOO{\kwd{:start1} \VAR{ start-foo}\DF{\LIT{0}}\\
  38       \kwd{:end1} \VAR{ end-foo}\DF{\LIT{\NIL}}\\
  39       \kwd{:start2} \VAR{ start-bar}\DF{\LIT{0}}\\
  40       \kwd{:end2} \VAR{ end-bar}\DF{\LIT{\NIL}}}{\}})}
  41   \index{string>@STRING\boldmath$>$}%
  42   \index{string>=@STRING\boldmath$>=$}%
  43   \index{string<@STRING\boldmath$<$}%
  44   \index{string<=@STRING\boldmath$<=$}%
  45   If \VAR{foo} is
  46   lexicographically not equal, greater, not less, less, or not greater,
  47   resp., then return \retval{character number} from beginning of \VAR{foo}
  48   where they begin to differ.  Otherwise return \retval{\NIL}.
  49
  50   \IT{(\xorGOO{\FU*{STRING-NOT-EQUAL}\\
  51       \FU*{STRING-GREATERP}\\
  52       \FU*{STRING-NOT-LESSP}\\
  53       \FU*{STRING-LESSP}\\
  54       \FU*{STRING-NOT-GREATERP}}{\}}
  55     \VAR{foo} \VAR{bar}
  56     \orGOO{%
  57       \kwd{:start1} \VAR{ start-foo}\DF{\LIT{0}}\\
  58       \kwd{:end1} \VAR{ end-foo}\DF{\LIT{\NIL}}\\
  59       \kwd{:start2} \VAR{ start-bar}\DF{\LIT{0}}\\
  60       \kwd{:end2} \VAR{ end-bar}\DF{\LIT{\NIL}}}{\}})}
  61   If \VAR{foo} is
  62   lexicographically not equal, greater, not less, less, or not greater,
  63   resp., ignoring case, then return \retval{character number} from beginning of \VAR{foo}
  64   where they begin to differ. Otherwise return \retval{\NIL}.
  65
  66   \IT{(\FU*{STRING} \VAR{x})}
  67   Convert \VAR{x} (symbol, string, or character) into a \retval{string}.
  68
  69   \IT{(\FU*{MAKE-STRING} \VAR{size} \orGOO{\kwd{initial-element} \VAR{ char}\\
  70       \kwd{element-type} \VAR{ type}\DF{\kwd{character}}}{\}})}
  71   Return \retval{string} of length \VAR{size}.
  72
  73   \IT{(\xorGOO{\FU*{STRING}\\\FU*{NSTRING}}{\}}\kwd{-}%
  74     \xorGOO{\kwd{CAPITALIZE}\\\kwd{UPCASE}
  75       \\\kwd{DOWNCASE}}{\}}
  76     \VAR{string}
  77     \orGOO{\kwd{:start} \VAR{ start}\DF{\LIT{0}}\\
  78       \kwd{:end} \VAR{ end}\DF{\NIL}}{\}})}
  79   \index{STRING-CAPITALIZE}%
  80   \index{STRING-UPCASE}%
  81   \index{STRING-DOWNCASE}%
  82   \index{NSTRING-CAPITALIZE}%
  83   \index{NSTRING-UPCASE}%
  84   \index{NSTRING-DOWNCASE}%
  85   Return \retval{\VAR{string}} (not modified or modified, resp.) with
  86   first letter of every word turned into uppercase, all letters
  87   uppercase, or all letters lowercase, resp.
  88
  89   \IT{(\xorGOO{\FU*{STRING-TRIM}\\
  90       \FU*{STRING-LEFT-TRIM}\\
  91       \FU*{STRING-RIGHT-TRIM}}{\}} \VAR{char-bag} \VAR{string})}
  92   Return \retval{string} with all characters in \VAR{char-bag} removed
  93   from both ends, from the beginning, or from the end, resp., of \VAR{string}.
  94
  95   \IT{\arrGOO{(\FU*{CHAR} \VAR{ string} \VAR{ i})\\
  96       (\FU*{SCHAR} \VAR{ string} \VAR{ i})}{\}}}
  97   Return \retval{\VAR{i}th character} of string ignoring/obeying,
  98   resp., fill pointer. \kwd{setf}able.
  99
 100   \IT{(\FU*{PARSE-INTEGER} \VAR{string}
 101     \orGOO{\kwd{:start} \VAR{ start}\DF{\LIT{0}}\\
 102       \kwd{:end} \VAR{ end}\DF{\NIL}\\
 103       \kwd{:junk-allowed} \VAR{ bool}\DF{\NIL}}{\}})}
 104   Parse \retval{integer} from \VAR{string}. Second value is
 105   \retvalii{index} of parse end in \VAR{string}.
 106
 107
 108
 109 \end{LIST}