src/support/docstream.h

   1 // -*- C++ -*-
   2 /**
   3  * \file docstream.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Georg Baum
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef LYX_DOCSTREAM_H
  13 #define LYX_DOCSTREAM_H
  14
  15 #include "TexRow.h"
  16 #include "support/docstring.h"
  17
  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"
  23 #endif
  24
  25 #include <fstream>
  26 #include <sstream>
  27
  28 namespace lyx {
  29
  30 class iconv_codecvt_facet_exception : public std::exception {
  31 public:
  32         virtual ~iconv_codecvt_facet_exception() throw() {}
  33         virtual const char * what() const throw();
  34 };
  35
  36 /// Base class for UCS4 input streams
  37 typedef std::basic_istream<char_type> idocstream;
  38
  39 /** Base class for UCS4 output streams.
  40     If you want to output a single UCS4 character, use \code
  41     os.put(c);
  42     \endcode, not \code
  43     os << c;
  44     \endcode . The latter will not output the character, but the code point
  45     as number if USE_WCHAR_T is not defined. This is because we can't overload
  46     operator<< (our character type is not always a real type but sometimes a
  47     typedef). Narrow characters of type char can be output as usual.
  48  */
  49 typedef std::basic_ostream<char_type> odocstream;
  50
  51 /// File stream for reading UTF8-encoded files with automatic conversion to
  52 /// UCS4.
  53 class ifdocstream : public std::basic_ifstream<char_type> {
  54         typedef std::basic_ifstream<char_type> base;
  55 public:
  56         ifdocstream();
  57         explicit ifdocstream(const char* s,
  58                 std::ios_base::openmode mode = std::ios_base::in,
  59                 std::string const & encoding = "UTF-8");
  60         ~ifdocstream() {}
  61 };
  62
  63 /// File stream for writing files in 8bit encoding \p encoding with automatic
  64 /// conversion from UCS4.
  65
  66 class ofdocstream : public std::basic_ofstream<char_type> {
  67         typedef std::basic_ofstream<char_type> base;
  68 public:
  69         ofdocstream();
  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");
  73         ~ofdocstream() {}
  74         ///
  75         void reset(std::string const & encoding);
  76 };
  77
  78
  79
  80 /// UCS4 input stringstream
  81 typedef std::basic_istringstream<char_type> idocstringstream;
  82
  83 /// UCS4 output manipulator
  84 typedef odocstream & (*odocstream_manip)(odocstream &);
  85
  86 /** Wrapper class for odocstream.
  87     This class is used to automatically count the lines of the exported latex
  88     code and also to ensure that no blank lines may be inadvertently output.
  89     To this end, use the special variables "breakln" and "safebreakln" as if
  90     they were iomanip's to ensure that the next output will start at the
  91     beginning of a line. Using "breakln", a '\n' char will be output if needed,
  92     while using "safebreakln", "%\n" will be output if needed.
  93     The class also records the last output character.
  94   */
  95
  96 class otexstream {
  97 public:
  98         ///
  99         otexstream(odocstream & os, TexRow & texrow)
 100                 : os_(os), texrow_(texrow),
 101                   canbreakline_(false), protectspace_(false), lastchar_(0) {}
 102         ///
 103         odocstream & os() { return os_; }
 104         ///
 105         TexRow & texrow() { return texrow_; }
 106         ///
 107         void put(char_type const & c);
 108         ///
 109         void canBreakLine(bool breakline) { canbreakline_ = breakline; }
 110         ///
 111         bool canBreakLine() const { return canbreakline_; }
 112         ///
 113         void protectSpace(bool protectspace) { protectspace_ = protectspace; }
 114         ///
 115         bool protectSpace() const { return protectspace_; }
 116         ///
 117         void lastChar(char_type const & c) { lastchar_ = c; }
 118         ///
 119         char_type lastChar() const { return lastchar_; }
 120 private:
 121         ///
 122         odocstream & os_;
 123         ///
 124         TexRow & texrow_;
 125         ///
 126         bool canbreakline_;
 127         ///
 128         bool protectspace_;
 129         ///
 130         char_type lastchar_;
 131 };
 132
 133 /// Helper structs for breaking a line
 134 struct BreakLine {
 135         char n;
 136 };
 137
 138 struct SafeBreakLine {
 139         char n;
 140 };
 141
 142 extern BreakLine breakln;
 143 extern SafeBreakLine safebreakln;
 144
 145 ///
 146 otexstream & operator<<(otexstream &, BreakLine);
 147 ///
 148 otexstream & operator<<(otexstream &, SafeBreakLine);
 149 ///
 150 otexstream & operator<<(otexstream &, odocstream_manip);
 151 ///
 152 otexstream & operator<<(otexstream &, docstring const &);
 153 ///
 154 otexstream & operator<<(otexstream &, std::string const &);
 155 ///
 156 otexstream & operator<<(otexstream &, char const *);
 157 ///
 158 otexstream & operator<<(otexstream &, char);
 159 ///
 160 template <typename Type>
 161 otexstream & operator<<(otexstream & ots, Type value);
 162
 163 /// Helper struct for changing stream encoding
 164 struct SetEnc {
 165         SetEnc(std::string const & e) : encoding(e) {}
 166         std::string encoding;
 167 };
 168
 169 /// Helper function for changing stream encoding
 170 SetEnc setEncoding(std::string const & encoding);
 171
 172 /** Change the encoding of \p os to \p e.encoding.
 173     \p e.encoding must be a valid iconv name of an 8bit encoding.
 174     This does nothing if the stream is not a file stream, since only
 175     file streams do have an associated 8bit encoding.
 176     Usage: \code
 177     os << setEncoding("ISO-8859-1");
 178     \endcode
 179  */
 180 odocstream & operator<<(odocstream & os, SetEnc e);
 181 idocstream & operator<<(idocstream & os, SetEnc e);
 182
 183 }
 184
 185 #endif