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"
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);
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);
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);
39 int compare(char const * a, char const * b)
41 #ifndef CXX_GLOBAL_CSTD
42 return std::strcmp(a, b);
50 int compare(char const * a, char const * b, unsigned int len)
52 #ifndef CXX_GLOBAL_CSTD
53 return std::strncmp(a, b, len);
55 return strncmp(a, b, len);
60 bool isStrInt(std::string const & str);
62 /// does the std::string represent an unsigned integer value ?
63 bool isStrUnsignedInt(std::string const & str);
66 bool isStrDbl(std::string const & str);
68 bool isHex(lyx::docstring const & str);
70 int hexToInt(lyx::docstring const & str);
72 /// is \p str pure ascii?
73 bool isAscii(docstring const & str);
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
82 char lowercase(char c);
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
91 char uppercase(char c);
93 /// Changes the case of \p c to lowercase.
94 /// Does not depend on the locale.
95 char_type lowercase(char_type c);
97 /// Changes the case of \p c to uppercase.
98 /// Does not depend on the locale.
99 char_type uppercase(char_type c);
101 /// same as lowercase(), but ignores locale
102 std::string const ascii_lowercase(std::string const &);
103 docstring const ascii_lowercase(docstring const &);
105 /// Changes the case of \p s to lowercase.
106 /// Does not depend on the locale.
107 docstring const lowercase(docstring const & s);
109 /// Changes the case of \p s to uppercase.
110 /// Does not depend on the locale.
111 docstring const uppercase(docstring const & s);
113 /// Does the string start with this prefix?
114 bool prefixIs(docstring const &, char_type);
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 &);
120 /// Does the string end with this char?
121 bool suffixIs(std::string const &, char);
122 bool suffixIs(docstring const &, char_type);
124 /// Does the std::string end with this suffix?
125 bool suffixIs(std::string const &, std::string const &);
128 inline bool contains(std::string const & a, std::string const & b)
130 return a.find(b) != std::string::npos;
133 inline bool contains(docstring const & a, docstring const & b)
135 return a.find(b) != docstring::npos;
138 inline bool contains(std::string const & a, char b)
140 return a.find(b) != std::string::npos;
143 inline bool contains(docstring const & a, char_type b)
145 return a.find(b) != docstring::npos;
149 bool containsOnly(std::string const &, std::string const &);
151 /** Extracts a token from this string at the nth delim.
152 Doesn't modify the original string. Similar to strtok.
155 token("a;bc;d", ';', 1) == "bc";
156 token("a;bc;d", ';', 2) == "d";
159 std::string const token(std::string const & a, char delim, int n);
161 docstring const token(docstring const & a, char_type delim, int n);
163 /** Search a token in this string using the delim.
164 Doesn't modify the original string. Returns -1 in case of
168 tokenPos("a;bc;d", ';', "bc") == 1;
169 tokenPos("a;bc;d", ';', "d") == 2;
172 int tokenPos(std::string const & a, char delim, std::string const & tok);
175 /// Substitute all \a oldchar with \a newchar
176 std::string const subst(std::string const & a, char oldchar, char newchar);
178 /// Substitute all \a oldchar with \a newchar
179 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
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);
185 /// substitutes all instances of \a oldstr with \a newstr
186 docstring const subst(docstring const & a,
187 docstring const & oldstr, docstring const & newstr);
189 /** Trims characters off the end and beginning of a string.
191 trim("ccabccc", "c") == "ab".
194 docstring const trim(docstring const & a, char const * p = " ");
196 /** Trims characters off the end and beginning of a string.
198 trim("ccabccc", "c") == "ab".
201 std::string const trim(std::string const & a, char const * p = " ");
203 /** Trims characters off the end of a string.
205 rtrim("abccc", "c") == "ab".
208 std::string const rtrim(std::string const & a, char const * p = " ");
209 docstring const rtrim(docstring const & a, char const * p = " ");
211 /** Trims characters off the beginning of a string.
213 ("ababcdef", "ab") = "cdef"
216 std::string const ltrim(std::string const & a, char const * p = " ");
217 docstring const ltrim(docstring const & a, char const * p = " ");
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.
225 s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
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);
231 /// Same as split but does not return a piece
232 std::string const split(std::string const & a, char delim);
234 /// Same as split but uses the last delim.
235 std::string const rsplit(std::string const & a, std::string & piece, char delim);
237 /// Escapes non ASCII chars and other problematic characters that cause
238 /// problems in latex labels.
239 docstring const escape(docstring const & lab);
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(","));
247 // the same vice versa
248 std::string const getStringFromVector(std::vector<std::string> const & vec,
249 std::string const & delim = std::string(","));
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);
255 /// Convert internal line endings to line endings as expected by the OS
256 docstring const externalLineEnding(docstring const & str);
258 /// Convert line endings in any formnat to internal line endings
259 docstring const internalLineEnding(docstring const & str);
262 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
264 #include <boost/format.hpp>
267 docstring bformat(docstring const & fmt, Arg1 arg1)
269 return (boost::basic_format<char_type>(fmt) % arg1).str();
273 template<class Arg1, class Arg2>
274 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
276 return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
280 template<class Arg1, class Arg2, class Arg3>
281 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
283 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
287 template<class Arg1, class Arg2, class Arg3, class Arg4>
288 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
290 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
295 template <class Arg1>
296 docstring bformat(docstring const & fmt, Arg1);
298 template <class Arg1, class Arg2>
299 docstring bformat(docstring const & fmt, Arg1, Arg2);
301 template <class Arg1, class Arg2, class Arg3>
302 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
304 template <class Arg1, class Arg2, class Arg3, class Arg4>
305 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
309 } // namespace support