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 inline
  39 int compare(char const * a, char const * b)
  40 {
  41 #ifndef CXX_GLOBAL_CSTD
  42         return std::strcmp(a, b);
  43 #else
  44         return strcmp(a, b);
  45 #endif
  46 }
  47
  48 ///
  49 inline
  50 int compare(char const * a, char const * b, unsigned int len)
  51 {
  52 #ifndef CXX_GLOBAL_CSTD
  53         return std::strncmp(a, b, len);
  54 #else
  55         return strncmp(a, b, len);
  56 #endif
  57 }
  58
  59 ///
  60 bool isStrInt(std::string const & str);
  61
  62 /// does the std::string represent an unsigned integer value ?
  63 bool isStrUnsignedInt(std::string const & str);
  64
  65 ///
  66 bool isStrDbl(std::string const & str);
  67
  68 bool isHex(lyx::docstring const & str);
  69
  70 int hexToInt(lyx::docstring const & str);
  71
  72 /// is \p str pure ascii?
  73 bool isAscii(docstring const & str);
  74
  75 /**
  76  * Changes the case of \p c to lowercase.
  77  * Don't use this for non-ASCII characters, since it depends on the locale.
  78  * This overloaded function is only implemented because the char_type variant
  79  * would be used otherwise, and we assert in this function that \p c is in
  80  * the ASCII range.
  81  */
  82 char lowercase(char c);
  83
  84 /**
  85  * Changes the case of \p c to uppercase.
  86  * Don't use this for non-ASCII characters, since it depends on the locale.
  87  * This overloaded function is only implemented because the char_type variant
  88  * would be used otherwise, and we assert in this function that \p c is in
  89  * the ASCII range.
  90  */
  91 char uppercase(char c);
  92
  93 /// Changes the case of \p c to lowercase.
  94 /// Does not depend on the locale.
  95 char_type lowercase(char_type c);
  96
  97 /// Changes the case of \p c to uppercase.
  98 /// Does not depend on the locale.
  99 char_type uppercase(char_type c);
 100
 101 /// same as lowercase(), but ignores locale
 102 std::string const ascii_lowercase(std::string const &);
 103 docstring const ascii_lowercase(docstring const &);
 104
 105 /// Changes the case of \p s to lowercase.
 106 /// Does not depend on the locale.
 107 docstring const lowercase(docstring const & s);
 108
 109 /// Changes the case of \p s to uppercase.
 110 /// Does not depend on the locale.
 111 docstring const uppercase(docstring const & s);
 112
 113 /// Does the string start with this prefix?
 114 bool prefixIs(docstring const &, char_type);
 115
 116 /// Does the std::string start with this prefix?
 117 bool prefixIs(std::string const &, std::string const &);
 118 bool prefixIs(docstring const &, docstring const &);
 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 std::string end with this suffix?
 125 bool suffixIs(std::string const &, std::string const &);
 126
 127 ///
 128 inline bool contains(std::string const & a, std::string const & b)
 129 {
 130         return a.find(b) != std::string::npos;
 131 }
 132
 133 inline bool contains(docstring const & a, docstring const & b)
 134 {
 135         return a.find(b) != docstring::npos;
 136 }
 137
 138 inline bool contains(std::string const & a, char b)
 139 {
 140         return a.find(b) != std::string::npos;
 141 }
 142
 143 inline bool contains(docstring const & a, char_type b)
 144 {
 145         return a.find(b) != docstring::npos;
 146 }
 147
 148 ///
 149 bool containsOnly(std::string const &, std::string const &);
 150
 151 /** Extracts a token from this string at the nth delim.
 152     Doesn't modify the original string. Similar to strtok.
 153     Example:
 154     \code
 155     token("a;bc;d", ';', 1) == "bc";
 156     token("a;bc;d", ';', 2) == "d";
 157     \endcode
 158 */
 159 std::string const token(std::string const & a, char delim, int n);
 160
 161 docstring const token(docstring const & a, char_type delim, int n);
 162
 163 /** Search a token in this string using the delim.
 164     Doesn't modify the original string. Returns -1 in case of
 165     failure.
 166     Example:
 167     \code
 168     tokenPos("a;bc;d", ';', "bc") == 1;
 169     tokenPos("a;bc;d", ';', "d") == 2;
 170     \endcode
 171 */
 172 int tokenPos(std::string const & a, char delim, std::string const & tok);
 173
 174
 175 /// Substitute all \a oldchar with \a newchar
 176 std::string const subst(std::string const & a, char oldchar, char newchar);
 177
 178 /// Substitute all \a oldchar with \a newchar
 179 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
 180
 181 /// substitutes all instances of \a oldstr with \a newstr
 182 std::string const subst(std::string const & a,
 183                    std::string const & oldstr, std::string const & newstr);
 184
 185 /// substitutes all instances of \a oldstr with \a newstr
 186 docstring const subst(docstring const & a,
 187                 docstring const & oldstr, docstring const & newstr);
 188
 189 /** Trims characters off the end and beginning of a string.
 190     \code
 191     trim("ccabccc", "c") == "ab".
 192     \endcode
 193 */
 194 docstring const trim(docstring const & a, char const * p = " ");
 195
 196 /** Trims characters off the end and beginning of a string.
 197     \code
 198     trim("ccabccc", "c") == "ab".
 199     \endcode
 200 */
 201 std::string const trim(std::string const & a, char const * p = " ");
 202
 203 /** Trims characters off the end of a string.
 204     \code
 205     rtrim("abccc", "c") == "ab".
 206     \endcode
 207 */
 208 std::string const rtrim(std::string const & a, char const * p = " ");
 209 docstring const rtrim(docstring const & a, char const * p = " ");
 210
 211 /** Trims characters off the beginning of a string.
 212     \code
 213    ("ababcdef", "ab") = "cdef"
 214     \endcode
 215 */
 216 std::string const ltrim(std::string const & a, char const * p = " ");
 217 docstring const ltrim(docstring const & a, char const * p = " ");
 218
 219 /** Splits the string by the first delim.
 220     Splits the string by the first appearance of delim.
 221     The leading string up to delim is returned in piece (not including
 222     delim), while the original string is cut from after the delimiter.
 223     Example:
 224     \code
 225     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
 226     \endcode
 227 */
 228 std::string const split(std::string const & a, std::string & piece, char delim);
 229 docstring const split(docstring const & a, docstring & piece, char_type delim);
 230
 231 /// Same as split but does not return a piece
 232 std::string const split(std::string const & a, char delim);
 233
 234 /// Same as split but uses the last delim.
 235 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 236
 237 /// Escapes non ASCII chars and other problematic characters that cause
 238 /// problems in latex labels.
 239 docstring const escape(docstring const & lab);
 240
 241 /// gives a vector of stringparts which have the delimiter delim
 242 std::vector<std::string> const getVectorFromString(std::string const & str,
 243                                               std::string const & delim = std::string(","));
 244 std::vector<docstring> const getVectorFromString(docstring const & str,
 245                 docstring const & delim = from_ascii(","));
 246
 247 // the same vice versa
 248 std::string const getStringFromVector(std::vector<std::string> const & vec,
 249                                  std::string const & delim = std::string(","));
 250
 251 /// Search \p search_token in \p str and return the position if it is
 252 /// found, else -1. The last item in \p str must be "".
 253 int findToken(char const * const str[], std::string const & search_token);
 254
 255 /// Convert internal line endings to line endings as expected by the OS
 256 docstring const externalLineEnding(docstring const & str);
 257
 258 /// Convert line endings in any formnat to internal line endings
 259 docstring const internalLineEnding(docstring const & str);
 260
 261
 262 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
 263
 264 #include <boost/format.hpp>
 265
 266 template<class Arg1>
 267 docstring bformat(docstring const & fmt, Arg1 arg1)
 268 {
 269         return (boost::basic_format<char_type>(fmt) % arg1).str();
 270 }
 271
 272
 273 template<class Arg1, class Arg2>
 274 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
 275 {
 276         return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
 277 }
 278
 279
 280 template<class Arg1, class Arg2, class Arg3>
 281 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
 282 {
 283         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
 284 }
 285
 286
 287 template<class Arg1, class Arg2, class Arg3, class Arg4>
 288 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
 289 {
 290         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
 291 }
 292
 293 #else
 294
 295 template <class Arg1>
 296 docstring bformat(docstring const & fmt, Arg1);
 297
 298 template <class Arg1, class Arg2>
 299 docstring bformat(docstring const & fmt, Arg1, Arg2);
 300
 301 template <class Arg1, class Arg2, class Arg3>
 302 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
 303
 304 template <class Arg1, class Arg2, class Arg3, class Arg4>
 305 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
 306
 307 #endif
 308
 309 } // namespace support
 310 } // namespace lyx
 311
 312 #endif