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 "support/docstring.h"
  20
  21 #include <vector>
  22
  23
  24 namespace lyx {
  25 namespace support {
  26
  27 /// Compare \p s and \p s2, ignoring the case.
  28 /// Does not depend on the locale.
  29 int compare_no_case(docstring const & s, docstring const & s2);
  30
  31 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
  32 int compare_ascii_no_case(std::string const & s, std::string const & s2);
  33
  34 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
  35 int compare_ascii_no_case(docstring const & s, docstring const & s2);
  36
  37 ///
  38 inline
  39 int compare(char const * a, char const * b)
  40 {
  41 #ifndef CXX_GLOBAL_CSTD
  42         return std::strcmp(a, b);
  43 #else
  44         return strcmp(a, b);
  45 #endif
  46 }
  47
  48 ///
  49 inline
  50 int compare(char const * a, char const * b, unsigned int len)
  51 {
  52 #ifndef CXX_GLOBAL_CSTD
  53         return std::strncmp(a, b, len);
  54 #else
  55         return strncmp(a, b, len);
  56 #endif
  57 }
  58
  59 ///
  60 bool isStrInt(std::string const & str);
  61
  62 /// does the std::string represent an unsigned integer value ?
  63 bool isStrUnsignedInt(std::string const & str);
  64
  65 ///
  66 bool isStrDbl(std::string const & str);
  67
  68 bool isHex(lyx::docstring const & str);
  69
  70 int hexToInt(lyx::docstring const & str);
  71
  72 /// is \p str pure ascii?
  73 bool isAscii(docstring const & str);
  74
  75 /// Changes the case of \p c to lowercase.
  76 /// Caution: Depends on the locale
  77 char lowercase(char c);
  78
  79 /// Changes the case of \p c to uppercase.
  80 /// Caution: Depends on the locale
  81 char uppercase(char c);
  82
  83 /// Changes the case of \p c to lowercase.
  84 /// Does not depend on the locale.
  85 char_type lowercase(char_type c);
  86
  87 /// Changes the case of \p c to uppercase.
  88 /// Does not depend on the locale.
  89 char_type uppercase(char_type c);
  90
  91 /// same as lowercase(), but ignores locale
  92 std::string const ascii_lowercase(std::string const &);
  93 docstring const ascii_lowercase(docstring const &);
  94
  95 /// Changes the case of \p s to lowercase.
  96 /// Does not depend on the locale.
  97 docstring const lowercase(docstring const & s);
  98
  99 /// Changes the case of \p s to uppercase.
 100 /// Does not depend on the locale.
 101 docstring const uppercase(docstring const & s);
 102
 103 /// Does the string start with this prefix?
 104 bool prefixIs(docstring const &, char_type);
 105
 106 /// Does the std::string start with this prefix?
 107 bool prefixIs(std::string const &, std::string const &);
 108 bool prefixIs(docstring const &, docstring const &);
 109
 110 /// Does the string end with this char?
 111 bool suffixIs(std::string const &, char);
 112 bool suffixIs(docstring const &, char_type);
 113
 114 /// Does the std::string end with this suffix?
 115 bool suffixIs(std::string const &, std::string const &);
 116
 117 ///
 118 inline bool contains(std::string const & a, std::string const & b)
 119 {
 120         return a.find(b) != std::string::npos;
 121 }
 122
 123 inline bool contains(docstring const & a, docstring const & b)
 124 {
 125         return a.find(b) != docstring::npos;
 126 }
 127
 128 inline bool contains(std::string const & a, char b)
 129 {
 130         return a.find(b) != std::string::npos;
 131 }
 132
 133 inline bool contains(docstring const & a, char_type b)
 134 {
 135         return a.find(b) != docstring::npos;
 136 }
 137
 138 ///
 139 bool containsOnly(std::string const &, std::string const &);
 140
 141 /** Extracts a token from this string at the nth delim.
 142     Doesn't modify the original string. Similar to strtok.
 143     Example:
 144     \code
 145     token("a;bc;d", ';', 1) == "bc";
 146     token("a;bc;d", ';', 2) == "d";
 147     \endcode
 148 */
 149 std::string const token(std::string const & a, char delim, int n);
 150
 151 docstring const token(docstring const & a, char_type delim, int n);
 152
 153 /** Search a token in this string using the delim.
 154     Doesn't modify the original string. Returns -1 in case of
 155     failure.
 156     Example:
 157     \code
 158     tokenPos("a;bc;d", ';', "bc") == 1;
 159     tokenPos("a;bc;d", ';', "d") == 2;
 160     \endcode
 161 */
 162 int tokenPos(std::string const & a, char delim, std::string const & tok);
 163
 164
 165 /// Substitute all \a oldchar with \a newchar
 166 std::string const subst(std::string const & a, char oldchar, char newchar);
 167
 168 /// Substitute all \a oldchar with \a newchar
 169 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
 170
 171 /// substitutes all instances of \a oldstr with \a newstr
 172 std::string const subst(std::string const & a,
 173                    std::string const & oldstr, std::string const & newstr);
 174
 175 /// substitutes all instances of \a oldstr with \a newstr
 176 docstring const subst(docstring const & a,
 177                 docstring const & oldstr, docstring const & newstr);
 178
 179 /** Trims characters off the end and beginning of a string.
 180     \code
 181     trim("ccabccc", "c") == "ab".
 182     \endcode
 183 */
 184 docstring const trim(docstring const & a, char const * p = " ");
 185
 186 /** Trims characters off the end and beginning of a string.
 187     \code
 188     trim("ccabccc", "c") == "ab".
 189     \endcode
 190 */
 191 std::string const trim(std::string const & a, char const * p = " ");
 192
 193 /** Trims characters off the end of a string.
 194     \code
 195     rtrim("abccc", "c") == "ab".
 196     \endcode
 197 */
 198 std::string const rtrim(std::string const & a, char const * p = " ");
 199 docstring const rtrim(docstring const & a, char const * p = " ");
 200
 201 /** Trims characters off the beginning of a string.
 202     \code
 203    ("ababcdef", "ab") = "cdef"
 204     \endcode
 205 */
 206 std::string const ltrim(std::string const & a, char const * p = " ");
 207 docstring const ltrim(docstring const & a, char const * p = " ");
 208
 209 /** Splits the string by the first delim.
 210     Splits the string by the first appearance of delim.
 211     The leading string up to delim is returned in piece (not including
 212     delim), while the original string is cut from after the delimiter.
 213     Example:
 214     \code
 215     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
 216     \endcode
 217 */
 218 std::string const split(std::string const & a, std::string & piece, char delim);
 219 docstring const split(docstring const & a, docstring & piece, char_type delim);
 220
 221 /// Same as split but does not return a piece
 222 std::string const split(std::string const & a, char delim);
 223
 224 /// Same as split but uses the last delim.
 225 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 226
 227 /// Escapes non ASCII chars and other problematic characters that cause
 228 /// problems in latex labels.
 229 docstring const escape(docstring const & lab);
 230
 231 /// gives a vector of stringparts which have the delimiter delim
 232 std::vector<std::string> const getVectorFromString(std::string const & str,
 233                                               std::string const & delim = std::string(","));
 234 std::vector<docstring> const getVectorFromString(docstring const & str,
 235                 docstring const & delim = from_ascii(","));
 236
 237 // the same vice versa
 238 std::string const getStringFromVector(std::vector<std::string> const & vec,
 239                                  std::string const & delim = std::string(","));
 240
 241 /// Search \p search_token in \p str and return the position if it is
 242 /// found, else -1. The last item in \p str must be "".
 243 int findToken(char const * const str[], std::string const & search_token);
 244
 245 /// Convert internal line endings to line endings as expected by the OS
 246 docstring const externalLineEnding(docstring const & str);
 247
 248 /// Convert line endings in any formnat to internal line endings
 249 docstring const internalLineEnding(docstring const & str);
 250
 251
 252 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
 253
 254 #include <boost/format.hpp>
 255
 256 template<class Arg1>
 257 docstring bformat(docstring const & fmt, Arg1 arg1)
 258 {
 259         return (boost::basic_format<char_type>(fmt) % arg1).str();
 260 }
 261
 262
 263 template<class Arg1, class Arg2>
 264 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
 265 {
 266         return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
 267 }
 268
 269
 270 template<class Arg1, class Arg2, class Arg3>
 271 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
 272 {
 273         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
 274 }
 275
 276
 277 template<class Arg1, class Arg2, class Arg3, class Arg4>
 278 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
 279 {
 280         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
 281 }
 282
 283 #else
 284
 285 template <class Arg1>
 286 docstring bformat(docstring const & fmt, Arg1);
 287
 288 template <class Arg1, class Arg2>
 289 docstring bformat(docstring const & fmt, Arg1, Arg2);
 290
 291 template <class Arg1, class Arg2, class Arg3>
 292 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
 293
 294 template <class Arg1, class Arg2, class Arg3, class Arg4>
 295 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
 296
 297 #endif
 298
 299 } // namespace support
 300 } // namespace lyx
 301
 302 #endif