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