include/wx/stream.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        stream.h
   3 // Purpose:     "wxWindows stream" base classes
   4 // Author:      Guilhem Lavaux
   5 // Modified by:
   6 // Created:     11/07/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Guilhem Lavaux
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_WXSTREAM_H__
  13 #define _WX_WXSTREAM_H__
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include <stdio.h>
  20 #include "wx/object.h"
  21 #include "wx/string.h"
  22 #include "wx/filefn.h"  // for off_t, wxInvalidOffset and wxSeekMode
  23
  24 class WXDLLEXPORT wxInputStream;
  25 class WXDLLEXPORT wxOutputStream;
  26
  27 typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
  28 typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);
  29
  30 wxOutputStream& WXDLLEXPORT wxEndL(wxOutputStream& o_stream);
  31
  32 // ---------------------------------------------------------------------------
  33 // Stream buffer
  34 // ---------------------------------------------------------------------------
  35
  36 class WXDLLEXPORT wxStreamBuffer {
  37  public:
  38   wxStreamBuffer(wxInputStream& stream);
  39   wxStreamBuffer(wxOutputStream& stream);
  40   ~wxStreamBuffer();
  41
  42   void Read(void *buffer, size_t size);
  43   void Write(const void *buffer, size_t size);
  44   void WriteBack(char c);
  45
  46   void SetBufferIO(char *buffer_start, char *buffer_end);
  47   void SetBufferIO(size_t bufsize);
  48   void ResetBuffer();
  49
  50   void SetBufferPosition(char *buffer_position)
  51                                   { m_buffer_pos = buffer_position; }
  52   void SetIntPosition(size_t pos)
  53                      { m_buffer_pos = m_buffer_start + pos; }
  54   char *GetBufferPosition() const { return m_buffer_pos; }
  55   size_t GetIntPosition() const { return m_buffer_pos - m_buffer_start; }
  56
  57   char *GetBufferStart() const    { return m_buffer_start; }
  58   char *GetBufferEnd() const      { return m_buffer_end; }
  59   size_t GetBufferSize() const    { return m_buffer_size; }
  60   size_t GetLastAccess() const      { return m_buffer_end - m_buffer_start; }
  61
  62  protected:
  63   char *m_buffer_start, *m_buffer_end, *m_buffer_pos;
  64   size_t m_buffer_size;
  65
  66   wxInputStream *m_istream;
  67   wxOutputStream *m_ostream;
  68 };
  69
  70 // ---------------------------------------------------------------------------
  71 // wxStream: base classes
  72 // ---------------------------------------------------------------------------
  73
  74 class WXDLLEXPORT wxInputStream {
  75  public:
  76   wxInputStream();
  77   virtual ~wxInputStream();
  78
  79   // IO functions
  80   virtual char Peek() { return 0; }
  81   virtual char GetC();
  82   virtual wxInputStream& Read(void *buffer, size_t size);
  83   wxInputStream& Read(wxOutputStream& stream_out);
  84
  85   // Position functions
  86   virtual off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
  87   virtual off_t TellI() const;
  88
  89   // State functions
  90   bool Eof() const { return m_eof; }
  91   size_t LastRead() { return m_lastread; }
  92   wxStreamBuffer *InputStreamBuffer() { return m_i_streambuf; }
  93
  94   // Operators
  95   wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }
  96   wxInputStream& operator>>(wxString& line);
  97   wxInputStream& operator>>(char& c);
  98   wxInputStream& operator>>(short& i);
  99   wxInputStream& operator>>(int& i);
 100   wxInputStream& operator>>(long& i);
 101   wxInputStream& operator>>(float& i);
 102   wxInputStream& operator>>(wxObject *& obj);
 103
 104   wxInputStream& operator>>(unsigned char& c) { return operator>>((char&)c); }
 105   wxInputStream& operator>>(unsigned short& i) { return operator>>((short&)i); }
 106   wxInputStream& operator>>(unsigned int& i) { return operator>>((int&)i); }
 107   wxInputStream& operator>>(unsigned long& i) { return operator>>((long&)i); }
 108   wxInputStream& operator>>( __wxInputManip func) { return func(*this); }
 109
 110  protected:
 111   friend class wxStreamBuffer;
 112   friend class wxFilterInputStream;
 113
 114   wxInputStream(wxStreamBuffer *buffer);
 115
 116   virtual size_t DoRead(void *buffer, size_t size) { return 0; }
 117   virtual off_t DoSeekInput(off_t pos, wxSeekMode mode)
 118          { return wxInvalidOffset; }
 119   virtual off_t DoTellInput() const
 120          { return wxInvalidOffset; }
 121
 122  protected:
 123   bool m_eof, m_i_destroybuf;
 124   size_t m_lastread;
 125   wxStreamBuffer *m_i_streambuf;
 126 };
 127
 128 class WXDLLEXPORT wxOutputStream {
 129  public:
 130   wxOutputStream();
 131   virtual ~wxOutputStream();
 132
 133   virtual wxOutputStream& Write(const void *buffer, size_t size);
 134   wxOutputStream& Write(wxInputStream& stream_in);
 135
 136   virtual off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
 137   virtual off_t TellO() const;
 138
 139   virtual bool Bad() const { return m_bad; }
 140   virtual size_t LastWrite() const { return m_lastwrite; }
 141   wxStreamBuffer *OutputStreamBuffer() { return m_o_streambuf; }
 142
 143   virtual void Sync();
 144
 145   wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
 146   wxOutputStream& operator<<(const char *string);
 147   wxOutputStream& operator<<(wxString& string);
 148   wxOutputStream& operator<<(char c);
 149   wxOutputStream& operator<<(short i);
 150   wxOutputStream& operator<<(int i);
 151   wxOutputStream& operator<<(long i);
 152   wxOutputStream& operator<<(double f);
 153   wxOutputStream& operator<<(wxObject& obj);
 154
 155   wxOutputStream& operator<<(float f) { return operator<<((double)f); }
 156   wxOutputStream& operator<<(unsigned char c) { return operator<<((char)c); }
 157   wxOutputStream& operator<<(unsigned short i) { return operator<<((short)i); }
 158   wxOutputStream& operator<<(unsigned int i) { return operator<<((int)i); }
 159   wxOutputStream& operator<<(unsigned long i) { return operator<<((long)i); }
 160   wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }
 161
 162  protected:
 163   friend class wxStreamBuffer;
 164   friend class wxFilterOutputStream;
 165
 166   wxOutputStream(wxStreamBuffer *buffer);
 167
 168   virtual size_t DoWrite(const void *buffer, size_t size) { return 0; }
 169   virtual off_t DoSeekOutput(off_t pos, wxSeekMode mode)
 170             { return wxInvalidOffset; }
 171   virtual off_t DoTellOutput() const
 172             { return wxInvalidOffset; }
 173
 174  protected:
 175   bool m_bad, m_o_destroybuf;
 176   size_t m_lastwrite;
 177   wxStreamBuffer *m_o_streambuf;
 178 };
 179
 180 class wxStream: virtual public wxInputStream,
 181                 virtual public wxOutputStream
 182 {
 183  public:
 184   wxStream();
 185 };
 186
 187 // ---------------------------------------------------------------------------
 188 // "Filter" streams
 189 // ---------------------------------------------------------------------------
 190
 191 class WXDLLEXPORT wxFilterInputStream: virtual public wxInputStream {
 192  public:
 193   wxFilterInputStream();
 194   wxFilterInputStream(wxInputStream& stream);
 195   ~wxFilterInputStream();
 196
 197   char Peek() { return m_parent_i_stream->Peek(); }
 198
 199   bool Eof() const { return m_parent_i_stream->Eof(); }
 200   size_t LastRead() const { return m_parent_i_stream->LastRead(); }
 201   off_t TellI() const { return m_parent_i_stream->TellI(); }
 202
 203  protected:
 204   size_t DoRead(void *buffer, size_t size);
 205   off_t DoSeekInput(off_t pos, wxSeekMode mode);
 206   off_t DoTellInput() const;
 207
 208  protected:
 209   wxInputStream *m_parent_i_stream;
 210 };
 211
 212 class WXDLLEXPORT wxFilterOutputStream: virtual public wxOutputStream {
 213  public:
 214   wxFilterOutputStream();
 215   wxFilterOutputStream(wxOutputStream& stream);
 216   virtual ~wxFilterOutputStream();
 217
 218   bool Bad() const { return m_parent_o_stream->Bad(); }
 219   size_t LastWrite() const { return m_parent_o_stream->LastWrite(); }
 220   off_t TellO() const { return m_parent_o_stream->TellO(); }
 221
 222  protected:
 223   // The forward is implicitely done by wxStreamBuffer.
 224
 225   size_t DoWrite(const void *buffer, size_t size);
 226   off_t DoSeekOutput(off_t pos, wxSeekMode mode);
 227   off_t DoTellOutput() const;
 228
 229  protected:
 230   wxOutputStream *m_parent_o_stream;
 231 };
 232
 233 class WXDLLEXPORT wxFilterStream: public wxStream,
 234                                   virtual public wxFilterInputStream,
 235                                   virtual public wxFilterOutputStream {
 236  public:
 237   wxFilterStream(wxStream& stream);
 238   wxFilterStream();
 239 };
 240
 241 #endif