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);
76 char lowercase(char c);
79 char uppercase(char c);
81 /// changes the case only if c is a one-byte char
82 char_type lowercase(char_type c);
84 /// changes the case only if c is a one-byte char
85 char_type uppercase(char_type c);
87 /// same as lowercase(), but ignores locale
88 std::string const ascii_lowercase(std::string const &);
91 std::string const lowercase(std::string const &);
94 std::string const uppercase(std::string const &);
96 /// Does the std::string start with this prefix?
97 bool prefixIs(std::string const &, std::string const &);
98 bool prefixIs(lyx::docstring const &, lyx::docstring const &);
100 /// Does the string end with this char?
101 bool suffixIs(std::string const &, char);
103 /// Does the std::string end with this suffix?
104 bool suffixIs(std::string const &, std::string const &);
107 inline bool contains(std::string const & a, std::string const & b)
109 return a.find(b) != std::string::npos;
112 inline bool contains(docstring const & a, docstring const & b)
114 return a.find(b) != docstring::npos;
117 inline bool contains(std::string const & a, char b)
119 return a.find(b) != std::string::npos;
122 inline bool contains(docstring const & a, char_type b)
124 return a.find(b) != docstring::npos;
128 bool containsOnly(std::string const &, std::string const &);
130 /** Extracts a token from this string at the nth delim.
131 Doesn't modify the original string. Similar to strtok.
134 token("a;bc;d", ';', 1) == "bc";
135 token("a;bc;d", ';', 2) == "d";
138 std::string const token(std::string const & a, char delim, int n);
140 docstring const token(docstring const & a, char_type delim, int n);
142 /** Search a token in this string using the delim.
143 Doesn't modify the original string. Returns -1 in case of
147 tokenPos("a;bc;d", ';', "bc") == 1;
148 tokenPos("a;bc;d", ';', "d") == 2;
151 int tokenPos(std::string const & a, char delim, std::string const & tok);
154 /// Substitute all \a oldchar with \a newchar
155 std::string const subst(std::string const & a, char oldchar, char newchar);
157 /// Substitute all \a oldchar with \a newchar
158 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
160 /// substitutes all instances of \a oldstr with \a newstr
161 std::string const subst(std::string const & a,
162 std::string const & oldstr, std::string const & newstr);
164 /// substitutes all instances of \a oldstr with \a newstr
165 docstring const subst(docstring const & a,
166 docstring const & oldstr, docstring const & newstr);
168 /** Trims characters off the end and beginning of a string.
170 trim("ccabccc", "c") == "ab".
173 docstring const trim(docstring const & a, char const * p = " ");
175 /** Trims characters off the end and beginning of a string.
177 trim("ccabccc", "c") == "ab".
180 std::string const trim(std::string const & a, char const * p = " ");
182 /** Trims characters off the end of a string.
184 rtrim("abccc", "c") == "ab".
187 std::string const rtrim(std::string const & a, char const * p = " ");
188 docstring const rtrim(docstring const & a, char const * p = " ");
190 /** Trims characters off the beginning of a string.
192 ("ababcdef", "ab") = "cdef"
195 std::string const ltrim(std::string const & a, char const * p = " ");
196 docstring const ltrim(docstring const & a, char const * p = " ");
198 /** Splits the string by the first delim.
199 Splits the string by the first appearance of delim.
200 The leading string up to delim is returned in piece (not including
201 delim), while the original string is cut from after the delimiter.
204 s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
207 std::string const split(std::string const & a, std::string & piece, char delim);
208 docstring const split(docstring const & a, docstring & piece, char_type delim);
210 /// Same as split but does not return a piece
211 std::string const split(std::string const & a, char delim);
213 /// Same as split but uses the last delim.
214 std::string const rsplit(std::string const & a, std::string & piece, char delim);
216 /// Escapes non ASCII chars
217 docstring const escape(docstring const & lab);
219 /// gives a vector of stringparts which have the delimiter delim
220 std::vector<std::string> const getVectorFromString(std::string const & str,
221 std::string const & delim = std::string(","));
223 // the same vice versa
224 std::string const getStringFromVector(std::vector<std::string> const & vec,
225 std::string const & delim = std::string(","));
227 /// Search \p search_token in \p str and return the position if it is
228 /// found, else -1. The last item in \p str must be "".
229 int findToken(char const * const str[], std::string const & search_token);
231 /// Convert internal line endings to line endings as expected by the OS
232 docstring const externalLineEnding(docstring const & str);
234 /// Convert line endings in any formnat to internal line endings
235 docstring const internalLineEnding(docstring const & str);
238 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
240 #include <boost/format.hpp>
243 docstring bformat(docstring const & fmt, Arg1 arg1)
245 return (boost::basic_format<char_type>(fmt) % arg1).str();
249 template<class Arg1, class Arg2>
250 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
252 return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
256 template<class Arg1, class Arg2, class Arg3>
257 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
259 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
263 template<class Arg1, class Arg2, class Arg3, class Arg4>
264 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
266 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
271 template <class Arg1>
272 docstring bformat(docstring const & fmt, Arg1);
274 template <class Arg1, class Arg2>
275 docstring bformat(docstring const & fmt, Arg1, Arg2);
277 template <class Arg1, class Arg2, class Arg3>
278 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
280 template <class Arg1, class Arg2, class Arg3, class Arg4>
281 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
285 } // namespace support