#include "support/docstring.h"
-#include <string>
#include <vector>
/// Does not depend on the locale.
int compare_no_case(docstring const & s, docstring const & s2);
+/// Compare \p s and \p s2 using the collating rules of the current locale.
+int compare_locale(docstring const & s, docstring const & s2);
+
/// Compare \p s and \p s2, ignoring the case of ASCII characters only.
int compare_ascii_no_case(std::string const & s, std::string const & s2);
bool isHex(docstring const & str);
-int hexToInt(docstring const & str);
+unsigned int hexToInt(docstring const & str);
/// is \p str pure ascii?
bool isAscii(docstring const & str);
/// Changes the case of \p s to lowercase.
/// Does not depend on the locale.
docstring const lowercase(docstring const & s);
+// Currently unused, but the code is there if needed.
+// std::string const lowercase(std::string const & s);
/// Changes the case of \p s to uppercase.
/// Does not depend on the locale.
return a.find(b) != docstring::npos;
}
-///
+/// Returns true if the first argument is made of ascii chars given in the
+/// second argument.
bool containsOnly(std::string const &, std::string const &);
+///
+bool containsOnly(docstring const &, std::string const &);
/** Extracts a token from this string at the nth delim.
Doesn't modify the original string. Similar to strtok.
docstring const subst(docstring const & a,
docstring const & oldstr, docstring const & newstr);
-/// Count all occurences of char \a chr inside \a str
+/// Count all occurrences of char \a chr inside \a str
+int count_char(std::string const & str, char chr);
+
+/// Count all occurrences of char \a chr inside \a str
int count_char(docstring const & str, docstring::value_type chr);
+/** Count all occurrences of binary chars inside \a str.
+ It is assumed that \a str is utf-8 encoded and that a binary char
+ belongs to the unicode class names Zl, Zp, Cc, Cf, Cs, Co, or Cn
+ (excluding white space characters such as '\t', '\n', '\v', '\f', '\r').
+ See http://www.unicode.org/Public/6.2.0/ucd/UnicodeData.txt
+*/
+int count_bin_chars(std::string const & str);
+
/** Trims characters off the end and beginning of a string.
\code
trim("ccabccc", "c") == "ab".
std::string const ltrim(std::string const & a, char const * p = " ");
docstring const ltrim(docstring const & a, char const * p = " ");
-/** Splits the string given in the first argument at the first occurence
+/** Splits the string given in the first argument at the first occurence
of the third argument, delim.
What precedes delim is returned in the second argument, piece; this
will be the whole of the string if no delimiter is found.
/// Same as split but uses the last delim.
std::string const rsplit(std::string const & a, std::string & piece, char delim);
+docstring const rsplit(docstring const & a, docstring & piece, char_type delim);
docstring const rsplit(docstring const & a, char_type delim);
/// Escapes non ASCII chars and other problematic characters that cause
/// problems in latex labels.
docstring const escape(docstring const & lab);
+/// Group contents of an argument if needed
+docstring const protectArgument(docstring & arg, char const l = '[',
+ char const r = ']');
+
+/// Truncates a string with an ellipsis at the end. Leaves str unchanged and
+/// returns false if it is shorter than len. Otherwise resizes str to len, with
+/// U+2026 HORIZONTAL ELLIPSIS at the end, and returns true.
+/// If mid is true, the ellipsis will be put to the mid of the string, and the first
+/// and last half is appended/prepended.
+///
+/// Warning (Unicode): The cases where we want to truncate the text and it does
+/// not end up converted into a QString for UI display must be really
+/// rare. Whenever possible, we should prefer calling QFontMetrics::elidedText()
+/// instead, which takes into account the actual length on the screen and the
+/// layout direction (RTL or LTR). Or a similar function taking into account the
+/// font metrics from the buffer view, which still has to be defined. Or set up
+/// the widgets such that Qt elides the string automatically with the exact
+/// needed width. Recall that not only graphemes vary greatly in width, but also
+/// can be made of several code points. See:
+/// <http://utf8everywhere.org/#myth.strlen>
+///
+/// What is acceptable is when we know that the string is probably going to be
+/// elided by Qt anyway, and len is chosen such that our own ellipsis will only
+/// be displayed in worst-case scenarios.
+///
+/// FIXME: apply those principles in the current code.
+///
+bool truncateWithEllipsis(docstring & str, size_t const len,
+ bool const mid = false);
+
/// Word-wraps the provided docstring, returning a line-broken string
-/// of width no wider than width, with the string broken at spaces.
-/// If the string cannot be broken appropriately, it returns something
+/// of width no wider than width, with the string broken at spaces.
+/// If the string cannot be broken appropriately, it returns something
/// with "..." at the end, again no wider than width.
/// We assume here that str does not contain newlines.
-/// If indent is positive, then the first line is indented that many
+/// If indent is positive, then the first line is indented that many
/// spaces. If it is negative, then successive lines are indented, as
/// if the first line were "outdented".
+///
+/// Warning (Unicode): uses truncateWithEllipsis() internally. Therefore it is
+/// subject to the same warning and FIXME as above.
+///
docstring wrap(docstring const & str, int const indent = 0,
size_t const width = 80);
/// that may contain embedded newlines.
/// \param numlines Don't return more than numlines lines. If numlines
/// is 0, we return everything.
+///
+/// Warning (Unicode): uses truncateWithEllipsis() internally. Therefore it is
+/// subject to the same warning and FIXME as above.
+///
docstring wrapParas(docstring const & str, int const indent = 0,
size_t const width = 80, size_t const maxlines = 10);
/// gives a vector of stringparts which have the delimiter delim
/// If \p keepempty is true, empty strings will be pushed to the vector as well
+/// If \p trimit is true, leading and trailing whitespace will be trimmed from
+/// all values. Note that this can affect what counts as "empty".
+/// NOTE: If you want to split a string on whitespace, then do:
+/// getVectorFromString(str, " ", false, true);
std::vector<std::string> const getVectorFromString(std::string const & str,
- std::string const & delim = std::string(","),
- bool keepempty = false);
+ std::string const & delim = std::string(","),
+ bool keepempty = false, bool trimit = true);
std::vector<docstring> const getVectorFromString(docstring const & str,
- docstring const & delim = from_ascii(","), bool keepempty = false);
+ docstring const & delim = from_ascii(","),
+ bool keepempty = false, bool trimit = true);
/// the same vice versa
std::string const getStringFromVector(std::vector<std::string> const & vec,
/// found, else -1. The last item in \p str must be "".
int findToken(char const * const str[], std::string const & search_token);
-template <class Arg1>
-docstring bformat(docstring const & fmt, Arg1);
-template <class Arg1, class Arg2>
-docstring bformat(docstring const & fmt, Arg1, Arg2);
+/// Format a floating point number with at least 6 siginificant digits, but
+/// without scientific notation.
+/// Scientific notation would be invalid in some contexts, such as lengths for
+/// LaTeX. Simply using std::ostream with std::fixed would produce results
+/// like "1000000.000000", and precision control would not be that easy either.
+std::string formatFPNumber(double);
-template <class Arg1, class Arg2, class Arg3>
-docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
+/// Returns an URI/URL-style percent-encoded copy of the string \p in.
+/// \p ex defines a string of characters that are excluded from the transformation
+docstring to_percent_encoding(docstring const & in, docstring const & ex = docstring());
-template <class Arg1, class Arg2, class Arg3, class Arg4>
-docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
+/// Returns a string decoded from an URI/URL-style percent-encoded string \p in.
+std::string from_percent_encoding(std::string const & in);
-
-template<> docstring bformat(docstring const & fmt, int arg1);
-template<> docstring bformat(docstring const & fmt, long arg1);
-template<> docstring bformat(docstring const & fmt, unsigned int arg1);
-template<> docstring bformat(docstring const & fmt, docstring arg1);
-template<> docstring bformat(docstring const & fmt, char * arg1);
-template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2);
-template<> docstring bformat(docstring const & fmt, docstring arg1, int arg2);
-template<> docstring bformat(docstring const & fmt, char const * arg1, docstring arg2);
-template<> docstring bformat(docstring const & fmt, int arg1, int arg2);
-template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3);
-template<> docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3, docstring arg4);
+docstring bformat(docstring const & fmt, int arg1);
+docstring bformat(docstring const & fmt, long arg1);
+#ifdef HAVE_LONG_LONG_INT
+docstring bformat(docstring const & fmt, long long arg1);
+#endif
+docstring bformat(docstring const & fmt, unsigned int arg1);
+docstring bformat(docstring const & fmt, docstring const & arg1);
+docstring bformat(docstring const & fmt, char * arg1);
+docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2);
+docstring bformat(docstring const & fmt, docstring const & arg1, int arg2);
+docstring bformat(docstring const & fmt, char const * arg1, docstring const & arg2);
+docstring bformat(docstring const & fmt, int arg1, int arg2);
+docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2, docstring const & arg3);
+docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2, docstring const & arg3, docstring const & arg4);
+docstring bformat(docstring const & fmt, docstring const & arg1, docstring const & arg2, docstring const & arg3, docstring const & arg4, docstring const & arg5);
} // namespace support
projects / lyx.git / blobdiff