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"
27 /// Compare \p s and \p s2, ignoring the case.
28 /// Does not depend on the locale.
29 int compare_no_case(docstring const & s, docstring const & s2);
31 /// Compare \p s and \p s2 using the collating rules of the current locale.
32 int compare_locale(docstring const & s, docstring const & s2);
34 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
35 int compare_ascii_no_case(std::string const & s, std::string const & s2);
37 /// Compare \p s and \p s2, ignoring the case of ASCII characters only.
38 int compare_ascii_no_case(docstring const & s, docstring const & s2);
41 bool isStrInt(std::string const & str);
43 /// does the std::string represent an unsigned integer value ?
44 bool isStrUnsignedInt(std::string const & str);
47 bool isStrDbl(std::string const & str);
49 /// does the string contain a digit?
50 bool hasDigitASCII(docstring const & str);
52 bool isHexChar(char_type);
54 bool isHex(docstring const & str);
56 unsigned int hexToInt(docstring const & str);
58 /// is \p str pure ascii?
59 bool isAscii(docstring const & str);
61 /// is \p str pure ascii?
62 bool isAscii(std::string const & str);
65 * Changes the case of \p c to lowercase.
66 * Don't use this for non-ASCII characters, since it depends on the locale.
67 * This overloaded function is only implemented because the char_type variant
68 * would be used otherwise, and we assert in this function that \p c is in
71 char lowercase(char c);
74 * Changes the case of \p c to uppercase.
75 * Don't use this for non-ASCII characters, since it depends on the locale.
76 * This overloaded function is only implemented because the char_type variant
77 * would be used otherwise, and we assert in this function that \p c is in
80 char uppercase(char c);
82 /// Changes the case of \p c to lowercase.
83 /// Does not depend on the locale.
84 char_type lowercase(char_type c);
86 /// Changes the case of \p c to uppercase.
87 /// Does not depend on the locale.
88 char_type uppercase(char_type c);
90 /// Checks if the supplied character is lower-case
91 bool isLowerCase(char_type ch);
93 /// Checks if the supplied character is upper-case
94 bool isUpperCase(char_type ch);
96 /// same as lowercase(), but ignores locale
97 std::string const ascii_lowercase(std::string const &);
98 docstring const ascii_lowercase(docstring const &);
100 /// Changes the case of \p s to lowercase.
101 /// Does not depend on the locale.
102 docstring const lowercase(docstring const & s);
103 // Currently unused, but the code is there if needed.
104 // std::string const lowercase(std::string const & s);
106 /// Changes the case of \p s to uppercase.
107 /// Does not depend on the locale.
108 docstring const uppercase(docstring const & s);
110 /// Returns the superscript of \p c or \p c if no superscript exists.
111 /// Does not depend on the locale.
112 char_type superscript(char_type c);
114 /// Returns the subscript of \p c or \p c if no subscript exists.
115 /// Does not depend on the locale.
116 char_type subscript(char_type c);
118 /// Does str start with c?
119 bool prefixIs(docstring const & str, char_type c);
121 /// Does str start with pre?
122 bool prefixIs(std::string const & str, std::string const & pre);
123 bool prefixIs(docstring const & str, docstring const & pre);
125 /// Does the string end with this char?
126 bool suffixIs(std::string const &, char);
127 bool suffixIs(docstring const &, char_type);
129 /// Does the string end with this suffix?
130 bool suffixIs(std::string const &, std::string const &);
131 bool suffixIs(docstring const &, docstring const &);
133 /// Is b contained in a?
134 inline bool contains(std::string const & a, std::string const & b)
136 return a.find(b) != std::string::npos;
139 inline bool contains(docstring const & a, docstring const & b)
141 return a.find(b) != docstring::npos;
144 inline bool contains(std::string const & a, char b)
146 return a.find(b) != std::string::npos;
149 inline bool contains(docstring const & a, char_type b)
151 return a.find(b) != docstring::npos;
154 /// Returns true if the first argument is made of ascii chars given in the
156 bool containsOnly(std::string const &, std::string const &);
158 bool containsOnly(docstring const &, std::string const &);
160 /** Extracts a token from this string at the nth delim.
161 Doesn't modify the original string. Similar to strtok.
164 token("a;bc;d", ';', 1) == "bc";
165 token("a;bc;d", ';', 2) == "d";
168 std::string const token(std::string const & a, char delim, int n);
170 docstring const token(docstring const & a, char_type delim, int n);
172 /** Search a token in this string using the delim.
173 Doesn't modify the original string. Returns -1 in case of
177 tokenPos("a;bc;d", ';', "bc") == 1;
178 tokenPos("a;bc;d", ';', "d") == 2;
181 int tokenPos(std::string const & a, char delim, std::string const & tok);
182 int tokenPos(docstring const & a, char_type delim, docstring const & tok);
185 /// Substitute all \a oldchar with \a newchar
186 std::string const subst(std::string const & a, char oldchar, char newchar);
188 /// Substitute all \a oldchar with \a newchar
189 docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
191 /// substitutes all instances of \a oldstr with \a newstr
192 std::string const subst(std::string const & a,
193 std::string const & oldstr, std::string const & newstr);
195 /// substitutes all instances of \a oldstr with \a newstr
196 docstring const subst(docstring const & a,
197 docstring const & oldstr, docstring const & newstr);
199 /// Count all occurrences of char \a chr inside \a str
200 int count_char(std::string const & str, char chr);
202 /// Count all occurrences of char \a chr inside \a str
203 int count_char(docstring const & str, docstring::value_type chr);
205 /** Count all occurrences of binary chars inside \a str.
206 It is assumed that \a str is utf-8 encoded and that a binary char
207 belongs to the unicode class names Zl, Zp, Cc, Cf, Cs, Co, or Cn
208 (excluding white space characters such as '\t', '\n', '\v', '\f', '\r').
209 See http://www.unicode.org/Public/6.2.0/ucd/UnicodeData.txt
211 int count_bin_chars(std::string const & str);
213 /** Trims characters off the end and beginning of a string.
215 trim("ccabccc", "c") == "ab".
218 docstring const trim(docstring const & a, char const * p = " ");
220 /** Trims characters off the end and beginning of a string.
222 trim("ccabccc", "c") == "ab".
225 std::string const trim(std::string const & a, char const * p = " ");
227 /** Trims characters off the end of a string, removing any character
230 rtrim("abcde", "dec") == "ab".
233 std::string const rtrim(std::string const & a, char const * p = " ");
234 docstring const rtrim(docstring const & a, char const * p = " ");
236 /** Trims characters off the beginning of a string.
238 ("abbabcdef", "ab") = "cdef"
241 std::string const ltrim(std::string const & a, char const * p = " ");
242 docstring const ltrim(docstring const & a, char const * p = " ");
244 /** Splits the string given in the first argument at the first occurence
245 of the third argument, delim.
246 What precedes delim is returned in the second argument, piece; this
247 will be the whole of the string if no delimiter is found.
248 The return value is what follows delim, if anything. So the return
249 value is the null string if no delimiter is found.
250 'a' and 'piece' must be different variables.
254 ret = split(s1, s2, ';') -> ret = "bc", s2 == "a"
257 std::string const split(std::string const & a, std::string & piece, char delim);
258 docstring const split(docstring const & a, docstring & piece, char_type delim);
260 /// Same as split but does not return a piece
261 std::string const split(std::string const & a, char delim);
263 /// Same as split but uses the last delim.
264 std::string const rsplit(std::string const & a, std::string & piece, char delim);
265 docstring const rsplit(docstring const & a, docstring & piece, char_type delim);
266 docstring const rsplit(docstring const & a, char_type delim);
268 /// Escapes non ASCII chars and other problematic characters that cause
269 /// problems in latex labels.
270 docstring const escape(docstring const & lab);
272 /// Group contents of an argument if needed
273 docstring const protectArgument(docstring & arg, char const l = '[',
276 /// Truncates a string with an ellipsis at the end. Leaves str unchanged and
277 /// returns false if it is shorter than len. Otherwise resizes str to len, with
278 /// U+2026 HORIZONTAL ELLIPSIS at the end, and returns true.
279 /// If mid is true, the ellipsis will be put to the mid of the string, and the first
280 /// and last half is appended/prepended.
282 /// Warning (Unicode): The cases where we want to truncate the text and it does
283 /// not end up converted into a QString for UI display must be really
284 /// rare. Whenever possible, we should prefer calling QFontMetrics::elidedText()
285 /// instead, which takes into account the actual length on the screen and the
286 /// layout direction (RTL or LTR). Or a similar function taking into account the
287 /// font metrics from the buffer view, which still has to be defined. Or set up
288 /// the widgets such that Qt elides the string automatically with the exact
289 /// needed width. Recall that not only graphemes vary greatly in width, but also
290 /// can be made of several code points. See:
291 /// <http://utf8everywhere.org/#myth.strlen>
293 /// What is acceptable is when we know that the string is probably going to be
294 /// elided by Qt anyway, and len is chosen such that our own ellipsis will only
295 /// be displayed in worst-case scenarios.
297 /// FIXME: apply those principles in the current code.
299 bool truncateWithEllipsis(docstring & str, size_t const len,
300 bool const mid = false);
302 /// Word-wraps the provided docstring, returning a line-broken string
303 /// of width no wider than width, with the string broken at spaces.
304 /// If the string cannot be broken appropriately, it returns something
305 /// with "..." at the end, again no wider than width.
306 /// We assume here that str does not contain newlines.
307 /// If indent is positive, then the first line is indented that many
308 /// spaces. If it is negative, then successive lines are indented, as
309 /// if the first line were "outdented".
311 /// Warning (Unicode): uses truncateWithEllipsis() internally. Therefore it is
312 /// subject to the same warning and FIXME as above.
314 docstring wrap(docstring const & str, int const indent = 0,
315 size_t const width = 80);
317 /// Like the preceding, except it is intended to operate on strings
318 /// that may contain embedded newlines.
319 /// \param numlines Don't return more than numlines lines. If numlines
320 /// is 0, we return everything.
322 /// Warning (Unicode): uses truncateWithEllipsis() internally. Therefore it is
323 /// subject to the same warning and FIXME as above.
325 docstring wrapParas(docstring const & str, int const indent = 0,
326 size_t const width = 80, size_t const maxlines = 10);
328 /// gives a vector of stringparts which have the delimiter delim
329 /// If \p keepempty is true, empty strings will be pushed to the vector as well
330 /// If \p trimit is true, leading and trailing whitespace will be trimmed from
331 /// all values. Note that this can affect what counts as "empty".
332 /// NOTE: If you want to split a string on whitespace, then do:
333 /// getVectorFromString(str, " ", false, true);
334 std::vector<std::string> const getVectorFromString(std::string const & str,
335 std::string const & delim = std::string(","),
336 bool keepempty = false, bool trimit = true);
337 std::vector<docstring> const getVectorFromString(docstring const & str,
338 docstring const & delim = from_ascii(","),
339 bool keepempty = false, bool trimit = true);
341 /// the same vice versa
342 std::string const getStringFromVector(std::vector<std::string> const & vec,
343 std::string const & delim = std::string(","));
344 docstring const getStringFromVector(std::vector<docstring> const & vec,
345 docstring const & delim = from_ascii(","));
347 /// Search \p search_token in \p str and return the position if it is
348 /// found, else -1. The last item in \p str must be "".
349 int findToken(char const * const str[], std::string const & search_token);
352 /// Format a floating point number with at least 6 siginificant digits, but
353 /// without scientific notation.
354 /// Scientific notation would be invalid in some contexts, such as lengths for
355 /// LaTeX. Simply using std::ostream with std::fixed would produce results
356 /// like "1000000.000000", and precision control would not be that easy either.
357 std::string formatFPNumber(double);
359 /// Returns an URI/URL-style percent-encoded copy of the string \p in.
360 /// \p ex defines a string of characters that are excluded from the transformation
361 docstring to_percent_encoding(docstring const & in, docstring const & ex = docstring());
363 /// Returns a string decoded from an URI/URL-style percent-encoded string \p in.
364 std::string from_percent_encoding(std::string const & in);
366 docstring bformat(docstring const & fmt, int arg1);
367 docstring bformat(docstring const & fmt, long arg1);
368 #ifdef HAVE_LONG_LONG_INT
369 docstring bformat(docstring const & fmt, long long arg1);
371 docstring bformat(docstring const & fmt, unsigned int arg1);
372 docstring bformat(docstring const & fmt, docstring const & arg1);
373 docstring bformat(docstring const & fmt, char * arg1);
374 docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2);
375 docstring bformat(docstring const & fmt, docstring const & arg1, int arg2);
376 docstring bformat(docstring const & fmt, char const * arg1, docstring const & arg2);
377 docstring bformat(docstring const & fmt, int arg1, int arg2);
378 docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2, docstring const & arg3);
379 docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2, docstring const & arg3, docstring const & arg4);
380 docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2, docstring const & arg3, docstring const & arg4, docstring const & arg5);
383 } // namespace support