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