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);
72 char lowercase(char c);
75 char uppercase(char c);
77 /// changes the case only if c is a one-byte char
78 char_type lowercase(char_type c);
80 /// changes the case only if c is a one-byte char
81 char_type uppercase(char_type c);
83 /// same as lowercase(), but ignores locale
84 std::string const ascii_lowercase(std::string const &);
87 std::string const lowercase(std::string const &);
90 std::string const uppercase(std::string const &);
92 /// Does the std::string start with this prefix?
93 bool prefixIs(std::string const &, std::string const &);
94 bool prefixIs(lyx::docstring const &, lyx::docstring const &);
96 /// Does the string end with this char?
97 bool suffixIs(std::string const &, char);
99 /// Does the std::string end with this suffix?
100 bool suffixIs(std::string const &, std::string const &);
103 template <typename B>
104 bool contains(std::string const & a, B b)
106 return a.find(b) != std::string::npos;
109 template <typename B>
110 bool contains(docstring const & a, B b)
112 return a.find(b) != docstring::npos;
116 bool containsOnly(std::string const &, std::string const &);
118 /** Extracts a token from this string at the nth delim.
119 Doesn't modify the original string. Similar to strtok.
122 token("a;bc;d", ';', 1) == "bc";
123 token("a;bc;d", ';', 2) == "d";
126 std::string const token(std::string const & a, char delim, int n);
128 docstring const token(docstring const & a, char_type delim, int n);
130 /** Search a token in this string using the delim.
131 Doesn't modify the original string. Returns -1 in case of
135 tokenPos("a;bc;d", ';', "bc") == 1;
136 tokenPos("a;bc;d", ';', "d") == 2;
139 int tokenPos(std::string const & a, char delim, std::string const & tok);
142 /// Substitute all \a oldchar with \a newchar
143 std::string const subst(std::string const & a, char oldchar, char newchar);
145 /// Substitute all \a oldchar with \a newchar
146 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
148 /// substitutes all instances of \a oldstr with \a newstr
149 std::string const subst(std::string const & a,
150 std::string const & oldstr, std::string const & newstr);
152 /// substitutes all instances of \a oldstr with \a newstr
153 docstring const subst(docstring const & a,
154 docstring const & oldstr, docstring const & newstr);
156 /** Trims characters off the end and beginning of a string.
158 trim("ccabccc", "c") == "ab".
161 docstring const trim(docstring const & a, char const * p = " ");
163 /** Trims characters off the end and beginning of a string.
165 trim("ccabccc", "c") == "ab".
168 std::string const trim(std::string const & a, char const * p = " ");
170 /** Trims characters off the end of a string.
172 rtrim("abccc", "c") == "ab".
175 std::string const rtrim(std::string const & a, char const * p = " ");
177 /** Trims characters off the beginning of a string.
179 ltrim("ababcdef", "ab") = "cdef"
182 std::string const ltrim(std::string const & a, char const * p = " ");
184 /** Splits the string by the first delim.
185 Splits the string by the first appearance of delim.
186 The leading string up to delim is returned in piece (not including
187 delim), while the original string is cut from after the delimiter.
190 s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
193 std::string const split(std::string const & a, std::string & piece, char delim);
194 docstring const split(docstring const & a, docstring & piece, char_type delim);
196 /// Same as split but does not return a piece
197 std::string const split(std::string const & a, char delim);
199 /// Same as split but uses the last delim.
200 std::string const rsplit(std::string const & a, std::string & piece, char delim);
202 /// Escapes non ASCII chars
203 docstring const escape(docstring const & lab);
205 /// gives a vector of stringparts which have the delimiter delim
206 std::vector<std::string> const getVectorFromString(std::string const & str,
207 std::string const & delim = std::string(","));
209 // the same vice versa
210 std::string const getStringFromVector(std::vector<std::string> const & vec,
211 std::string const & delim = std::string(","));
213 /// Search \p search_token in \p str and return the position if it is
214 /// found, else -1. The last item in \p str must be "".
215 int findToken(char const * const str[], std::string const & search_token);
217 /// Convert internal line endings to line endings as expected by the OS
218 docstring const externalLineEnding(docstring const & str);
220 /// Convert line endings in any formnat to internal line endings
221 docstring const internalLineEnding(docstring const & str);
224 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
226 #include <boost/format.hpp>
229 docstring bformat(docstring const & fmt, Arg1 arg1)
231 return (boost::basic_format<char_type>(fmt) % arg1).str();
235 template<class Arg1, class Arg2>
236 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2)
238 return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
242 template<class Arg1, class Arg2, class Arg3>
243 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
245 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
249 template<class Arg1, class Arg2, class Arg3, class Arg4>
250 docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
252 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
257 template <class Arg1>
258 docstring bformat(docstring const & fmt, Arg1);
260 template <class Arg1, class Arg2>
261 docstring bformat(docstring const & fmt, Arg1, Arg2);
263 template <class Arg1, class Arg2, class Arg3>
264 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
266 template <class Arg1, class Arg2, class Arg3, class Arg4>
267 docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
271 } // namespace support