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);
40 inline int compare(char const * a, char const * b)
47 bool isStrInt(std::string const & str);
49 /// does the std::string represent an unsigned integer value ?
50 bool isStrUnsignedInt(std::string const & str);
53 bool isStrDbl(std::string const & str);
55 bool isHex(docstring const & str);
57 int hexToInt(docstring const & str);
59 /// is \p str pure ascii?
60 bool isAscii(docstring const & str);
62 /// is \p str pure ascii?
63 bool isAscii(std::string const & str);
66 * Changes the case of \p c to lowercase.
67 * Don't use this for non-ASCII characters, since it depends on the locale.
68 * This overloaded function is only implemented because the char_type variant
69 * would be used otherwise, and we assert in this function that \p c is in
72 char lowercase(char c);
75 * Changes the case of \p c to uppercase.
76 * Don't use this for non-ASCII characters, since it depends on the locale.
77 * This overloaded function is only implemented because the char_type variant
78 * would be used otherwise, and we assert in this function that \p c is in
81 char uppercase(char c);
83 /// Changes the case of \p c to lowercase.
84 /// Does not depend on the locale.
85 char_type lowercase(char_type c);
87 /// Changes the case of \p c to uppercase.
88 /// Does not depend on the locale.
89 char_type uppercase(char_type c);
91 /// same as lowercase(), but ignores locale
92 std::string const ascii_lowercase(std::string const &);
93 docstring const ascii_lowercase(docstring const &);
95 /// Changes the case of \p s to lowercase.
96 /// Does not depend on the locale.
97 docstring const lowercase(docstring const & s);
99 /// Changes the case of \p s to uppercase.
100 /// Does not depend on the locale.
101 docstring const uppercase(docstring const & s);
103 /// Does the string start with this prefix?
104 bool prefixIs(docstring const &, char_type);
106 /// Does the std::string start with this prefix?
107 bool prefixIs(std::string const &, std::string const &);
108 bool prefixIs(docstring const &, docstring const &);
110 /// Does the string end with this char?
111 bool suffixIs(std::string const &, char);
112 bool suffixIs(docstring const &, char_type);
114 /// Does the std::string end with this suffix?
115 bool suffixIs(std::string const &, std::string const &);
118 inline bool contains(std::string const & a, std::string const & b)
120 return a.find(b) != std::string::npos;
123 inline bool contains(docstring const & a, docstring const & b)
125 return a.find(b) != docstring::npos;
128 inline bool contains(std::string const & a, char b)
130 return a.find(b) != std::string::npos;
133 inline bool contains(docstring const & a, char_type b)
135 return a.find(b) != docstring::npos;
139 bool containsOnly(std::string const &, std::string const &);
141 /** Extracts a token from this string at the nth delim.
142 Doesn't modify the original string. Similar to strtok.
145 token("a;bc;d", ';', 1) == "bc";
146 token("a;bc;d", ';', 2) == "d";
149 std::string const token(std::string const & a, char delim, int n);
151 docstring const token(docstring const & a, char_type delim, int n);
153 /** Search a token in this string using the delim.
154 Doesn't modify the original string. Returns -1 in case of
158 tokenPos("a;bc;d", ';', "bc") == 1;
159 tokenPos("a;bc;d", ';', "d") == 2;
162 int tokenPos(std::string const & a, char delim, std::string const & tok);
165 /// Substitute all \a oldchar with \a newchar
166 std::string const subst(std::string const & a, char oldchar, char newchar);
168 /// Substitute all \a oldchar with \a newchar
169 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
171 /// substitutes all instances of \a oldstr with \a newstr
172 std::string const subst(std::string const & a,
173 std::string const & oldstr, std::string const & newstr);
175 /// substitutes all instances of \a oldstr with \a newstr
176 docstring const subst(docstring const & a,
177 docstring const & oldstr, docstring const & newstr);
179 /** Trims characters off the end and beginning of a string.
181 trim("ccabccc", "c") == "ab".
184 docstring const trim(docstring const & a, char const * p = " ");
186 /** Trims characters off the end and beginning of a string.
188 trim("ccabccc", "c") == "ab".
191 std::string const trim(std::string const & a, char const * p = " ");
193 /** Trims characters off the end of a string.
195 rtrim("abccc", "c") == "ab".
198 std::string const rtrim(std::string const & a, char const * p = " ");
199 docstring const rtrim(docstring const & a, char const * p = " ");
201 /** Trims characters off the beginning of a string.
203 ("ababcdef", "ab") = "cdef"
206 std::string const ltrim(std::string const & a, char const * p = " ");
207 docstring const ltrim(docstring const & a, char const * p = " ");
209 /** Splits the string given in the first argument at the first occurence
210 of the third argumnent, delim.
211 What precedes delim is returned in the second argument, piece; this
212 will be the whole of the string if no delimiter is found.
213 The return value is what follows delim, if anything. So the return
214 value is the null string if no delimiter is found.
218 ret = split(s1, s2, ';') -> ret = "bc", s2 == "a"
221 std::string const split(std::string const & a, std::string & piece, char delim);
222 docstring const split(docstring const & a, docstring & piece, char_type delim);
224 /// Same as split but does not return a piece
225 std::string const split(std::string const & a, char delim);
227 /// Same as split but uses the last delim.
228 std::string const rsplit(std::string const & a, std::string & piece, char delim);
230 /// Escapes non ASCII chars and other problematic characters that cause
231 /// problems in latex labels.
232 docstring const escape(docstring const & lab);
234 /// gives a vector of stringparts which have the delimiter delim
235 std::vector<std::string> const getVectorFromString(std::string const & str,
236 std::string const & delim = std::string(","));
237 std::vector<docstring> const getVectorFromString(docstring const & str,
238 docstring const & delim = from_ascii(","));
240 // the same vice versa
241 std::string const getStringFromVector(std::vector<std::string> const & vec,
242 std::string const & delim = std::string(","));
244 /// Search \p search_token in \p str and return the position if it is
245 /// found, else -1. The last item in \p str must be "".
246 int findToken(char const * const str[], std::string const & search_token);
248 /// Convert internal line endings to line endings as expected by the OS
249 docstring const externalLineEnding(docstring const & str);
251 /// Convert line endings in any formnat to internal line endings
252 docstring const internalLineEnding(docstring const & str);
255 template <class Arg1>
256 docstring bformat(docstring const & fmt, Arg1);
258 template <class Arg1, class Arg2>
259 docstring bformat(docstring const & fmt, Arg1, Arg2);
261 template <class Arg1, class Arg2, class Arg3>
262 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
264 template <class Arg1, class Arg2, class Arg3, class Arg4>
265 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
268 template<> docstring bformat(docstring const & fmt, int arg1);
269 template<> docstring bformat(docstring const & fmt, long arg1);
270 template<> docstring bformat(docstring const & fmt, unsigned int arg1);
271 template<> docstring bformat(docstring const & fmt, docstring arg1);
272 template<> docstring bformat(docstring const & fmt, char * arg1);
273 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2);
274 template<> docstring bformat(docstring const & fmt, char const * arg1, docstring arg2);
275 template<> docstring bformat(docstring const & fmt, int arg1, int arg2);
276 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3);
277 template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3, docstring arg4);
280 } // namespace support