Fix bug 9798.

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

diff --git a/src/support/docstream.h b/src/support/docstream.h
index 167bdd1e218a042dd2aa30a1f7bd4bab71d2d59b..409c7557a85cbdd8a854f80f127a2f6c58dd0bee 100644 (file)
--- a/src/support/docstream.h
+++ b/src/support/docstream.h
@@ -14,13 +14,6 @@
 
 #include "support/docstring.h"
 
-#if defined(_MSC_VER) && (_MSC_VER >= 1600) 
-// Ugly workaround for MSVC10 STL bug:
-// std::numpunct has a hardcoded dllimport in definition, but we wanna it with 32 bit 
-// so we can't import it and must define it but then the compiler complains.
-#include "support/numpunct_lyx_char_type.h"
-#endif
-
 #include <fstream>
 #include <sstream>
 
@@ -41,18 +34,25 @@ typedef std::basic_istream<char_type> idocstream;
     \endcode, not \code
     os << c;
     \endcode . The latter will not output the character, but the code point
-    as number. This is because we can't overload operator<< (our character
-    type is not a real type but a typedef). Narrow characters of type char
-    can be output as usual.
+    as number if USE_WCHAR_T is not defined. This is because we can't overload
+    operator<< (our character type is not always a real type but sometimes a
+    typedef). Narrow characters of type char can be output as usual.
  */
 typedef std::basic_ostream<char_type> odocstream;
 
+struct SetEnc;
+
 /// File stream for reading UTF8-encoded files with automatic conversion to
 /// UCS4.
+/// Buffering must be switched off if the encoding is changed after
+/// construction by calling rdbuf()->pubsetbuf(0, 0).
 class ifdocstream : public std::basic_ifstream<char_type> {
        typedef std::basic_ifstream<char_type> base;
 public:
        ifdocstream();
+       /// Create a stream with a specific encoding \p enc.
+       /// We must not pass \p enc as string, to avoid confusing it with a file name.
+       explicit ifdocstream(SetEnc const & enc);
        explicit ifdocstream(const char* s,
                std::ios_base::openmode mode = std::ios_base::in,
                std::string const & encoding = "UTF-8");
@@ -66,6 +66,9 @@ class ofdocstream : public std::basic_ofstream<char_type> {
        typedef std::basic_ofstream<char_type> base;
 public:
        ofdocstream();
+       /// Create a stream with a specific encoding \p enc.
+       /// We must not pass \p enc as string, to avoid confusing it with a file name.
+       explicit ofdocstream(SetEnc const & enc);
        explicit ofdocstream(const char* s,
                std::ios_base::openmode mode = std::ios_base::out|std::ios_base::trunc,
                std::string const & encoding = "UTF-8");
@@ -79,83 +82,21 @@ public:
 /// UCS4 input stringstream
 typedef std::basic_istringstream<char_type> idocstringstream;
 
-/// UCS4 output stringstream
-typedef std::basic_ostringstream<char_type> odocstringstream;
-
-/** Wrapper class for odocstream.
-    This class helps ensuring that no blank lines may be inadvertently output.
-    Use the special variables "breakln" and "safebreakln" as if they were
-    iomanip's to ensure that the next output will start at the beginning of
-    a line. Using "breakln", a '\n' char will be output if needed, while
-    using "safebreakln", "%\n" will be output if needed.
-    Use countLines() to retrieve the number of \n output since previous call.
-  */
-
-class otexstream {
-public:
-       ///
-       explicit otexstream(odocstream & os)
-               : os_(os), lines_(0), canbreakline_(false), protectspace_(false)
-       {}
-       ///
-       odocstream & os() { return os_; }
-       ///
-       void put(char_type const & c);
-       ///
-       size_t countLines() { size_t l = lines_; lines_ = 0; return l; }
-       ///
-       void addLines(size_t n) { lines_ += n; }
-       ///
-       void canBreakLine(bool breakline) { canbreakline_ = breakline; }
-       ///
-       bool canBreakLine() const { return canbreakline_; }
-       ///
-       void protectSpace(bool protectspace) { protectspace_ = protectspace; }
-       ///
-       bool protectSpace() const { return protectspace_; };
-private:
-       ///
-       odocstream & os_;
-       ///
-       size_t lines_;
-       ///
-       bool canbreakline_;
-       ///
-       bool protectspace_;
-};
-
-/// Helper structs for breaking a line
-struct BreakLine {
-       char n;
-};
-
-struct SafeBreakLine {
-       char n;
-};
+/// UCS4 output manipulator
+typedef odocstream & (*odocstream_manip)(odocstream &);
 
-extern BreakLine breakln;
-extern SafeBreakLine safebreakln;
-
-///
-otexstream & operator<<(otexstream &, BreakLine);
-///
-otexstream & operator<<(otexstream &, SafeBreakLine);
-///
-otexstream & operator<<(otexstream &, docstring const &);
-///
-otexstream & operator<<(otexstream &, char const *);
-///
-otexstream & operator<<(otexstream &, char);
-///
-otexstream & operator<<(otexstream &, double);
-///
-otexstream & operator<<(otexstream &, int);
-///
-otexstream & operator<<(otexstream &, unsigned int);
 
 /// Helper struct for changing stream encoding
 struct SetEnc {
-       SetEnc(std::string const & e) : encoding(e) {}
+       /**
+        * It is important that this constructor is explicit.
+        * Otherwise the attempt to output a std::string to an odocstream
+        * would compile, but cause a (probably failing) encoding change
+        * instead of string output (we do not define
+        * operator<<(odocstream &, std::string) since we want to avoid
+        * outputting strings with unspecified encoding)
+        */
+       explicit SetEnc(std::string const & e) : encoding(e) {}
        std::string encoding;
 };
 
@@ -171,9 +112,8 @@ SetEnc setEncoding(std::string const & encoding);
     \endcode
  */
 odocstream & operator<<(odocstream & os, SetEnc e);
-otexstream & operator<<(otexstream & os, SetEnc e);
 idocstream & operator<<(idocstream & os, SetEnc e);
 
-}
+} // namespace lyx
 
 #endif