* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
*
* Full author contact details are available in file CREDITS.
#include "support/docstring.h"
-#include <cstring>
#include <string>
#include <vector>
/// Compare \p s and \p s2, ignoring the case of ASCII characters only.
int compare_ascii_no_case(docstring const & s, docstring const & s2);
-///
-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);
/// 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 str start with c?
+bool prefixIs(docstring const & str, char_type c);
-/// Does the std::string start with this prefix?
-bool prefixIs(std::string const &, std::string const &);
-bool prefixIs(docstring const &, docstring const &);
+/// Does str start with pre?
+bool prefixIs(std::string const & str, std::string const & pre);
+bool prefixIs(docstring const & str, docstring const & pre);
/// 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?
+/// Does the string end with this suffix?
bool suffixIs(std::string const &, std::string const &);
+bool suffixIs(docstring const &, docstring const &);
-///
+/// Is b contained in a?
inline bool contains(std::string const & a, std::string const & b)
{
return a.find(b) != std::string::npos;
\endcode
*/
int tokenPos(std::string const & a, char delim, std::string const & tok);
+int tokenPos(docstring const & a, char_type delim, docstring const & tok);
/// Substitute all \a oldchar with \a newchar
*/
std::string const trim(std::string const & a, char const * p = " ");
-/** Trims characters off the end of a string.
+/** Trims characters off the end of a string, removing any character
+ in p.
\code
- rtrim("abccc", "c") == "ab".
+ rtrim("abcde", "dec") == "ab".
\endcode
*/
std::string const rtrim(std::string const & a, char const * p = " ");
/** Trims characters off the beginning of a string.
\code
- ("ababcdef", "ab") = "cdef"
+ ("abbabcdef", "ab") = "cdef"
\endcode
*/
std::string const ltrim(std::string const & a, char const * p = " ");
/// problems in latex labels.
docstring const escape(docstring const & lab);
+/// Word-wraps the provided docstring, returning a line-broken string
+/// of width no wider than width, with the string broken at spaces.
+/// If the string cannot be broken appropriately, it returns something
+/// with "..." at the end, again no wider than width.
+/// We assume here that str does not contain newlines.
+/// If indent is positive, then the first line is indented that many
+/// spaces. If it is negative, then successive lines are indented, as
+/// if the first line were "outdented".
+docstring wrap(docstring const & str, int const indent = 0,
+ size_t const width = 80);
+
+/// Like the preceding, except it is intended to operate on strings
+/// that may contain embedded newlines.
+/// \param numlines Don't return more than numlines lines. If numlines
+/// is 0, we return everything.
+docstring wrapParas(docstring const & str, int const indent = 0,
+ size_t const width = 80, size_t const maxlines = 10);
+
/// gives a vector of stringparts which have the delimiter delim
+/// If \p keepempty is true, empty strings will be pushed to the vector as well
std::vector<std::string> const getVectorFromString(std::string const & str,
- std::string const & delim = std::string(","));
+ std::string const & delim = std::string(","),
+ bool keepempty = false);
std::vector<docstring> const getVectorFromString(docstring const & str,
- docstring const & delim = from_ascii(","));
+ docstring const & delim = from_ascii(","), bool keepempty = false);
-// the same vice versa
+/// the same vice versa
std::string const getStringFromVector(std::vector<std::string> const & vec,
std::string const & delim = std::string(","));
+docstring const getStringFromVector(std::vector<docstring> const & vec,
+ docstring const & delim = from_ascii(","));
/// 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);
-
-
template <class Arg1>
docstring bformat(docstring const & fmt, Arg1);
docstring bformat(docstring const & fmt, Arg1, Arg2, Arg3, Arg4);
+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
projects / lyx.git / blobdiff