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 <string>
  22 #include <vector>
  23
  24
  25 namespace lyx {
  26 namespace support {
  27
  28 /// Compare \p s and \p s2, ignoring the case.
  29 /// Does not depend on the locale.
  30 int compare_no_case(docstring const & s, docstring const & s2);
  31
  32 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
  33 int compare_ascii_no_case(std::string const & s, std::string const & s2);
  34
  35 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
  36 int compare_ascii_no_case(docstring const & s, docstring const & s2);
  37
  38 ///
  39 bool isStrInt(std::string const & str);
  40
  41 /// does the std::string represent an unsigned integer value ?
  42 bool isStrUnsignedInt(std::string const & str);
  43
  44 ///
  45 bool isStrDbl(std::string const & str);
  46
  47 /// does the string contain a digit?
  48 bool hasDigit(docstring const & str);
  49
  50 bool isHex(docstring const & str);
  51
  52 int hexToInt(docstring const & str);
  53
  54 /// is \p str pure ascii?
  55 bool isAscii(docstring const & str);
  56
  57 /// is \p str pure ascii?
  58 bool isAscii(std::string const & str);
  59
  60 /**
  61  * Changes the case of \p c to lowercase.
  62  * Don't use this for non-ASCII characters, since it depends on the locale.
  63  * This overloaded function is only implemented because the char_type variant
  64  * would be used otherwise, and we assert in this function that \p c is in
  65  * the ASCII range.
  66  */
  67 char lowercase(char c);
  68
  69 /**
  70  * Changes the case of \p c to uppercase.
  71  * Don't use this for non-ASCII characters, since it depends on the locale.
  72  * This overloaded function is only implemented because the char_type variant
  73  * would be used otherwise, and we assert in this function that \p c is in
  74  * the ASCII range.
  75  */
  76 char uppercase(char c);
  77
  78 /// Changes the case of \p c to lowercase.
  79 /// Does not depend on the locale.
  80 char_type lowercase(char_type c);
  81
  82 /// Changes the case of \p c to uppercase.
  83 /// Does not depend on the locale.
  84 char_type uppercase(char_type c);
  85
  86 /// same as lowercase(), but ignores locale
  87 std::string const ascii_lowercase(std::string const &);
  88 docstring const ascii_lowercase(docstring const &);
  89
  90 /// Changes the case of \p s to lowercase.
  91 /// Does not depend on the locale.
  92 docstring const lowercase(docstring const & s);
  93
  94 /// Changes the case of \p s to uppercase.
  95 /// Does not depend on the locale.
  96 docstring const uppercase(docstring const & s);
  97
  98 /// Does str start with c?
  99 bool prefixIs(docstring const & str, char_type c);
 100
 101 /// Does str start with pre?
 102 bool prefixIs(std::string const & str, std::string const & pre);
 103 bool prefixIs(docstring const & str, docstring const & pre);
 104
 105 /// Does the string end with this char?
 106 bool suffixIs(std::string const &, char);
 107 bool suffixIs(docstring const &, char_type);
 108
 109 /// Does the string end with this suffix?
 110 bool suffixIs(std::string const &, std::string const &);
 111 bool suffixIs(docstring const &, docstring const &);
 112
 113 /// Is b contained in a?
 114 inline bool contains(std::string const & a, std::string const & b)
 115 {
 116         return a.find(b) != std::string::npos;
 117 }
 118
 119 inline bool contains(docstring const & a, docstring const & b)
 120 {
 121         return a.find(b) != docstring::npos;
 122 }
 123
 124 inline bool contains(std::string const & a, char b)
 125 {
 126         return a.find(b) != std::string::npos;
 127 }
 128
 129 inline bool contains(docstring const & a, char_type b)
 130 {
 131         return a.find(b) != docstring::npos;
 132 }
 133
 134 ///
 135 bool containsOnly(std::string const &, std::string const &);
 136
 137 /** Extracts a token from this string at the nth delim.
 138     Doesn't modify the original string. Similar to strtok.
 139     Example:
 140     \code
 141     token("a;bc;d", ';', 1) == "bc";
 142     token("a;bc;d", ';', 2) == "d";
 143     \endcode
 144 */
 145 std::string const token(std::string const & a, char delim, int n);
 146
 147 docstring const token(docstring const & a, char_type delim, int n);
 148
 149 /** Search a token in this string using the delim.
 150     Doesn't modify the original string. Returns -1 in case of
 151     failure.
 152     Example:
 153     \code
 154     tokenPos("a;bc;d", ';', "bc") == 1;
 155     tokenPos("a;bc;d", ';', "d") == 2;
 156     \endcode
 157 */
 158 int tokenPos(std::string const & a, char delim, std::string const & tok);
 159 int tokenPos(docstring const & a, char_type delim, docstring const & tok);
 160
 161
 162 /// Substitute all \a oldchar with \a newchar
 163 std::string const subst(std::string const & a, char oldchar, char newchar);
 164
 165 /// Substitute all \a oldchar with \a newchar
 166 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
 167
 168 /// substitutes all instances of \a oldstr with \a newstr
 169 std::string const subst(std::string const & a,
 170                    std::string const & oldstr, std::string const & newstr);
 171
 172 /// substitutes all instances of \a oldstr with \a newstr
 173 docstring const subst(docstring const & a,
 174                 docstring const & oldstr, docstring const & newstr);
 175
 176 /** Trims characters off the end and beginning of a string.
 177     \code
 178     trim("ccabccc", "c") == "ab".
 179     \endcode
 180 */
 181 docstring const trim(docstring const & a, char const * p = " ");
 182
 183 /** Trims characters off the end and beginning of a string.
 184     \code
 185     trim("ccabccc", "c") == "ab".
 186     \endcode
 187 */
 188 std::string const trim(std::string const & a, char const * p = " ");
 189
 190 /** Trims characters off the end of a string, removing any character
 191     in p.
 192     \code
 193     rtrim("abcde", "dec") == "ab".
 194     \endcode
 195 */
 196 std::string const rtrim(std::string const & a, char const * p = " ");
 197 docstring const rtrim(docstring const & a, char const * p = " ");
 198
 199 /** Trims characters off the beginning of a string.
 200     \code
 201    ("abbabcdef", "ab") = "cdef"
 202     \endcode
 203 */
 204 std::string const ltrim(std::string const & a, char const * p = " ");
 205 docstring const ltrim(docstring const & a, char const * p = " ");
 206
 207 /** Splits the string given in the first argument at the first occurence
 208     of the third argument, delim.
 209     What precedes delim is returned in the second argument, piece; this
 210     will be the whole of the string if no delimiter is found.
 211     The return value is what follows delim, if anything. So the return
 212     value is the null string if no delimiter is found.
 213     Examples:
 214     \code
 215     s1= "a;bc"; s2= ""
 216     ret = split(s1, s2, ';') -> ret = "bc", s2 == "a"
 217     \endcode
 218  */
 219 std::string const split(std::string const & a, std::string & piece, char delim);
 220 docstring const split(docstring const & a, docstring & piece, char_type delim);
 221
 222 /// Same as split but does not return a piece
 223 std::string const split(std::string const & a, char delim);
 224
 225 /// Same as split but uses the last delim.
 226 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 227 docstring const rsplit(docstring const & a, char_type delim);
 228
 229 /// Escapes non ASCII chars and other problematic characters that cause
 230 /// problems in latex labels.
 231 docstring const escape(docstring const & lab);
 232
 233 /// Word-wraps the provided docstring, returning a line-broken string
 234 /// of width no wider than width, with the string broken at spaces.
 235 /// If the string cannot be broken appropriately, it returns something
 236 /// with "..." at the end, again no wider than width.
 237 /// We assume here that str does not contain newlines.
 238 /// If indent is positive, then the first line is indented that many
 239 /// spaces. If it is negative, then successive lines are indented, as
 240 /// if the first line were "outdented".
 241 docstring wrap(docstring const & str, int const indent = 0,
 242                size_t const width = 80);
 243
 244 /// Like the preceding, except it is intended to operate on strings
 245 /// that may contain embedded newlines.
 246 /// \param numlines Don't return more than numlines lines. If numlines
 247 ///    is 0, we return everything.
 248 docstring wrapParas(docstring const & str, int const indent = 0,
 249                     size_t const width = 80, size_t const maxlines = 10);
 250
 251 /// gives a vector of stringparts which have the delimiter delim
 252 /// If \p keepempty is true, empty strings will be pushed to the vector as well
 253 std::vector<std::string> const getVectorFromString(std::string const & str,
 254                                               std::string const & delim = std::string(","),
 255                                               bool keepempty = false);
 256 std::vector<docstring> const getVectorFromString(docstring const & str,
 257                 docstring const & delim = from_ascii(","), bool keepempty = false);
 258
 259 /// the same vice versa
 260 std::string const getStringFromVector(std::vector<std::string> const & vec,
 261                                  std::string const & delim = std::string(","));
 262 docstring const getStringFromVector(std::vector<docstring> const & vec,
 263                                  docstring const & delim = from_ascii(","));
 264
 265 /// Search \p search_token in \p str and return the position if it is
 266 /// found, else -1. The last item in \p str must be "".
 267 int findToken(char const * const str[], std::string const & search_token);
 268
 269 template <class Arg1>
 270 docstring bformat(docstring const & fmt, Arg1);
 271
 272 template <class Arg1, class Arg2>
 273 docstring bformat(docstring const & fmt, Arg1, Arg2);
 274
 275 template <class Arg1, class Arg2, class Arg3>
 276 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
 277
 278 template <class Arg1, class Arg2, class Arg3, class Arg4>
 279 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
 280
 281
 282 template<> docstring bformat(docstring const & fmt, int arg1);
 283 template<> docstring bformat(docstring const & fmt, long arg1);
 284 template<> docstring bformat(docstring const & fmt, unsigned int arg1);
 285 template<> docstring bformat(docstring const & fmt, docstring arg1);
 286 template<> docstring bformat(docstring const & fmt, char * arg1);
 287 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2);
 288 template<> docstring bformat(docstring const & fmt, docstring arg1, int arg2);
 289 template<> docstring bformat(docstring const & fmt, char const * arg1, docstring arg2);
 290 template<> docstring bformat(docstring const & fmt, int arg1, int arg2);
 291 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3);
 292 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3, docstring arg4);
 293
 294
 295 } // namespace support
 296 } // namespace lyx
 297
 298 #endif