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"
29 /// Compare \p s and \p s2, ignoring the case.
30 /// Does not depend on the locale.
31 int compare_no_case(docstring const & s, docstring const & s2);
33 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
34 int compare_ascii_no_case(std::string const & s, std::string const & s2);
36 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
37 int compare_ascii_no_case(docstring const & s, docstring const & s2);
41 int compare(char const * a, char const * b)
43 #ifndef CXX_GLOBAL_CSTD
44 return std::strcmp(a, b);
51 bool isStrInt(std::string const & str);
53 /// does the std::string represent an unsigned integer value ?
54 bool isStrUnsignedInt(std::string const & str);
57 bool isStrDbl(std::string const & str);
59 bool isHex(docstring const & str);
61 int hexToInt(docstring const & str);
63 /// is \p str pure ascii?
64 bool isAscii(docstring const & str);
66 /// is \p str pure ascii?
67 bool isAscii(std::string const & str);
70 * Changes the case of \p c to lowercase.
71 * Don't use this for non-ASCII characters, since it depends on the locale.
72 * This overloaded function is only implemented because the char_type variant
73 * would be used otherwise, and we assert in this function that \p c is in
76 char lowercase(char c);
79 * Changes the case of \p c to uppercase.
80 * Don't use this for non-ASCII characters, since it depends on the locale.
81 * This overloaded function is only implemented because the char_type variant
82 * would be used otherwise, and we assert in this function that \p c is in
85 char uppercase(char c);
87 /// Changes the case of \p c to lowercase.
88 /// Does not depend on the locale.
89 char_type lowercase(char_type c);
91 /// Changes the case of \p c to uppercase.
92 /// Does not depend on the locale.
93 char_type uppercase(char_type c);
95 /// same as lowercase(), but ignores locale
96 std::string const ascii_lowercase(std::string const &);
97 docstring const ascii_lowercase(docstring const &);
99 /// Changes the case of \p s to lowercase.
100 /// Does not depend on the locale.
101 docstring const lowercase(docstring const & s);
103 /// Changes the case of \p s to uppercase.
104 /// Does not depend on the locale.
105 docstring const uppercase(docstring const & s);
107 /// Does the string start with this prefix?
108 bool prefixIs(docstring const &, char_type);
110 /// Does the std::string start with this prefix?
111 bool prefixIs(std::string const &, std::string const &);
112 bool prefixIs(docstring const &, docstring const &);
114 /// Does the string end with this char?
115 bool suffixIs(std::string const &, char);
116 bool suffixIs(docstring const &, char_type);
118 /// Does the std::string end with this suffix?
119 bool suffixIs(std::string const &, std::string const &);
122 inline bool contains(std::string const & a, std::string const & b)
124 return a.find(b) != std::string::npos;
127 inline bool contains(docstring const & a, docstring const & b)
129 return a.find(b) != docstring::npos;
132 inline bool contains(std::string const & a, char b)
134 return a.find(b) != std::string::npos;
137 inline bool contains(docstring const & a, char_type b)
139 return a.find(b) != docstring::npos;
143 bool containsOnly(std::string const &, std::string const &);
145 /** Extracts a token from this string at the nth delim.
146 Doesn't modify the original string. Similar to strtok.
149 token("a;bc;d", ';', 1) == "bc";
150 token("a;bc;d", ';', 2) == "d";
153 std::string const token(std::string const & a, char delim, int n);
155 docstring const token(docstring const & a, char_type delim, int n);
157 /** Search a token in this string using the delim.
158 Doesn't modify the original string. Returns -1 in case of
162 tokenPos("a;bc;d", ';', "bc") == 1;
163 tokenPos("a;bc;d", ';', "d") == 2;
166 int tokenPos(std::string const & a, char delim, std::string const & tok);
169 /// Substitute all \a oldchar with \a newchar
170 std::string const subst(std::string const & a, char oldchar, char newchar);
172 /// Substitute all \a oldchar with \a newchar
173 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
175 /// substitutes all instances of \a oldstr with \a newstr
176 std::string const subst(std::string const & a,
177 std::string const & oldstr, std::string const & newstr);
179 /// substitutes all instances of \a oldstr with \a newstr
180 docstring const subst(docstring const & a,
181 docstring const & oldstr, docstring const & newstr);
183 /** Trims characters off the end and beginning of a string.
185 trim("ccabccc", "c") == "ab".
188 docstring const trim(docstring const & a, char const * p = " ");
190 /** Trims characters off the end and beginning of a string.
192 trim("ccabccc", "c") == "ab".
195 std::string const trim(std::string const & a, char const * p = " ");
197 /** Trims characters off the end of a string.
199 rtrim("abccc", "c") == "ab".
202 std::string const rtrim(std::string const & a, char const * p = " ");
203 docstring const rtrim(docstring const & a, char const * p = " ");
205 /** Trims characters off the beginning of a string.
207 ("ababcdef", "ab") = "cdef"
210 std::string const ltrim(std::string const & a, char const * p = " ");
211 docstring const ltrim(docstring const & a, char const * p = " ");
213 /** Splits the string given in the first argument at the first occurence
214 of the third argumnent, delim.
215 What precedes delim is returned in the second argument, piece; this
216 will be the whole of the string if no delimiter is found.
217 The return value is what follows delim, if anything. So the return
218 value is the null string if no delimiter is found.
222 ret = split(s1, s2, ';') -> ret = "bc", s2 == "a"
225 std::string const split(std::string const & a, std::string & piece, char delim);
226 docstring const split(docstring const & a, docstring & piece, char_type delim);
228 /// Same as split but does not return a piece
229 std::string const split(std::string const & a, char delim);
231 /// Same as split but uses the last delim.
232 std::string const rsplit(std::string const & a, std::string & piece, char delim);
234 /// Escapes non ASCII chars and other problematic characters that cause
235 /// problems in latex labels.
236 docstring const escape(docstring const & lab);
238 /// gives a vector of stringparts which have the delimiter delim
239 std::vector<std::string> const getVectorFromString(std::string const & str,
240 std::string const & delim = std::string(","));
241 std::vector<docstring> const getVectorFromString(docstring const & str,
242 docstring const & delim = from_ascii(","));
244 // the same vice versa
245 std::string const getStringFromVector(std::vector<std::string> const & vec,
246 std::string const & delim = std::string(","));
248 /// Search \p search_token in \p str and return the position if it is
249 /// found, else -1. The last item in \p str must be "".
250 int findToken(char const * const str[], std::string const & search_token);
252 /// Convert internal line endings to line endings as expected by the OS
253 docstring const externalLineEnding(docstring const & str);
255 /// Convert line endings in any formnat to internal line endings
256 docstring const internalLineEnding(docstring const & str);
259 template <class Arg1>
260 docstring bformat(docstring const & fmt, Arg1);
262 template <class Arg1, class Arg2>
263 docstring bformat(docstring const & fmt, Arg1, Arg2);
265 template <class Arg1, class Arg2, class Arg3>
266 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
268 template <class Arg1, class Arg2, class Arg3, class Arg4>
269 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
272 } // namespace support