Updated PyCrust from Patrick O'Brien

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

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 2e57b4ce7b3e3c651b89b87ba90965ad3ff7a821..d035bde1cfbbffd1ec560d3e97aa272423ce22df 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        stream.h
+// Name:        wx/stream.h

 // Purpose:     "wxWindows stream" base classes
 // Author:      Guilhem Lavaux
 // Modified by:
 // Purpose:     "wxWindows stream" base classes
 // Author:      Guilhem Lavaux
 // Modified by:


@@ -38,21 +38,20 @@ WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream);
 // wxStream: base classes
 // ---------------------------------------------------------------------------
 
 // wxStream: base classes
 // ---------------------------------------------------------------------------
 

-typedef enum
+enum wxStreamError

 {
 {

-  wxSTREAM_NO_ERROR = 0,
-  wxSTREAM_NO_ERR = wxSTREAM_NO_ERROR,
-  wxSTREAM_NOERROR = wxSTREAM_NO_ERROR,
+    wxSTREAM_NO_ERROR = 0,
+    wxSTREAM_NO_ERR = wxSTREAM_NO_ERROR,
+    wxSTREAM_NOERROR = wxSTREAM_NO_ERROR,

 
 

-  wxSTREAM_EOF,
+    wxSTREAM_EOF,

 
 

-  wxSTREAM_WRITE_ERROR,
-  wxSTREAM_WRITE_ERR = wxSTREAM_WRITE_ERROR,
+    wxSTREAM_WRITE_ERROR,
+    wxSTREAM_WRITE_ERR = wxSTREAM_WRITE_ERROR,

 
 

-  wxSTREAM_READ_ERROR,
-  wxSTREAM_READ_ERR = wxSTREAM_READ_ERROR
-
-} wxStreamError;
+    wxSTREAM_READ_ERROR,
+    wxSTREAM_READ_ERR = wxSTREAM_READ_ERROR
+};

 
 // compatibility
 #define wxStream_NOERROR    wxSTREAM_NOERROR
 
 // compatibility
 #define wxStream_NOERROR    wxSTREAM_NOERROR


@@ -67,17 +66,25 @@ public:
     virtual ~wxStreamBase();
 
     // error testing
     virtual ~wxStreamBase();
 
     // error testing

-    wxStreamError LastError() const { return m_lasterror; }

     wxStreamError GetLastError() const { return m_lasterror; }
     bool IsOk() const { return LastError() == wxSTREAM_NOERROR; }
     bool operator!() const { return LastError() != wxSTREAM_NOERROR; }
 
     wxStreamError GetLastError() const { return m_lasterror; }
     bool IsOk() const { return LastError() == wxSTREAM_NOERROR; }
     bool operator!() const { return LastError() != wxSTREAM_NOERROR; }
 

-    virtual size_t GetSize() const { return ~((size_t)0); }
+    virtual size_t GetSize() const { return 0; }
+
+    // deprecated, for compatibility only
+    wxStreamError LastError() const { return m_lasterror; }

     size_t StreamSize() const { return GetSize(); }
 
 protected:
     size_t StreamSize() const { return GetSize(); }
 
 protected:

+    // VZ: these functions are really pure virtual and shouldn't be declared
+    //     in the base class because it creates ambiguties in stream classes
+    //     deriving from both wxInputStream and wxOutputStream
+#if 0

     virtual size_t OnSysRead(void *buffer, size_t bufsize);
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
     virtual size_t OnSysRead(void *buffer, size_t bufsize);
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);

+#endif
+

     virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
     virtual off_t OnSysTell() const;
 
     virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
     virtual off_t OnSysTell() const;
 


@@ -87,7 +94,7 @@ protected:
     wxStreamError m_lasterror;
 };
 
     wxStreamError m_lasterror;
 };
 

-class WXDLLEXPORT wxInputStream: public wxStreamBase
+class WXDLLEXPORT wxInputStream : /* virtual */ public wxStreamBase

 {
 public:
     wxInputStream();
 {
 public:
     wxInputStream();


@@ -115,22 +122,25 @@ public:
 
     // Operators
     wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }
 
     // Operators
     wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }

-#if wxUSE_SERIAL
-    wxInputStream& operator>>(wxObject *& obj);
-#endif

     wxInputStream& operator>>( __wxInputManip func) { return func(*this); }
 
 protected:
     wxInputStream& operator>>( __wxInputManip func) { return func(*this); }
 
 protected:

+    // to be implemented in the derived classes (it should have been pure
+    // virtual)
+    virtual size_t OnSysRead(void *buffer, size_t bufsize);
+

     // Ungetch managers
     char *m_wback;
     size_t m_wbacksize;
     size_t m_wbackcur;
 
     char *AllocSpaceWBack(size_t needed_size);
     // Ungetch managers
     char *m_wback;
     size_t m_wbacksize;
     size_t m_wbackcur;
 
     char *AllocSpaceWBack(size_t needed_size);

-    size_t GetWBack(char *buf, size_t bsize);
+    size_t GetWBack(void *buf, size_t bsize);
+
+    friend class wxStreamBuffer;

 };
 
 };
 

-class WXDLLEXPORT wxOutputStream: public wxStreamBase
+class WXDLLEXPORT wxOutputStream : /* virtual */ public wxStreamBase

 {
 public:
     wxOutputStream();
 {
 public:
     wxOutputStream();


@@ -148,17 +158,21 @@ public:
     virtual void Sync();
 
     wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
     virtual void Sync();
 
     wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }

-#if wxUSE_SERIAL
-    wxOutputStream& operator<<(wxObject& obj);
-#endif

     wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }
     wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }

+
+protected:
+    // to be implemented in the derived classes (it should have been pure
+    // virtual)
+    virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
+
+    friend class wxStreamBuffer;

 };
 
 // ---------------------------------------------------------------------------
 // A stream for measuring streamed output
 // ---------------------------------------------------------------------------
 
 };
 
 // ---------------------------------------------------------------------------
 // A stream for measuring streamed output
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCountingOutputStream: public wxOutputStream
+class WXDLLEXPORT wxCountingOutputStream : public wxOutputStream

 {
 public:
     wxCountingOutputStream();
 {
 public:
     wxCountingOutputStream();


@@ -167,9 +181,9 @@ public:
     bool Ok() const { return TRUE; }
 
 protected:
     bool Ok() const { return TRUE; }
 
 protected:

-    size_t OnSysWrite(const void *buffer, size_t size);
-    off_t OnSysSeek(off_t pos, wxSeekMode mode);
-    off_t OnSysTell() const;
+    virtual size_t OnSysWrite(const void *buffer, size_t size);
+    virtual off_t OnSysSeek(off_t pos, wxSeekMode mode);
+    virtual off_t OnSysTell() const;

 
     size_t m_currentPos;
 };
 
     size_t m_currentPos;
 };


@@ -178,72 +192,86 @@ protected:
 // "Filter" streams
 // ---------------------------------------------------------------------------
 
 // "Filter" streams
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFilterInputStream: public wxInputStream
+class WXDLLEXPORT wxFilterInputStream : public wxInputStream

 {
 public:
     wxFilterInputStream();
     wxFilterInputStream(wxInputStream& stream);
 {
 public:
     wxFilterInputStream();
     wxFilterInputStream(wxInputStream& stream);

-    ~wxFilterInputStream();
+    virtual ~wxFilterInputStream();

 
     char Peek() { return m_parent_i_stream->Peek(); }
 
     size_t GetSize() const { return m_parent_i_stream->GetSize(); }
 
 
     char Peek() { return m_parent_i_stream->Peek(); }
 
     size_t GetSize() const { return m_parent_i_stream->GetSize(); }
 

+    wxInputStream *GetFilterInputStream() const { return m_parent_i_stream; }
+

 protected:
     wxInputStream *m_parent_i_stream;
 };
 
 protected:
     wxInputStream *m_parent_i_stream;
 };
 

-class WXDLLEXPORT wxFilterOutputStream: public wxOutputStream
+class WXDLLEXPORT wxFilterOutputStream : public wxOutputStream

 {
 public:
     wxFilterOutputStream();
     wxFilterOutputStream(wxOutputStream& stream);
 {
 public:
     wxFilterOutputStream();
     wxFilterOutputStream(wxOutputStream& stream);

-    ~wxFilterOutputStream();
+    virtual ~wxFilterOutputStream();

 
     size_t GetSize() const { return m_parent_o_stream->GetSize(); }
 
 
     size_t GetSize() const { return m_parent_o_stream->GetSize(); }
 

+    wxOutputStream *GetFilterOutputStream() const { return m_parent_o_stream; }
+

 protected:
     wxOutputStream *m_parent_o_stream;
 };
 
 // ---------------------------------------------------------------------------
 protected:
     wxOutputStream *m_parent_o_stream;
 };
 
 // ---------------------------------------------------------------------------

-// Stream buffer
+// Stream buffer: this class can be derived from and passed to
+// wxBufferedStreams to implement custom buffering

 // ---------------------------------------------------------------------------
 
 class WXDLLEXPORT wxStreamBuffer
 {
 public:
 // ---------------------------------------------------------------------------
 
 class WXDLLEXPORT wxStreamBuffer
 {
 public:

-    typedef enum {
-        read = 0, write, read_write
-    } BufMode;
+    enum BufMode
+    {
+        read,
+        write,
+        read_write
+    };

 
     wxStreamBuffer(wxStreamBase& stream, BufMode mode);
     wxStreamBuffer(BufMode mode);
     wxStreamBuffer(const wxStreamBuffer& buf);
 
     wxStreamBuffer(wxStreamBase& stream, BufMode mode);
     wxStreamBuffer(BufMode mode);
     wxStreamBuffer(const wxStreamBuffer& buf);

-    ~wxStreamBuffer();
+    virtual ~wxStreamBuffer();

 
     // Filtered IO
 
     // Filtered IO

-    size_t Read(void *buffer, size_t size);
+    virtual size_t Read(void *buffer, size_t size);

     size_t Read(wxStreamBuffer *buf);
     size_t Read(wxStreamBuffer *buf);

-    size_t Write(const void *buffer, size_t size);
+    virtual size_t Write(const void *buffer, size_t size);

     size_t Write(wxStreamBuffer *buf);
 
     size_t Write(wxStreamBuffer *buf);
 

-    char Peek();
-    char GetChar();
-    void PutChar(char c);
-    off_t Tell() const;
-    off_t Seek(off_t pos, wxSeekMode mode);
+    virtual char Peek();
+    virtual char GetChar();
+    virtual void PutChar(char c);
+    virtual off_t Tell() const;
+    virtual off_t Seek(off_t pos, wxSeekMode mode);

 
     // Buffer control
     void ResetBuffer();
 
     // Buffer control
     void ResetBuffer();

-    void SetBufferIO(char *buffer_start, char *buffer_end);
+
+    // NB: the buffer must always be allocated with malloc() if takeOwn is
+    //     TRUE as it will be deallocated by free()
+    void SetBufferIO(void *start, void *end, bool takeOwnership = FALSE);
+    void SetBufferIO(void *start, size_t len, bool takeOwnership = FALSE);

     void SetBufferIO(size_t bufsize);
     void SetBufferIO(size_t bufsize);

-    char *GetBufferStart() const { return m_buffer_start; }
-    char *GetBufferEnd() const { return m_buffer_end; }
-    char *GetBufferPos() const { return m_buffer_pos; }
-    off_t GetIntPosition() const { return m_buffer_pos-m_buffer_start; }
-    void SetIntPosition(off_t pos) { m_buffer_pos = m_buffer_start+pos; }
-    size_t GetLastAccess() const { return m_buffer_end-m_buffer_start; }
+    void *GetBufferStart() const { return m_buffer_start; }
+    void *GetBufferEnd() const { return m_buffer_end; }
+    void *GetBufferPos() const { return m_buffer_pos; }
+    size_t GetBufferSize() const { return m_buffer_size; }
+    size_t GetIntPosition() const { return m_buffer_pos - m_buffer_start; }
+    void SetIntPosition(size_t pos) { m_buffer_pos = m_buffer_start + pos; }
+    size_t GetLastAccess() const { return m_buffer_end - m_buffer_start; }
+    size_t GetBytesLeft() const { return m_buffer_end - m_buffer_pos; }

 
     void Fixed(bool fixed) { m_fixed = fixed; }
     void Flushable(bool f) { m_flushable = f; }
 
     void Fixed(bool fixed) { m_fixed = fixed; }
     void Flushable(bool f) { m_flushable = f; }


@@ -252,32 +280,70 @@ public:
     bool FillBuffer();
     size_t GetDataLeft();
 
     bool FillBuffer();
     size_t GetDataLeft();
 

-    // Misc.
+    // misc accessors
+    wxStreamBase *GetStream() const { return m_stream; }
+    bool HasBuffer() const { return m_buffer_size != 0; }
+
+    bool IsFixed() const { return m_fixed; }
+    bool IsFlushable() const { return m_flushable; }
+
+    // only for input/output buffers respectively, returns NULL otherwise
+    wxInputStream *GetInputStream() const;
+    wxOutputStream *GetOutputStream() const;
+
+    // deprecated, for compatibility only

     wxStreamBase *Stream() { return m_stream; }
 
 protected:
     void GetFromBuffer(void *buffer, size_t size);
     void PutToBuffer(const void *buffer, size_t size);
 
     wxStreamBase *Stream() { return m_stream; }
 
 protected:
     void GetFromBuffer(void *buffer, size_t size);
     void PutToBuffer(const void *buffer, size_t size);
 

-    char *m_buffer_start, *m_buffer_end, *m_buffer_pos;
-    size_t m_buffer_size;
+    // set the last error to the specified value if we didn't have it before
+    void SetError(wxStreamError err);
+
+    // common part of several ctors
+    void Init();

 
 

-    bool m_fixed, m_flushable;
+    // init buffer variables to be empty
+    void InitBuffer();

 
 

+    // free the buffer (always safe to call)
+    void FreeBuffer();
+
+    // the buffer itself: the pointers to its start and end and the current
+    // position in the buffer
+    char *m_buffer_start,
+         *m_buffer_end,
+         *m_buffer_pos;
+
+    // the buffer size
+    // FIXME: isn't it the same as m_buffer_end - m_buffer_start? (VZ)
+    size_t m_buffer_size;
+
+    // the stream we're associated with

     wxStreamBase *m_stream;
     wxStreamBase *m_stream;

+
+    // its mode

     BufMode m_mode;
     BufMode m_mode;

-    bool m_destroybuf, m_destroystream;
+
+    // flags
+    bool m_destroybuf,      // deallocate buffer?
+         m_destroystream,   // delete associated stream?
+         m_fixed,
+         m_flushable;

 };
 
 // ---------------------------------------------------------------------------
 // wxBufferedStreams
 // ---------------------------------------------------------------------------
 
 };
 
 // ---------------------------------------------------------------------------
 // wxBufferedStreams
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBufferedInputStream: public wxFilterInputStream
+class WXDLLEXPORT wxBufferedInputStream : public wxFilterInputStream

 {
 public:
 {
 public:

-    wxBufferedInputStream(wxInputStream& stream);
-    ~wxBufferedInputStream();
+    // if a non NULL buffer is given to the stream, it will be deleted by it
+    wxBufferedInputStream(wxInputStream& stream,
+                          wxStreamBuffer *buffer = NULL);
+    virtual ~wxBufferedInputStream();

 
     char Peek();
     wxInputStream& Read(void *buffer, size_t size);
 
     char Peek();
     wxInputStream& Read(void *buffer, size_t size);


@@ -286,21 +352,28 @@ public:
     off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
     off_t TellI() const;
 
     off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
     off_t TellI() const;
 

+    // the buffer given to the stream will be deleted by it
+    void SetInputStreamBuffer(wxStreamBuffer *buffer);
+    wxStreamBuffer *GetInputStreamBuffer() const { return m_i_streambuf; }
+
+    // deprecated, for compatibility only

     wxStreamBuffer *InputStreamBuffer() const { return m_i_streambuf; }
 
 protected:
     wxStreamBuffer *InputStreamBuffer() const { return m_i_streambuf; }
 
 protected:

-    size_t OnSysRead(void *buffer, size_t bufsize);
-    off_t OnSysSeek(off_t seek, wxSeekMode mode);
-    off_t OnSysTell() const;
+    virtual size_t OnSysRead(void *buffer, size_t bufsize);
+    virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
+    virtual off_t OnSysTell() const;

 
     wxStreamBuffer *m_i_streambuf;
 };
 
 
     wxStreamBuffer *m_i_streambuf;
 };
 

-class WXDLLEXPORT wxBufferedOutputStream: public wxFilterOutputStream
+class WXDLLEXPORT wxBufferedOutputStream : public wxFilterOutputStream

 {
 public:
 {
 public:

-    wxBufferedOutputStream(wxOutputStream& stream);
-    ~wxBufferedOutputStream();
+    // if a non NULL buffer is given to the stream, it will be deleted by it
+    wxBufferedOutputStream(wxOutputStream& stream,
+                           wxStreamBuffer *buffer = NULL);
+    virtual ~wxBufferedOutputStream();

 
     wxOutputStream& Write(const void *buffer, size_t size);
 
 
     wxOutputStream& Write(const void *buffer, size_t size);
 


@@ -312,18 +385,22 @@ public:
 
     size_t GetSize() const;
 
 
     size_t GetSize() const;
 

+    // the buffer given to the stream will be deleted by it
+    void SetOutputStreamBuffer(wxStreamBuffer *buffer);
+    wxStreamBuffer *GetOutputStreamBuffer() const { return m_o_streambuf; }
+
+    // deprecated, for compatibility only

     wxStreamBuffer *OutputStreamBuffer() const { return m_o_streambuf; }
 
 protected:
     wxStreamBuffer *OutputStreamBuffer() const { return m_o_streambuf; }
 
 protected:

-    size_t OnSysWrite(const void *buffer, size_t bufsize);
-    off_t OnSysSeek(off_t seek, wxSeekMode mode);
-    off_t OnSysTell() const;
+    virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
+    virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
+    virtual off_t OnSysTell() const;

 
     wxStreamBuffer *m_o_streambuf;
 };
 
 
     wxStreamBuffer *m_o_streambuf;
 };
 

-#endif
-  // wxUSE_STREAMS
+#endif // wxUSE_STREAMS
+
+#endif // _WX_WXSTREAM_H__

 
 

-#endif
-  // _WX_WXSTREAM_H__