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 ///
  28 int compare_no_case(std::string const & s, std::string const & s2);
  29 int compare_no_case(docstring const & s, docstring const & s2);
  30
  31 ///
  32 int compare_ascii_no_case(std::string const & s, std::string const & s2);
  33
  34 ///
  35 int compare_ascii_no_case(docstring const & s, docstring const & s2);
  36
  37 ///
  38 int compare_no_case(std::string const & s, std::string const & s2, unsigned int len);
  39
  40 ///
  41 inline
  42 int compare(char const * a, char const * b)
  43 {
  44 #ifndef CXX_GLOBAL_CSTD
  45         return std::strcmp(a, b);
  46 #else
  47         return strcmp(a, b);
  48 #endif
  49 }
  50
  51 ///
  52 inline
  53 int compare(char const * a, char const * b, unsigned int len)
  54 {
  55 #ifndef CXX_GLOBAL_CSTD
  56         return std::strncmp(a, b, len);
  57 #else
  58         return strncmp(a, b, len);
  59 #endif
  60 }
  61
  62 ///
  63 bool isStrInt(std::string const & str);
  64
  65 /// does the std::string represent an unsigned integer value ?
  66 bool isStrUnsignedInt(std::string const & str);
  67
  68 ///
  69 bool isStrDbl(std::string const & str);
  70
  71 bool isHex(lyx::docstring const & str);
  72
  73 int hexToInt(lyx::docstring const & str);
  74
  75 /// is \p str pure ascii?
  76 bool isAscii(docstring const & str);
  77
  78 ///
  79 char lowercase(char c);
  80
  81 ///
  82 char uppercase(char c);
  83
  84 /// changes the case only if c is a one-byte char
  85 char_type lowercase(char_type c);
  86
  87 /// changes the case only if c is a one-byte char
  88 char_type uppercase(char_type c);
  89
  90 /// same as lowercase(), but ignores locale
  91 std::string const ascii_lowercase(std::string const &);
  92
  93 ///
  94 std::string const lowercase(std::string const &);
  95 docstring const lowercase(docstring const &);
  96
  97 ///
  98 std::string const uppercase(std::string const &);
  99
 100 /// Does the std::string start with this prefix?
 101 bool prefixIs(std::string const &, std::string const &);
 102 bool prefixIs(lyx::docstring const &, lyx::docstring const &);
 103
 104 /// Does the string end with this char?
 105 bool suffixIs(std::string const &, char);
 106
 107 /// Does the std::string end with this suffix?
 108 bool suffixIs(std::string const &, std::string const &);
 109
 110 ///
 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
 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 by the first delim.
 203     Splits the string by the first appearance of delim.
 204     The leading string up to delim is returned in piece (not including
 205     delim), while the original string is cut from after the delimiter.
 206     Example:
 207     \code
 208     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
 209     \endcode
 210 */
 211 std::string const split(std::string const & a, std::string & piece, char delim);
 212 docstring const split(docstring const & a, docstring & piece, char_type delim);
 213
 214 /// Same as split but does not return a piece
 215 std::string const split(std::string const & a, char delim);
 216
 217 /// Same as split but uses the last delim.
 218 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 219
 220 /// Escapes non ASCII chars and other problematic characters that cause
 221 /// problems in latex labels.
 222 docstring const escape(docstring const & lab);
 223
 224 /// gives a vector of stringparts which have the delimiter delim
 225 std::vector<std::string> const getVectorFromString(std::string const & str,
 226                                               std::string const & delim = std::string(","));
 227
 228 // the same vice versa
 229 std::string const getStringFromVector(std::vector<std::string> const & vec,
 230                                  std::string const & delim = std::string(","));
 231
 232 /// Search \p search_token in \p str and return the position if it is
 233 /// found, else -1. The last item in \p str must be "".
 234 int findToken(char const * const str[], std::string const & search_token);
 235
 236 /// Convert internal line endings to line endings as expected by the OS
 237 docstring const externalLineEnding(docstring const & str);
 238
 239 /// Convert line endings in any formnat to internal line endings
 240 docstring const internalLineEnding(docstring const & str);
 241
 242
 243 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
 244
 245 #include <boost/format.hpp>
 246
 247 template<class Arg1>
 248 docstring bformat(docstring const & fmt, Arg1 arg1)
 249 {
 250         return (boost::basic_format<char_type>(fmt) % arg1).str();
 251 }
 252
 253
 254 template<class Arg1, class Arg2>
 255 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
 256 {
 257         return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
 258 }
 259
 260
 261 template<class Arg1, class Arg2, class Arg3>
 262 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
 263 {
 264         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
 265 }
 266
 267
 268 template<class Arg1, class Arg2, class Arg3, class Arg4>
 269 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
 270 {
 271         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
 272 }
 273
 274 #else
 275
 276 template <class Arg1>
 277 docstring bformat(docstring const & fmt, Arg1);
 278
 279 template <class Arg1, class Arg2>
 280 docstring bformat(docstring const & fmt, Arg1, Arg2);
 281
 282 template <class Arg1, class Arg2, class Arg3>
 283 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
 284
 285 template <class Arg1, class Arg2, class Arg3, class Arg4>
 286 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
 287
 288 #endif
 289
 290 } // namespace support
 291 } // namespace lyx
 292
 293 #endif