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