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
16 #include "support/docstring.h"
18 #if defined(_MSC_VER) && (_MSC_VER >= 1600)
19 // Ugly workaround for MSVC10 STL bug:
20 // std::numpunct has a hardcoded dllimport in definition, but we wanna it with 32 bit
21 // so we can't import it and must define it but then the compiler complains.
22 #include "support/numpunct_lyx_char_type.h"
30 class iconv_codecvt_facet_exception : public std::exception {
32 virtual ~iconv_codecvt_facet_exception() throw() {}
33 virtual const char * what() const throw();
36 /// Base class for UCS4 input streams
37 typedef std::basic_istream<char_type> idocstream;
39 /** Base class for UCS4 output streams.
40 If you want to output a single UCS4 character, use \code
44 \endcode . The latter will not output the character, but the code point
45 as number. This is because we can't overload operator<< (our character
46 type is not a real type but a typedef). Narrow characters of type char
47 can be output as usual.
49 typedef std::basic_ostream<char_type> odocstream;
51 /// File stream for reading UTF8-encoded files with automatic conversion to
53 class ifdocstream : public std::basic_ifstream<char_type> {
54 typedef std::basic_ifstream<char_type> base;
57 explicit ifdocstream(const char* s,
58 std::ios_base::openmode mode = std::ios_base::in,
59 std::string const & encoding = "UTF-8");
63 /// File stream for writing files in 8bit encoding \p encoding with automatic
64 /// conversion from UCS4.
66 class ofdocstream : public std::basic_ofstream<char_type> {
67 typedef std::basic_ofstream<char_type> base;
70 explicit ofdocstream(const char* s,
71 std::ios_base::openmode mode = std::ios_base::out|std::ios_base::trunc,
72 std::string const & encoding = "UTF-8");
75 void reset(std::string const & encoding);
80 /// UCS4 input stringstream
81 typedef std::basic_istringstream<char_type> idocstringstream;
83 /// UCS4 output stringstream
84 typedef std::basic_ostringstream<char_type> odocstringstream;
86 /// UCS4 output manipulator
87 typedef odocstream & (*odocstream_manip)(odocstream &);
89 /** Wrapper class for odocstream.
90 This class is used to automatically count the lines of the exported latex
91 code and also to ensure that no blank lines may be inadvertently output.
92 To this end, use the special variables "breakln" and "safebreakln" as if
93 they were iomanip's to ensure that the next output will start at the
94 beginning of a line. Using "breakln", a '\n' char will be output if needed,
95 while using "safebreakln", "%\n" will be output if needed.
101 otexstream(odocstream & os, TexRow & texrow)
102 : os_(os), texrow_(texrow),
103 canbreakline_(false), protectspace_(false) {}
105 odocstream & os() { return os_; }
107 TexRow & texrow() { return texrow_; }
109 void put(char_type const & c);
111 void canBreakLine(bool breakline) { canbreakline_ = breakline; }
113 bool canBreakLine() const { return canbreakline_; }
115 void protectSpace(bool protectspace) { protectspace_ = protectspace; }
117 bool protectSpace() const { return protectspace_; }
129 /// Helper structs for breaking a line
134 struct SafeBreakLine {
138 extern BreakLine breakln;
139 extern SafeBreakLine safebreakln;
142 otexstream & operator<<(otexstream &, BreakLine);
144 otexstream & operator<<(otexstream &, SafeBreakLine);
146 otexstream & operator<<(otexstream &, odocstream_manip);
148 otexstream & operator<<(otexstream &, docstring const &);
150 otexstream & operator<<(otexstream &, char const *);
152 otexstream & operator<<(otexstream &, char);
154 template <typename Type>
155 otexstream & operator<<(otexstream & ots, Type value);
157 /// Helper struct for changing stream encoding
159 SetEnc(std::string const & e) : encoding(e) {}
160 std::string encoding;
163 /// Helper function for changing stream encoding
164 SetEnc setEncoding(std::string const & encoding);
166 /** Change the encoding of \p os to \p e.encoding.
167 \p e.encoding must be a valid iconv name of an 8bit encoding.
168 This does nothing if the stream is not a file stream, since only
169 file streams do have an associated 8bit encoding.
171 os << setEncoding("ISO-8859-1");
174 odocstream & operator<<(odocstream & os, SetEnc e);
175 idocstream & operator<<(idocstream & os, SetEnc e);