include/wx/sstream.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/sstream.h
   3 // Purpose:     string-based streams
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     2004-09-19
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_SSTREAM_H_
  13 #define _WX_SSTREAM_H_
  14
  15 #include "wx/stream.h"
  16
  17 #if wxUSE_STREAMS
  18
  19 // ----------------------------------------------------------------------------
  20 // wxStringInputStream is a stream reading from the given (fixed size) string
  21 // ----------------------------------------------------------------------------
  22
  23 class WXDLLIMPEXP_BASE wxStringInputStream : public wxInputStream
  24 {
  25 public:
  26     // ctor associates the stream with the given string which makes a copy of
  27     // it
  28     wxStringInputStream(const wxString& s);
  29
  30     virtual wxFileOffset GetLength() const;
  31
  32 protected:
  33     virtual wxFileOffset OnSysSeek(wxFileOffset ofs, wxSeekMode mode);
  34     virtual wxFileOffset OnSysTell() const;
  35     virtual size_t OnSysRead(void *buffer, size_t size);
  36
  37 private:
  38     // the string that was passed in the ctor
  39     wxString m_str;
  40
  41     // the buffer we're reading from
  42     wxCharBuffer m_buf;
  43
  44     // length of the buffer we're reading from
  45     size_t m_len;
  46
  47     // position in the stream in bytes, *not* in chars
  48     size_t m_pos;
  49
  50     wxDECLARE_NO_COPY_CLASS(wxStringInputStream);
  51 };
  52
  53 // ----------------------------------------------------------------------------
  54 // wxStringOutputStream writes data to the given string, expanding it as needed
  55 // ----------------------------------------------------------------------------
  56
  57 class WXDLLIMPEXP_BASE wxStringOutputStream : public wxOutputStream
  58 {
  59 public:
  60     // The stream will write data either to the provided string or to an
  61     // internal string which can be retrieved using GetString()
  62     //
  63     // Note that the conversion object should have the life time greater than
  64     // this stream.
  65     wxStringOutputStream(wxString *pString = NULL,
  66                          wxMBConv& conv = wxConvUTF8)
  67         : m_conv(conv)
  68 #if wxUSE_UNICODE_WCHAR
  69         , m_unconv(0)
  70 #endif // wxUSE_UNICODE_WCHAR
  71     {
  72         m_str = pString ? pString : &m_strInternal;
  73         m_pos = m_str->length() / sizeof(wxChar);
  74     }
  75
  76     // get the string containing current output
  77     const wxString& GetString() const { return *m_str; }
  78
  79 protected:
  80     virtual wxFileOffset OnSysTell() const;
  81     virtual size_t OnSysWrite(const void *buffer, size_t size);
  82
  83 private:
  84     // internal string, not used if caller provided his own string
  85     wxString m_strInternal;
  86
  87     // pointer given by the caller or just pointer to m_strInternal
  88     wxString *m_str;
  89
  90     // position in the stream in bytes, *not* in chars
  91     size_t m_pos;
  92
  93     // converter to use: notice that with the default UTF-8 one the input
  94     // stream must contain valid UTF-8 data, use wxConvISO8859_1 to work with
  95     // arbitrary 8 bit data
  96     wxMBConv& m_conv;
  97
  98 #if wxUSE_UNICODE_WCHAR
  99     // unconverted data from the last call to OnSysWrite()
 100     wxMemoryBuffer m_unconv;
 101 #endif // wxUSE_UNICODE_WCHAR
 102
 103     wxDECLARE_NO_COPY_CLASS(wxStringOutputStream);
 104 };
 105
 106 #endif // wxUSE_STREAMS
 107
 108 #endif // _WX_SSTREAM_H_
 109