* support/os_unix.C (canAutoOpen, autoOpenFile): on Mac OS X, use

[lyx.git] / src / support / docstring.h

diff --git a/src/support/docstring.h b/src/support/docstring.h
index 5b64a08d5c452bd2ad99d92f84cce529493e0f4d..0f097063076ee971fe4a6abc5f9b0161084bd91d 100644 (file)
--- 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,19 +13,85 @@
 #ifndef LYX_DOCSTRING_H
 #define LYX_DOCSTRING_H
 
-#include <boost/cstdint.hpp>
+#include "support/types.h"
+
 #include <string>
+#include <typeinfo>
 
 namespace lyx {
 
-typedef std::basic_string<boost::uint32_t> docstring;
+/// String type for storing the main text in UCS4 encoding
+typedef std::basic_string<char_type> docstring;
 
-}
+/// Creates a docstring from a C string of ASCII characters
+docstring const from_ascii(char const *);
+
+/// 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 &);
+
+/// 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 &);
+
+/// convert \p s from the encoding of the locale to ucs4.
+docstring const from_local8bit(std::string const & s);
+
+/// Exception thrown by to_local8bit if the string could not be converted
+class to_local8bit_failure : public std::bad_cast {
+public:
+       to_local8bit_failure() throw() : std::bad_cast() {}
+       virtual ~to_local8bit_failure() throw() {}
+       virtual const char* what() const throw();
+};
+
+/**
+ * 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);
+
+/// Compare a docstring with a C string of ASCII characters
+bool operator==(lyx::docstring const &, char const *);
+
+/// Compare a C string of ASCII characters with a docstring
+inline bool operator==(char const * l, lyx::docstring const & r) { return r == l; }
+
+/// Compare a docstring with a C string of ASCII characters
+inline bool operator!=(lyx::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, lyx::docstring const & r) { return !(r == l); }
+
+/// Concatenate a docstring and a C string of ASCII characters
+lyx::docstring operator+(lyx::docstring const &, char const *);
+
+/// Concatenate a C string of ASCII characters and a docstring
+lyx::docstring operator+(char const *, lyx::docstring const &);
+
+/// Concatenate a docstring and a single ASCII character
+lyx::docstring operator+(lyx::docstring const & l, char r);
+
+/// Concatenate a single ASCII character and a docstring
+lyx::docstring operator+(char l, lyx::docstring const & r);
+
+/// Append a C string of ASCII characters to a docstring
+lyx::docstring & operator+=(lyx::docstring &, char const *);
+
+/// Append a single ASCII character to a docstring
+lyx::docstring & operator+=(lyx::docstring & l, char r);
+
+} // namespace lyx
 
 
-#if defined(__GNUC__) && defined(__GNUC_MINOR__) && __GNUC__ == 3 && __GNUC_MINOR__ < 4
+#if SIZEOF_WCHAR_T != 4 && 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 {
+namespace std {$
 
 template<typename T> void
 char_traits<T>::assign(char_type & c1, char_type const & c2)