]> git.lyx.org Git - lyx.git/blobdiff - src/support/lstrings.h
Convert most of the bibtex machinery to docstring.
[lyx.git] / src / support / lstrings.h
index 7d371266e327ac143cb1e26b10b4c78841c0b018..87e7f242fd7691785e12966ba4f5ad98f444537b 100644 (file)
@@ -16,8 +16,9 @@
 #ifndef LSTRINGS_H
 #define LSTRINGS_H
 
+#include "support/docstring.h"
+
 #include <vector>
-#include <string>
 
 
 namespace lyx {
@@ -25,10 +26,14 @@ namespace support {
 
 ///
 int compare_no_case(std::string const & s, std::string 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);
 
+///
+int compare_ascii_no_case(docstring const & s, docstring const & s2);
+
 ///
 int compare_no_case(std::string const & s, std::string const & s2, unsigned int len);
 
@@ -61,16 +66,14 @@ bool isStrInt(std::string const & str);
 bool isStrUnsignedInt(std::string const & str);
 
 ///
-int strToInt(std::string const & str);
+bool isStrDbl(std::string const & str);
 
-/// convert string to an unsigned integer
-unsigned int strToUnsignedInt(std::string const & str);
+bool isHex(lyx::docstring const & str);
 
-///
-bool isStrDbl(std::string const & str);
+int hexToInt(lyx::docstring const & str);
 
-///
-double strToDbl(std::string const & str);
+/// is \p str pure ascii?
+bool isAscii(docstring const & str);
 
 ///
 char lowercase(char c);
@@ -78,17 +81,26 @@ char lowercase(char c);
 ///
 char uppercase(char c);
 
+/// changes the case only if c is a one-byte char
+char_type lowercase(char_type c);
+
+/// changes the case only if c is a one-byte char
+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);
@@ -97,12 +109,26 @@ 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;
+}
+
+inline bool contains(docstring const & a, char_type b)
+{
+       return a.find(b) != docstring::npos;
+}
+
 ///
 bool containsOnly(std::string const &, std::string const &);
 
@@ -116,6 +142,7 @@ bool containsOnly(std::string const &, std::string const &);
 */
 std::string const token(std::string const & a, char 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
@@ -132,10 +159,24 @@ int tokenPos(std::string const & a, char delim, std::string 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
+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
+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
+*/
+docstring const trim(docstring const & a, char const * p = " ");
+
 /** Trims characters off the end and beginning of a string.
     \code
     trim("ccabccc", "c") == "ab".
@@ -149,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.
@@ -167,6 +210,7 @@ std::string const ltrim(std::string const & a, char const * p = " ");
     \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 does not return a piece
 std::string const split(std::string const & a, char delim);
@@ -174,29 +218,77 @@ 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
-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);
 
 /// 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,
                                 std::string const & delim = std::string(","));
 
-// wrapper around boost::format using one argument %1$s
-std::string bformat(std::string const & fmt, std::string const & arg1);
-// arguments %1$s and %2$s
-std::string bformat(std::string const & fmt, std::string const & arg1, std::string const & arg2);
-// arguments %1$d and %2$d
-std::string bformat(std::string const & fmt, int arg1, int arg2);
-// arguments %1$s and %2$s and %3$s
-std::string bformat(std::string const & fmt, std::string const & arg1, std::string const & arg2,
-               std::string const & arg3);
-// arguments %1$s and %2$s and %3$s and %4$s
-std::string bformat(std::string const & fmt, std::string const & arg1, std::string const & arg2,
-               std::string const & arg3, std::string const & arg4);
+/// 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
+docstring const externalLineEnding(docstring const & str);
+
+/// Convert line endings in any formnat to internal line endings
+docstring const internalLineEnding(docstring const & str);
+
+
+#ifdef I_AM_NOT_AFRAID_OF_HEADER_LIBRARIES
+
+#include <boost/format.hpp>
+
+template<class Arg1>
+docstring bformat(docstring const & fmt, Arg1 arg1)
+{
+       return (boost::basic_format<char_type>(fmt) % arg1).str();
+}
+
+
+template<class Arg1, class 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>
+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>
+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();
+}
+
+#else
+
+template <class Arg1>
+docstring bformat(docstring const & fmt, Arg1);
+
+template <class Arg1, class Arg2>
+docstring bformat(docstring const & fmt, Arg1, Arg2);
+
+template <class Arg1, class Arg2, class Arg3>
+docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3);
+
+template <class Arg1, class Arg2, class Arg3, class Arg4>
+docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
+
+#endif
 
 } // namespace support
 } // namespace lyx