X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f42c1512dd009866feb5a4410ef5e2dd1e535404..8e77fd8bca165aab9709649d79a7cbc6a172d4e1:/include/wx/stream.h?ds=sidebyside diff --git a/include/wx/stream.h b/include/wx/stream.h index 3f34c95212..b1746b84b5 100644 --- a/include/wx/stream.h +++ b/include/wx/stream.h @@ -64,7 +64,7 @@ public: bool operator!() const { return !IsOk(); } // reset the stream state - void Reset() { m_lasterror = wxSTREAM_NO_ERROR; } + void Reset(wxStreamError error = wxSTREAM_NO_ERROR) { m_lasterror = error; } // this doesn't make sense for all streams, always test its return value virtual size_t GetSize() const; @@ -83,7 +83,7 @@ protected: friend class wxStreamBuffer; DECLARE_ABSTRACT_CLASS(wxStreamBase) - DECLARE_NO_COPY_CLASS(wxStreamBase) + wxDECLARE_NO_COPY_CLASS(wxStreamBase); }; // ---------------------------------------------------------------------------- @@ -128,6 +128,11 @@ public: // it means that EOF has been reached. virtual wxInputStream& Read(void *buffer, size_t size); + // Read exactly the given number of bytes, unlike Read(), which may read + // less than the requested amount of data without returning an error, this + // method either reads all the data or returns false. + bool ReadAll(void *buffer, size_t size); + // copy the entire contents of this stream into streamOut, stopping only // when EOF is reached or an error occurs wxInputStream& Read(wxOutputStream& streamOut); @@ -218,7 +223,7 @@ protected: friend class wxStreamBuffer; DECLARE_ABSTRACT_CLASS(wxInputStream) - DECLARE_NO_COPY_CLASS(wxInputStream) + wxDECLARE_NO_COPY_CLASS(wxInputStream); }; // ---------------------------------------------------------------------------- @@ -233,6 +238,12 @@ public: void PutC(char c); virtual wxOutputStream& Write(const void *buffer, size_t size); + + // This is ReadAll() equivalent for Write(): it either writes exactly the + // given number of bytes or returns false, unlike Write() which can write + // less data than requested but still return without error. + bool WriteAll(const void *buffer, size_t size); + wxOutputStream& Write(wxInputStream& stream_in); virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart); @@ -254,7 +265,7 @@ protected: friend class wxStreamBuffer; DECLARE_ABSTRACT_CLASS(wxOutputStream) - DECLARE_NO_COPY_CLASS(wxOutputStream) + wxDECLARE_NO_COPY_CLASS(wxOutputStream); }; // ============================================================================ @@ -270,19 +281,20 @@ class WXDLLIMPEXP_BASE wxCountingOutputStream : public wxOutputStream public: wxCountingOutputStream(); - wxFileOffset GetLength() const; + virtual wxFileOffset GetLength() const; bool Ok() const { return IsOk(); } - bool IsOk() const { return true; } + virtual bool IsOk() const { return true; } protected: virtual size_t OnSysWrite(const void *buffer, size_t size); virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode); virtual wxFileOffset OnSysTell() const; - size_t m_currentPos; + size_t m_currentPos, + m_lastPos; DECLARE_DYNAMIC_CLASS(wxCountingOutputStream) - DECLARE_NO_COPY_CLASS(wxCountingOutputStream) + wxDECLARE_NO_COPY_CLASS(wxCountingOutputStream); }; // --------------------------------------------------------------------------- @@ -308,7 +320,7 @@ protected: bool m_owns; DECLARE_ABSTRACT_CLASS(wxFilterInputStream) - DECLARE_NO_COPY_CLASS(wxFilterInputStream) + wxDECLARE_NO_COPY_CLASS(wxFilterInputStream); }; class WXDLLIMPEXP_BASE wxFilterOutputStream : public wxOutputStream @@ -330,7 +342,7 @@ protected: bool m_owns; DECLARE_ABSTRACT_CLASS(wxFilterOutputStream) - DECLARE_NO_COPY_CLASS(wxFilterOutputStream) + wxDECLARE_NO_COPY_CLASS(wxFilterOutputStream); }; enum wxStreamProtocolType @@ -421,13 +433,13 @@ public: InitWithStream(stream, mode); } - wxStreamBuffer(wxInputStream& stream, size_t bufsize) + wxStreamBuffer(size_t bufsize, wxInputStream& stream) { InitWithStream(stream, read); SetBufferIO(bufsize); } - wxStreamBuffer(wxOutputStream& stream, size_t bufsize) + wxStreamBuffer(size_t bufsize, wxOutputStream& stream) { InitWithStream(stream, write); SetBufferIO(bufsize); @@ -530,7 +542,7 @@ protected: m_flushable; - DECLARE_NO_ASSIGN_CLASS(wxStreamBuffer) + wxDECLARE_NO_ASSIGN_CLASS(wxStreamBuffer); }; // --------------------------------------------------------------------------- @@ -579,7 +591,7 @@ protected: wxStreamBuffer *m_i_streambuf; - DECLARE_NO_COPY_CLASS(wxBufferedInputStream) + wxDECLARE_NO_COPY_CLASS(wxBufferedInputStream); }; // ---------------------------------------------------------------------------- @@ -631,7 +643,7 @@ protected: wxStreamBuffer *m_o_streambuf; - DECLARE_NO_COPY_CLASS(wxBufferedOutputStream) + wxDECLARE_NO_COPY_CLASS(wxBufferedOutputStream); }; #if WXWIN_COMPATIBILITY_2_6 @@ -640,6 +652,54 @@ protected: inline wxStreamBuffer *wxBufferedOutputStream::OutputStreamBuffer() const { return m_o_streambuf; } #endif // WXWIN_COMPATIBILITY_2_6 +// --------------------------------------------------------------------------- +// wxWrapperInputStream: forwards all IO to another stream. +// --------------------------------------------------------------------------- + +class WXDLLIMPEXP_BASE wxWrapperInputStream : public wxFilterInputStream +{ +public: + // Constructor fully initializing the stream. The overload taking pointer + // takes ownership of the parent stream, the one taking reference does not. + // + // Notice that this class also has a default ctor but it's protected as the + // derived class is supposed to take care of calling InitParentStream() if + // it's used. + wxWrapperInputStream(wxInputStream& stream); + wxWrapperInputStream(wxInputStream* stream); + + // Override the base class methods to forward to the wrapped stream. + virtual wxFileOffset GetLength() const; + virtual bool IsSeekable() const; + +protected: + virtual size_t OnSysRead(void *buffer, size_t size); + virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode); + virtual wxFileOffset OnSysTell() const; + + // Ensure that our own last error is the same as that of the real stream. + // + // This method is const because the error must be updated even from const + // methods (in other words, it really should have been mutable in the first + // place). + void SynchronizeLastError() const + { + const_cast(this)-> + Reset(m_parent_i_stream->GetLastError()); + } + + // Default constructor, use InitParentStream() later. + wxWrapperInputStream(); + + // Set up the wrapped stream for an object initialized using the default + // constructor. The ownership logic is the same as above. + void InitParentStream(wxInputStream& stream); + void InitParentStream(wxInputStream* stream); + + wxDECLARE_NO_COPY_CLASS(wxWrapperInputStream); +}; + + #endif // wxUSE_STREAMS #endif // _WX_WXSTREAM_H__