src/support/lstrings.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lstrings.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  *
  12  * A collection of string helper functions that works with string.
  13  * Some of these would certainly benefit from a rewrite/optimization.
  14  */
  15
  16 #ifndef LSTRINGS_H
  17 #define LSTRINGS_H
  18
  19 #include <vector>
  20 #include <string>
  21
  22
  23 namespace lyx {
  24 namespace support {
  25
  26 ///
  27 int compare_no_case(std::string const & s, std::string const & s2);
  28
  29 ///
  30 int compare_ascii_no_case(std::string const & s, std::string const & s2);
  31
  32 ///
  33 int compare_no_case(std::string const & s, std::string const & s2, unsigned int len);
  34
  35 ///
  36 inline
  37 int compare(char const * a, char const * b)
  38 {
  39 #ifndef CXX_GLOBAL_CSTD
  40         return std::strcmp(a, b);
  41 #else
  42         return strcmp(a, b);
  43 #endif
  44 }
  45
  46 ///
  47 inline
  48 int compare(char const * a, char const * b, unsigned int len)
  49 {
  50 #ifndef CXX_GLOBAL_CSTD
  51         return std::strncmp(a, b, len);
  52 #else
  53         return strncmp(a, b, len);
  54 #endif
  55 }
  56
  57 ///
  58 bool isStrInt(std::string const & str);
  59
  60 /// does the std::string represent an unsigned integer value ?
  61 bool isStrUnsignedInt(std::string const & str);
  62
  63 ///
  64 int strToInt(std::string const & str);
  65
  66 /// convert string to an unsigned integer
  67 unsigned int strToUnsignedInt(std::string const & str);
  68
  69 ///
  70 bool isStrDbl(std::string const & str);
  71
  72 ///
  73 double strToDbl(std::string const & str);
  74
  75 ///
  76 char lowercase(char c);
  77
  78 ///
  79 char uppercase(char c);
  80
  81 /// same as lowercase(), but ignores locale
  82 std::string const ascii_lowercase(std::string const &);
  83
  84 ///
  85 std::string const lowercase(std::string const &);
  86
  87 ///
  88 std::string const uppercase(std::string const &);
  89
  90 /// Does the std::string start with this prefix?
  91 bool prefixIs(std::string const &, std::string const &);
  92
  93 /// Does the string end with this char?
  94 bool suffixIs(std::string const &, char);
  95
  96 /// Does the std::string end with this suffix?
  97 bool suffixIs(std::string const &, std::string const &);
  98
  99 ///
 100 bool contains(std::string const & a, std::string const & b);
 101
 102 ///
 103 bool contains(std::string const & a, char b);
 104
 105 /// This should probably we rewritten to be more general.
 106 struct contains_functor
 107         : public std::binary_function<std::string, std::string, bool>
 108 {
 109         bool operator()(std::string const & haystack,
 110                         std::string const & needle) const
 111         {
 112                 return contains(haystack, needle);
 113         }
 114 };
 115
 116
 117 ///
 118 bool containsOnly(std::string const &, std::string const &);
 119
 120 /** Extracts a token from this string at the nth delim.
 121     Doesn't modify the original string. Similar to strtok.
 122     Example:
 123     \code
 124     token("a;bc;d", ';', 1) == "bc";
 125     token("a;bc;d", ';', 2) == "d";
 126     \endcode
 127 */
 128 std::string const token(std::string const & a, char delim, int n);
 129
 130
 131 /** Search a token in this string using the delim.
 132     Doesn't modify the original string. Returns -1 in case of
 133     failure.
 134     Example:
 135     \code
 136     tokenPos("a;bc;d", ';', "bc") == 1;
 137     tokenPos("a;bc;d", ';', "d") == 2;
 138     \endcode
 139 */
 140 int tokenPos(std::string const & a, char delim, std::string const & tok);
 141
 142
 143 /// Substitute all \a oldchar with \a newchar
 144 std::string const subst(std::string const & a, char oldchar, char newchar);
 145
 146 /// substitutes all instances of \a oldstr with \a newstr
 147 std::string const subst(std::string const & a,
 148                    std::string const & oldstr, std::string const & newstr);
 149
 150 /** Trims characters off the end and beginning of a string.
 151     \code
 152     trim("ccabccc", "c") == "ab".
 153     \endcode
 154 */
 155 std::string const trim(std::string const & a, char const * p = " ");
 156
 157 /** Trims characters off the end of a string.
 158     \code
 159     rtrim("abccc", "c") == "ab".
 160     \endcode
 161 */
 162 std::string const rtrim(std::string const & a, char const * p = " ");
 163
 164 /** Trims characters off the beginning of a string.
 165     \code
 166    ltrim("ababcdef", "ab") = "cdef"
 167     \endcode
 168 */
 169 std::string const ltrim(std::string const & a, char const * p = " ");
 170
 171 /** Splits the string by the first delim.
 172     Splits the string by the first appearance of delim.
 173     The leading string up to delim is returned in piece (not including
 174     delim), while the original string is cut from after the delimiter.
 175     Example:
 176     \code
 177     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
 178     \endcode
 179 */
 180 std::string const split(std::string const & a, std::string & piece, char delim);
 181
 182 /// Same as split but does not return a piece
 183 std::string const split(std::string const & a, char delim);
 184
 185 /// Same as split but uses the last delim.
 186 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 187
 188 /// Escapes non ASCII chars
 189 std::string const escape(std::string const & lab);
 190
 191 /// gives a vector of stringparts which have the delimiter delim
 192 std::vector<std::string> const getVectorFromString(std::string const & str,
 193                                               std::string const & delim = std::string(","));
 194
 195 // the same vice versa
 196 std::string const getStringFromVector(std::vector<std::string> const & vec,
 197                                  std::string const & delim = std::string(","));
 198
 199 // wrapper around boost::format using one argument %1$s
 200 std::string bformat(std::string const & fmt, std::string const & arg1);
 201 // arguments %1$s and %2$s
 202 std::string bformat(std::string const & fmt, std::string const & arg1, std::string const & arg2);
 203 // arguments %1$d and %2$d
 204 std::string bformat(std::string const & fmt, int arg1, int arg2);
 205 // arguments %1$s and %2$s and %3$s
 206 std::string bformat(std::string const & fmt, std::string const & arg1, std::string const & arg2,
 207                std::string const & arg3);
 208 // arguments %1$s and %2$s and %3$s and %4$s
 209 std::string bformat(std::string const & fmt, std::string const & arg1, std::string const & arg2,
 210                std::string const & arg3, std::string const & arg4);
 211
 212 } // namespace support
 213 } // namespace lyx
 214
 215 #endif