// -*- C++ -*-
-
-/** String helper functions.
- \file lstrings.h
- This is a collection of string helper functions that works
- together with string (and later also with STL String. Some of these
- would certainly benefit from a rewrite/optimization.
- \author Lars Gullik Bjønnes
- \author Jean-Marc Lasgouttes
-*/
+/**
+ * \file lstrings.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ *
+ * Full author contact details are available in file CREDITS.
+ *
+ * A collection of string helper functions that works with string.
+ * Some of these would certainly benefit from a rewrite/optimization.
+ */
#ifndef LSTRINGS_H
#define LSTRINGS_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "support/docstring.h"
#include <vector>
-#include "Lsstream.h"
-#include "LString.h"
+namespace lyx {
+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(string const & s, string 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
}
///
-bool isStrInt(string const & str);
+bool isStrInt(std::string const & str);
-/// does the string represent an unsigned integer value ?
-bool isStrUnsignedInt(string const & str);
-
-///
-int strToInt(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);
///
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 &);
-/// convert \a T to string
-template<typename T>
-inline
-string const tostr(T const & t)
-{
- ostringstream ostr;
- ostr << t;
- return ostr.str().c_str();
- // We need to use the .c_str since we sometimes are using
- // our own string class and that is not compatible with
- // basic_string<char>. (of course we don't want this later)
-}
+/// 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(std::string const &, char);
+
+/// Does the std::string end with this suffix?
+bool suffixIs(std::string const &, std::string const &);
///
-template<>
-inline
-string const tostr(bool const & b)
+template <typename B>
+bool contains(std::string const & a, B b)
{
- return (b ? "true" : "false");
+ return a.find(b) != std::string::npos;
}
-///
-template<>
-inline
-string const tostr(string const & s)
+template <typename B>
+bool contains(lyx::docstring const & a, B b)
{
- return s;
+ return a.find(b) != lyx::docstring::npos;
}
-/// Does the string start with this prefix?
-bool prefixIs(string const &, char const *);
-
-/// Does the string start with this prefix?
-bool prefixIs(string const &, string const &);
-
-/// Does the string end with this char?
-bool suffixIs(string const &, char);
-
-/// Does the string end with this suffix?
-bool suffixIs(string const &, char const *);
-
-/// Does the string end with this suffix?
-bool suffixIs(string const &, string const &);
-
-///
-bool contains(string const & a, string const & b);
-
///
-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);
- }
-};
-
-
-///
-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.
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
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);
-/** Compares a string and a (simple) regular expression
- The only element allowed is "*" for any string of characters
- */
-bool regexMatch(string const & a, string const & pattern);
+/// 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
-string const subst(string const & a, char oldchar, char 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
-string const subst(string const & a,
- char const * oldstr, string const & newstr);
+/// 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);
-/** Strips characters off the end of a string.
+/** Trims characters off the end and beginning of a string.
\code
- strip("abccc", "c") == "ab".
+ trim("ccabccc", "c") == "ab".
\endcode
*/
-string const strip(string const & a, char const * p = " ");
+lyx::docstring const trim(lyx::docstring const & a, char const * p = " ");
-/** Strips characters off the beginning of a string.
+/** Trims characters off the end and beginning of a string.
\code
- frontstrip("ababcdef", "ab") = "cdef"
+ trim("ccabccc", "c") == "ab".
\endcode
*/
-string const frontStrip(string const & a, char const * p = " ");
+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
+*/
+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
+*/
+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.
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 = ",");
+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
#endif
projects / lyx.git / blobdiff