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 string start with this prefix?
102 bool prefixIs(docstring const &, char_type);
104 /// Does the std::string start with this prefix?
105 bool prefixIs(std::string const &, std::string const &);
106 bool prefixIs(docstring const &, docstring const &);
108 /// Does the string end with this char?
109 bool suffixIs(std::string const &, char);
110 bool suffixIs(docstring const &, char_type);
112 /// Does the std::string end with this suffix?
113 bool suffixIs(std::string const &, std::string const &);
116 inline bool contains(std::string const & a, std::string const & b)
118 return a.find(b) != std::string::npos;
121 inline bool contains(docstring const & a, docstring const & b)
123 return a.find(b) != docstring::npos;
126 inline bool contains(std::string const & a, char b)
128 return a.find(b) != std::string::npos;
131 inline bool contains(docstring const & a, char_type b)
133 return a.find(b) != docstring::npos;
137 bool containsOnly(std::string const &, std::string const &);
139 /** Extracts a token from this string at the nth delim.
140 Doesn't modify the original string. Similar to strtok.
143 token("a;bc;d", ';', 1) == "bc";
144 token("a;bc;d", ';', 2) == "d";
147 std::string const token(std::string const & a, char delim, int n);
149 docstring const token(docstring const & a, char_type delim, int n);
151 /** Search a token in this string using the delim.
152 Doesn't modify the original string. Returns -1 in case of
156 tokenPos("a;bc;d", ';', "bc") == 1;
157 tokenPos("a;bc;d", ';', "d") == 2;
160 int tokenPos(std::string const & a, char delim, std::string const & tok);
163 /// Substitute all \a oldchar with \a newchar
164 std::string const subst(std::string const & a, char oldchar, char newchar);
166 /// Substitute all \a oldchar with \a newchar
167 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
169 /// substitutes all instances of \a oldstr with \a newstr
170 std::string const subst(std::string const & a,
171 std::string const & oldstr, std::string const & newstr);
173 /// substitutes all instances of \a oldstr with \a newstr
174 docstring const subst(docstring const & a,
175 docstring const & oldstr, docstring const & newstr);
177 /** Trims characters off the end and beginning of a string.
179 trim("ccabccc", "c") == "ab".
182 docstring const trim(docstring const & a, char const * p = " ");
184 /** Trims characters off the end and beginning of a string.
186 trim("ccabccc", "c") == "ab".
189 std::string const trim(std::string const & a, char const * p = " ");
191 /** Trims characters off the end of a string.
193 rtrim("abccc", "c") == "ab".
196 std::string const rtrim(std::string const & a, char const * p = " ");
197 docstring const rtrim(docstring const & a, char const * p = " ");
199 /** Trims characters off the beginning of a string.
201 ("ababcdef", "ab") = "cdef"
204 std::string const ltrim(std::string const & a, char const * p = " ");
205 docstring const ltrim(docstring const & a, char const * p = " ");
207 /** Splits the string by the first delim.
208 Splits the string by the first appearance of delim.
209 The leading string up to delim is returned in piece (not including
210 delim), while the original string is cut from after the delimiter.
213 s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
216 std::string const split(std::string const & a, std::string & piece, char delim);
217 docstring const split(docstring const & a, docstring & piece, char_type delim);
219 /// Same as split but does not return a piece
220 std::string const split(std::string const & a, char delim);
222 /// Same as split but uses the last delim.
223 std::string const rsplit(std::string const & a, std::string & piece, char delim);
225 /// Escapes non ASCII chars and other problematic characters that cause
226 /// problems in latex labels.
227 docstring const escape(docstring const & lab);
229 /// gives a vector of stringparts which have the delimiter delim
230 std::vector<std::string> const getVectorFromString(std::string const & str,
231 std::string const & delim = std::string(","));
232 std::vector<docstring> const getVectorFromString(docstring const & str,
233 docstring const & delim = from_ascii(","));
235 // the same vice versa
236 std::string const getStringFromVector(std::vector<std::string> const & vec,
237 std::string const & delim = std::string(","));
239 /// Search \p search_token in \p str and return the position if it is
240 /// found, else -1. The last item in \p str must be "".
241 int findToken(char const * const str[], std::string const & search_token);
243 /// Convert internal line endings to line endings as expected by the OS
244 docstring const externalLineEnding(docstring const & str);
246 /// Convert line endings in any formnat to internal line endings
247 docstring const internalLineEnding(docstring const & str);
250 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
252 #include <boost/format.hpp>
255 docstring bformat(docstring const & fmt, Arg1 arg1)
257 return (boost::basic_format<char_type>(fmt) % arg1).str();
261 template<class Arg1, class Arg2>
262 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
264 return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
268 template<class Arg1, class Arg2, class Arg3>
269 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
271 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
275 template<class Arg1, class Arg2, class Arg3, class Arg4>
276 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
278 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
283 template <class Arg1>
284 docstring bformat(docstring const & fmt, Arg1);
286 template <class Arg1, class Arg2>
287 docstring bformat(docstring const & fmt, Arg1, Arg2);
289 template <class Arg1, class Arg2, class Arg3>
290 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
292 template <class Arg1, class Arg2, class Arg3, class Arg4>
293 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
297 } // namespace support