src/support/lstrings.h

   1 // -*- C++ -*-
   2
   3 /*
   4   This is a collection of string helper functions that works
   5   together with string (and later also with STL String. Some of these
   6   would certainly benefit from a rewrite/optimization.
   7 */
   8
   9 #ifndef LSTRINGS_H
  10 #define LSTRINGS_H
  11
  12 #ifdef __GNUG__
  13 #pragma interface
  14 #endif
  15
  16 #include <cstring>
  17 #include <cctype>
  18
  19 #include "Lsstream.h"
  20
  21 #include "LString.h"
  22
  23
  24 ///
  25 int compare_no_case(string const & s, string const & s2);
  26
  27 ///
  28 int compare_no_case(string const & s, string const & s2, unsigned int len);
  29
  30 ///
  31 inline
  32 int compare(char const * a, char const * b)
  33 {
  34         return strcmp(a, b);
  35 }
  36
  37 ///
  38 inline
  39 int compare(char const * a, char const * b, unsigned int len)
  40 {
  41         return strncmp(a, b, len);
  42 }
  43
  44 ///
  45 bool isStrInt(string const & str);
  46
  47 ///
  48 int strToInt(string const & str);
  49
  50 ///
  51 bool isStrDbl(string const & str);
  52
  53 ///
  54 double strToDbl(string const & str);
  55
  56 ///
  57 char lowercase(char c);
  58
  59 ///
  60 char uppercase(char c);
  61
  62 ///
  63 string const lowercase(string const &);
  64
  65 ///
  66 string const uppercase(string const &);
  67
  68 /// convert T to string
  69 template<typename T>
  70 inline
  71 string const tostr(T const & t)
  72 {
  73         std::ostringstream ostr;
  74         ostr << t;
  75         return ostr.str().c_str();
  76         // We need to use the .c_str since we sometimes are using
  77         // our own string class and that is not compatible with
  78         // basic_string<char>. (of course we don't want this later)
  79 }
  80
  81
  82 ///
  83 template<>
  84 inline
  85 string const tostr(bool const & b)
  86 {
  87         return (b ? "true" : "false");
  88 }
  89
  90 /// Does the string start with this prefix?
  91 bool prefixIs(string const &, char const *);
  92
  93 /// Does the string start with this prefix?
  94 bool prefixIs(string const &, string const &);
  95
  96 /// Does the string end with this char?
  97 bool suffixIs(string const &, char);
  98
  99 /// Does the string end with this suffix?
 100 bool suffixIs(string const &, char const *);
 101
 102 /// Does the string end with this suffix?
 103 bool suffixIs(string const &, string const &);
 104
 105 ///
 106 bool contains(char const * a, string const & b);
 107
 108 ///
 109 bool contains(string const & a, char const * b);
 110
 111 ///
 112 bool contains(string const & a, string const & b);
 113
 114 ///
 115 bool contains(char const * a, char const * b);
 116
 117 ///
 118 bool containsOnly(string const &, char const *);
 119
 120 ///
 121 bool containsOnly(string const &, string const &);
 122
 123 ///
 124 bool containsOnly(char const *, char const *);
 125
 126 ///
 127 bool containsOnly(char const *, string const &);
 128
 129 /// Counts how many of character c there is in a
 130 unsigned int countChar(string const & a, char c);
 131
 132 /** Extracts a token from this string at the nth delim.
 133   Doesn't modify the original string. Similar to strtok.
 134   Example:
 135   #"a;bc;d".token(';', 1) == "bc";#
 136   #"a;bc;d".token(';', 2) == "d";#
 137 */
 138 string const token(string const & a, char delim, int n);
 139
 140
 141 /** Search a token in this string using the delim.
 142   Doesn't modify the original string. Returns -1 in case of
 143   failure.
 144   Example:
 145   #"a;bc;d".tokenPos(';', "bc") == 1;#
 146   #"a;bc;d".token(';', "d") == 2;#
 147 */
 148 int tokenPos(string const & a, char delim, string const & tok);
 149
 150
 151 /** Compares a string and a (simple) regular expression
 152   The only element allowed is "*" for any string of characters
 153   */
 154 bool regexMatch(string const & a, string const & pattern);
 155
 156 /// Substitute all "oldchar"s with "newchar"
 157 string const subst(string const & a, char oldchar, char newchar);
 158
 159 /// Substitutes all instances of oldstr with newstr
 160 string const subst(string const & a,
 161              char const * oldstr, string const & newstr);
 162
 163 /// substitutes all instances ofr oldstr with newstr
 164 string const subst(string const & a,
 165                    string const & oldstr, string const & newstr);
 166
 167 /** Strips characters off the end of a string.
 168   #"abccc".strip('c') = "ab".#
 169   */
 170 string const strip(string const & a, char c = ' ');
 171
 172 /** Strips characters of the beginning of a string.
 173   #"cccba".frontstrip('c') = "ba"#. */
 174 string const frontStrip(string const & a, char c = ' ');
 175
 176 /** Strips characters off the beginning of a string.
 177     #"ababcdef".frontstrip("ab") = "cdef"# .*/
 178 string const frontStrip(string const & a, char const * p);
 179
 180 /** Splits the string by the first delim.
 181   Splits the string by the first appearance of delim.
 182   The leading string up to delim is returned in piece (not including
 183   delim), while the original string is cut from after the delimiter.
 184   Example:
 185   #s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";#
 186   */
 187 string const split(string const & a, string & piece, char delim);
 188
 189 /// Same as split but does not return a piece
 190 string const split(string const & a, char delim);
 191
 192 /// Same as split but uses the last delim.
 193 string const rsplit(string const & a, string & piece, char delim);
 194
 195 #endif