synchronize GTK2 minimum version in docs

[wxWidgets.git] / include / wx / mstream.h

diff --git a/include/wx/mstream.h b/include/wx/mstream.h
index 716c8099673a11bfb622d843d533a6f5255042ab..8e12d632744ffcf5ea18513dd82a2e779848ea5f 100644 (file)
--- a/include/wx/mstream.h
+++ b/include/wx/mstream.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        mstream.h
+// Name:        wx/mstream.h
 // Purpose:     Memory stream classes
 // Author:      Guilhem Lavaux
 // Modified by:
@@ -8,70 +8,103 @@
 // Copyright:   (c) Guilhem Lavaux
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
-#ifndef __WXMMSTREAM_H__
-#define __WXMMSTREAM_H__
 
-#include "wx/object.h"
+#ifndef _WX_WXMMSTREAM_H__
+#define _WX_WXMMSTREAM_H__
+
+#include "wx/defs.h"
+
+#if wxUSE_STREAMS
+
 #include "wx/stream.h"
 
-class wxMemoryStreamBase: public wxStream {
-  DECLARE_CLASS(wxMemoryStreamBase)
- public:
-  wxMemoryStreamBase(char *data, size_t length, int iolimit);
-  virtual ~wxMemoryStreamBase();
-
-  // Input part
-  wxInputStream& Read(void *buffer, size_t size);
-  size_t SeekI(int pos, wxWhenceType whence = wxBeginPosition);
-  size_t TellI() const { return m_position_i; }
-
-  bool Eof() const { return m_eof; }
-  size_t LastRead() const { return m_lastread; }
-
-  // Output part
-  wxOutputStream& Write(const void *buffer, size_t size);
-  size_t SeekO(int pos, wxWhenceType whence = wxBeginPosition);
-  size_t TellO() const { return m_position_o; }
-
-  bool Bad() const { return m_bad; }
-  size_t LastWrite() const { return m_lastwrite; }
-  void Sync() {}
-
- protected:
-  bool ChangeBufferSize(size_t new_length);
-
- protected:
-  bool m_bad, m_eof, m_persistent;
-  size_t m_lastread, m_lastwrite;
-  size_t m_length;
-  size_t m_position_i, m_position_o;
-  char *m_buffer;
-  int m_iolimit;
-};
+class WXDLLIMPEXP_FWD_BASE wxMemoryOutputStream;
 
+class WXDLLIMPEXP_BASE wxMemoryInputStream : public wxInputStream
+{
+public:
+    wxMemoryInputStream(const void *data, size_t length);
+    wxMemoryInputStream(const wxMemoryOutputStream& stream);
+    wxMemoryInputStream(wxInputStream& stream,
+                        wxFileOffset lenFile = wxInvalidOffset)
+    {
+        InitFromStream(stream, lenFile);
+    }
+    wxMemoryInputStream(wxMemoryInputStream& stream)
+        : wxInputStream()
+    {
+        InitFromStream(stream, wxInvalidOffset);
+    }
 
-class wxMemoryInputStream: public wxMemoryStreamBase {
-  DECLARE_CLASS(wxMemoryInputStream)
- public:
-  wxMemoryInputStream(char *data, size_t length)
-     : wxMemoryStreamBase(data, length, 1)
-    {}
-};
+    virtual ~wxMemoryInputStream();
+    virtual wxFileOffset GetLength() const { return m_length; }
+    virtual bool IsSeekable() const { return true; }
+
+    virtual char Peek();
+    virtual bool CanRead() const;
+
+    wxStreamBuffer *GetInputStreamBuffer() const { return m_i_streambuf; }
+
+#if WXWIN_COMPATIBILITY_2_6
+    // deprecated, compatibility only
+    wxDEPRECATED( wxStreamBuffer *InputStreamBuffer() const );
+#endif // WXWIN_COMPATIBILITY_2_6
+
+protected:
+    wxStreamBuffer *m_i_streambuf;
+
+    size_t OnSysRead(void *buffer, size_t nbytes);
+    wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode);
+    wxFileOffset OnSysTell() const;
+
+private:
+    // common part of ctors taking wxInputStream
+    void InitFromStream(wxInputStream& stream, wxFileOffset lenFile);
 
-class wxMemoryOutputStream: public wxMemoryStreamBase {
-  DECLARE_DYNAMIC_CLASS(wxMemoryOutputStream)
- public:
-  wxMemoryOutputStream(char *data = NULL, size_t length = 0)
-     : wxMemoryStreamBase(data, length, 2)
-   {}
+    size_t m_length;
+
+    // copy ctor is implemented above: it copies the other stream in this one
+    DECLARE_ABSTRACT_CLASS(wxMemoryInputStream)
+    wxDECLARE_NO_ASSIGN_CLASS(wxMemoryInputStream);
 };
 
-class wxMemoryStream: public wxMemoryStreamBase {
-  DECLARE_DYNAMIC_CLASS(wxMemoryStream)
- public:
-  wxMemoryStream(char *data = NULL, size_t length = 0)
-     : wxMemoryStreamBase(data, length, 0)
-   {}
+class WXDLLIMPEXP_BASE wxMemoryOutputStream : public wxOutputStream
+{
+public:
+    // if data is !NULL it must be allocated with malloc()
+    wxMemoryOutputStream(void *data = NULL, size_t length = 0);
+    virtual ~wxMemoryOutputStream();
+    virtual wxFileOffset GetLength() const { return m_o_streambuf->GetLastAccess(); }
+    virtual bool IsSeekable() const { return true; }
+
+    size_t CopyTo(void *buffer, size_t len) const;
+
+    wxStreamBuffer *GetOutputStreamBuffer() const { return m_o_streambuf; }
+
+#if WXWIN_COMPATIBILITY_2_6
+    // deprecated, compatibility only
+    wxDEPRECATED( wxStreamBuffer *OutputStreamBuffer() const );
+#endif // WXWIN_COMPATIBILITY_2_6
+
+protected:
+    wxStreamBuffer *m_o_streambuf;
+
+protected:
+    size_t OnSysWrite(const void *buffer, size_t nbytes);
+    wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode);
+    wxFileOffset OnSysTell() const;
+
+    DECLARE_DYNAMIC_CLASS(wxMemoryOutputStream)
+    wxDECLARE_NO_COPY_CLASS(wxMemoryOutputStream);
 };
 
+#if WXWIN_COMPATIBILITY_2_6
+    inline wxStreamBuffer *wxMemoryInputStream::InputStreamBuffer() const { return m_i_streambuf; }
+    inline wxStreamBuffer *wxMemoryOutputStream::OutputStreamBuffer() const { return m_o_streambuf; }
+#endif // WXWIN_COMPATIBILITY_2_6
+
+#endif
+  // wxUSE_STREAMS
+
 #endif
+  // _WX_WXMMSTREAM_H__