Convert most of the bibtex machinery to docstring.

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

diff --git a/src/support/lstrings.h b/src/support/lstrings.h
index 00016c3932c32e3259ab48a646ea985834d04404..87e7f242fd7691785e12966ba4f5ad98f444537b 100644 (file)
--- a/src/support/lstrings.h
+++ b/src/support/lstrings.h
@@ -26,7 +26,7 @@ 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);
+int compare_no_case(docstring const & s, docstring const & s2);
 
 ///
 int compare_ascii_no_case(std::string const & s, std::string const & s2);
@@ -68,6 +68,13 @@ bool isStrUnsignedInt(std::string const & str);
 ///
 bool isStrDbl(std::string const & str);
 
+bool isHex(lyx::docstring const & str);
+
+int hexToInt(lyx::docstring const & str);
+
+/// is \p str pure ascii?
+bool isAscii(docstring const & str);
+
 ///
 char lowercase(char c);
 
@@ -82,15 +89,18 @@ char_type uppercase(char_type c);
 
 /// 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 &);
+docstring const lowercase(docstring const &);
 
 ///
 std::string const uppercase(std::string const &);
 
 /// Does the std::string start with this prefix?
 bool prefixIs(std::string const &, std::string const &);
+bool prefixIs(lyx::docstring const &, lyx::docstring const &);
 
 /// Does the string end with this char?
 bool suffixIs(std::string const &, char);
@@ -99,16 +109,24 @@ bool suffixIs(std::string const &, char);
 bool suffixIs(std::string const &, std::string const &);
 
 ///
-template <typename B>
-bool contains(std::string const & a, B b)
+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;
 }
 
 ///
@@ -124,8 +142,7 @@ bool containsOnly(std::string const &, std::string const &);
 */
 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
@@ -143,23 +160,22 @@ int tokenPos(std::string const & a, char delim, std::string const & tok);
 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);
 
 /** 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
@@ -174,13 +190,15 @@ std::string const trim(std::string const & a, char const * p = " ");
     \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"
+   ("ababcdef", "ab") = "cdef"
     \endcode
 */
 std::string const ltrim(std::string const & a, char const * p = " ");
+docstring const ltrim(docstring const & a, char const * p = " ");
 
 /** Splits the string by the first delim.
     Splits the string by the first appearance of delim.
@@ -200,12 +218,15 @@ 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);
 
-/// Escapes non ASCII chars
-lyx::docstring const escape(lyx::docstring const & lab);
+/// Escapes non ASCII chars and other problematic characters that cause
+/// problems in latex labels.
+docstring const escape(docstring const & lab);
 
 /// gives a vector of stringparts which have the delimiter delim
 std::vector<std::string> const getVectorFromString(std::string const & str,
                                              std::string const & delim = std::string(","));
+std::vector<docstring> const getVectorFromString(docstring const & str,
+               docstring const & delim = from_ascii(","));
 
 // the same vice versa
 std::string const getStringFromVector(std::vector<std::string> const & vec,
@@ -216,10 +237,10 @@ std::string const getStringFromVector(std::vector<std::string> const & vec,
 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);
+docstring const externalLineEnding(docstring const & str);
 
 /// Convert line endings in any formnat to internal line endings
-lyx::docstring const internalLineEnding(lyx::docstring const & str);
+docstring const internalLineEnding(docstring const & str);
 
 
 #ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
@@ -227,28 +248,28 @@ lyx::docstring const internalLineEnding(lyx::docstring const & str);
 #include <boost/format.hpp>
 
 template<class Arg1>
-lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1)
+docstring bformat(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)
+docstring bformat(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)
+docstring bformat(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)
+docstring bformat(docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 arg3, Arg4 arg4)
 {
        return (boost::basic_format<char_type>(fmt) % arg1 % arg2 % arg3 % arg4).str();
 }
@@ -256,16 +277,16 @@ lyx::docstring bformat(lyx::docstring const & fmt, Arg1 arg1, Arg2 arg2, Arg3 ar
 #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);
 
 #endif