Extend the otexstream class to also report about paragraph breaks.

[lyx.git] / src / support / lstrings.h

diff --git a/src/support/lstrings.h b/src/support/lstrings.h
index 486244180c0f9a66953b1bbaa6731d581d4d5a02..576a5b921df363639c09e6cbc13d21b4123a1445 100644 (file)
--- a/src/support/lstrings.h
+++ b/src/support/lstrings.h
@@ -18,7 +18,6 @@
 
 #include "support/docstring.h"
 
-#include <string>
 #include <vector>
 
 
@@ -44,6 +43,11 @@ bool isStrUnsignedInt(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);
@@ -80,6 +84,12 @@ char_type lowercase(char_type c);
 /// 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 &);
@@ -87,11 +97,21 @@ docstring const ascii_lowercase(docstring 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);
 
 /// Changes the case of \p s to uppercase.
 /// Does not depend on the locale.
 docstring const uppercase(docstring const & s);
 
+/// 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);
 
@@ -170,6 +190,12 @@ std::string const subst(std::string const & a,
 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);
+
 /** Trims characters off the end and beginning of a string.
     \code
     trim("ccabccc", "c") == "ab".
@@ -202,11 +228,12 @@ 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 
-    of the third argumnent, delim.
+    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= "a;bc"; s2= ""
@@ -221,6 +248,8 @@ std::string const split(std::string const & a, char 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 and other problematic characters that cause
 /// problems in latex labels.
@@ -237,6 +266,13 @@ docstring const escape(docstring const & lab);
 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.
+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,
@@ -245,9 +281,11 @@ std::vector<std::string> const getVectorFromString(std::string const & str,
 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 "".
@@ -272,6 +310,7 @@ 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);