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() noexcept {}
25 const char * what() const noexcept override;
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 if USE_WCHAR_T is not defined. This is because we can't overload
38 operator<< (our character type is not always a real type but sometimes a
39 typedef). Narrow characters of type char can be output as usual.
41 typedef std::basic_ostream<char_type> odocstream;
45 /// File stream for reading UTF8-encoded files with automatic conversion to
47 /// Buffering must be switched off if the encoding is changed after
48 /// construction by calling rdbuf()->pubsetbuf(0, 0).
49 class ifdocstream : public std::basic_ifstream<char_type> {
50 typedef std::basic_ifstream<char_type> base;
53 /// Create a stream with a specific encoding \p enc.
54 /// We must not pass \p enc as string, to avoid confusing it with a file name.
55 explicit ifdocstream(SetEnc const & enc);
56 explicit ifdocstream(const char* s,
57 std::ios_base::openmode mode = std::ios_base::in,
58 std::string const & encoding = "UTF-8");
62 /// File stream for writing files in 8bit encoding \p encoding with automatic
63 /// conversion from UCS4.
65 class ofdocstream : public std::basic_ofstream<char_type> {
66 typedef std::basic_ofstream<char_type> base;
69 /// Create a stream with a specific encoding \p enc.
70 /// We must not pass \p enc as string, to avoid confusing it with a file name.
71 explicit ofdocstream(SetEnc const & enc);
72 explicit ofdocstream(const char* s,
73 std::ios_base::openmode mode = std::ios_base::out|std::ios_base::trunc,
74 std::string const & encoding = "UTF-8");
77 void reset(std::string const & encoding);
82 /// UCS4 input stringstream
83 typedef std::basic_istringstream<char_type> idocstringstream;
85 /// UCS4 output manipulator
86 typedef odocstream & (*odocstream_manip)(odocstream &);
89 /// Helper struct for changing stream encoding
92 * It is important that this constructor is explicit.
93 * Otherwise the attempt to output a std::string to an odocstream
94 * would compile, but cause a (probably failing) encoding change
95 * instead of string output (we do not define
96 * operator<<(odocstream &, std::string) since we want to avoid
97 * outputting strings with unspecified encoding)
99 explicit SetEnc(std::string const & e) : encoding(e) {}
100 std::string encoding;
103 /// Helper function for changing stream encoding
104 SetEnc setEncoding(std::string const & encoding);
106 /** Change the encoding of \p os to \p e.encoding.
107 \p e.encoding must be a valid iconv name of an 8bit encoding.
108 This does nothing if the stream is not a file stream, since only
109 file streams do have an associated 8bit encoding.
111 os << setEncoding("ISO-8859-1");
114 odocstream & operator<<(odocstream & os, SetEnc const & e);
115 idocstream & operator<<(idocstream & os, SetEnc const & e);