// 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
#include <stdio.h>
#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
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
// ============================================================================
// wxStreamBase: common (but non virtual!) base for all stream classes
// ---------------------------------------------------------------------------
-class WXDLLEXPORT wxStreamBase
+class WXDLLIMPEXP_BASE wxStreamBase
{
public:
wxStreamBase();
// 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; }
+
+ // Reserved for future use
+ virtual void ReservedStreamFunc1() {}
+ virtual void ReservedStreamFunc2() {}
+ virtual void ReservedStreamFunc3() {}
+ virtual void ReservedStreamFunc4() {}
+ virtual void ReservedStreamFunc5() {}
+ virtual void ReservedStreamFunc6() {}
+ virtual void ReservedStreamFunc7() {}
+ virtual void ReservedStreamFunc8() {}
+ virtual void ReservedStreamFunc9() {}
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;
// wxInputStream: base class for the input streams
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxInputStream : public wxStreamBase
+class WXDLLIMPEXP_BASE wxInputStream : public wxStreamBase
{
public:
// ctor and dtor, nothing exciting
// 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;
// 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);
// 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
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;
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();
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); }
virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
friend class wxStreamBuffer;
+
+ DECLARE_NO_COPY_CLASS(wxOutputStream)
};
// ============================================================================
// 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();
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; }
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; }
// wxBufferedStreams to implement custom buffering
// ---------------------------------------------------------------------------
-class WXDLLEXPORT wxStreamBuffer
+class WXDLLIMPEXP_BASE wxStreamBuffer
{
public:
enum BufMode
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; }
// 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
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);
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;
// 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
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);
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;
projects / wxWidgets.git / blobdiff