X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..7521630773affd2e8d8ff818285fe9c38f901eb6:/include/wx/stream.h diff --git a/include/wx/stream.h b/include/wx/stream.h index 5b80f8766c..ca3b84eb57 100644 --- a/include/wx/stream.h +++ b/include/wx/stream.h @@ -6,16 +6,12 @@ // Created: 11/07/98 // RCS-ID: $Id$ // Copyright: (c) Guilhem Lavaux -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_WXSTREAM_H__ #define _WX_WXSTREAM_H__ -#if defined(__GNUG__) && !defined(__APPLE__) -#pragma interface "stream.h" -#endif - #include "wx/defs.h" #if wxUSE_STREAMS @@ -23,16 +19,16 @@ #include #include "wx/object.h" #include "wx/string.h" -#include "wx/filefn.h" // for off_t, wxInvalidOffset and wxSeekMode +#include "wx/filefn.h" // for wxFileOffset, wxInvalidOffset and wxSeekMode -class WXDLLEXPORT wxStreamBase; -class WXDLLEXPORT wxInputStream; -class WXDLLEXPORT wxOutputStream; +class WXDLLIMPEXP_BASE wxStreamBase; +class WXDLLIMPEXP_BASE wxInputStream; +class WXDLLIMPEXP_BASE wxOutputStream; typedef wxInputStream& (*__wxInputManip)(wxInputStream&); typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&); -WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream); +WXDLLIMPEXP_BASE wxOutputStream& wxEndL(wxOutputStream& o_stream); // ---------------------------------------------------------------------------- // constants @@ -46,19 +42,6 @@ enum wxStreamError wxSTREAM_READ_ERROR // generic read error }; -// compatibility -#if WXWIN_COMPATIBILITY_2_2 - #define wxStream_NOERROR wxSTREAM_NOERROR - #define wxStream_EOF wxSTREAM_EOF - #define wxStream_WRITE_ERR wxSTREAM_WRITE_ERROR - #define wxStream_READ_ERR wxSTREAM_READ_ERROR - - #define wxSTREAM_NO_ERR wxSTREAM_NO_ERROR - #define wxSTREAM_NOERROR wxSTREAM_NO_ERROR - #define wxSTREAM_WRITE_ERR wxSTREAM_WRITE_ERROR - #define wxSTREAM_READ_ERR wxSTREAM_READ_ERROR -#endif // WXWIN_COMPATIBILITY_2_2 - // ============================================================================ // base stream classes: wxInputStream and wxOutputStream // ============================================================================ @@ -67,7 +50,7 @@ enum wxStreamError // wxStreamBase: common (but non virtual!) base for all stream classes // --------------------------------------------------------------------------- -class WXDLLEXPORT wxStreamBase +class WXDLLIMPEXP_BASE wxStreamBase { public: wxStreamBase(); @@ -81,30 +64,30 @@ public: // reset the stream state void Reset() { m_lasterror = wxSTREAM_NO_ERROR; } - // deprecated (doesn't make sense!), don't use - virtual size_t GetSize() const { return 0; } + // this doesn't make sense for all streams, always test its return value + virtual size_t GetSize() const; + virtual wxFileOffset GetLength() const { return wxInvalidOffset; } -#if WXWIN_COMPATIBILITY_2_2 - // deprecated, for compatibility only - wxStreamError LastError() const { return m_lasterror; } - size_t StreamSize() const { return GetSize(); } -#endif // WXWIN_COMPATIBILITY_2_2 + // returns true if the streams supports seeking to arbitrary offsets + virtual bool IsSeekable() const { return false; } protected: - virtual off_t OnSysSeek(off_t seek, wxSeekMode mode); - virtual off_t OnSysTell() const; + virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode); + virtual wxFileOffset OnSysTell() const; size_t m_lastcount; wxStreamError m_lasterror; friend class wxStreamBuffer; + + DECLARE_NO_COPY_CLASS(wxStreamBase) }; // ---------------------------------------------------------------------------- // wxInputStream: base class for the input streams // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxInputStream : public wxStreamBase +class WXDLLIMPEXP_BASE wxInputStream : public wxStreamBase { public: // ctor and dtor, nothing exciting @@ -157,7 +140,7 @@ public: // all the requested data or not virtual size_t LastRead() const { return wxStreamBase::m_lastcount; } - // returns TRUE if some data is available in the stream right now, so that + // returns true if some data is available in the stream right now, so that // calling Read() wouldn't block virtual bool CanRead() const; @@ -179,7 +162,7 @@ public: // put back the specified character in the stream // - // returns TRUE if ok, FALSE on error + // returns true if ok, false on error bool Ungetch(char c); @@ -190,10 +173,10 @@ public: // it) // // returns wxInvalidOffset on error - virtual off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart); + virtual wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart); // return the current position of the stream pointer or wxInvalidOffset - virtual off_t TellI() const; + virtual wxFileOffset TellI() const; // stream-like operators @@ -205,7 +188,7 @@ public: protected: // do read up to size bytes of data into the provided buffer // - // this method should return 0 if EOF has been reached or an error occured + // this method should return 0 if EOF has been reached or an error occurred // (m_lasterror should be set accordingly as well) or the number of bytes // read virtual size_t OnSysRead(void *buffer, size_t size) = 0; @@ -230,13 +213,15 @@ protected: size_t m_wbackcur; friend class wxStreamBuffer; + + DECLARE_NO_COPY_CLASS(wxInputStream) }; // ---------------------------------------------------------------------------- // wxOutputStream: base for the output streams // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxOutputStream : public wxStreamBase +class WXDLLIMPEXP_BASE wxOutputStream : public wxStreamBase { public: wxOutputStream(); @@ -246,12 +231,13 @@ public: virtual wxOutputStream& Write(const void *buffer, size_t size); wxOutputStream& Write(wxInputStream& stream_in); - virtual off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart); - virtual off_t TellO() const; + virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart); + virtual wxFileOffset TellO() const; virtual size_t LastWrite() const { return wxStreamBase::m_lastcount; } virtual void Sync(); + virtual bool Close() { return true; } wxOutputStream& operator<<(wxInputStream& out) { return Write(out); } wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); } @@ -262,6 +248,8 @@ protected: virtual size_t OnSysWrite(const void *buffer, size_t bufsize); friend class wxStreamBuffer; + + DECLARE_NO_COPY_CLASS(wxOutputStream) }; // ============================================================================ @@ -272,27 +260,29 @@ protected: // A stream for measuring streamed output // --------------------------------------------------------------------------- -class WXDLLEXPORT wxCountingOutputStream : public wxOutputStream +class WXDLLIMPEXP_BASE wxCountingOutputStream : public wxOutputStream { public: wxCountingOutputStream(); - size_t GetSize() const; - bool Ok() const { return TRUE; } + wxFileOffset GetLength() const; + bool Ok() const { return true; } protected: virtual size_t OnSysWrite(const void *buffer, size_t size); - virtual off_t OnSysSeek(off_t pos, wxSeekMode mode); - virtual off_t OnSysTell() const; + virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode); + virtual wxFileOffset OnSysTell() const; size_t m_currentPos; + + DECLARE_NO_COPY_CLASS(wxCountingOutputStream) }; // --------------------------------------------------------------------------- // "Filter" streams // --------------------------------------------------------------------------- -class WXDLLEXPORT wxFilterInputStream : public wxInputStream +class WXDLLIMPEXP_BASE wxFilterInputStream : public wxInputStream { public: wxFilterInputStream(); @@ -301,27 +291,31 @@ public: char Peek() { return m_parent_i_stream->Peek(); } - size_t GetSize() const { return m_parent_i_stream->GetSize(); } + wxFileOffset GetLength() const { return m_parent_i_stream->GetLength(); } wxInputStream *GetFilterInputStream() const { return m_parent_i_stream; } protected: wxInputStream *m_parent_i_stream; + + DECLARE_NO_COPY_CLASS(wxFilterInputStream) }; -class WXDLLEXPORT wxFilterOutputStream : public wxOutputStream +class WXDLLIMPEXP_BASE wxFilterOutputStream : public wxOutputStream { public: wxFilterOutputStream(); wxFilterOutputStream(wxOutputStream& stream); virtual ~wxFilterOutputStream(); - size_t GetSize() const { return m_parent_o_stream->GetSize(); } + wxFileOffset GetLength() const { return m_parent_o_stream->GetLength(); } wxOutputStream *GetFilterOutputStream() const { return m_parent_o_stream; } protected: wxOutputStream *m_parent_o_stream; + + DECLARE_NO_COPY_CLASS(wxFilterOutputStream) }; // ============================================================================ @@ -333,7 +327,7 @@ protected: // wxBufferedStreams to implement custom buffering // --------------------------------------------------------------------------- -class WXDLLEXPORT wxStreamBuffer +class WXDLLIMPEXP_BASE wxStreamBuffer { public: enum BufMode @@ -356,16 +350,16 @@ public: 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); + virtual wxFileOffset Tell() const; + virtual wxFileOffset Seek(wxFileOffset pos, wxSeekMode mode); // Buffer control void ResetBuffer(); // 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); + // 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 *GetBufferStart() const { return m_buffer_start; } void *GetBufferEnd() const { return m_buffer_end; } @@ -394,8 +388,10 @@ public: wxInputStream *GetInputStream() const; wxOutputStream *GetOutputStream() const; +#if WXWIN_COMPATIBILITY_2_6 // deprecated, for compatibility only - wxStreamBase *Stream() { return m_stream; } + wxDEPRECATED( wxStreamBase *Stream() ); +#endif // WXWIN_COMPATIBILITY_2_6 // this constructs a dummy wxStreamBuffer, used by (and exists for) // wxMemoryStreams only, don't use! @@ -437,13 +433,21 @@ protected: bool m_destroybuf, // deallocate buffer? m_fixed, m_flushable; + +private: +// Cannot use +// DECLARE_NO_COPY_CLASS(wxStreamBuffer) +// because copy constructor is explicitly declared above; +// but no copy assignment operator is defined, so declare +// it private to prevent the compiler from defining it: + wxStreamBuffer& operator=(const wxStreamBuffer&); }; // --------------------------------------------------------------------------- // wxBufferedInputStream // --------------------------------------------------------------------------- -class WXDLLEXPORT wxBufferedInputStream : public wxFilterInputStream +class WXDLLIMPEXP_BASE wxBufferedInputStream : public wxFilterInputStream { public: // if a non NULL buffer is given to the stream, it will be deleted by it @@ -455,29 +459,34 @@ public: wxInputStream& Read(void *buffer, size_t size); // Position functions - off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart); - off_t TellI() const; + wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart); + wxFileOffset TellI() const; + bool IsSeekable() const { return m_parent_i_stream->IsSeekable(); } // the buffer given to the stream will be deleted by it void SetInputStreamBuffer(wxStreamBuffer *buffer); wxStreamBuffer *GetInputStreamBuffer() const { return m_i_streambuf; } +#if WXWIN_COMPATIBILITY_2_6 // deprecated, for compatibility only - wxStreamBuffer *InputStreamBuffer() const { return m_i_streambuf; } + wxDEPRECATED( wxStreamBuffer *InputStreamBuffer() const ); +#endif // WXWIN_COMPATIBILITY_2_6 protected: virtual size_t OnSysRead(void *buffer, size_t bufsize); - virtual off_t OnSysSeek(off_t seek, wxSeekMode mode); - virtual off_t OnSysTell() const; + virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode); + virtual wxFileOffset OnSysTell() const; wxStreamBuffer *m_i_streambuf; + + DECLARE_NO_COPY_CLASS(wxBufferedInputStream) }; // ---------------------------------------------------------------------------- // wxBufferedOutputStream // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxBufferedOutputStream : public wxFilterOutputStream +class WXDLLIMPEXP_BASE wxBufferedOutputStream : public wxFilterOutputStream { public: // if a non NULL buffer is given to the stream, it will be deleted by it @@ -488,29 +497,40 @@ public: wxOutputStream& Write(const void *buffer, size_t size); // Position functions - off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart); - off_t TellO() const; + wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart); + wxFileOffset TellO() const; + bool IsSeekable() const { return m_parent_o_stream->IsSeekable(); } void Sync(); + bool Close(); - size_t GetSize() const; + wxFileOffset GetLength() const; // the buffer given to the stream will be deleted by it void SetOutputStreamBuffer(wxStreamBuffer *buffer); wxStreamBuffer *GetOutputStreamBuffer() const { return m_o_streambuf; } +#if WXWIN_COMPATIBILITY_2_6 // deprecated, for compatibility only - wxStreamBuffer *OutputStreamBuffer() const { return m_o_streambuf; } + wxDEPRECATED( wxStreamBuffer *OutputStreamBuffer() const ); +#endif // WXWIN_COMPATIBILITY_2_6 protected: virtual size_t OnSysWrite(const void *buffer, size_t bufsize); - virtual off_t OnSysSeek(off_t seek, wxSeekMode mode); - virtual off_t OnSysTell() const; + virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode); + virtual wxFileOffset OnSysTell() const; wxStreamBuffer *m_o_streambuf; + + DECLARE_NO_COPY_CLASS(wxBufferedOutputStream) }; +#if WXWIN_COMPATIBILITY_2_6 + inline wxStreamBase *wxStreamBuffer::Stream() { return m_stream; } + inline wxStreamBuffer *wxBufferedInputStream::InputStreamBuffer() const { return m_i_streambuf; } + inline wxStreamBuffer *wxBufferedOutputStream::OutputStreamBuffer() const { return m_o_streambuf; } +#endif // WXWIN_COMPATIBILITY_2_6 + #endif // wxUSE_STREAMS #endif // _WX_WXSTREAM_H__ -