no message

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

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 692d522305a6b3b30a8489b52418abce253431ef..25f04afbcca039f977ec578102b1a99407003670 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -9,105 +9,250 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

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

 
 #ifdef __GNUG__
 #pragma interface
 #endif
 
 #include <stdio.h>
 
 #ifdef __GNUG__
 #pragma interface
 #endif
 
 #include <stdio.h>

-#include <wx/object.h>
-#include <wx/string.h>
+#include "wx/object.h"
+#include "wx/string.h"
+#include "wx/filefn.h"  // for off_t, wxInvalidOffset and wxSeekMode

 
 

-#ifdef    _MSC_VER
-  #define   off_t       _off_t
-#endif
+class WXDLLEXPORT wxStreamBase;
+class WXDLLEXPORT wxInputStream;
+class WXDLLEXPORT wxOutputStream;
+
+typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
+typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);
+
+WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream);
+
+// ---------------------------------------------------------------------------
+// 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);
+
+  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);
+  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; }

 
 

-/*
- * wxStream: base classes
- */
+  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;
+
+  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
+// ---------------------------------------------------------------------------

 
 typedef enum {
 
 typedef enum {

-  wxFromStart, wxFromCurrent, wxFromEnd
-} wxSeekMode;
+  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 wxOutputStream;
-class wxInputStream: virtual public wxObject {
-  DECLARE_ABSTRACT_CLASS(wxInputStream)
+class WXDLLEXPORT wxInputStream: public wxStreamBase {

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

+  wxInputStream(wxStreamBuffer *sbuf);

   virtual ~wxInputStream();
 
   virtual ~wxInputStream();
 

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

   wxInputStream& Read(wxOutputStream& stream_out);
 
   wxInputStream& Read(wxOutputStream& stream_out);
 

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

 
 

-  virtual bool Eof() const = 0;
-  virtual size_t LastRead() const = 0;
+  // State functions
+  wxStreamBuffer *InputStreamBuffer() { return m_i_streambuf; }
+  size_t LastRead() { return wxStreamBase::m_lastcount; }

 
 

+  // Operators

   wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }
   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>>(double& i);
+#if wxUSE_SERIAL
+  wxInputStream& operator>>(wxObject *& obj);
+#endif
+
+  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:
+  bool m_i_destroybuf;
+  wxStreamBuffer *m_i_streambuf;

 };
 
 };
 

-class wxOutputStream: virtual public wxObject {
-  DECLARE_ABSTRACT_CLASS(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) = 0;
+  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) = 0;
-  virtual off_t TellO() const = 0;
+  off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
+  off_t TellO() const;
+
+  size_t LastWrite() const { return wxStreamBase::m_lastcount; }
+  wxStreamBuffer *OutputStreamBuffer() { return m_o_streambuf; }

 
 

-  virtual bool Bad() const = 0;
-  virtual size_t LastWrite() const = 0;
+  void Sync();

 
 

-  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:
+  bool m_o_destroybuf;
+  wxStreamBuffer *m_o_streambuf;

 };
 
 };
 

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

 
 

-class wxFilterInputStream: public wxInputStream {
-  DECLARE_CLASS(wxFilterInputStream)
+class WXDLLEXPORT wxFilterInputStream: public wxInputStream {

  public:
  public:

+  wxFilterInputStream();

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

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

 
 

-  virtual wxInputStream& Read(void *buffer, size_t size)
-     { return m_parent_i_stream->Read(buffer, size); }
-  virtual off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart)
-     { return m_parent_i_stream->SeekI(pos, mode); }
-  virtual off_t TellI() const
-     { return m_parent_i_stream->TellI(); }
+  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(); } 
+  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;
 };
 

-class wxFilterOutputStream: public wxOutputStream {
-  DECLARE_CLASS(wxFilterOutputStream)
+class WXDLLEXPORT wxFilterOutputStream: public wxOutputStream {

  public:
  public:

+  wxFilterOutputStream();

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

-  virtual ~wxFilterOutputStream();
-
-  virtual wxOutputStream& Write(const void *buffer, size_t size)
-     { return m_parent_o_stream->Write(buffer, size); }
-  virtual off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart)
-     { return m_parent_o_stream->SeekO(pos, mode); }
-  virtual off_t TellO() const
-     { return m_parent_o_stream->TellO(); }
+  ~wxFilterOutputStream();

 
 

-  virtual bool Bad() const { return m_parent_o_stream->Bad(); }
-  virtual size_t LastWrite() const { return m_parent_o_stream->LastWrite(); }
+  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;