X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fsupport%2Fdocstring.h;h=2c2901bf9d7dcde75e90eeeb2429d4b2c6043408;hb=8d640dc77608bedddb5b00982c23665584f52d21;hp=5b64a08d5c452bd2ad99d92f84cce529493e0f4d;hpb=161db0a9ee7b6aa5284b2c8f48b281242b484b1f;p=lyx.git diff --git a/src/support/docstring.h b/src/support/docstring.h index 5b64a08d5c..2c2901bf9d 100644 --- a/src/support/docstring.h +++ b/src/support/docstring.h @@ -4,11 +4,8 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * Provide a set of typedefs for commonly used things like sizes and - * indices wile trying to stay compatible with types used - * by the standard containers. - * - * \author André Pönitz + * \author Lars Gullik Bjønnes + * \author Georg Baum * * Full author contact details are available in file CREDITS. */ @@ -16,130 +13,84 @@ #ifndef LYX_DOCSTRING_H #define LYX_DOCSTRING_H -#include +#include "support/strfwd.h" + #include namespace lyx { -typedef std::basic_string docstring; - -} - - -#if defined(__GNUC__) && defined(__GNUC_MINOR__) && __GNUC__ == 3 && __GNUC_MINOR__ < 4 -// Missing char_traits methods in gcc 3.3 and older. Taken from gcc 4.2svn. -namespace std { - -template void -char_traits::assign(char_type & c1, char_type const & c2) -{ - c1 = c2; -} - +/// Creates a docstring from a C string of ASCII characters +docstring const from_ascii(char const *); -template bool -char_traits::eq(char_type const & c1, char_type const & c2) -{ - return c1 == c2; -} +/// Creates a docstring from a std::string of ASCII characters +docstring const from_ascii(std::string const &); +/// Creates a std::string of ASCII characters from a docstring +std::string const to_ascii(docstring const &); -template bool -char_traits::lt(char_type const & c1, char_type const & c2) -{ - return c1 < c2; -} +/// Creates a docstring from a UTF8 string. This should go eventually. +docstring const from_utf8(std::string const &); +/// Creates a UTF8 string from a docstring. This should go eventually. +std::string const to_utf8(docstring const &); -template int -char_traits::compare(char_type const * s1, char_type const * s2, std::size_t n) -{ - for (std::size_t i = 0; i < n; ++i) - if (lt(s1[i], s2[i])) - return -1; - else if (lt(s2[i], s1[i])) - return 1; - return 0; -} +/// convert \p s from the encoding of the locale to ucs4. +docstring const from_local8bit(std::string const & s); +/** + * Convert \p s from ucs4 to the encoding of the locale. + * This may fail and throw an exception, the caller is expected to act + * appropriately. + */ +std::string const to_local8bit(docstring const & s); -template std::size_t -char_traits::length(char_type const * p) -{ - std::size_t i = 0; - while (!eq(p[i], char_type())) - ++i; - return i; -} - - -template typename char_traits::char_type const * -char_traits::find(char_type const * s, size_t n, char_type const & a) -{ - for (std::size_t i = 0; i < n; ++i) - if (eq(s[i], a)) - return s + i; - return 0; -} - +/// convert \p s from the encoding of the file system to ucs4. +docstring const from_filesystem8bit(std::string const & s); -template typename char_traits::char_type * -char_traits::move(char_type * s1, char_type const * s2, std::size_t n) -{ - return static_cast(std::memmove(s1, s2, n * sizeof(char_type))); -} +/// convert \p s from ucs4 to the encoding of the file system. +std::string const to_filesystem8bit(docstring const & s); +/// convert \p s from ucs4 to the \p encoding. +std::string const to_iconv_encoding(docstring const & s, + std::string const & encoding); -template typename char_traits::char_type * -char_traits::copy(char_type * s1, char_type const * s2, std::size_t n) -{ - std::copy(s2, s2 + n, s1); - return s1; -} +/// convert \p s from \p encoding to ucs4. +docstring const from_iconv_encoding(std::string const & s, + std::string const & encoding); +/// normalize \p s to precomposed form c +docstring const normalize_c(docstring const & s); -template typename char_traits::char_type * -char_traits::assign(char_type * s, std::size_t n, char_type a) -{ - std::fill_n(s, n, a); - return s; -} +/// Compare a docstring with a C string of ASCII characters +bool operator==(docstring const &, char const *); +/// Compare a C string of ASCII characters with a docstring +inline bool operator==(char const * l, docstring const & r) { return r == l; } -template typename char_traits::char_type -char_traits::to_char_type(int_type const & c) -{ - return static_cast(c); -} +/// Compare a docstring with a C string of ASCII characters +inline bool operator!=(docstring const & l, char const * r) { return !(l == r); } +/// Compare a C string of ASCII characters with a docstring +inline bool operator!=(char const * l, docstring const & r) { return !(r == l); } -template typename char_traits::int_type -char_traits::to_int_type(char_type const & c) -{ - return static_cast(c); -} +/// Concatenate a docstring and a C string of ASCII characters +docstring operator+(docstring const &, char const *); +/// Concatenate a C string of ASCII characters and a docstring +docstring operator+(char const *, docstring const &); -template bool -char_traits::eq_int_type(int_type const & c1, int_type const & c2) -{ - return c1 == c2; -} +/// Concatenate a docstring and a single ASCII character +docstring operator+(docstring const & l, char r); +/// Concatenate a single ASCII character and a docstring +docstring operator+(char l, docstring const & r); -template typename char_traits::int_type -char_traits::eof() -{ - return static_cast(EOF); -} +/// Append a C string of ASCII characters to a docstring +docstring & operator+=(docstring &, char const *); +/// Append a single ASCII character to a docstring +docstring & operator+=(docstring & l, char r); -template typename char_traits::int_type -char_traits::not_eof(int_type const & c) -{ - return !eq_int_type(c, eof()) ? c : to_int_type(char_type()); -} +} // namespace lyx -} -#endif #endif