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(lyx::docstring const & s, lyx::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 ///
  72 char lowercase(char c);
  73
  74 ///
  75 char uppercase(char c);
  76
  77 /// changes the case only if c is a one-byte char
  78 char_type lowercase(char_type c);
  79
  80 /// changes the case only if c is a one-byte char
  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
  86 ///
  87 std::string const lowercase(std::string const &);
  88
  89 ///
  90 std::string const uppercase(std::string const &);
  91
  92 /// Does the std::string start with this prefix?
  93 bool prefixIs(std::string const &, std::string const &);
  94
  95 /// Does the string end with this char?
  96 bool suffixIs(std::string const &, char);
  97
  98 /// Does the std::string end with this suffix?
  99 bool suffixIs(std::string const &, std::string const &);
 100
 101 ///
 102 template <typename B>
 103 bool contains(std::string const & a, B b)
 104 {
 105         return a.find(b) != std::string::npos;
 106 }
 107
 108 template <typename B>
 109 bool contains(lyx::docstring const & a, B b)
 110 {
 111         return a.find(b) != lyx::docstring::npos;
 112 }
 113
 114 ///
 115 bool containsOnly(std::string const &, std::string const &);
 116
 117 /** Extracts a token from this string at the nth delim.
 118     Doesn't modify the original string. Similar to strtok.
 119     Example:
 120     \code
 121     token("a;bc;d", ';', 1) == "bc";
 122     token("a;bc;d", ';', 2) == "d";
 123     \endcode
 124 */
 125 std::string const token(std::string const & a, char delim, int n);
 126
 127 lyx::docstring const token(lyx::docstring const & a,
 128                            lyx::char_type delim, int n);
 129
 130 /** Search a token in this string using the delim.
 131     Doesn't modify the original string. Returns -1 in case of
 132     failure.
 133     Example:
 134     \code
 135     tokenPos("a;bc;d", ';', "bc") == 1;
 136     tokenPos("a;bc;d", ';', "d") == 2;
 137     \endcode
 138 */
 139 int tokenPos(std::string const & a, char delim, std::string const & tok);
 140
 141
 142 /// Substitute all \a oldchar with \a newchar
 143 std::string const subst(std::string const & a, char oldchar, char newchar);
 144
 145 /// Substitute all \a oldchar with \a newchar
 146 lyx::docstring const subst(docstring const & a,
 147                                                    lyx::char_type oldchar, lyx::char_type newchar);
 148
 149 /// substitutes all instances of \a oldstr with \a newstr
 150 std::string const subst(std::string const & a,
 151                    std::string const & oldstr, std::string const & newstr);
 152
 153 /// substitutes all instances of \a oldstr with \a newstr
 154 lyx::docstring const subst(lyx::docstring const & a,
 155                 lyx::docstring const & oldstr, lyx::docstring const & newstr);
 156
 157 /** Trims characters off the end and beginning of a string.
 158     \code
 159     trim("ccabccc", "c") == "ab".
 160     \endcode
 161 */
 162 lyx::docstring const trim(lyx::docstring const & a, char const * p = " ");
 163
 164 /** Trims characters off the end and beginning of a string.
 165     \code
 166     trim("ccabccc", "c") == "ab".
 167     \endcode
 168 */
 169 std::string const trim(std::string const & a, char const * p = " ");
 170
 171 /** Trims characters off the end of a string.
 172     \code
 173     rtrim("abccc", "c") == "ab".
 174     \endcode
 175 */
 176 std::string const rtrim(std::string const & a, char const * p = " ");
 177
 178 /** Trims characters off the beginning of a string.
 179     \code
 180    ltrim("ababcdef", "ab") = "cdef"
 181     \endcode
 182 */
 183 std::string const ltrim(std::string const & a, char const * p = " ");
 184
 185 /** Splits the string by the first delim.
 186     Splits the string by the first appearance of delim.
 187     The leading string up to delim is returned in piece (not including
 188     delim), while the original string is cut from after the delimiter.
 189     Example:
 190     \code
 191     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
 192     \endcode
 193 */
 194 std::string const split(std::string const & a, std::string & piece, char delim);
 195 docstring const split(docstring const & a, docstring & piece, char_type delim);
 196
 197 /// Same as split but does not return a piece
 198 std::string const split(std::string const & a, char delim);
 199
 200 /// Same as split but uses the last delim.
 201 std::string const rsplit(std::string const & a, std::string & piece, char delim);
 202
 203 /// Escapes non ASCII chars
 204 lyx::docstring const escape(lyx::docstring const & lab);
 205
 206 /// gives a vector of stringparts which have the delimiter delim
 207 std::vector<std::string> const getVectorFromString(std::string const & str,
 208                                               std::string const & delim = std::string(","));
 209
 210 // the same vice versa
 211 std::string const getStringFromVector(std::vector<std::string> const & vec,
 212                                  std::string const & delim = std::string(","));
 213
 214 /// Search \p search_token in \p str and return the position if it is
 215 /// found, else -1. The last item in \p str must be "".
 216 int findToken(char const * const str[], std::string const & search_token);
 217
 218 /// Convert internal line endings to line endings as expected by the OS
 219 lyx::docstring const externalLineEnding(lyx::docstring const & str);
 220
 221 /// Convert line endings in any formnat to internal line endings
 222 lyx::docstring const internalLineEnding(lyx::docstring const & str);
 223
 224
 225 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
 226
 227 #include <boost/format.hpp>
 228
 229 template<class Arg1>
 230 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1)
 231 {
 232         return (boost::basic_format<char_type>(fmt) % arg1).str();
 233 }
 234
 235
 236 template<class Arg1, class Arg2>
 237 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2)
 238 {
 239         return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
 240 }
 241
 242
 243 template<class Arg1, class Arg2, class Arg3>
 244 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
 245 {
 246         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
 247 }
 248
 249
 250 template<class Arg1, class Arg2, class Arg3, class Arg4>
 251 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
 252 {
 253         return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
 254 }
 255
 256 #else
 257
 258 template <class Arg1>
 259 lyx::docstring bformat(lyx::docstring const & fmt, Arg1);
 260
 261 template <class Arg1, class Arg2>
 262 lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2);
 263
 264 template <class Arg1, class Arg2, class Arg3>
 265 lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2, Arg3);
 266
 267 template <class Arg1, class Arg2, class Arg3, class Arg4>
 268 lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
 269
 270 #endif
 271
 272 } // namespace support
 273 } // namespace lyx
 274
 275 #endif