no message

[wxWidgets.git] / include / wx / stream.h

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 13ee1dce4289e75cbc0190a62e63bd4a17e2dbad..25f04afbcca039f977ec578102b1a99407003670 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -9,8 +9,8 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __WXSTREAM_H__
-#define __WXSTREAM_H__
+#ifndef _WX_WXSTREAM_H__
+#define _WX_WXSTREAM_H__

 
 #ifdef __GNUG__
 #pragma interface
 
 #ifdef __GNUG__
 #pragma interface


@@ -21,112 +21,186 @@
 #include "wx/string.h"
 #include "wx/filefn.h"  // for off_t, wxInvalidOffset and wxSeekMode
 
 #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&);
 
 class WXDLLEXPORT wxInputStream;
 class WXDLLEXPORT wxOutputStream;
 
 typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
 typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);
 

-wxOutputStream& WXDLLEXPORT wxEndL(wxOutputStream& o_stream);
+WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream);
+
+// ---------------------------------------------------------------------------
+// Stream buffer
+// ---------------------------------------------------------------------------

 
 class WXDLLEXPORT wxStreamBuffer {
  public:
 
 class WXDLLEXPORT wxStreamBuffer {
  public:

-  wxStreamBuffer(wxInputStream& stream);
-  wxStreamBuffer(wxOutputStream& stream);
+  typedef enum {
+    read = 0, write, read_write
+  } BufMode;
+
+  // -----------
+  // ctor & dtor
+  // -----------
+  wxStreamBuffer(wxStreamBase& stream, BufMode mode);
+  wxStreamBuffer(BufMode mode);
+  wxStreamBuffer(const wxStreamBuffer& buf);

   ~wxStreamBuffer();
 
   ~wxStreamBuffer();
 

-  void Read(void *buffer, size_t size);
-  void Write(const void *buffer, size_t size);
-  void WriteBack(char c);
-
+  // -----------
+  // 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);
+
+  size_t WriteBack(const char *buffer, size_t size);
+  bool WriteBack(char c);
+  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);
   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; }
+  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:
+  char *AllocSpaceWBack(size_t needed_size);
+  size_t GetWBack(char *buf, size_t bsize);
+
+  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;
 
 
  protected:
   char *m_buffer_start, *m_buffer_end, *m_buffer_pos;
   size_t m_buffer_size;
 

-  wxInputStream *m_istream;
-  wxOutputStream *m_ostream;
+  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;

 };
 
 };
 

-/*
- * wxStream: base classes
- */
-class WXDLLEXPORT wxInputStream {
+// ---------------------------------------------------------------------------
+// wxStream: base classes
+// ---------------------------------------------------------------------------
+
+typedef enum {
+  wxStream_NOERROR = 0,
+  wxStream_EOF,
+  wxStream_WRITE_ERR,
+  wxStream_READ_ERR
+} wxStreamError;
+
+class WXDLLEXPORT wxStreamBase {
+ public:
+  wxStreamBase();
+  virtual ~wxStreamBase();
+
+  wxStreamError LastError() const { return m_lasterror; }
+  virtual size_t StreamSize() const { return ~((size_t)0); }
+
+ protected:
+  friend class wxStreamBuffer;
+
+  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:
+  size_t m_lastcount;
+  wxStreamError m_lasterror;
+};
+
+class WXDLLEXPORT wxInputStream: public wxStreamBase {

  public:
   wxInputStream();
  public:
   wxInputStream();

+  wxInputStream(wxStreamBuffer *sbuf);

   virtual ~wxInputStream();
 
   // IO functions
   virtual ~wxInputStream();
 
   // IO functions

-  virtual char Peek() = 0;
-  virtual char GetC();
-  virtual wxInputStream& Read(void *buffer, size_t size);
+  virtual char Peek();
+  char GetC();
+  wxInputStream& Read(void *buffer, size_t size);

   wxInputStream& Read(wxOutputStream& stream_out);
 
   // Position functions
   wxInputStream& Read(wxOutputStream& stream_out);
 
   // Position functions

-  virtual off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
-  virtual off_t TellI() const;
+  off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
+  off_t TellI() const;

 
   // State functions
 
   // State functions

-  bool Eof() const { return m_eof; }
-  size_t LastRead() { return m_lastread; }

   wxStreamBuffer *InputStreamBuffer() { return m_i_streambuf; }
   wxStreamBuffer *InputStreamBuffer() { return m_i_streambuf; }

+  size_t LastRead() { return wxStreamBase::m_lastcount; }

 
   // Operators
   wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }
   wxInputStream& operator>>(wxString& line);
   wxInputStream& operator>>(char& c);
   wxInputStream& operator>>(short& i);
 
   // 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>>(long& i);

-  wxInputStream& operator>>(float& i);
-  wxInputStream& operator>>( __wxInputManip func) { return func(*this); }
-
- protected:
-  friend class wxStreamBuffer;
-  friend class wxFilterInputStream;
-
-  wxInputStream(wxStreamBuffer *buffer);
+  wxInputStream& operator>>(double& i);
+#if wxUSE_SERIAL
+  wxInputStream& operator>>(wxObject *& obj);
+#endif

 
 

-  virtual size_t DoRead(void *buffer, size_t size) = 0;
-  virtual off_t DoSeekInput(off_t pos, wxSeekMode mode) = 0;
-  virtual off_t DoTellInput() const = 0;
+  wxInputStream& operator>>(float& f) { double d; operator>>((double&)d); f = (float)d; return *this; }
+  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:
 
  protected:

-  bool m_eof, m_i_destroybuf;
-  size_t m_lastread;
+  bool m_i_destroybuf;

   wxStreamBuffer *m_i_streambuf;
 };
 
   wxStreamBuffer *m_i_streambuf;
 };
 

-class WXDLLEXPORT wxOutputStream {
+class WXDLLEXPORT wxOutputStream: public wxStreamBase {

  public:
   wxOutputStream();
  public:
   wxOutputStream();

+  wxOutputStream(wxStreamBuffer *sbuf);

   virtual ~wxOutputStream();
 
   virtual ~wxOutputStream();
 

-  virtual wxOutputStream& Write(const void *buffer, size_t size);
+  wxOutputStream& Write(const void *buffer, size_t size);

   wxOutputStream& Write(wxInputStream& stream_in);
 
   wxOutputStream& Write(wxInputStream& stream_in);
 

-  virtual off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
-  virtual off_t TellO() const;
+  off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
+  off_t TellO() const;

 
 

-  virtual bool Bad() const { return m_bad; }
-  virtual size_t LastWrite() const { return m_lastwrite; }
+  size_t LastWrite() const { return wxStreamBase::m_lastcount; }

   wxStreamBuffer *OutputStreamBuffer() { return m_o_streambuf; }
 
   wxStreamBuffer *OutputStreamBuffer() { return m_o_streambuf; }
 

-  virtual void Sync();
+  void Sync();

 
   wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
   wxOutputStream& operator<<(const char *string);
 
   wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
   wxOutputStream& operator<<(const char *string);


@@ -136,50 +210,36 @@ class WXDLLEXPORT wxOutputStream {
   wxOutputStream& operator<<(int i);
   wxOutputStream& operator<<(long i);
   wxOutputStream& operator<<(double f);
   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<<(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:
   wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }
 
  protected:

-  friend class wxStreamBuffer;
-  friend class wxFilterOutputStream;
-
-  wxOutputStream(wxStreamBuffer *buffer);
-
-  virtual size_t DoWrite(const void *buffer, size_t size) = 0;
-  virtual off_t DoSeekOutput(off_t pos, wxSeekMode mode) = 0;
-  virtual off_t DoTellOutput() const = 0;
-
- protected:
-  bool m_bad, m_o_destroybuf;
-  size_t m_lastwrite;
+  bool m_o_destroybuf;

   wxStreamBuffer *m_o_streambuf;
 };
 
   wxStreamBuffer *m_o_streambuf;
 };
 

-/*
- * "Filter" streams
- */
+// ---------------------------------------------------------------------------
+// "Filter" streams
+// ---------------------------------------------------------------------------

 
 class WXDLLEXPORT wxFilterInputStream: public wxInputStream {
  public:
 
 class WXDLLEXPORT wxFilterInputStream: public wxInputStream {
  public:

+  wxFilterInputStream();

   wxFilterInputStream(wxInputStream& stream);
   wxFilterInputStream(wxInputStream& stream);

-  virtual ~wxFilterInputStream();
+  ~wxFilterInputStream();

 
 

-  virtual char Peek() { return m_parent_i_stream->Peek(); }
+  char Peek() { return m_parent_i_stream->Peek(); }

 
 

-  virtual bool Eof() const { return m_parent_i_stream->Eof(); } 
-  virtual size_t LastRead() const { return m_parent_i_stream->LastRead(); } 
-  virtual off_t TellI() const { return m_parent_i_stream->TellI(); }
-
- protected:
-  virtual size_t DoRead(void *buffer, size_t size);
-  virtual off_t DoSeekInput(off_t pos, wxSeekMode mode);
-  virtual off_t DoTellInput() const;
+  wxStreamError LastError() const { return m_parent_i_stream->LastError(); }
+  size_t StreamSize() const { return m_parent_i_stream->StreamSize(); }

 
  protected:
   wxInputStream *m_parent_i_stream;
 
  protected:
   wxInputStream *m_parent_i_stream;


@@ -187,19 +247,12 @@ class WXDLLEXPORT wxFilterInputStream: public wxInputStream {
 
 class WXDLLEXPORT wxFilterOutputStream: public wxOutputStream {
  public:
 
 class WXDLLEXPORT wxFilterOutputStream: public wxOutputStream {
  public:

+  wxFilterOutputStream();

   wxFilterOutputStream(wxOutputStream& stream);
   wxFilterOutputStream(wxOutputStream& stream);

-  virtual ~wxFilterOutputStream();
-
-  virtual bool Bad() const { return m_parent_o_stream->Bad(); }
-  virtual size_t LastWrite() const { return m_parent_o_stream->LastWrite(); }
-  virtual off_t TellO() const { return m_parent_o_stream->TellO(); }
-
- protected:
-  // The forward is implicitely done by wxStreamBuffer.
+  ~wxFilterOutputStream();

 
 

-  virtual size_t DoWrite(const void *buffer, size_t size);
-  virtual off_t DoSeekOutput(off_t pos, wxSeekMode mode);
-  virtual off_t DoTellOutput() const;
+  wxStreamError LastError() const { return m_parent_o_stream->LastError(); }
+  size_t StreamSize() const { return m_parent_o_stream->StreamSize(); }

 
  protected:
   wxOutputStream *m_parent_o_stream;
 
  protected:
   wxOutputStream *m_parent_o_stream;