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