]> git.lyx.org Git - lyx.git/blobdiff - src/support/lstrings.h
* get rid of support::absolutePath()
[lyx.git] / src / support / lstrings.h
index 21d57eeb91380727a1cbe65a4a8d1c299477170e..381e818f763336286fa3d1836ad3980a90b9d0e7 100644 (file)
 
 #include "support/docstring.h"
 
+#include <string>
 #include <vector>
 
 
 namespace lyx {
 namespace support {
 
-///
-int compare_no_case(std::string const & s, std::string 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);
 
-///
+/// 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);
 
-///
+/// Compare \p s and \p s2, ignoring the case of ASCII characters only.
 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);
-
-///
-inline
-int compare(char const * a, char const * b)
-{
-#ifndef CXX_GLOBAL_CSTD
-       return std::strcmp(a, b);
-#else
-       return strcmp(a, b);
-#endif
-}
-
-///
-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
-}
-
 ///
 bool isStrInt(std::string const & str);
 
@@ -68,40 +44,64 @@ bool isStrUnsignedInt(std::string const & str);
 ///
 bool isStrDbl(std::string const & str);
 
-bool isHex(lyx::docstring const & str);
+bool isHex(docstring const & str);
 
-int hexToInt(lyx::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);
 
 /// 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);
 
-///
-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 string start with this prefix?
+bool prefixIs(docstring const &, char_type);
 
 /// Does the std::string start with this prefix?
 bool prefixIs(std::string const &, std::string const &);
-bool prefixIs(lyx::docstring const &, lyx::docstring const &);
+bool prefixIs(docstring const &, docstring const &);
 
 /// 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?
 bool suffixIs(std::string const &, std::string const &);
@@ -198,15 +198,18 @@ docstring const rtrim(docstring const & a, char const * p = " ");
 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.
-    The leading string up to delim is returned in piece (not including
-    delim), while the original string is cut from after the delimiter.
-    Example:
+/** Splits the string given in the first argument at the first occurence 
+    of the third argumnent, 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.
+    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);
 
@@ -223,6 +226,8 @@ 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,
@@ -239,39 +244,6 @@ docstring const externalLineEnding(docstring const & str);
 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);
 
@@ -284,7 +256,18 @@ 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
+
+template<> docstring bformat(docstring const & fmt, int arg1);
+template<> docstring bformat(docstring const & fmt, long arg1);
+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, 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