1998-07-12 11:24:52 -04:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2000-11-22 23:34:27 -05:00
|
|
|
// Name: wx/stream.h
|
2002-12-04 09:11:26 -05:00
|
|
|
// Purpose: stream classes
|
|
|
|
// Author: Guilhem Lavaux, Guillermo Rodriguez Garcia, Vadim Zeitlin
|
1998-07-12 11:24:52 -04:00
|
|
|
// Modified by:
|
|
|
|
// Created: 11/07/98
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) Guilhem Lavaux
|
|
|
|
// Licence: wxWindows license
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
1998-08-14 20:23:28 -04:00
|
|
|
#ifndef _WX_WXSTREAM_H__
|
|
|
|
#define _WX_WXSTREAM_H__
|
1998-07-12 11:24:52 -04:00
|
|
|
|
2002-08-31 07:29:13 -04:00
|
|
|
#if defined(__GNUG__) && !defined(__APPLE__)
|
|
|
|
#pragma interface "stream.h"
|
1998-07-12 11:24:52 -04:00
|
|
|
#endif
|
|
|
|
|
1999-06-15 16:21:59 -04:00
|
|
|
#include "wx/defs.h"
|
|
|
|
|
|
|
|
#if wxUSE_STREAMS
|
|
|
|
|
1998-07-12 11:24:52 -04:00
|
|
|
#include <stdio.h>
|
1998-07-14 18:15:29 -04:00
|
|
|
#include "wx/object.h"
|
|
|
|
#include "wx/string.h"
|
1998-07-24 13:13:47 -04:00
|
|
|
#include "wx/filefn.h" // for off_t, wxInvalidOffset and wxSeekMode
|
|
|
|
|
1998-10-14 13:36:50 -04:00
|
|
|
class WXDLLEXPORT wxStreamBase;
|
1998-07-24 13:13:47 -04:00
|
|
|
class WXDLLEXPORT wxInputStream;
|
|
|
|
class WXDLLEXPORT wxOutputStream;
|
|
|
|
|
|
|
|
typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
|
|
|
|
typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);
|
|
|
|
|
1998-11-22 17:32:53 -05:00
|
|
|
WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream);
|
1998-07-24 13:13:47 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// constants
|
|
|
|
// ----------------------------------------------------------------------------
|
1998-09-06 14:28:00 -04:00
|
|
|
|
2000-11-22 23:34:27 -05:00
|
|
|
enum wxStreamError
|
2000-03-02 14:06:13 -05:00
|
|
|
{
|
2002-12-04 09:11:26 -05:00
|
|
|
wxSTREAM_NO_ERROR = 0, // stream is in good state
|
|
|
|
wxSTREAM_EOF, // EOF reached in Read() or similar
|
|
|
|
wxSTREAM_WRITE_ERROR, // generic write error
|
|
|
|
wxSTREAM_READ_ERROR // generic read error
|
2000-11-22 23:34:27 -05:00
|
|
|
};
|
1998-10-14 13:36:50 -04:00
|
|
|
|
2000-03-02 14:06:13 -05:00
|
|
|
// compatibility
|
2002-12-04 09:11:26 -05:00
|
|
|
#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
|
|
|
|
// ---------------------------------------------------------------------------
|
2000-03-02 14:06:13 -05:00
|
|
|
|
1999-12-21 12:48:24 -05:00
|
|
|
class WXDLLEXPORT wxStreamBase
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxStreamBase();
|
|
|
|
virtual ~wxStreamBase();
|
1998-10-14 13:36:50 -04:00
|
|
|
|
2000-03-02 14:06:13 -05:00
|
|
|
// error testing
|
|
|
|
wxStreamError GetLastError() const { return m_lasterror; }
|
2002-12-04 09:11:26 -05:00
|
|
|
bool IsOk() const { return GetLastError() == wxSTREAM_NO_ERROR; }
|
|
|
|
bool operator!() const { return !IsOk(); }
|
2000-03-02 14:06:13 -05:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// reset the stream state
|
|
|
|
void Reset() { m_lasterror = wxSTREAM_NO_ERROR; }
|
|
|
|
|
|
|
|
// deprecated (doesn't make sense!), don't use
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual size_t GetSize() const { return 0; }
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
#if WXWIN_COMPATIBILITY_2_2
|
2000-11-23 14:45:46 -05:00
|
|
|
// deprecated, for compatibility only
|
|
|
|
wxStreamError LastError() const { return m_lasterror; }
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t StreamSize() const { return GetSize(); }
|
2002-12-04 09:11:26 -05:00
|
|
|
#endif // WXWIN_COMPATIBILITY_2_2
|
1998-10-14 13:36:50 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
|
|
|
virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
|
|
|
|
virtual off_t OnSysTell() const;
|
1998-10-14 13:36:50 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t m_lastcount;
|
|
|
|
wxStreamError m_lasterror;
|
2002-12-04 09:11:26 -05:00
|
|
|
|
|
|
|
friend class wxStreamBuffer;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
2003-01-02 18:46:08 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxStreamBase)
|
1998-10-14 13:36:50 -04:00
|
|
|
};
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxInputStream: base class for the input streams
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxInputStream : public wxStreamBase
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
2002-12-04 09:11:26 -05:00
|
|
|
// ctor and dtor, nothing exciting
|
1999-12-20 11:15:32 -05:00
|
|
|
wxInputStream();
|
|
|
|
virtual ~wxInputStream();
|
1998-07-12 11:24:52 -04:00
|
|
|
|
2000-03-02 14:06:13 -05:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
// IO functions
|
2002-12-04 09:11:26 -05:00
|
|
|
// ------------
|
|
|
|
|
|
|
|
// return a character from the stream without removing it, i.e. it will
|
|
|
|
// still be returned by the next call to GetC()
|
|
|
|
//
|
|
|
|
// blocks until something appears in the stream if necessary, if nothing
|
|
|
|
// ever does (i.e. EOF) LastRead() will return 0 (and the return value is
|
|
|
|
// undefined), otherwise 1
|
1999-12-20 11:15:32 -05:00
|
|
|
virtual char Peek();
|
2002-12-04 09:11:26 -05:00
|
|
|
|
|
|
|
// return one character from the stream, blocking until it appears if
|
|
|
|
// necessary
|
|
|
|
//
|
|
|
|
// if EOF, return value is undefined and LastRead() will return 0 and not 1
|
1999-12-20 11:15:32 -05:00
|
|
|
char GetC();
|
2002-12-04 09:11:26 -05:00
|
|
|
|
|
|
|
// read at most the given number of bytes from the stream
|
|
|
|
//
|
|
|
|
// there are 2 possible situations here: either there is nothing at all in
|
|
|
|
// the stream right now in which case Read() blocks until something appears
|
|
|
|
// (use CanRead() to avoid this) or there is already some data available in
|
|
|
|
// the stream and then Read() doesn't block but returns just the data it
|
|
|
|
// can read without waiting for more
|
|
|
|
//
|
|
|
|
// in any case, if there are not enough bytes in the stream right now,
|
|
|
|
// LastRead() value will be less than size but greater than 0. If it is 0,
|
|
|
|
// it means that EOF has been reached.
|
1999-12-20 11:15:32 -05:00
|
|
|
virtual wxInputStream& Read(void *buffer, size_t size);
|
1998-07-12 11:24:52 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// copy the entire contents of this stream into streamOut, stopping only
|
|
|
|
// when EOF is reached or an error occurs
|
|
|
|
wxInputStream& Read(wxOutputStream& streamOut);
|
|
|
|
|
|
|
|
|
|
|
|
// status functions
|
|
|
|
// ----------------
|
|
|
|
|
|
|
|
// returns the number of bytes read by the last call to Read(), GetC() or
|
|
|
|
// Peek()
|
|
|
|
//
|
|
|
|
// this should be used to discover whether that call succeeded in reading
|
|
|
|
// 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
|
|
|
|
// calling Read() wouldn't block
|
|
|
|
virtual bool CanRead() const;
|
1998-07-12 11:24:52 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// is the stream at EOF?
|
|
|
|
//
|
|
|
|
// note that this cannot be really implemented for all streams and
|
|
|
|
// CanRead() is more reliable than Eof()
|
|
|
|
virtual bool Eof() const;
|
|
|
|
|
|
|
|
|
|
|
|
// write back buffer
|
|
|
|
// -----------------
|
1999-07-07 13:45:35 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// put back the specified number of bytes into the stream, they will be
|
|
|
|
// fetched by the next call to the read functions
|
|
|
|
//
|
|
|
|
// returns the number of bytes really stuffed back
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t Ungetch(const void *buffer, size_t size);
|
2002-12-04 09:11:26 -05:00
|
|
|
|
|
|
|
// put back the specified character in the stream
|
|
|
|
//
|
|
|
|
// returns TRUE if ok, FALSE on error
|
1999-12-20 11:15:32 -05:00
|
|
|
bool Ungetch(char c);
|
1998-07-14 12:35:50 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
|
|
|
|
// position functions
|
|
|
|
// ------------------
|
|
|
|
|
|
|
|
// move the stream pointer to the given position (if the stream supports
|
|
|
|
// it)
|
|
|
|
//
|
|
|
|
// returns wxInvalidOffset on error
|
|
|
|
virtual off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
|
|
|
|
|
|
|
|
// return the current position of the stream pointer or wxInvalidOffset
|
|
|
|
virtual off_t TellI() const;
|
|
|
|
|
|
|
|
|
|
|
|
// stream-like operators
|
|
|
|
// ---------------------
|
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }
|
2002-12-04 09:11:26 -05:00
|
|
|
wxInputStream& operator>>(__wxInputManip func) { return func(*this); }
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
2002-12-04 09:11:26 -05:00
|
|
|
// 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
|
|
|
|
// (m_lasterror should be set accordingly as well) or the number of bytes
|
|
|
|
// read
|
|
|
|
virtual size_t OnSysRead(void *buffer, size_t size) = 0;
|
|
|
|
|
|
|
|
// write-back buffer support
|
|
|
|
// -------------------------
|
|
|
|
|
|
|
|
// return the pointer to a buffer big enough to hold sizeNeeded bytes
|
|
|
|
char *AllocSpaceWBack(size_t sizeNeeded);
|
|
|
|
|
|
|
|
// read up to size data from the write back buffer, return the number of
|
|
|
|
// bytes read
|
|
|
|
size_t GetWBack(void *buf, size_t size);
|
2000-11-23 14:45:46 -05:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// write back buffer or NULL if none
|
1999-12-20 11:15:32 -05:00
|
|
|
char *m_wback;
|
2002-12-04 09:11:26 -05:00
|
|
|
|
|
|
|
// the size of the buffer
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t m_wbacksize;
|
1999-07-07 13:45:35 -04:00
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// the current position in the buffer
|
|
|
|
size_t m_wbackcur;
|
2000-11-23 14:45:46 -05:00
|
|
|
|
|
|
|
friend class wxStreamBuffer;
|
1998-07-12 11:24:52 -04:00
|
|
|
};
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxOutputStream: base for the output streams
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxOutputStream : public wxStreamBase
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxOutputStream();
|
|
|
|
virtual ~wxOutputStream();
|
1998-07-12 11:24:52 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
void PutC(char c);
|
|
|
|
virtual wxOutputStream& Write(const void *buffer, size_t size);
|
|
|
|
wxOutputStream& Write(wxInputStream& stream_in);
|
1998-07-12 11:24:52 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
virtual off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
|
|
|
|
virtual off_t TellO() const;
|
1998-07-24 13:13:47 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
virtual size_t LastWrite() const { return wxStreamBase::m_lastcount; }
|
1998-07-12 11:24:52 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
virtual void Sync();
|
1998-07-12 11:24:52 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
|
|
|
|
wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }
|
2000-11-23 14:45:46 -05:00
|
|
|
|
|
|
|
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;
|
1998-07-12 11:24:52 -04:00
|
|
|
};
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// ============================================================================
|
|
|
|
// helper stream classes
|
|
|
|
// ============================================================================
|
|
|
|
|
1999-08-22 10:10:50 -04:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// A stream for measuring streamed output
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
class WXDLLEXPORT wxCountingOutputStream : public wxOutputStream
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxCountingOutputStream();
|
1999-08-22 10:10:50 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t GetSize() const;
|
|
|
|
bool Ok() const { return TRUE; }
|
1999-08-22 10:10:50 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual size_t OnSysWrite(const void *buffer, size_t size);
|
|
|
|
virtual off_t OnSysSeek(off_t pos, wxSeekMode mode);
|
|
|
|
virtual off_t OnSysTell() const;
|
1999-08-22 10:10:50 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t m_currentPos;
|
1999-08-22 10:10:50 -04:00
|
|
|
};
|
|
|
|
|
1998-09-06 14:28:00 -04:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// "Filter" streams
|
|
|
|
// ---------------------------------------------------------------------------
|
1998-07-12 11:24:52 -04:00
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
class WXDLLEXPORT wxFilterInputStream : public wxInputStream
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxFilterInputStream();
|
|
|
|
wxFilterInputStream(wxInputStream& stream);
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual ~wxFilterInputStream();
|
1998-07-12 11:24:52 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
char Peek() { return m_parent_i_stream->Peek(); }
|
1998-07-12 11:24:52 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t GetSize() const { return m_parent_i_stream->GetSize(); }
|
1998-10-28 13:29:51 -05:00
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
wxInputStream *GetFilterInputStream() const { return m_parent_i_stream; }
|
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
|
|
|
wxInputStream *m_parent_i_stream;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
|
|
|
DECLARE_NO_COPY_CLASS(wxFilterInputStream)
|
1998-07-12 11:24:52 -04:00
|
|
|
};
|
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
class WXDLLEXPORT wxFilterOutputStream : public wxOutputStream
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
wxFilterOutputStream();
|
|
|
|
wxFilterOutputStream(wxOutputStream& stream);
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual ~wxFilterOutputStream();
|
1998-07-24 13:13:47 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t GetSize() const { return m_parent_o_stream->GetSize(); }
|
1998-10-28 13:29:51 -05:00
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
wxOutputStream *GetFilterOutputStream() const { return m_parent_o_stream; }
|
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
|
|
|
wxOutputStream *m_parent_o_stream;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
|
|
|
DECLARE_NO_COPY_CLASS(wxFilterOutputStream)
|
1998-07-12 11:24:52 -04:00
|
|
|
};
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// ============================================================================
|
|
|
|
// buffered streams
|
|
|
|
// ============================================================================
|
|
|
|
|
1999-07-07 13:45:35 -04:00
|
|
|
// ---------------------------------------------------------------------------
|
2000-11-23 14:45:46 -05:00
|
|
|
// Stream buffer: this class can be derived from and passed to
|
|
|
|
// wxBufferedStreams to implement custom buffering
|
1999-07-07 13:45:35 -04:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
1999-12-21 12:48:24 -05:00
|
|
|
class WXDLLEXPORT wxStreamBuffer
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
2000-11-22 23:34:27 -05:00
|
|
|
enum BufMode
|
|
|
|
{
|
|
|
|
read,
|
|
|
|
write,
|
|
|
|
read_write
|
|
|
|
};
|
1999-12-20 11:15:32 -05:00
|
|
|
|
|
|
|
wxStreamBuffer(wxStreamBase& stream, BufMode mode);
|
|
|
|
wxStreamBuffer(const wxStreamBuffer& buf);
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual ~wxStreamBuffer();
|
1999-12-20 11:15:32 -05:00
|
|
|
|
|
|
|
// Filtered IO
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual size_t Read(void *buffer, size_t size);
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t Read(wxStreamBuffer *buf);
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual size_t Write(const void *buffer, size_t size);
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t Write(wxStreamBuffer *buf);
|
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
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);
|
1999-12-20 11:15:32 -05:00
|
|
|
|
|
|
|
// Buffer control
|
|
|
|
void ResetBuffer();
|
2000-11-22 23:34:27 -05:00
|
|
|
|
|
|
|
// 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);
|
2000-11-23 11:26:12 -05:00
|
|
|
void SetBufferIO(void *start, size_t len, bool takeOwnership = FALSE);
|
1999-12-20 11:15:32 -05:00
|
|
|
void SetBufferIO(size_t bufsize);
|
2000-11-22 23:34:27 -05:00
|
|
|
void *GetBufferStart() const { return m_buffer_start; }
|
|
|
|
void *GetBufferEnd() const { return m_buffer_end; }
|
|
|
|
void *GetBufferPos() const { return m_buffer_pos; }
|
2000-11-23 11:26:12 -05:00
|
|
|
size_t GetBufferSize() const { return m_buffer_size; }
|
2000-11-22 23:34:27 -05:00
|
|
|
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; }
|
1999-12-20 11:15:32 -05:00
|
|
|
|
|
|
|
void Fixed(bool fixed) { m_fixed = fixed; }
|
|
|
|
void Flushable(bool f) { m_flushable = f; }
|
|
|
|
|
|
|
|
bool FlushBuffer();
|
|
|
|
bool FillBuffer();
|
|
|
|
size_t GetDataLeft();
|
|
|
|
|
2000-11-22 23:34:27 -05:00
|
|
|
// 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; }
|
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
// only for input/output buffers respectively, returns NULL otherwise
|
|
|
|
wxInputStream *GetInputStream() const;
|
|
|
|
wxOutputStream *GetOutputStream() const;
|
|
|
|
|
2000-11-22 23:34:27 -05:00
|
|
|
// deprecated, for compatibility only
|
1999-12-20 11:15:32 -05:00
|
|
|
wxStreamBase *Stream() { return m_stream; }
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// this constructs a dummy wxStreamBuffer, used by (and exists for)
|
|
|
|
// wxMemoryStreams only, don't use!
|
|
|
|
wxStreamBuffer(BufMode mode);
|
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
|
|
|
void GetFromBuffer(void *buffer, size_t size);
|
|
|
|
void PutToBuffer(const void *buffer, size_t size);
|
|
|
|
|
2000-11-22 23:34:27 -05:00
|
|
|
// 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();
|
1999-12-20 11:15:32 -05:00
|
|
|
|
2000-11-22 23:34:27 -05:00
|
|
|
// init buffer variables to be empty
|
|
|
|
void InitBuffer();
|
1999-12-20 11:15:32 -05:00
|
|
|
|
2000-11-22 23:34:27 -05:00
|
|
|
// 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
|
1999-12-20 11:15:32 -05:00
|
|
|
wxStreamBase *m_stream;
|
2000-11-22 23:34:27 -05:00
|
|
|
|
|
|
|
// its mode
|
1999-12-20 11:15:32 -05:00
|
|
|
BufMode m_mode;
|
2000-11-22 23:34:27 -05:00
|
|
|
|
|
|
|
// flags
|
|
|
|
bool m_destroybuf, // deallocate buffer?
|
|
|
|
m_fixed,
|
|
|
|
m_flushable;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
|
|
|
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&);
|
1999-07-07 13:45:35 -04:00
|
|
|
};
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
2002-12-04 09:11:26 -05:00
|
|
|
// wxBufferedInputStream
|
1999-07-07 13:45:35 -04:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
class WXDLLEXPORT wxBufferedInputStream : public wxFilterInputStream
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
2000-11-23 14:45:46 -05:00
|
|
|
// if a non NULL buffer is given to the stream, it will be deleted by it
|
|
|
|
wxBufferedInputStream(wxInputStream& stream,
|
|
|
|
wxStreamBuffer *buffer = NULL);
|
|
|
|
virtual ~wxBufferedInputStream();
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
char Peek();
|
|
|
|
wxInputStream& Read(void *buffer, size_t size);
|
1999-12-21 12:48:24 -05:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
// Position functions
|
|
|
|
off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
|
|
|
|
off_t TellI() const;
|
1999-07-07 13:45:35 -04:00
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
// 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
|
1999-12-20 11:15:32 -05:00
|
|
|
wxStreamBuffer *InputStreamBuffer() const { return m_i_streambuf; }
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual size_t OnSysRead(void *buffer, size_t bufsize);
|
|
|
|
virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
|
|
|
|
virtual off_t OnSysTell() const;
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
wxStreamBuffer *m_i_streambuf;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
|
|
|
DECLARE_NO_COPY_CLASS(wxBufferedInputStream)
|
1999-07-07 13:45:35 -04:00
|
|
|
};
|
|
|
|
|
2002-12-04 09:11:26 -05:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxBufferedOutputStream
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
class WXDLLEXPORT wxBufferedOutputStream : public wxFilterOutputStream
|
1999-12-20 11:15:32 -05:00
|
|
|
{
|
|
|
|
public:
|
2000-11-23 14:45:46 -05:00
|
|
|
// if a non NULL buffer is given to the stream, it will be deleted by it
|
|
|
|
wxBufferedOutputStream(wxOutputStream& stream,
|
|
|
|
wxStreamBuffer *buffer = NULL);
|
|
|
|
virtual ~wxBufferedOutputStream();
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
wxOutputStream& Write(const void *buffer, size_t size);
|
1999-12-21 12:48:24 -05:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
// Position functions
|
|
|
|
off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
|
|
|
|
off_t TellO() const;
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
void Sync();
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
size_t GetSize() const;
|
1999-12-21 12:48:24 -05:00
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
// 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
|
1999-12-20 11:15:32 -05:00
|
|
|
wxStreamBuffer *OutputStreamBuffer() const { return m_o_streambuf; }
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
protected:
|
2000-11-23 14:45:46 -05:00
|
|
|
virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
|
|
|
|
virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
|
|
|
|
virtual off_t OnSysTell() const;
|
1999-07-07 13:45:35 -04:00
|
|
|
|
1999-12-20 11:15:32 -05:00
|
|
|
wxStreamBuffer *m_o_streambuf;
|
2003-01-02 18:38:11 -05:00
|
|
|
|
|
|
|
DECLARE_NO_COPY_CLASS(wxBufferedOutputStream)
|
1999-07-07 13:45:35 -04:00
|
|
|
};
|
|
|
|
|
2000-11-23 14:45:46 -05:00
|
|
|
#endif // wxUSE_STREAMS
|
|
|
|
|
|
|
|
#endif // _WX_WXSTREAM_H__
|
1999-06-15 16:21:59 -04:00
|
|
|
|