4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef LYX_DOCSTREAM_H
13 #define LYX_DOCSTREAM_H
15 #include "support/docstring.h"
22 class iconv_codecvt_facet_exception : public std::exception {
24 virtual ~iconv_codecvt_facet_exception() throw() {}
25 virtual const char * what() const throw();
28 /// Base class for UCS4 input streams
29 typedef std::basic_istream<char_type> idocstream;
31 /** Base class for UCS4 output streams.
32 If you want to output a single UCS4 character, use \code
36 \endcode . The latter will not output the character, but the code point
37 as number. This is because we can't overload operator<< (our character
38 type is not a real type but a typedef). Narrow characters of type char
39 can be output as usual.
41 typedef std::basic_ostream<char_type> odocstream;
43 /// File stream for reading UTF8-encoded files with automatic conversion to
45 class idocfstream : public std::basic_ifstream<char_type> {
46 typedef std::basic_ifstream<char_type> base;
48 idocfstream(std::string const & encoding = "UTF-8");
49 explicit idocfstream(const char* s,
50 std::ios_base::openmode mode = std::ios_base::in,
51 std::string const & encoding = "UTF-8");
55 /// File stream for writing files in 8bit encoding \p encoding with automatic
56 /// conversion from UCS4.
57 class odocfstream : public std::basic_ofstream<char_type> {
58 typedef std::basic_ofstream<char_type> base;
60 odocfstream(std::string const & encoding = "UTF-8");
61 explicit odocfstream(const char* s,
62 std::ios_base::openmode mode = std::ios_base::out|std::ios_base::trunc,
63 std::string const & encoding = "UTF-8");
67 /// UCS4 input stringstream
68 typedef std::basic_istringstream<char_type> idocstringstream;
70 /// UCS4 output stringstream
71 typedef std::basic_ostringstream<char_type> odocstringstream;
74 odocstream & operator<<(odocstream & os, char c)
80 /// Helper struct for changing stream encoding
82 SetEnc(std::string const & e) : encoding(e) {}
86 /// Helper function for changing stream encoding
87 SetEnc setEncoding(std::string const & encoding);
89 /** Change the encoding of \p os to \p e.encoding.
90 \p e.encoding must be a valid iconv name of an 8bit encoding.
91 This does nothing if the stream is not a file stream, since only
92 file streams do have an associated 8bit encoding.
94 os << setEncoding("ISO-8859-1");
97 odocstream & operator<<(odocstream & os, SetEnc e);