]> git.lyx.org Git - lyx.git/blobdiff - src/support/lstrings.h
Introduce wide streams. This fixes the remaining problems of plain text
[lyx.git] / src / support / lstrings.h
index d85dca7a4e716d3afdea584ecc036d4d0d7c744e..2f61aaa8f4b1ed8b743c5af5e8b582c028e21372 100644 (file)
 #ifndef LSTRINGS_H
 #define LSTRINGS_H
 
+#include "support/docstring.h"
+
 #include <vector>
 
-#include "support/std_string.h"
 
 namespace lyx {
 namespace support {
 
 ///
-int compare_no_case(string const & s, string const & s2);
+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_ascii_no_case(std::string const & s, std::string const & s2);
 
 ///
-int compare_ascii_no_case(string const & s, string const & s2);
+int compare_ascii_no_case(docstring const & s, docstring const & s2);
 
 ///
-int compare_no_case(string const & s, string const & s2, unsigned int len);
+int compare_no_case(std::string const & s, std::string const & s2, unsigned int len);
 
 ///
 inline
@@ -55,22 +60,13 @@ int compare(char const * a, char const * b, unsigned int len)
 }
 
 ///
-bool isStrInt(string const & str);
-
-/// does the string represent an unsigned integer value ?
-bool isStrUnsignedInt(string const & str);
-
-///
-int strToInt(string const & str);
+bool isStrInt(std::string const & str);
 
-/// convert string to an unsigned integer
-unsigned int strToUnsignedInt(string const & str);
-
-///
-bool isStrDbl(string const & str);
+/// does the std::string represent an unsigned integer value ?
+bool isStrUnsignedInt(std::string const & str);
 
 ///
-double strToDbl(string const & str);
+bool isStrDbl(std::string const & str);
 
 ///
 char lowercase(char c);
@@ -78,45 +74,45 @@ 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
-string const ascii_lowercase(string const &);
+std::string const ascii_lowercase(std::string const &);
 
 ///
-string const lowercase(string const &);
+std::string const lowercase(std::string const &);
 
 ///
-string const uppercase(string const &);
+std::string const uppercase(std::string const &);
 
-/// Does the string start with this prefix?
-bool prefixIs(string const &, string const &);
+/// Does the std::string start with this prefix?
+bool prefixIs(std::string const &, std::string const &);
 
 /// Does the string end with this char?
-bool suffixIs(string const &, char);
+bool suffixIs(std::string const &, char);
 
-/// Does the string end with this suffix?
-bool suffixIs(string const &, string const &);
-
-///
-bool contains(string const & a, string const & b);
+/// Does the std::string end with this suffix?
+bool suffixIs(std::string const &, std::string const &);
 
 ///
-bool contains(string const & a, char b);
-
-/// This should probably we rewritten to be more general.
-class contains_functor {
-public:
-       typedef string first_argument_type;
-       typedef string second_argument_type;
-       typedef bool result_type;
-
-       bool operator()(string const & haystack, string const & needle) const {
-               return contains(haystack, needle);
-       }
-};
+template <typename B>
+bool contains(std::string const & a, B b)
+{
+       return a.find(b) != std::string::npos;
+}
 
+template <typename B>
+bool contains(lyx::docstring const & a, B b)
+{
+       return a.find(b) != lyx::docstring::npos;
+}
 
 ///
-bool containsOnly(string const &, string const &);
+bool containsOnly(std::string const &, std::string const &);
 
 /** Extracts a token from this string at the nth delim.
     Doesn't modify the original string. Similar to strtok.
@@ -126,8 +122,10 @@ bool containsOnly(string const &, string const &);
     token("a;bc;d", ';', 2) == "d";
     \endcode
 */
-string const token(string const & a, char delim, int n);
+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);
 
 /** Search a token in this string using the delim.
     Doesn't modify the original string. Returns -1 in case of
@@ -138,36 +136,51 @@ string const token(string const & a, char delim, int n);
     tokenPos("a;bc;d", ';', "d") == 2;
     \endcode
 */
-int tokenPos(string const & a, char delim, string const & tok);
+int tokenPos(std::string const & a, char delim, std::string const & tok);
 
 
 /// Substitute all \a oldchar with \a newchar
-string const subst(string const & a, char oldchar, char 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);
+
+/// 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
-string const subst(string const & a,
-                  string const & oldstr, string const & newstr);
+lyx::docstring const subst(lyx::docstring const & a,
+               lyx::docstring const & oldstr, lyx::docstring const & newstr);
 
 /** Trims characters off the end and beginning of a string.
     \code
     trim("ccabccc", "c") == "ab".
     \endcode
 */
-string const trim(string const & a, char const * p = " ");
+lyx::docstring const trim(lyx::docstring const & a, char const * p = " ");
+
+/** Trims characters off the end and beginning of a string.
+    \code
+    trim("ccabccc", "c") == "ab".
+    \endcode
+*/
+std::string const trim(std::string const & a, char const * p = " ");
 
 /** Trims characters off the end of a string.
     \code
     rtrim("abccc", "c") == "ab".
     \endcode
 */
-string const rtrim(string const & a, char const * p = " ");
+std::string const rtrim(std::string const & a, char const * p = " ");
 
 /** Trims characters off the beginning of a string.
     \code
    ltrim("ababcdef", "ab") = "cdef"
     \endcode
 */
-string const ltrim(string const & a, char const * p = " ");
+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.
@@ -178,37 +191,83 @@ string const ltrim(string const & a, char const * p = " ");
     s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";
     \endcode
 */
-string const split(string const & a, string & piece, char delim);
+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
-string const split(string const & a, char delim);
+std::string const split(std::string const & a, char delim);
 
 /// Same as split but uses the last delim.
-string const rsplit(string const & a, string & piece, char delim);
+std::string const rsplit(std::string const & a, std::string & piece, char delim);
 
 /// Escapes non ASCII chars
-string const escape(string const & lab);
+std::string const escape(std::string const & lab);
 
 /// gives a vector of stringparts which have the delimiter delim
-std::vector<string> const getVectorFromString(string const & str,
-                                             string const & delim = ",");
+std::vector<std::string> const getVectorFromString(std::string const & str,
+                                             std::string const & delim = std::string(","));
 
 // the same vice versa
-string const getStringFromVector(std::vector<string> const & vec,
-                                string const & delim = ",");
-
-// wrapper around boost::format using one argument %1$s
-string bformat(string const & fmt, string const & arg1);
-// arguments %1$s and %2$s
-string bformat(string const & fmt, string const & arg1, string const & arg2);
-// arguments %1$d and %2$d
-string bformat(string const & fmt, int arg1, int arg2);
-// arguments %1$s and %2$s and %3$s
-string bformat(string const & fmt, string const & arg1, string const & arg2,
-               string const & arg3);
-// arguments %1$s and %2$s and %3$s and %4$s
-string bformat(string const & fmt, string const & arg1, string const & arg2,
-               string const & arg3, string const & arg4);
+std::string const getStringFromVector(std::vector<std::string> const & vec,
+                                std::string const & delim = std::string(","));
+
+/// 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);
+
+
+#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);
+
+template <class Arg1, class Arg2>
+lyx::docstring bformat(lyx::docstring const & fmt, Arg1, Arg2);
+
+template <class Arg1, class Arg2, class Arg3>
+lyx::docstring bformat(lyx::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);
+
+#endif
 
 } // namespace support
 } // namespace lyx