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 std::string end with this suffix?
 107 bool suffixIs(std::string const &, std::string const &);
 108
 109 ///
 110 inline bool contains(std::string const & a, std::string const & b)
 111 {
 112         return a.find(b) != std::string::npos;
 113 }
 114
 115 inline bool contains(docstring const & a, docstring const & b)
 116 {
 117         return a.find(b) != docstring::npos;
 118 }
 119
 120 inline bool contains(std::string const & a, char b)
 121 {
 122         return a.find(b) != std::string::npos;
 123 }
 124
 125 inline bool contains(docstring const & a, char_type b)
 126 {
 127         return a.find(b) != docstring::npos;
 128 }
 129
 130 ///
 131 bool containsOnly(std::string const &, std::string const &);
 132
 133 /** Extracts a token from this string at the nth delim.
 134     Doesn't modify the original string. Similar to strtok.
 135     Example:
 136     \code
 137     token("a;bc;d", ';', 1) == "bc";
 138     token("a;bc;d", ';', 2) == "d";
 139     \endcode
 140 */
 141 std::string const token(std::string const & a, char delim, int n);
 142
 143 docstring const token(docstring const & a, char_type delim, int n);
 144
 145 /** Search a token in this string using the delim.
 146     Doesn't modify the original string. Returns -1 in case of
 147     failure.
 148     Example:
 149     \code
 150     tokenPos("a;bc;d", ';', "bc") == 1;
 151     tokenPos("a;bc;d", ';', "d") == 2;
 152     \endcode
 153 */
 154 int tokenPos(std::string const & a, char delim, std::string const & tok);
 155 int tokenPos(docstring const & a, char_type delim, docstring const & tok);
 156
 157
 158 /// Substitute all \a oldchar with \a newchar
 159 std::string const subst(std::string const & a, char oldchar, char newchar);
 160
 161 /// Substitute all \a oldchar with \a newchar
 162 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
 163
 164 /// substitutes all instances of \a oldstr with \a newstr
 165 std::string const subst(std::string const & a,
 166                    std::string const & oldstr, std::string const & newstr);
 167
 168 /// substitutes all instances of \a oldstr with \a newstr
 169 docstring const subst(docstring const & a,
 170                 docstring const & oldstr, docstring const & newstr);
 171
 172 /** Trims characters off the end and beginning of a string.
 173     \code
 174     trim("ccabccc", "c") == "ab".
 175     \endcode
 176 */
 177 docstring const trim(docstring const & a, char const * p = " ");
 178
 179 /** Trims characters off the end and beginning of a string.
 180     \code
 181     trim("ccabccc", "c") == "ab".
 182     \endcode
 183 */
 184 std::string const trim(std::string const & a, char const * p = " ");
 185
 186 /** Trims characters off the end of a string.
 187     \code
 188     rtrim("abccc", "c") == "ab".
 189     \endcode
 190 */
 191 std::string const rtrim(std::string const & a, char const * p = " ");
 192 docstring const rtrim(docstring const & a, char const * p = " ");
 193
 194 /** Trims characters off the beginning of a string.
 195     \code
 196    ("ababcdef", "ab") = "cdef"
 197     \endcode
 198 */
 199 std::string const ltrim(std::string const & a, char const * p = " ");
 200 docstring const ltrim(docstring const & a, char const * p = " ");
 201
 202 /** Splits the string given in the first argument at the first occurence
 203     of the third argumnent, delim.
 204     What precedes delim is returned in the second argument, piece; this
 205     will be the whole of the string if no delimiter is found.
 206     The return value is what follows delim, if anything. So the return
 207     value is the null string if no delimiter is found.
 208     Examples:
 209     \code
 210     s1= "a;bc"; s2= ""
 211     ret = split(s1, s2, ';') -> ret = "bc", s2 == "a"
 212     \endcode
 213  */
 214 std::string const split(std::string const & a, std::string & piece, char delim);
 215 docstring const split(docstring const & a, docstring & piece, char_type delim);
 216
 217 /// Same as split but does not return a piece
 218 std::string const split(std::string const & a, char delim);
 219
 220 /// Same as split but uses the last delim.
 221 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 222
 223 /// Escapes non ASCII chars and other problematic characters that cause
 224 /// problems in latex labels.
 225 docstring const escape(docstring const & lab);
 226
 227 /// gives a vector of stringparts which have the delimiter delim
 228 /// If \p keepempty is true, empty strings will be pushed to the vector as well
 229 std::vector<std::string> const getVectorFromString(std::string const & str,
 230                                               std::string const & delim = std::string(","),
 231                                               bool keepempty = false);
 232 std::vector<docstring> const getVectorFromString(docstring const & str,
 233                 docstring const & delim = from_ascii(","), bool keepempty = false);
 234
 235 // the same vice versa
 236 std::string const getStringFromVector(std::vector<std::string> const & vec,
 237                                  std::string const & delim = std::string(","));
 238
 239 /// Search \p search_token in \p str and return the position if it is
 240 /// found, else -1. The last item in \p str must be "".
 241 int findToken(char const * const str[], std::string const & search_token);
 242
 243 /// Convert internal line endings to line endings as expected by the OS
 244 docstring const externalLineEnding(docstring const & str);
 245
 246 /// Convert line endings in any formnat to internal line endings
 247 docstring const internalLineEnding(docstring const & str);
 248
 249
 250 template <class Arg1>
 251 docstring bformat(docstring const & fmt, Arg1);
 252
 253 template <class Arg1, class Arg2>
 254 docstring bformat(docstring const & fmt, Arg1, Arg2);
 255
 256 template <class Arg1, class Arg2, class Arg3>
 257 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
 258
 259 template <class Arg1, class Arg2, class Arg3, class Arg4>
 260 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
 261
 262
 263 template<> docstring bformat(docstring const & fmt, int arg1);
 264 template<> docstring bformat(docstring const & fmt, long arg1);
 265 template<> docstring bformat(docstring const & fmt, unsigned int arg1);
 266 template<> docstring bformat(docstring const & fmt, docstring arg1);
 267 template<> docstring bformat(docstring const & fmt, char * arg1);
 268 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2);
 269 template<> docstring bformat(docstring const & fmt, char const * arg1, docstring arg2);
 270 template<> docstring bformat(docstring const & fmt, int arg1, int arg2);
 271 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3);
 272 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3, docstring arg4);
 273
 274
 275 } // namespace support
 276 } // namespace lyx
 277
 278 #endif