include/wx/stream.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/stream.h
   3 // Purpose:     stream classes
   4 // Author:      Guilhem Lavaux, Guillermo Rodriguez Garcia, Vadim Zeitlin
   5 // Modified by:
   6 // Created:     11/07/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Guilhem Lavaux
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_WXSTREAM_H__
  13 #define _WX_WXSTREAM_H__
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_STREAMS
  18
  19 #include <stdio.h>
  20 #include "wx/object.h"
  21 #include "wx/string.h"
  22 #include "wx/filefn.h"  // for wxFileOffset, wxInvalidOffset and wxSeekMode
  23
  24 class WXDLLIMPEXP_BASE wxStreamBase;
  25 class WXDLLIMPEXP_BASE wxInputStream;
  26 class WXDLLIMPEXP_BASE wxOutputStream;
  27
  28 typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
  29 typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);
  30
  31 WXDLLIMPEXP_BASE wxOutputStream& wxEndL(wxOutputStream& o_stream);
  32
  33 // ----------------------------------------------------------------------------
  34 // constants
  35 // ----------------------------------------------------------------------------
  36
  37 enum wxStreamError
  38 {
  39     wxSTREAM_NO_ERROR = 0,      // stream is in good state
  40     wxSTREAM_EOF,               // EOF reached in Read() or similar
  41     wxSTREAM_WRITE_ERROR,       // generic write error
  42     wxSTREAM_READ_ERROR         // generic read error
  43 };
  44
  45 // ============================================================================
  46 // base stream classes: wxInputStream and wxOutputStream
  47 // ============================================================================
  48
  49 // ---------------------------------------------------------------------------
  50 // wxStreamBase: common (but non virtual!) base for all stream classes
  51 // ---------------------------------------------------------------------------
  52
  53 class WXDLLIMPEXP_BASE wxStreamBase
  54 {
  55 public:
  56     wxStreamBase();
  57     virtual ~wxStreamBase();
  58
  59     // error testing
  60     wxStreamError GetLastError() const { return m_lasterror; }
  61     virtual bool IsOk() const { return GetLastError() == wxSTREAM_NO_ERROR; }
  62     bool operator!() const { return !IsOk(); }
  63
  64     // reset the stream state
  65     void Reset() { m_lasterror = wxSTREAM_NO_ERROR; }
  66
  67     // this doesn't make sense for all streams, always test its return value
  68     virtual size_t GetSize() const;
  69     virtual wxFileOffset GetLength() const { return wxInvalidOffset; }
  70
  71     // returns true if the streams supports seeking to arbitrary offsets
  72     virtual bool IsSeekable() const { return false; }
  73
  74 protected:
  75     virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
  76     virtual wxFileOffset OnSysTell() const;
  77
  78     size_t m_lastcount;
  79     wxStreamError m_lasterror;
  80
  81     friend class wxStreamBuffer;
  82
  83     DECLARE_NO_COPY_CLASS(wxStreamBase)
  84 };
  85
  86 // ----------------------------------------------------------------------------
  87 // wxInputStream: base class for the input streams
  88 // ----------------------------------------------------------------------------
  89
  90 class WXDLLIMPEXP_BASE wxInputStream : public wxStreamBase
  91 {
  92 public:
  93     // ctor and dtor, nothing exciting
  94     wxInputStream();
  95     virtual ~wxInputStream();
  96
  97
  98     // IO functions
  99     // ------------
 100
 101     // return a character from the stream without removing it, i.e. it will
 102     // still be returned by the next call to GetC()
 103     //
 104     // blocks until something appears in the stream if necessary, if nothing
 105     // ever does (i.e. EOF) LastRead() will return 0 (and the return value is
 106     // undefined), otherwise 1
 107     virtual char Peek();
 108
 109     // return one character from the stream, blocking until it appears if
 110     // necessary
 111     //
 112     // if EOF, return value is undefined and LastRead() will return 0 and not 1
 113     char GetC();
 114
 115     // read at most the given number of bytes from the stream
 116     //
 117     // there are 2 possible situations here: either there is nothing at all in
 118     // the stream right now in which case Read() blocks until something appears
 119     // (use CanRead() to avoid this) or there is already some data available in
 120     // the stream and then Read() doesn't block but returns just the data it
 121     // can read without waiting for more
 122     //
 123     // in any case, if there are not enough bytes in the stream right now,
 124     // LastRead() value will be less than size but greater than 0. If it is 0,
 125     // it means that EOF has been reached.
 126     virtual wxInputStream& Read(void *buffer, size_t size);
 127
 128     // copy the entire contents of this stream into streamOut, stopping only
 129     // when EOF is reached or an error occurs
 130     wxInputStream& Read(wxOutputStream& streamOut);
 131
 132
 133     // status functions
 134     // ----------------
 135
 136     // returns the number of bytes read by the last call to Read(), GetC() or
 137     // Peek()
 138     //
 139     // this should be used to discover whether that call succeeded in reading
 140     // all the requested data or not
 141     virtual size_t LastRead() const { return wxStreamBase::m_lastcount; }
 142
 143     // returns true if some data is available in the stream right now, so that
 144     // calling Read() wouldn't block
 145     virtual bool CanRead() const;
 146
 147     // is the stream at EOF?
 148     //
 149     // note that this cannot be really implemented for all streams and
 150     // CanRead() is more reliable than Eof()
 151     virtual bool Eof() const;
 152
 153
 154     // write back buffer
 155     // -----------------
 156
 157     // put back the specified number of bytes into the stream, they will be
 158     // fetched by the next call to the read functions
 159     //
 160     // returns the number of bytes really stuffed back
 161     size_t Ungetch(const void *buffer, size_t size);
 162
 163     // put back the specified character in the stream
 164     //
 165     // returns true if ok, false on error
 166     bool Ungetch(char c);
 167
 168
 169     // position functions
 170     // ------------------
 171
 172     // move the stream pointer to the given position (if the stream supports
 173     // it)
 174     //
 175     // returns wxInvalidOffset on error
 176     virtual wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart);
 177
 178     // return the current position of the stream pointer or wxInvalidOffset
 179     virtual wxFileOffset TellI() const;
 180
 181
 182     // stream-like operators
 183     // ---------------------
 184
 185     wxInputStream& operator>>(wxOutputStream& out) { return Read(out); }
 186     wxInputStream& operator>>(__wxInputManip func) { return func(*this); }
 187
 188 protected:
 189     // do read up to size bytes of data into the provided buffer
 190     //
 191     // this method should return 0 if EOF has been reached or an error occurred
 192     // (m_lasterror should be set accordingly as well) or the number of bytes
 193     // read
 194     virtual size_t OnSysRead(void *buffer, size_t size) = 0;
 195
 196     // write-back buffer support
 197     // -------------------------
 198
 199     // return the pointer to a buffer big enough to hold sizeNeeded bytes
 200     char *AllocSpaceWBack(size_t sizeNeeded);
 201
 202     // read up to size data from the write back buffer, return the number of
 203     // bytes read
 204     size_t GetWBack(void *buf, size_t size);
 205
 206     // write back buffer or NULL if none
 207     char *m_wback;
 208
 209     // the size of the buffer
 210     size_t m_wbacksize;
 211
 212     // the current position in the buffer
 213     size_t m_wbackcur;
 214
 215     friend class wxStreamBuffer;
 216
 217     DECLARE_NO_COPY_CLASS(wxInputStream)
 218 };
 219
 220 // ----------------------------------------------------------------------------
 221 // wxOutputStream: base for the output streams
 222 // ----------------------------------------------------------------------------
 223
 224 class WXDLLIMPEXP_BASE wxOutputStream : public wxStreamBase
 225 {
 226 public:
 227     wxOutputStream();
 228     virtual ~wxOutputStream();
 229
 230     void PutC(char c);
 231     virtual wxOutputStream& Write(const void *buffer, size_t size);
 232     wxOutputStream& Write(wxInputStream& stream_in);
 233
 234     virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart);
 235     virtual wxFileOffset TellO() const;
 236
 237     virtual size_t LastWrite() const { return wxStreamBase::m_lastcount; }
 238
 239     virtual void Sync();
 240     virtual bool Close() { return true; }
 241
 242     wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
 243     wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }
 244
 245 protected:
 246     // to be implemented in the derived classes (it should have been pure
 247     // virtual)
 248     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
 249
 250     friend class wxStreamBuffer;
 251
 252     DECLARE_NO_COPY_CLASS(wxOutputStream)
 253 };
 254
 255 // ============================================================================
 256 // helper stream classes
 257 // ============================================================================
 258
 259 // ---------------------------------------------------------------------------
 260 // A stream for measuring streamed output
 261 // ---------------------------------------------------------------------------
 262
 263 class WXDLLIMPEXP_BASE wxCountingOutputStream : public wxOutputStream
 264 {
 265 public:
 266     wxCountingOutputStream();
 267
 268     wxFileOffset GetLength() const;
 269     bool Ok() const { return IsOk(); }
 270     bool IsOk() const { return true; }
 271
 272 protected:
 273     virtual size_t OnSysWrite(const void *buffer, size_t size);
 274     virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode);
 275     virtual wxFileOffset OnSysTell() const;
 276
 277     size_t m_currentPos;
 278
 279     DECLARE_NO_COPY_CLASS(wxCountingOutputStream)
 280 };
 281
 282 // ---------------------------------------------------------------------------
 283 // "Filter" streams
 284 // ---------------------------------------------------------------------------
 285
 286 class WXDLLIMPEXP_BASE wxFilterInputStream : public wxInputStream
 287 {
 288 public:
 289     wxFilterInputStream();
 290     wxFilterInputStream(wxInputStream& stream);
 291     wxFilterInputStream(wxInputStream *stream);
 292     virtual ~wxFilterInputStream();
 293
 294     char Peek() { return m_parent_i_stream->Peek(); }
 295
 296     wxFileOffset GetLength() const { return m_parent_i_stream->GetLength(); }
 297
 298     wxInputStream *GetFilterInputStream() const { return m_parent_i_stream; }
 299
 300 protected:
 301     wxInputStream *m_parent_i_stream;
 302     bool m_owns;
 303
 304     DECLARE_NO_COPY_CLASS(wxFilterInputStream)
 305 };
 306
 307 class WXDLLIMPEXP_BASE wxFilterOutputStream : public wxOutputStream
 308 {
 309 public:
 310     wxFilterOutputStream();
 311     wxFilterOutputStream(wxOutputStream& stream);
 312     wxFilterOutputStream(wxOutputStream *stream);
 313     virtual ~wxFilterOutputStream();
 314
 315     wxFileOffset GetLength() const { return m_parent_o_stream->GetLength(); }
 316
 317     wxOutputStream *GetFilterOutputStream() const { return m_parent_o_stream; }
 318
 319     bool Close();
 320
 321 protected:
 322     wxOutputStream *m_parent_o_stream;
 323     bool m_owns;
 324
 325     DECLARE_NO_COPY_CLASS(wxFilterOutputStream)
 326 };
 327
 328 enum wxStreamProtocolType
 329 {
 330     wxSTREAM_PROTOCOL,      // wxFileSystem protocol (should be only one)
 331     wxSTREAM_MIMETYPE,      // Mime types the stream handles
 332     wxSTREAM_ENCODING,      // The http Content-Encodings the stream handles
 333     wxSTREAM_FILEEXTENSION  // File extensions the stream handles
 334 };
 335
 336 void WXDLLIMPEXP_BASE wxUseFilterClasses();
 337
 338 class WXDLLIMPEXP_BASE wxFilterClassFactory : public wxObject
 339 {
 340 public:
 341     virtual ~wxFilterClassFactory() { }
 342
 343     virtual wxFilterInputStream  *NewStream(wxInputStream& stream)  const = 0;
 344     virtual wxFilterOutputStream *NewStream(wxOutputStream& stream) const = 0;
 345     virtual wxFilterInputStream  *NewStream(wxInputStream *stream)  const = 0;
 346     virtual wxFilterOutputStream *NewStream(wxOutputStream *stream) const = 0;
 347
 348     wxString GetProtocol() const { return wxString(*GetProtocols()); }
 349
 350     virtual const wxChar * const *GetProtocols(wxStreamProtocolType type
 351                                                = wxSTREAM_PROTOCOL) const = 0;
 352
 353     bool CanHandle(const wxChar *protocol,
 354                    wxStreamProtocolType type
 355                    = wxSTREAM_PROTOCOL) const;
 356
 357     static const wxFilterClassFactory *Find(const wxChar *protocol,
 358                                             wxStreamProtocolType type
 359                                             = wxSTREAM_PROTOCOL);
 360
 361     static const wxFilterClassFactory *GetFirst();
 362     const wxFilterClassFactory *GetNext() const { return m_next; }
 363
 364     void PushFront() { Remove(); m_next = sm_first; sm_first = this; }
 365     void Remove();
 366
 367 protected:
 368     wxFilterClassFactory() : m_next(this) { }
 369
 370     wxFilterClassFactory& operator=(const wxFilterClassFactory&)
 371         { return *this; }
 372
 373 private:
 374     static wxFilterClassFactory *sm_first;
 375     wxFilterClassFactory *m_next;
 376
 377     DECLARE_ABSTRACT_CLASS(wxFilterClassFactory)
 378 };
 379
 380 // ============================================================================
 381 // buffered streams
 382 // ============================================================================
 383
 384 // ---------------------------------------------------------------------------
 385 // Stream buffer: this class can be derived from and passed to
 386 // wxBufferedStreams to implement custom buffering
 387 // ---------------------------------------------------------------------------
 388
 389 class WXDLLIMPEXP_BASE wxStreamBuffer
 390 {
 391 public:
 392     enum BufMode
 393     {
 394         read,
 395         write,
 396         read_write
 397     };
 398
 399     wxStreamBuffer(wxStreamBase& stream, BufMode mode);
 400     wxStreamBuffer(const wxStreamBuffer& buf);
 401     virtual ~wxStreamBuffer();
 402
 403     // Filtered IO
 404     virtual size_t Read(void *buffer, size_t size);
 405     size_t Read(wxStreamBuffer *buf);
 406     virtual size_t Write(const void *buffer, size_t size);
 407     size_t Write(wxStreamBuffer *buf);
 408
 409     virtual char Peek();
 410     virtual char GetChar();
 411     virtual void PutChar(char c);
 412     virtual wxFileOffset Tell() const;
 413     virtual wxFileOffset Seek(wxFileOffset pos, wxSeekMode mode);
 414
 415     // Buffer control
 416     void ResetBuffer();
 417
 418     // NB: the buffer must always be allocated with malloc() if takeOwn is
 419     //     true as it will be deallocated by free()
 420     void SetBufferIO(void *start, void *end, bool takeOwnership = false);
 421     void SetBufferIO(void *start, size_t len, bool takeOwnership = false);
 422     void SetBufferIO(size_t bufsize);
 423     void *GetBufferStart() const { return m_buffer_start; }
 424     void *GetBufferEnd() const { return m_buffer_end; }
 425     void *GetBufferPos() const { return m_buffer_pos; }
 426     size_t GetBufferSize() const { return m_buffer_size; }
 427     size_t GetIntPosition() const { return m_buffer_pos - m_buffer_start; }
 428     void SetIntPosition(size_t pos) { m_buffer_pos = m_buffer_start + pos; }
 429     size_t GetLastAccess() const { return m_buffer_end - m_buffer_start; }
 430     size_t GetBytesLeft() const { return m_buffer_end - m_buffer_pos; }
 431
 432     void Fixed(bool fixed) { m_fixed = fixed; }
 433     void Flushable(bool f) { m_flushable = f; }
 434
 435     bool FlushBuffer();
 436     bool FillBuffer();
 437     size_t GetDataLeft();
 438
 439     // misc accessors
 440     wxStreamBase *GetStream() const { return m_stream; }
 441     bool HasBuffer() const { return m_buffer_size != 0; }
 442
 443     bool IsFixed() const { return m_fixed; }
 444     bool IsFlushable() const { return m_flushable; }
 445
 446     // only for input/output buffers respectively, returns NULL otherwise
 447     wxInputStream *GetInputStream() const;
 448     wxOutputStream *GetOutputStream() const;
 449
 450 #if WXWIN_COMPATIBILITY_2_6
 451     // deprecated, for compatibility only
 452     wxDEPRECATED( wxStreamBase *Stream() );
 453 #endif // WXWIN_COMPATIBILITY_2_6
 454
 455     // this constructs a dummy wxStreamBuffer, used by (and exists for)
 456     // wxMemoryStreams only, don't use!
 457     wxStreamBuffer(BufMode mode);
 458
 459 protected:
 460     void GetFromBuffer(void *buffer, size_t size);
 461     void PutToBuffer(const void *buffer, size_t size);
 462
 463     // set the last error to the specified value if we didn't have it before
 464     void SetError(wxStreamError err);
 465
 466     // common part of several ctors
 467     void Init();
 468
 469     // init buffer variables to be empty
 470     void InitBuffer();
 471
 472     // free the buffer (always safe to call)
 473     void FreeBuffer();
 474
 475     // the buffer itself: the pointers to its start and end and the current
 476     // position in the buffer
 477     char *m_buffer_start,
 478          *m_buffer_end,
 479          *m_buffer_pos;
 480
 481     // the buffer size
 482     // FIXME: isn't it the same as m_buffer_end - m_buffer_start? (VZ)
 483     size_t m_buffer_size;
 484
 485     // the stream we're associated with
 486     wxStreamBase *m_stream;
 487
 488     // its mode
 489     BufMode m_mode;
 490
 491     // flags
 492     bool m_destroybuf,      // deallocate buffer?
 493          m_fixed,
 494          m_flushable;
 495
 496 private:
 497 // Cannot use
 498 //  DECLARE_NO_COPY_CLASS(wxStreamBuffer)
 499 // because copy constructor is explicitly declared above;
 500 // but no copy assignment operator is defined, so declare
 501 // it private to prevent the compiler from defining it:
 502     wxStreamBuffer& operator=(const wxStreamBuffer&);
 503 };
 504
 505 // ---------------------------------------------------------------------------
 506 // wxBufferedInputStream
 507 // ---------------------------------------------------------------------------
 508
 509 class WXDLLIMPEXP_BASE wxBufferedInputStream : public wxFilterInputStream
 510 {
 511 public:
 512     // if a non NULL buffer is given to the stream, it will be deleted by it
 513     wxBufferedInputStream(wxInputStream& stream,
 514                           wxStreamBuffer *buffer = NULL);
 515     virtual ~wxBufferedInputStream();
 516
 517     char Peek();
 518     wxInputStream& Read(void *buffer, size_t size);
 519
 520     // Position functions
 521     wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart);
 522     wxFileOffset TellI() const;
 523     bool IsSeekable() const { return m_parent_i_stream->IsSeekable(); }
 524
 525     // the buffer given to the stream will be deleted by it
 526     void SetInputStreamBuffer(wxStreamBuffer *buffer);
 527     wxStreamBuffer *GetInputStreamBuffer() const { return m_i_streambuf; }
 528
 529 #if WXWIN_COMPATIBILITY_2_6
 530     // deprecated, for compatibility only
 531     wxDEPRECATED( wxStreamBuffer *InputStreamBuffer() const );
 532 #endif // WXWIN_COMPATIBILITY_2_6
 533
 534 protected:
 535     virtual size_t OnSysRead(void *buffer, size_t bufsize);
 536     virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
 537     virtual wxFileOffset OnSysTell() const;
 538
 539     wxStreamBuffer *m_i_streambuf;
 540
 541     DECLARE_NO_COPY_CLASS(wxBufferedInputStream)
 542 };
 543
 544 // ----------------------------------------------------------------------------
 545 // wxBufferedOutputStream
 546 // ----------------------------------------------------------------------------
 547
 548 class WXDLLIMPEXP_BASE wxBufferedOutputStream : public wxFilterOutputStream
 549 {
 550 public:
 551     // if a non NULL buffer is given to the stream, it will be deleted by it
 552     wxBufferedOutputStream(wxOutputStream& stream,
 553                            wxStreamBuffer *buffer = NULL);
 554     virtual ~wxBufferedOutputStream();
 555
 556     wxOutputStream& Write(const void *buffer, size_t size);
 557
 558     // Position functions
 559     wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart);
 560     wxFileOffset TellO() const;
 561     bool IsSeekable() const { return m_parent_o_stream->IsSeekable(); }
 562
 563     void Sync();
 564     bool Close();
 565
 566     wxFileOffset GetLength() const;
 567
 568     // the buffer given to the stream will be deleted by it
 569     void SetOutputStreamBuffer(wxStreamBuffer *buffer);
 570     wxStreamBuffer *GetOutputStreamBuffer() const { return m_o_streambuf; }
 571
 572 #if WXWIN_COMPATIBILITY_2_6
 573     // deprecated, for compatibility only
 574     wxDEPRECATED( wxStreamBuffer *OutputStreamBuffer() const );
 575 #endif // WXWIN_COMPATIBILITY_2_6
 576
 577 protected:
 578     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
 579     virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
 580     virtual wxFileOffset OnSysTell() const;
 581
 582     wxStreamBuffer *m_o_streambuf;
 583
 584     DECLARE_NO_COPY_CLASS(wxBufferedOutputStream)
 585 };
 586
 587 #if WXWIN_COMPATIBILITY_2_6
 588     inline wxStreamBase *wxStreamBuffer::Stream() { return m_stream; }
 589     inline wxStreamBuffer *wxBufferedInputStream::InputStreamBuffer() const { return m_i_streambuf; }
 590     inline wxStreamBuffer *wxBufferedOutputStream::OutputStreamBuffer() const { return m_o_streambuf; }
 591 #endif // WXWIN_COMPATIBILITY_2_6
 592
 593 #endif // wxUSE_STREAMS
 594
 595 #endif // _WX_WXSTREAM_H__