X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/47d67540a017101b3e46abe9ef0f55914d8de37e..751215324589d1f9f5493b1223cfa72f18d3a586:/include/wx/stream.h diff --git a/include/wx/stream.h b/include/wx/stream.h index 13bd256293..efef1ec113 100644 --- a/include/wx/stream.h +++ b/include/wx/stream.h @@ -16,76 +16,72 @@ #pragma interface #endif +#include "wx/defs.h" + +#if wxUSE_STREAMS + #include #include "wx/object.h" #include "wx/string.h" #include "wx/filefn.h" // for off_t, wxInvalidOffset and wxSeekMode +class WXDLLEXPORT wxStreamBase; class WXDLLEXPORT wxInputStream; class WXDLLEXPORT wxOutputStream; typedef wxInputStream& (*__wxInputManip)(wxInputStream&); typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&); -wxOutputStream& WXDLLEXPORT wxEndL(wxOutputStream& o_stream); - -// Disable warnings such as -// 'wxFilterStream' : inherits 'wxFilterInputStream::Peek' via dominance - -#ifdef _MSC_VER -#pragma warning(disable:4250) -#endif +WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream); // --------------------------------------------------------------------------- -// Stream buffer +// wxStream: base classes // --------------------------------------------------------------------------- -class WXDLLEXPORT wxStreamBuffer { +#define wxStream_NOERROR wxSTREAM_NOERROR +#define wxStream_EOF wxSTREAM_EOF +#define wxStream_WRITE_ERR wxSTREAM_WRITE_ERROR +#define wxStream_READ_ERR wxSTREAM_READ_ERROR + +typedef enum { + wxStream_NOERROR = 0, + wxStream_EOF, + wxStream_WRITE_ERR, + wxStream_READ_ERR +} wxStreamError; + +class WXDLLEXPORT wxStreamBase { public: - wxStreamBuffer(wxInputStream& stream); - wxStreamBuffer(wxOutputStream& stream); - ~wxStreamBuffer(); + wxStreamBase(); + virtual ~wxStreamBase(); - void Read(void *buffer, size_t size); - void Write(const void *buffer, size_t size); - void WriteBack(char c); + bool operator!() const { return (LastError() != wxSTREAM_NOERROR); } + wxStreamError LastError() const { return m_lasterror; } + virtual size_t GetSize() const { return ~((size_t)0); } + size_t StreamSize() const { return GetSize(); } - void SetBufferIO(char *buffer_start, char *buffer_end); - void SetBufferIO(size_t bufsize); - void ResetBuffer(); - - void SetBufferPosition(char *buffer_position) - { m_buffer_pos = buffer_position; } - void SetIntPosition(size_t pos) - { m_buffer_pos = m_buffer_start + pos; } - char *GetBufferPosition() const { return m_buffer_pos; } - size_t GetIntPosition() const { return m_buffer_pos - m_buffer_start; } - - char *GetBufferStart() const { return m_buffer_start; } - char *GetBufferEnd() const { return m_buffer_end; } - size_t GetBufferSize() const { return m_buffer_size; } - size_t GetLastAccess() const { return m_buffer_end - m_buffer_start; } + protected: + + virtual size_t OnSysRead(void *buffer, size_t bufsize); + virtual size_t OnSysWrite(const void *buffer, size_t bufsize); + virtual off_t OnSysSeek(off_t seek, wxSeekMode mode); + virtual off_t OnSysTell() const; protected: - char *m_buffer_start, *m_buffer_end, *m_buffer_pos; - size_t m_buffer_size; + friend class wxStreamBuffer; - wxInputStream *m_istream; - wxOutputStream *m_ostream; + size_t m_lastcount; + wxStreamError m_lasterror; }; -// --------------------------------------------------------------------------- -// wxStream: base classes -// --------------------------------------------------------------------------- - -class WXDLLEXPORT wxInputStream { +class WXDLLEXPORT wxInputStream: public wxStreamBase { public: wxInputStream(); virtual ~wxInputStream(); // IO functions - virtual char Peek() { return 0; } - virtual char GetC(); + virtual char Peek(); + char GetC(); virtual wxInputStream& Read(void *buffer, size_t size); wxInputStream& Read(wxOutputStream& stream_out); @@ -94,48 +90,31 @@ class WXDLLEXPORT wxInputStream { virtual off_t TellI() const; // State functions - bool Eof() const { return m_eof; } - size_t LastRead() { return m_lastread; } - wxStreamBuffer *InputStreamBuffer() { return m_i_streambuf; } + virtual size_t LastRead() { return wxStreamBase::m_lastcount; } + + // Ungetch + size_t Ungetch(const void *buffer, size_t size); + bool Ungetch(char c); // Operators wxInputStream& operator>>(wxOutputStream& out) { return Read(out); } - wxInputStream& operator>>(wxString& line); - wxInputStream& operator>>(char& c); - wxInputStream& operator>>(short& i); - wxInputStream& operator>>(int& i); - wxInputStream& operator>>(long& i); - wxInputStream& operator>>(float& i); #if wxUSE_SERIAL wxInputStream& operator>>(wxObject *& obj); #endif - - wxInputStream& operator>>(unsigned char& c) { return operator>>((char&)c); } - wxInputStream& operator>>(unsigned short& i) { return operator>>((short&)i); } - wxInputStream& operator>>(unsigned int& i) { return operator>>((int&)i); } - wxInputStream& operator>>(unsigned long& i) { return operator>>((long&)i); } wxInputStream& operator>>( __wxInputManip func) { return func(*this); } protected: - friend class wxStreamBuffer; - friend class wxFilterInputStream; - - wxInputStream(wxStreamBuffer *buffer); + // Ungetch managers + char *m_wback; + size_t m_wbacksize; + size_t m_wbackcur; - virtual size_t DoRead(void *WXUNUSED(buffer), size_t WXUNUSED(size) ) - { return 0; } - virtual off_t DoSeekInput( off_t WXUNUSED(pos), wxSeekMode WXUNUSED(mode) ) - { return wxInvalidOffset; } - virtual off_t DoTellInput() const - { return wxInvalidOffset; } + char *AllocSpaceWBack(size_t needed_size); + size_t GetWBack(char *buf, size_t bsize); - protected: - bool m_eof, m_i_destroybuf; - size_t m_lastread; - wxStreamBuffer *m_i_streambuf; }; -class WXDLLEXPORT wxOutputStream { +class WXDLLEXPORT wxOutputStream: public wxStreamBase { public: wxOutputStream(); virtual ~wxOutputStream(); @@ -146,62 +125,44 @@ class WXDLLEXPORT wxOutputStream { virtual off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart); virtual off_t TellO() const; - virtual bool Bad() const { return m_bad; } - virtual size_t LastWrite() const { return m_lastwrite; } - wxStreamBuffer *OutputStreamBuffer() { return m_o_streambuf; } + virtual size_t LastWrite() const { return wxStreamBase::m_lastcount; } virtual void Sync(); wxOutputStream& operator<<(wxInputStream& out) { return Write(out); } - wxOutputStream& operator<<(const char *string); - wxOutputStream& operator<<(wxString& string); - wxOutputStream& operator<<(char c); - wxOutputStream& operator<<(short i); - wxOutputStream& operator<<(int i); - wxOutputStream& operator<<(long i); - wxOutputStream& operator<<(double f); #if wxUSE_SERIAL wxOutputStream& operator<<(wxObject& obj); #endif - - wxOutputStream& operator<<(float f) { return operator<<((double)f); } - wxOutputStream& operator<<(unsigned char c) { return operator<<((char)c); } - wxOutputStream& operator<<(unsigned short i) { return operator<<((short)i); } - wxOutputStream& operator<<(unsigned int i) { return operator<<((int)i); } - wxOutputStream& operator<<(unsigned long i) { return operator<<((long)i); } wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); } +}; - protected: - friend class wxStreamBuffer; - friend class wxFilterOutputStream; +// --------------------------------------------------------------------------- +// A stream for measuring streamed output +// --------------------------------------------------------------------------- - wxOutputStream(wxStreamBuffer *buffer); +class wxCountingOutputStream: public wxOutputStream { + public: + wxCountingOutputStream(); - virtual size_t DoWrite( const void *WXUNUSED(buffer), size_t WXUNUSED(size) ) - { return 0; } - virtual off_t DoSeekOutput( off_t WXUNUSED(pos), wxSeekMode WXUNUSED(mode) ) - { return wxInvalidOffset; } - virtual off_t DoTellOutput() const - { return wxInvalidOffset; } + size_t GetSize() const; + bool Ok() const { return TRUE; } protected: - bool m_bad, m_o_destroybuf; - size_t m_lastwrite; - wxStreamBuffer *m_o_streambuf; -}; -class WXDLLEXPORT wxStream: public virtual wxInputStream, - public virtual wxOutputStream -{ - public: - wxStream(); + size_t OnSysWrite(const void *buffer, size_t size); + off_t OnSysSeek(off_t pos, wxSeekMode mode); + off_t OnSysTell() const; + + protected: + size_t m_currentPos; }; + // --------------------------------------------------------------------------- // "Filter" streams // --------------------------------------------------------------------------- -class WXDLLEXPORT wxFilterInputStream: public virtual wxInputStream { +class WXDLLEXPORT wxFilterInputStream: public wxInputStream { public: wxFilterInputStream(); wxFilterInputStream(wxInputStream& stream); @@ -209,50 +170,152 @@ class WXDLLEXPORT wxFilterInputStream: public virtual wxInputStream { char Peek() { return m_parent_i_stream->Peek(); } - bool Eof() const { return m_parent_i_stream->Eof(); } - size_t LastRead() const { return m_parent_i_stream->LastRead(); } - off_t TellI() const { return m_parent_i_stream->TellI(); } - - protected: - size_t DoRead(void *buffer, size_t size); - off_t DoSeekInput(off_t pos, wxSeekMode mode); - off_t DoTellInput() const; + size_t GetSize() const { return m_parent_i_stream->GetSize(); } protected: wxInputStream *m_parent_i_stream; }; -class WXDLLEXPORT wxFilterOutputStream: public virtual wxOutputStream { +class WXDLLEXPORT wxFilterOutputStream: public wxOutputStream { public: wxFilterOutputStream(); wxFilterOutputStream(wxOutputStream& stream); - virtual ~wxFilterOutputStream(); + ~wxFilterOutputStream(); - bool Bad() const { return m_parent_o_stream->Bad(); } - size_t LastWrite() const { return m_parent_o_stream->LastWrite(); } - off_t TellO() const { return m_parent_o_stream->TellO(); } + size_t GetSize() const { return m_parent_o_stream->GetSize(); } protected: - // The forward is implicitely done by wxStreamBuffer. + wxOutputStream *m_parent_o_stream; +}; - size_t DoWrite(const void *buffer, size_t size); - off_t DoSeekOutput(off_t pos, wxSeekMode mode); - off_t DoTellOutput() const; +// --------------------------------------------------------------------------- +// Stream buffer +// --------------------------------------------------------------------------- + +class WXDLLEXPORT wxStreamBuffer { + public: + typedef enum { + read = 0, write, read_write + } BufMode; + + // ----------- + // ctor & dtor + // ----------- + wxStreamBuffer(wxStreamBase& stream, BufMode mode); + wxStreamBuffer(BufMode mode); + wxStreamBuffer(const wxStreamBuffer& buf); + ~wxStreamBuffer(); + + // ----------- + // Filtered IO + // ----------- + size_t Read(void *buffer, size_t size); + size_t Read(wxStreamBuffer *buf); + size_t Write(const void *buffer, size_t size); + 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); + + // -------------- + // Buffer control + // -------------- + void ResetBuffer(); + void SetBufferIO(char *buffer_start, char *buffer_end); + 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 Fixed(bool fixed) { m_fixed = fixed; } + void Flushable(bool f) { m_flushable = f; } + + bool FlushBuffer(); + bool FillBuffer(); + size_t GetDataLeft(); + + // -------------- + // Administration + // -------------- + wxStreamBase *Stream() { return m_stream; } protected: - wxOutputStream *m_parent_o_stream; + void GetFromBuffer(void *buffer, size_t size); + void PutToBuffer(const void *buffer, size_t size); + + protected: + char *m_buffer_start, *m_buffer_end, *m_buffer_pos; + size_t m_buffer_size; + + char *m_wback; + size_t m_wbacksize, m_wbackcur; + + bool m_fixed, m_flushable; + + wxStreamBase *m_stream; + BufMode m_mode; + bool m_destroybuf, m_destroystream; }; -class WXDLLEXPORT wxFilterStream: public wxStream, - public virtual wxFilterInputStream, - public virtual wxFilterOutputStream { +// --------------------------------------------------------------------------- +// wxBufferedStreams +// --------------------------------------------------------------------------- + +class wxBufferedInputStream: public wxFilterInputStream { public: - wxFilterStream(wxStream& stream); - wxFilterStream(); + wxBufferedInputStream(wxInputStream& stream); + ~wxBufferedInputStream(); + + char Peek(); + wxInputStream& Read(void *buffer, size_t size); + + // Position functions + off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart); + off_t TellI() const; + + 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; + + protected: + wxStreamBuffer *m_i_streambuf; +}; + +class wxBufferedOutputStream: public wxFilterOutputStream { + public: + wxBufferedOutputStream(wxOutputStream& stream); + ~wxBufferedOutputStream(); + + wxOutputStream& Write(const void *buffer, size_t size); + + // Position functions + off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart); + off_t TellO() const; + + void Sync(); + + 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; + + protected: + wxStreamBuffer *m_o_streambuf; }; -#ifdef _MSC_VER -#pragma warning(default:4250) #endif + // wxUSE_STREAMS #endif + // _WX_WXSTREAM_H__