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