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
  96 ///
  97 std::string const uppercase(std::string const &);
  98
  99 /// Does the std::string start with this prefix?
 100 bool prefixIs(std::string const &, std::string const &);
 101 bool prefixIs(lyx::docstring const &, lyx::docstring const &);
 102
 103 /// Does the string end with this char?
 104 bool suffixIs(std::string const &, char);
 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
 156
 157 /// Substitute all \a oldchar with \a newchar
 158 std::string const subst(std::string const & a, char oldchar, char newchar);
 159
 160 /// Substitute all \a oldchar with \a newchar
 161 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
 162
 163 /// substitutes all instances of \a oldstr with \a newstr
 164 std::string const subst(std::string const & a,
 165                    std::string const & oldstr, std::string const & newstr);
 166
 167 /// substitutes all instances of \a oldstr with \a newstr
 168 docstring const subst(docstring const & a,
 169                 docstring const & oldstr, docstring const & newstr);
 170
 171 /** Trims characters off the end and beginning of a string.
 172     \code
 173     trim("ccabccc", "c") == "ab".
 174     \endcode
 175 */
 176 docstring const trim(docstring const & a, char const * p = " ");
 177
 178 /** Trims characters off the end and beginning of a string.
 179     \code
 180     trim("ccabccc", "c") == "ab".
 181     \endcode
 182 */
 183 std::string const trim(std::string const & a, char const * p = " ");
 184
 185 /** Trims characters off the end of a string.
 186     \code
 187     rtrim("abccc", "c") == "ab".
 188     \endcode
 189 */
 190 std::string const rtrim(std::string const & a, char const * p = " ");
 191 docstring const rtrim(docstring const & a, char const * p = " ");
 192
 193 /** Trims characters off the beginning of a string.
 194     \code
 195    ("ababcdef", "ab") = "cdef"
 196     \endcode
 197 */
 198 std::string const ltrim(std::string const & a, char const * p = " ");
 199 docstring const ltrim(docstring const & a, char const * p = " ");
 200
 201 /** Splits the string by the first delim.
 202     Splits the string by the first appearance of delim.
 203     The leading string up to delim is returned in piece (not including
 204     delim), while the original string is cut from after the delimiter.
 205     Example:
 206     \code
 207     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
 208     \endcode
 209 */
 210 std::string const split(std::string const & a, std::string & piece, char delim);
 211 docstring const split(docstring const & a, docstring & piece, char_type delim);
 212
 213 /// Same as split but does not return a piece
 214 std::string const split(std::string const & a, char delim);
 215
 216 /// Same as split but uses the last delim.
 217 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 218
 219 /// Escapes non ASCII chars and other problematic characters that cause
 220 /// problems in latex labels.
 221 docstring const escape(docstring const & lab);
 222
 223 /// gives a vector of stringparts which have the delimiter delim
 224 std::vector<std::string> const getVectorFromString(std::string const & str,
 225                                               std::string const & delim = std::string(","));
 226
 227 // the same vice versa
 228 std::string const getStringFromVector(std::vector<std::string> const & vec,
 229                                  std::string const & delim = std::string(","));
 230
 231 /// Search \p search_token in \p str and return the position if it is
 232 /// found, else -1. The last item in \p str must be "".
 233 int findToken(char const * const str[], std::string const & search_token);
 234
 235 /// Convert internal line endings to line endings as expected by the OS
 236 docstring const externalLineEnding(docstring const & str);
 237
 238 /// Convert line endings in any formnat to internal line endings
 239 docstring const internalLineEnding(docstring const & str);
 240
 241
 242 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
 243
 244 #include <boost/format.hpp>
 245
 246 template<class Arg1>
 247 docstring bformat(docstring const & fmt, Arg1 arg1)
 248 {
 249         return (boost::basic_format<char_type>(fmt) % arg1).str();
 250 }
 251
 252
 253 template<class Arg1, class Arg2>
 254 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
 255 {
 256         return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
 257 }
 258
 259
 260 template<class Arg1, class Arg2, class Arg3>
 261 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
 262 {
 263         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
 264 }
 265
 266
 267 template<class Arg1, class Arg2, class Arg3, class Arg4>
 268 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
 269 {
 270         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
 271 }
 272
 273 #else
 274
 275 template <class Arg1>
 276 docstring bformat(docstring const & fmt, Arg1);
 277
 278 template <class Arg1, class Arg2>
 279 docstring bformat(docstring const & fmt, Arg1, Arg2);
 280
 281 template <class Arg1, class Arg2, class Arg3>
 282 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
 283
 284 template <class Arg1, class Arg2, class Arg3, class Arg4>
 285 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
 286
 287 #endif
 288
 289 } // namespace support
 290 } // namespace lyx
 291
 292 #endif