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(lyx::docstring const & s, lyx::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(lyx::docstring const & a, B b)
112 return a.find(b) != lyx::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 lyx::docstring const token(lyx::docstring const & a,
129 lyx::char_type delim, int n);
131 /** Search a token in this string using the delim.
132 Doesn't modify the original string. Returns -1 in case of
136 tokenPos("a;bc;d", ';', "bc") == 1;
137 tokenPos("a;bc;d", ';', "d") == 2;
140 int tokenPos(std::string const & a, char delim, std::string const & tok);
143 /// Substitute all \a oldchar with \a newchar
144 std::string const subst(std::string const & a, char oldchar, char newchar);
146 /// Substitute all \a oldchar with \a newchar
147 lyx::docstring const subst(docstring const & a,
148 lyx::char_type oldchar, lyx::char_type newchar);
150 /// substitutes all instances of \a oldstr with \a newstr
151 std::string const subst(std::string const & a,
152 std::string const & oldstr, std::string const & newstr);
154 /// substitutes all instances of \a oldstr with \a newstr
155 lyx::docstring const subst(lyx::docstring const & a,
156 lyx::docstring const & oldstr, lyx::docstring const & newstr);
158 /** Trims characters off the end and beginning of a string.
160 trim("ccabccc", "c") == "ab".
163 lyx::docstring const trim(lyx::docstring const & a, char const * p = " ");
165 /** Trims characters off the end and beginning of a string.
167 trim("ccabccc", "c") == "ab".
170 std::string const trim(std::string const & a, char const * p = " ");
172 /** Trims characters off the end of a string.
174 rtrim("abccc", "c") == "ab".
177 std::string const rtrim(std::string const & a, char const * p = " ");
179 /** Trims characters off the beginning of a string.
181 ltrim("ababcdef", "ab") = "cdef"
184 std::string const ltrim(std::string const & a, char const * p = " ");
186 /** Splits the string by the first delim.
187 Splits the string by the first appearance of delim.
188 The leading string up to delim is returned in piece (not including
189 delim), while the original string is cut from after the delimiter.
192 s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
195 std::string const split(std::string const & a, std::string & piece, char delim);
196 docstring const split(docstring const & a, docstring & piece, char_type delim);
198 /// Same as split but does not return a piece
199 std::string const split(std::string const & a, char delim);
201 /// Same as split but uses the last delim.
202 std::string const rsplit(std::string const & a, std::string & piece, char delim);
204 /// Escapes non ASCII chars
205 lyx::docstring const escape(lyx::docstring const & lab);
207 /// gives a vector of stringparts which have the delimiter delim
208 std::vector<std::string> const getVectorFromString(std::string const & str,
209 std::string const & delim = std::string(","));
211 // the same vice versa
212 std::string const getStringFromVector(std::vector<std::string> const & vec,
213 std::string const & delim = std::string(","));
215 /// Search \p search_token in \p str and return the position if it is
216 /// found, else -1. The last item in \p str must be "".
217 int findToken(char const * const str[], std::string const & search_token);
219 /// Convert internal line endings to line endings as expected by the OS
220 lyx::docstring const externalLineEnding(lyx::docstring const & str);
222 /// Convert line endings in any formnat to internal line endings
223 lyx::docstring const internalLineEnding(lyx::docstring const & str);
226 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
228 #include <boost/format.hpp>
231 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1)
233 return (boost::basic_format<char_type>(fmt) % arg1).str();
237 template<class Arg1, class Arg2>
238 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2)
240 return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
244 template<class Arg1, class Arg2, class Arg3>
245 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
247 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
251 template<class Arg1, class Arg2, class Arg3, class Arg4>
252 lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
254 return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
259 template <class Arg1>
260 lyx::docstring bformat(lyx::docstring const & fmt, Arg1);
262 template <class Arg1, class Arg2>
263 lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2);
265 template <class Arg1, class Arg2, class Arg3>
266 lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2, Arg3);
268 template <class Arg1, class Arg2, class Arg3, class Arg4>
269 lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
273 } // namespace support