4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
12 * A collection of string helper functions that works with string.
13 * Some of these would certainly benefit from a rewrite/optimization.
19 #include "support/docstring.h"
28 int compare_no_case(std::string const & s, std::string const & s2);
29 int compare_no_case(docstring const & s, docstring const & s2);
32 int compare_ascii_no_case(std::string const & s, std::string const & s2);
35 int compare_ascii_no_case(docstring const & s, docstring const & s2);
38 int compare_no_case(std::string const & s, std::string const & s2, unsigned int len);
42 int compare(char const * a, char const * b)
44 #ifndef CXX_GLOBAL_CSTD
45 return std::strcmp(a, b);
53 int compare(char const * a, char const * b, unsigned int len)
55 #ifndef CXX_GLOBAL_CSTD
56 return std::strncmp(a, b, len);
58 return strncmp(a, b, len);
63 bool isStrInt(std::string const & str);
65 /// does the std::string represent an unsigned integer value ?
66 bool isStrUnsignedInt(std::string const & str);
69 bool isStrDbl(std::string const & str);
71 bool isHex(lyx::docstring const & str);
73 int hexToInt(lyx::docstring const & str);
75 /// is \p str pure ascii?
76 bool isAscii(docstring const & str);
79 char lowercase(char c);
82 char uppercase(char c);
84 /// changes the case only if c is a one-byte char
85 char_type lowercase(char_type c);
87 /// changes the case only if c is a one-byte char
88 char_type uppercase(char_type c);
90 /// same as lowercase(), but ignores locale
91 std::string const ascii_lowercase(std::string const &);
94 std::string const lowercase(std::string const &);
97 std::string const uppercase(std::string const &);
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 &);
103 /// Does the string end with this char?
104 bool suffixIs(std::string const &, char);
106 /// Does the std::string end with this suffix?
107 bool suffixIs(std::string const &, std::string const &);
110 inline bool contains(std::string const & a, std::string const & b)
112 return a.find(b) != std::string::npos;
115 inline bool contains(docstring const & a, docstring const & b)
117 return a.find(b) != docstring::npos;
120 inline bool contains(std::string const & a, char b)
122 return a.find(b) != std::string::npos;
125 inline bool contains(docstring const & a, char_type b)
127 return a.find(b) != docstring::npos;
131 bool containsOnly(std::string const &, std::string const &);
133 /** Extracts a token from this string at the nth delim.
134 Doesn't modify the original string. Similar to strtok.
137 token("a;bc;d", ';', 1) == "bc";
138 token("a;bc;d", ';', 2) == "d";
141 std::string const token(std::string const & a, char delim, int n);
143 docstring const token(docstring const & a, char_type delim, int n);
145 /** Search a token in this string using the delim.
146 Doesn't modify the original string. Returns -1 in case of
150 tokenPos("a;bc;d", ';', "bc") == 1;
151 tokenPos("a;bc;d", ';', "d") == 2;
154 int tokenPos(std::string const & a, char delim, std::string const & tok);
157 /// Substitute all \a oldchar with \a newchar
158 std::string const subst(std::string const & a, char oldchar, char newchar);
160 /// Substitute all \a oldchar with \a newchar
161 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
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);
167 /// substitutes all instances of \a oldstr with \a newstr
168 docstring const subst(docstring const & a,
169 docstring const & oldstr, docstring const & newstr);
171 /** Trims characters off the end and beginning of a string.
173 trim("ccabccc", "c") == "ab".
176 docstring const trim(docstring const & a, char const * p = " ");
178 /** Trims characters off the end and beginning of a string.
180 trim("ccabccc", "c") == "ab".
183 std::string const trim(std::string const & a, char const * p = " ");
185 /** Trims characters off the end of a string.
187 rtrim("abccc", "c") == "ab".
190 std::string const rtrim(std::string const & a, char const * p = " ");
191 docstring const rtrim(docstring const & a, char const * p = " ");
193 /** Trims characters off the beginning of a string.
195 ("ababcdef", "ab") = "cdef"
198 std::string const ltrim(std::string const & a, char const * p = " ");
199 docstring const ltrim(docstring const & a, char const * p = " ");
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.
207 s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
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);
213 /// Same as split but does not return a piece
214 std::string const split(std::string const & a, char delim);
216 /// Same as split but uses the last delim.
217 std::string const rsplit(std::string const & a, std::string & piece, char delim);
219 /// Escapes non ASCII chars
220 docstring const escape(docstring const & lab);
222 /// gives a vector of stringparts which have the delimiter delim
223 std::vector<std::string> const getVectorFromString(std::string const & str,
224 std::string const & delim = std::string(","));
226 // the same vice versa
227 std::string const getStringFromVector(std::vector<std::string> const & vec,
228 std::string const & delim = std::string(","));
230 /// Search \p search_token in \p str and return the position if it is
231 /// found, else -1. The last item in \p str must be "".
232 int findToken(char const * const str[], std::string const & search_token);
234 /// Convert internal line endings to line endings as expected by the OS
235 docstring const externalLineEnding(docstring const & str);
237 /// Convert line endings in any formnat to internal line endings
238 docstring const internalLineEnding(docstring const & str);
241 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
243 #include <boost/format.hpp>
246 docstring bformat(docstring const & fmt, Arg1 arg1)
248 return (boost::basic_format<char_type>(fmt) % arg1).str();
252 template<class Arg1, class Arg2>
253 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
255 return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
259 template<class Arg1, class Arg2, class Arg3>
260 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
262 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
266 template<class Arg1, class Arg2, class Arg3, class Arg4>
267 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
269 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
274 template <class Arg1>
275 docstring bformat(docstring const & fmt, Arg1);
277 template <class Arg1, class Arg2>
278 docstring bformat(docstring const & fmt, Arg1, Arg2);
280 template <class Arg1, class Arg2, class Arg3>
281 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
283 template <class Arg1, class Arg2, class Arg3, class Arg4>
284 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
288 } // namespace support