* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
*
* Full author contact details are available in file CREDITS.
namespace lyx {
namespace support {
-///
-int compare_no_case(std::string const & s, std::string const & s2);
-int compare_no_case(lyx::docstring const & s, lyx::docstring const & s2);
+/// Compare \p s and \p s2, ignoring the case.
+/// Does not depend on the locale.
+int compare_no_case(docstring const & s, docstring const & s2);
-///
-int compare_ascii_no_case(std::string const & s, std::string const & s2);
-
-///
-int compare_no_case(std::string const & s, std::string const & s2, unsigned int len);
+/// Compare \p s and \p s2 using the collating rules of the current locale.
+int compare_locale(docstring const & s, docstring const & s2);
-///
-inline
-int compare(char const * a, char const * b)
-{
-#ifndef CXX_GLOBAL_CSTD
- return std::strcmp(a, b);
-#else
- return strcmp(a, b);
-#endif
-}
+/// 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);
-///
-inline
-int compare(char const * a, char const * b, unsigned int len)
-{
-#ifndef CXX_GLOBAL_CSTD
- return std::strncmp(a, b, len);
-#else
- return strncmp(a, b, len);
-#endif
-}
+/// Compare \p s and \p s2, ignoring the case of ASCII characters only.
+int compare_ascii_no_case(docstring const & s, docstring const & s2);
///
bool isStrInt(std::string const & str);
///
bool isStrDbl(std::string const & str);
-///
+/// does the string contain a digit?
+bool hasDigitASCII(docstring const & str);
+
+bool isHexChar(char_type);
+
+bool isHex(docstring const & str);
+
+int hexToInt(docstring const & str);
+
+/// is \p str pure ascii?
+bool isAscii(docstring const & str);
+
+/// is \p str pure ascii?
+bool isAscii(std::string const & str);
+
+/**
+ * Changes the case of \p c to lowercase.
+ * Don't use this for non-ASCII characters, since it depends on the locale.
+ * This overloaded function is only implemented because the char_type variant
+ * would be used otherwise, and we assert in this function that \p c is in
+ * the ASCII range.
+ */
char lowercase(char c);
-///
+/**
+ * Changes the case of \p c to uppercase.
+ * Don't use this for non-ASCII characters, since it depends on the locale.
+ * This overloaded function is only implemented because the char_type variant
+ * would be used otherwise, and we assert in this function that \p c is in
+ * the ASCII range.
+ */
char uppercase(char c);
-/// changes the case only if c is a one-byte char
+/// Changes the case of \p c to lowercase.
+/// Does not depend on the locale.
char_type lowercase(char_type c);
-/// changes the case only if c is a one-byte char
+/// Changes the case of \p c to uppercase.
+/// Does not depend on the locale.
char_type uppercase(char_type c);
+/// Checks if the supplied character is lower-case
+bool isLowerCase(char_type ch);
+
+/// Checks if the supplied character is upper-case
+bool isUpperCase(char_type ch);
+
/// same as lowercase(), but ignores locale
std::string const ascii_lowercase(std::string const &);
+docstring const ascii_lowercase(docstring const &);
-///
-std::string const lowercase(std::string const &);
+/// 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);
-///
-std::string const uppercase(std::string const &);
+/// Changes the case of \p s to uppercase.
+/// Does not depend on the locale.
+docstring const uppercase(docstring const & s);
-/// Does the std::string start with this prefix?
-bool prefixIs(std::string const &, std::string const &);
+/// Returns the superscript of \p c or \p c if no superscript exists.
+/// Does not depend on the locale.
+char_type superscript(char_type c);
+
+/// Returns the subscript of \p c or \p c if no subscript exists.
+/// Does not depend on the locale.
+char_type subscript(char_type c);
+
+/// Does str start with c?
+bool prefixIs(docstring const & str, char_type c);
+
+/// Does str start with pre?
+bool prefixIs(std::string const & str, std::string const & pre);
+bool prefixIs(docstring const & str, docstring const & pre);
/// Does the string end with this char?
bool suffixIs(std::string const &, char);
+bool suffixIs(docstring const &, char_type);
-/// Does the std::string end with this suffix?
+/// Does the string end with this suffix?
bool suffixIs(std::string const &, std::string const &);
+bool suffixIs(docstring const &, docstring const &);
-///
-template <typename B>
-bool contains(std::string const & a, B b)
+/// Is b contained in a?
+inline bool contains(std::string const & a, std::string const & b)
+{
+ return a.find(b) != std::string::npos;
+}
+
+inline bool contains(docstring const & a, docstring const & b)
+{
+ return a.find(b) != docstring::npos;
+}
+
+inline bool contains(std::string const & a, char b)
{
return a.find(b) != std::string::npos;
}
-template <typename B>
-bool contains(lyx::docstring const & a, B b)
+inline bool contains(docstring const & a, char_type b)
{
- return a.find(b) != lyx::docstring::npos;
+ return a.find(b) != docstring::npos;
}
///
*/
std::string const token(std::string const & a, char delim, int n);
-lyx::docstring const token(lyx::docstring const & a,
- lyx::char_type delim, int n);
+docstring const token(docstring const & a, char_type delim, int n);
/** Search a token in this string using the delim.
Doesn't modify the original string. Returns -1 in case of
\endcode
*/
int tokenPos(std::string const & a, char delim, std::string const & tok);
+int tokenPos(docstring const & a, char_type delim, docstring const & tok);
/// Substitute all \a oldchar with \a newchar
std::string const subst(std::string const & a, char oldchar, char newchar);
/// Substitute all \a oldchar with \a newchar
-lyx::docstring const subst(docstring const & a,
- lyx::char_type oldchar, lyx::char_type newchar);
+docstring const subst(docstring const & a, char_type oldchar, char_type newchar);
/// substitutes all instances of \a oldstr with \a newstr
std::string const subst(std::string const & a,
std::string const & oldstr, std::string const & newstr);
/// substitutes all instances of \a oldstr with \a newstr
-lyx::docstring const subst(lyx::docstring const & a,
- lyx::docstring const & oldstr, lyx::docstring const & newstr);
+docstring const subst(docstring const & a,
+ docstring const & oldstr, docstring const & newstr);
+
+/// Count all occurences of char \a chr inside \a str
+int count_char(std::string const & str, char chr);
+
+/// Count all occurences of char \a chr inside \a str
+int count_char(docstring const & str, docstring::value_type chr);
+
+/** Count all occurences 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".
\endcode
*/
-lyx::docstring const trim(lyx::docstring const & a, char const * p = " ");
+docstring const trim(docstring const & a, char const * p = " ");
/** Trims characters off the end and beginning of a string.
\code
*/
std::string const trim(std::string const & a, char const * p = " ");
-/** Trims characters off the end of a string.
+/** Trims characters off the end of a string, removing any character
+ in p.
\code
- rtrim("abccc", "c") == "ab".
+ rtrim("abcde", "dec") == "ab".
\endcode
*/
std::string const rtrim(std::string const & a, char const * p = " ");
+docstring const rtrim(docstring const & a, char const * p = " ");
/** Trims characters off the beginning of a string.
\code
- ltrim("ababcdef", "ab") = "cdef"
+ ("abbabcdef", "ab") = "cdef"
\endcode
*/
std::string const ltrim(std::string const & a, char const * p = " ");
-
-/** Splits the string by the first delim.
- Splits the string by the first appearance of delim.
- The leading string up to delim is returned in piece (not including
- delim), while the original string is cut from after the delimiter.
- Example:
+docstring const ltrim(docstring const & a, char const * p = " ");
+
+/** 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.
+ The return value is what follows delim, if anything. So the return
+ value is the null string if no delimiter is found.
+ 'a' and 'piece' must be different variables.
+ Examples:
\code
- s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
+ s1= "a;bc"; s2= ""
+ ret = split(s1, s2, ';') -> ret = "bc", s2 == "a"
\endcode
-*/
+ */
std::string const split(std::string const & a, std::string & piece, char delim);
docstring const split(docstring const & a, docstring & piece, char_type delim);
/// 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
-std::string const escape(std::string const & lab);
+/// Escapes non ASCII chars and other problematic characters that cause
+/// problems in latex labels.
+docstring const escape(docstring const & lab);
+
+/// 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.
+///
+/// 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);
+
+/// 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
+/// 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
+/// 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);
+
+/// Like the preceding, except it is intended to operate on strings
+/// 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
std::vector<std::string> const getVectorFromString(std::string const & str,
- std::string const & delim = std::string(","));
+ std::string const & delim = std::string(","),
+ bool keepempty = false);
+std::vector<docstring> const getVectorFromString(docstring const & str,
+ docstring const & delim = from_ascii(","), bool keepempty = false);
-// the same vice versa
+/// the same vice versa
std::string const getStringFromVector(std::vector<std::string> const & vec,
std::string const & delim = std::string(","));
+docstring const getStringFromVector(std::vector<docstring> const & vec,
+ docstring const & delim = from_ascii(","));
/// Search \p search_token in \p str and return the position if it is
/// found, else -1. The last item in \p str must be "".
int findToken(char const * const str[], std::string const & search_token);
-/// Convert internal line endings to line endings as expected by the OS
-lyx::docstring const externalLineEnding(lyx::docstring const & str);
-
-/// Convert line endings in any formnat to internal line endings
-lyx::docstring const internalLineEnding(lyx::docstring const & str);
+/// 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);
-#ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
-
-#include <boost/format.hpp>
-
-template<class Arg1>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1)
-{
- return (boost::basic_format<char_type>(fmt) % arg1).str();
-}
-
-
-template<class Arg1, class Arg2>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2)
-{
- return (boost::basic_format<char_type>(fmt) % arg1 % arg2).str();
-}
-
-
-template<class Arg1, class Arg2, class Arg3>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3)
-{
- return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3).str();
-}
-
-
-template<class Arg1, class Arg2, class Arg3, class Arg4>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
-{
- return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
-}
-
-#else
template <class Arg1>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1);
+docstring bformat(docstring const & fmt, Arg1);
template <class Arg1, class Arg2>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2);
+docstring bformat(docstring const & fmt, Arg1, Arg2);
template <class Arg1, class Arg2, class Arg3>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2, Arg3);
+docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
template <class Arg1, class Arg2, class Arg3, class Arg4>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
+docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
+
+template<> docstring bformat(docstring const & fmt, int arg1);
+template<> docstring bformat(docstring const & fmt, long arg1);
+#ifdef LYX_USE_LONG_LONG
+template<> docstring bformat(docstring const & fmt, long long arg1);
#endif
+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);
+
} // namespace support
} // namespace lyx
projects / lyx.git / blobdiff