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 "wx/defs.h"
  20
  21 #if wxUSE_STREAMS
  22
  23 #include <stdio.h>
  24 #include "wx/object.h"
  25 #include "wx/string.h"
  26 #include "wx/filefn.h"  // for off_t, wxInvalidOffset and wxSeekMode
  27
  28 class WXDLLEXPORT wxStreamBase;
  29 class WXDLLEXPORT wxInputStream;
  30 class WXDLLEXPORT wxOutputStream;
  31
  32 typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
  33 typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);
  34
  35 WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream);
  36
  37 // ---------------------------------------------------------------------------
  38 // Stream buffer
  39 // ---------------------------------------------------------------------------
  40
  41 class WXDLLEXPORT wxStreamBuffer {
  42  public:
  43   typedef enum {
  44     read = 0, write, read_write
  45   } BufMode;
  46
  47   // -----------
  48   // ctor & dtor
  49   // -----------
  50   wxStreamBuffer(wxStreamBase& stream, BufMode mode);
  51   wxStreamBuffer(BufMode mode);
  52   wxStreamBuffer(const wxStreamBuffer& buf);
  53   ~wxStreamBuffer();
  54
  55   // -----------
  56   // Filtered IO
  57   // -----------
  58   size_t Read(void *buffer, size_t size);
  59   size_t Read(wxStreamBuffer *buf);
  60   size_t Write(const void *buffer, size_t size);
  61   size_t Write(wxStreamBuffer *buf);
  62
  63   size_t WriteBack(const char *buffer, size_t size);
  64   bool WriteBack(char c);
  65   char GetChar();
  66   void PutChar(char c);
  67   off_t Tell() const;
  68   off_t Seek(off_t pos, wxSeekMode mode);
  69
  70   // --------------
  71   // Buffer control
  72   // --------------
  73   void ResetBuffer();
  74   void SetBufferIO(char *buffer_start, char *buffer_end);
  75   void SetBufferIO(size_t bufsize);
  76   char *GetBufferStart() const { return m_buffer_start; }
  77   char *GetBufferEnd() const { return m_buffer_end; }
  78   char *GetBufferPos() const { return m_buffer_pos; }
  79   off_t GetIntPosition() const { return m_buffer_pos-m_buffer_start; }
  80   void SetIntPosition(off_t pos) { m_buffer_pos = m_buffer_start+pos; }
  81   size_t GetLastAccess() const { return m_buffer_end-m_buffer_start; }
  82
  83   void Fixed(bool fixed) { m_fixed = fixed; }
  84   void Flushable(bool f) { m_flushable = f; }
  85
  86   bool FlushBuffer();
  87   bool FillBuffer();
  88   size_t GetDataLeft();
  89
  90   // --------------
  91   // Administration
  92   // --------------
  93   wxStreamBase *Stream() { return m_stream; }
  94
  95  protected:
  96   char *AllocSpaceWBack(size_t needed_size);
  97   size_t GetWBack(char *buf, size_t bsize);
  98
  99   void GetFromBuffer(void *buffer, size_t size);
 100   void PutToBuffer(const void *buffer, size_t size);
 101
 102  protected:
 103   char *m_buffer_start, *m_buffer_end, *m_buffer_pos;
 104   size_t m_buffer_size;
 105
 106   char *m_wback;
 107   size_t m_wbacksize, m_wbackcur;
 108
 109   bool m_fixed, m_flushable;
 110
 111   wxStreamBase *m_stream;
 112   BufMode m_mode;
 113   bool m_destroybuf, m_destroystream;
 114 };
 115
 116 // ---------------------------------------------------------------------------
 117 // wxStream: base classes
 118 // ---------------------------------------------------------------------------
 119
 120 #define wxStream_NOERROR    wxSTR_NOERROR
 121 #define wxStream_EOF        wxSTR_EOF
 122 #define wxStream_WRITE_ERR  wxSTR_WRITE_ERROR
 123 #define wxStream_READ_ERR   wxSTR_READ_ERROR
 124
 125 typedef enum {
 126   wxStream_NOERROR = 0,
 127   wxStream_EOF,
 128   wxStream_WRITE_ERR,
 129   wxStream_READ_ERR
 130 } wxStreamError;
 131
 132 class WXDLLEXPORT wxStreamBase {
 133  public:
 134   wxStreamBase();
 135   virtual ~wxStreamBase();
 136
 137   wxStreamError LastError() const { return m_lasterror; }
 138   virtual size_t StreamSize() const { return ~((size_t)0); }
 139
 140  protected:
 141   friend class wxStreamBuffer;
 142
 143   virtual size_t OnSysRead(void *buffer, size_t bufsize);
 144   virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
 145   virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
 146   virtual off_t OnSysTell() const;
 147
 148  protected:
 149   size_t m_lastcount;
 150   wxStreamError m_lasterror;
 151 };
 152
 153 class WXDLLEXPORT wxInputStream: public wxStreamBase {
 154  public:
 155   wxInputStream();
 156   wxInputStream(wxStreamBuffer *sbuf);
 157   virtual ~wxInputStream();
 158
 159   // IO functions
 160   virtual char Peek();
 161   char GetC();
 162   virtual wxInputStream& Read(void *buffer, size_t size);
 163   wxInputStream& Read(wxOutputStream& stream_out);
 164   wxString ReadLine();
 165
 166   // Position functions
 167   off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
 168   off_t TellI() const;
 169
 170   // State functions
 171   wxStreamBuffer *InputStreamBuffer() { return m_i_streambuf; }
 172   size_t LastRead() { return wxStreamBase::m_lastcount; }
 173
 174   // Operators
 175   wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }
 176   wxInputStream& operator>>(wxString& line);
 177   wxInputStream& operator>>(char& c);
 178   wxInputStream& operator>>(signed short& i);
 179   wxInputStream& operator>>(signed int& i);
 180   wxInputStream& operator>>(signed long& i);
 181   wxInputStream& operator>>(unsigned char& c);
 182   wxInputStream& operator>>(unsigned short& i);
 183   wxInputStream& operator>>(unsigned int& i);
 184   wxInputStream& operator>>(unsigned long& i);
 185   wxInputStream& operator>>(double& i);
 186   wxInputStream& operator>>(float& f) { double d; operator>>((double&)d); f = (float)d; return *this; }
 187 #if wxUSE_SERIAL
 188   wxInputStream& operator>>(wxObject *& obj);
 189 #endif
 190   wxInputStream& operator>>( __wxInputManip func) { return func(*this); }
 191
 192  protected:
 193   bool m_i_destroybuf;
 194   wxStreamBuffer *m_i_streambuf;
 195 };
 196
 197 class WXDLLEXPORT wxOutputStream: public wxStreamBase {
 198  public:
 199   wxOutputStream();
 200   wxOutputStream(wxStreamBuffer *sbuf);
 201   virtual ~wxOutputStream();
 202
 203   virtual wxOutputStream& Write(const void *buffer, size_t size);
 204   wxOutputStream& Write(wxInputStream& stream_in);
 205   void WriteLine(const wxString& line);
 206
 207   off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
 208   off_t TellO() const;
 209
 210   size_t LastWrite() const { return wxStreamBase::m_lastcount; }
 211   wxStreamBuffer *OutputStreamBuffer() { return m_o_streambuf; }
 212
 213   void Sync();
 214
 215   wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
 216   wxOutputStream& operator<<(const char *string);
 217   wxOutputStream& operator<<(wxString& string);
 218   wxOutputStream& operator<<(char c);
 219   wxOutputStream& operator<<(signed short i);
 220   wxOutputStream& operator<<(signed int i);
 221   wxOutputStream& operator<<(signed long i);
 222   wxOutputStream& operator<<(unsigned char c);
 223   wxOutputStream& operator<<(unsigned short i);
 224   wxOutputStream& operator<<(unsigned int i);
 225   wxOutputStream& operator<<(unsigned long i);
 226   wxOutputStream& operator<<(double f);
 227   wxOutputStream& operator<<(float f) { return operator<<((double)f); }
 228 #if wxUSE_SERIAL
 229   wxOutputStream& operator<<(wxObject& obj);
 230 #endif
 231   wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }
 232
 233  protected:
 234   bool m_o_destroybuf;
 235   wxStreamBuffer *m_o_streambuf;
 236 };
 237
 238 // ---------------------------------------------------------------------------
 239 // "Filter" streams
 240 // ---------------------------------------------------------------------------
 241
 242 class WXDLLEXPORT wxFilterInputStream: public wxInputStream {
 243  public:
 244   wxFilterInputStream();
 245   wxFilterInputStream(wxInputStream& stream);
 246   ~wxFilterInputStream();
 247
 248   char Peek() { return m_parent_i_stream->Peek(); }
 249
 250   wxStreamError LastError() const { return m_parent_i_stream->LastError(); }
 251   size_t StreamSize() const { return m_parent_i_stream->StreamSize(); }
 252
 253  protected:
 254   wxInputStream *m_parent_i_stream;
 255 };
 256
 257 class WXDLLEXPORT wxFilterOutputStream: public wxOutputStream {
 258  public:
 259   wxFilterOutputStream();
 260   wxFilterOutputStream(wxOutputStream& stream);
 261   ~wxFilterOutputStream();
 262
 263   wxStreamError LastError() const { return m_parent_o_stream->LastError(); }
 264   size_t StreamSize() const { return m_parent_o_stream->StreamSize(); }
 265
 266  protected:
 267   wxOutputStream *m_parent_o_stream;
 268 };
 269
 270 #endif
 271   // wxUSE_STREAMS
 272
 273 #endif
 274   // _WX_WXSTREAM_H__