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 &);
92 docstring const ascii_lowercase(docstring const &);
95 std::string const lowercase(std::string const &);
96 docstring const lowercase(docstring const &);
99 std::string const uppercase(std::string const &);
101 /// Does the std::string start with this prefix?
102 bool prefixIs(std::string const &, std::string const &);
103 bool prefixIs(lyx::docstring const &, lyx::docstring const &);
105 /// Does the string end with this char?
106 bool suffixIs(std::string const &, char);
108 /// Does the std::string end with this suffix?
109 bool suffixIs(std::string const &, std::string const &);
112 inline bool contains(std::string const & a, std::string const & b)
114 return a.find(b) != std::string::npos;
117 inline bool contains(docstring const & a, docstring const & b)
119 return a.find(b) != docstring::npos;
122 inline bool contains(std::string const & a, char b)
124 return a.find(b) != std::string::npos;
127 inline bool contains(docstring const & a, char_type b)
129 return a.find(b) != docstring::npos;
133 bool containsOnly(std::string const &, std::string const &);
135 /** Extracts a token from this string at the nth delim.
136 Doesn't modify the original string. Similar to strtok.
139 token("a;bc;d", ';', 1) == "bc";
140 token("a;bc;d", ';', 2) == "d";
143 std::string const token(std::string const & a, char delim, int n);
145 docstring const token(docstring const & a, char_type delim, int n);
147 /** Search a token in this string using the delim.
148 Doesn't modify the original string. Returns -1 in case of
152 tokenPos("a;bc;d", ';', "bc") == 1;
153 tokenPos("a;bc;d", ';', "d") == 2;
156 int tokenPos(std::string const & a, char delim, std::string const & tok);
159 /// Substitute all \a oldchar with \a newchar
160 std::string const subst(std::string const & a, char oldchar, char newchar);
162 /// Substitute all \a oldchar with \a newchar
163 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
165 /// substitutes all instances of \a oldstr with \a newstr
166 std::string const subst(std::string const & a,
167 std::string const & oldstr, std::string const & newstr);
169 /// substitutes all instances of \a oldstr with \a newstr
170 docstring const subst(docstring const & a,
171 docstring const & oldstr, docstring const & newstr);
173 /** Trims characters off the end and beginning of a string.
175 trim("ccabccc", "c") == "ab".
178 docstring const trim(docstring const & a, char const * p = " ");
180 /** Trims characters off the end and beginning of a string.
182 trim("ccabccc", "c") == "ab".
185 std::string const trim(std::string const & a, char const * p = " ");
187 /** Trims characters off the end of a string.
189 rtrim("abccc", "c") == "ab".
192 std::string const rtrim(std::string const & a, char const * p = " ");
193 docstring const rtrim(docstring const & a, char const * p = " ");
195 /** Trims characters off the beginning of a string.
197 ("ababcdef", "ab") = "cdef"
200 std::string const ltrim(std::string const & a, char const * p = " ");
201 docstring const ltrim(docstring const & a, char const * p = " ");
203 /** Splits the string by the first delim.
204 Splits the string by the first appearance of delim.
205 The leading string up to delim is returned in piece (not including
206 delim), while the original string is cut from after the delimiter.
209 s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
212 std::string const split(std::string const & a, std::string & piece, char delim);
213 docstring const split(docstring const & a, docstring & piece, char_type delim);
215 /// Same as split but does not return a piece
216 std::string const split(std::string const & a, char delim);
218 /// Same as split but uses the last delim.
219 std::string const rsplit(std::string const & a, std::string & piece, char delim);
221 /// Escapes non ASCII chars and other problematic characters that cause
222 /// problems in latex labels.
223 docstring const escape(docstring const & lab);
225 /// gives a vector of stringparts which have the delimiter delim
226 std::vector<std::string> const getVectorFromString(std::string const & str,
227 std::string const & delim = std::string(","));
228 std::vector<docstring> const getVectorFromString(docstring const & str,
229 docstring const & delim = from_ascii(","));
231 // the same vice versa
232 std::string const getStringFromVector(std::vector<std::string> const & vec,
233 std::string const & delim = std::string(","));
235 /// Search \p search_token in \p str and return the position if it is
236 /// found, else -1. The last item in \p str must be "".
237 int findToken(char const * const str[], std::string const & search_token);
239 /// Convert internal line endings to line endings as expected by the OS
240 docstring const externalLineEnding(docstring const & str);
242 /// Convert line endings in any formnat to internal line endings
243 docstring const internalLineEnding(docstring const & str);
246 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
248 #include <boost/format.hpp>
251 docstring bformat(docstring const & fmt, Arg1 arg1)
253 return (boost::basic_format<char_type>(fmt) % arg1).str();
257 template<class Arg1, class Arg2>
258 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
260 return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
264 template<class Arg1, class Arg2, class Arg3>
265 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
267 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
271 template<class Arg1, class Arg2, class Arg3, class Arg4>
272 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
274 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
279 template <class Arg1>
280 docstring bformat(docstring const & fmt, Arg1);
282 template <class Arg1, class Arg2>
283 docstring bformat(docstring const & fmt, Arg1, Arg2);
285 template <class Arg1, class Arg2, class Arg3>
286 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
288 template <class Arg1, class Arg2, class Arg3, class Arg4>
289 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
293 } // namespace support