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 template <typename B>
 101 bool contains(std::string const & a, B b)
 102 {
 103         return a.find(b) != std::string::npos;
 104 }
 105
 106 ///
 107 bool containsOnly(std::string const &, std::string const &);
 108
 109 /** Extracts a token from this string at the nth delim.
 110     Doesn't modify the original string. Similar to strtok.
 111     Example:
 112     \code
 113     token("a;bc;d", ';', 1) == "bc";
 114     token("a;bc;d", ';', 2) == "d";
 115     \endcode
 116 */
 117 std::string const token(std::string const & a, char delim, int n);
 118
 119
 120 /** Search a token in this string using the delim.
 121     Doesn't modify the original string. Returns -1 in case of
 122     failure.
 123     Example:
 124     \code
 125     tokenPos("a;bc;d", ';', "bc") == 1;
 126     tokenPos("a;bc;d", ';', "d") == 2;
 127     \endcode
 128 */
 129 int tokenPos(std::string const & a, char delim, std::string const & tok);
 130
 131
 132 /// Substitute all \a oldchar with \a newchar
 133 std::string const subst(std::string const & a, char oldchar, char newchar);
 134
 135 /// substitutes all instances of \a oldstr with \a newstr
 136 std::string const subst(std::string const & a,
 137                    std::string const & oldstr, std::string const & newstr);
 138
 139 /** Trims characters off the end and beginning of a string.
 140     \code
 141     trim("ccabccc", "c") == "ab".
 142     \endcode
 143 */
 144 std::string const trim(std::string const & a, char const * p = " ");
 145
 146 /** Trims characters off the end of a string.
 147     \code
 148     rtrim("abccc", "c") == "ab".
 149     \endcode
 150 */
 151 std::string const rtrim(std::string const & a, char const * p = " ");
 152
 153 /** Trims characters off the beginning of a string.
 154     \code
 155    ltrim("ababcdef", "ab") = "cdef"
 156     \endcode
 157 */
 158 std::string const ltrim(std::string const & a, char const * p = " ");
 159
 160 /** Splits the string by the first delim.
 161     Splits the string by the first appearance of delim.
 162     The leading string up to delim is returned in piece (not including
 163     delim), while the original string is cut from after the delimiter.
 164     Example:
 165     \code
 166     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
 167     \endcode
 168 */
 169 std::string const split(std::string const & a, std::string & piece, char delim);
 170
 171 /// Same as split but does not return a piece
 172 std::string const split(std::string const & a, char delim);
 173
 174 /// Same as split but uses the last delim.
 175 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 176
 177 /// Escapes non ASCII chars
 178 std::string const escape(std::string const & lab);
 179
 180 /// gives a vector of stringparts which have the delimiter delim
 181 std::vector<std::string> const getVectorFromString(std::string const & str,
 182                                               std::string const & delim = std::string(","));
 183
 184 // the same vice versa
 185 std::string const getStringFromVector(std::vector<std::string> const & vec,
 186                                  std::string const & delim = std::string(","));
 187
 188
 189 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
 190
 191 #include <boost/format.hpp>
 192
 193 template<class Arg1>
 194 string bformat(string const & fmt, Arg1 arg1)
 195 {
 196         return (boost::format(fmt) % arg1).str();
 197 }
 198
 199
 200 template<class Arg1, class Arg2>
 201 string bformat(string const & fmt, Arg1 arg1, Arg2 arg2)
 202 {
 203         return (boost::format(fmt) % arg1 % arg2).str();
 204 }
 205
 206
 207 template<class Arg1, class Arg2, class Arg3>
 208 string bformat(string const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
 209 {
 210         return (boost::format(fmt) % arg1 % arg2 % arg3).str();
 211 }
 212
 213
 214 template<class Arg1, class Arg2, class Arg3, class Arg4>
 215 string bformat(string const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
 216 {
 217         return (boost::format(fmt) % arg1 % arg2 % arg3 % arg4).str();
 218 }
 219
 220 #else
 221
 222 template <class Arg1>
 223 std::string bformat(std::string const & fmt, Arg1);
 224
 225 template <class Arg1, class Arg2>
 226 std::string bformat(std::string const & fmt, Arg1, Arg2);
 227
 228 template <class Arg1, class Arg2, class Arg3>
 229 std::string bformat(std::string const & fmt, Arg1, Arg2, Arg3);
 230
 231 template <class Arg1, class Arg2, class Arg3, class Arg4>
 232 std::string bformat(std::string const & fmt, Arg1, Arg2, Arg3, Arg4);
 233
 234 #endif
 235
 236 } // namespace support
 237 } // namespace lyx
 238
 239 #endif