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 inline
  84 string const tostr(bool b)
  85 {
  86         return (b ? "true" : "false");
  87 }
  88
  89 /// Does the string start with this prefix?
  90 bool prefixIs(string const &, char const *);
  91
  92 /// Does the string end with this char?
  93 bool suffixIs(string const &, char);
  94
  95 /// Does the string end with this suffix?
  96 bool suffixIs(string const &, char const *);
  97
  98 ///
  99 bool contains(char const * a, string const & b);
 100
 101 ///
 102 bool contains(string const & a, char const * b);
 103
 104 ///
 105 bool contains(string const & a, string const & b);
 106
 107 ///
 108 bool contains(char const * a, char const * b);
 109
 110 ///
 111 bool containsOnly(string const &, char const *);
 112
 113 ///
 114 bool containsOnly(string const &, string const &);
 115
 116 ///
 117 bool containsOnly(char const *, char const *);
 118
 119 ///
 120 bool containsOnly(char const *, string const &);
 121
 122 /// Counts how many of character c there is in a
 123 unsigned int countChar(string const & a, char c);
 124
 125 /** Extracts a token from this string at the nth delim.
 126   Doesn't modify the original string. Similar to strtok.
 127   Example:
 128   #"a;bc;d".token(';', 1) == "bc";#
 129   #"a;bc;d".token(';', 2) == "d";#
 130 */
 131 string const token(string const & a, char delim, int n);
 132
 133
 134 /** Search a token in this string using the delim.
 135   Doesn't modify the original string. Returns -1 in case of
 136   failure.
 137   Example:
 138   #"a;bc;d".tokenPos(';', "bc") == 1;#
 139   #"a;bc;d".token(';', "d") == 2;#
 140 */
 141 int tokenPos(string const & a, char delim, string const & tok);
 142
 143
 144 /** Compares a string and a (simple) regular expression
 145   The only element allowed is "*" for any string of characters
 146   */
 147 bool regexMatch(string const & a, string const & pattern);
 148
 149 /// Substitute all "oldchar"s with "newchar"
 150 string const subst(string const & a, char oldchar, char newchar);
 151
 152 /// Substitutes all instances of oldstr with newstr
 153 string const subst(string const & a,
 154              char const * oldstr, string const & newstr);
 155
 156 /** Strips characters off the end of a string.
 157   #"abccc".strip('c') = "ab".#
 158   */
 159 string const strip(string const & a, char c = ' ');
 160
 161 /** Strips characters of the beginning of a string.
 162   #"cccba".frontstrip('c') = "ba"#. */
 163 string const frontStrip(string const & a, char c = ' ');
 164
 165 /** Strips characters off the beginning of a string.
 166     #"ababcdef".frontstrip("ab") = "cdef"# .*/
 167 string const frontStrip(string const & a, char const * p);
 168
 169 /** Splits the string by the first delim.
 170   Splits the string by the first appearance of delim.
 171   The leading string up to delim is returned in piece (not including
 172   delim), while the original string is cut from after the delimiter.
 173   Example:
 174   #s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";#
 175   */
 176 string const split(string const & a, string & piece, char delim);
 177
 178 /// Same as split but does not return a piece
 179 string const split(string const & a, char delim);
 180
 181 /// Same as split but uses the last delim.
 182 string const rsplit(string const & a, string & piece, char delim);
 183
 184 #endif