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