document various enumerations defined in defs.h; give a name to the anonymous enum...

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

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 5ef6ccdc4bd5f43eb0d0f1b6be02d5d00598196a..3f34c95212d769ef59f8c085a919fba75129b518 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -21,9 +21,9 @@
 #include "wx/string.h"
 #include "wx/filefn.h"  // for wxFileOffset, wxInvalidOffset and wxSeekMode
 
 #include "wx/string.h"
 #include "wx/filefn.h"  // for wxFileOffset, wxInvalidOffset and wxSeekMode
 

-class WXDLLIMPEXP_BASE wxStreamBase;
-class WXDLLIMPEXP_BASE wxInputStream;
-class WXDLLIMPEXP_BASE wxOutputStream;
+class WXDLLIMPEXP_FWD_BASE wxStreamBase;
+class WXDLLIMPEXP_FWD_BASE wxInputStream;
+class WXDLLIMPEXP_FWD_BASE wxOutputStream;

 
 typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
 typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);
 
 typedef wxInputStream& (*__wxInputManip)(wxInputStream&);
 typedef wxOutputStream& (*__wxOutputManip)(wxOutputStream&);


@@ -354,12 +354,12 @@ public:
     virtual const wxChar * const *GetProtocols(wxStreamProtocolType type
                                                = wxSTREAM_PROTOCOL) const = 0;
 
     virtual const wxChar * const *GetProtocols(wxStreamProtocolType type
                                                = wxSTREAM_PROTOCOL) const = 0;
 

-    bool CanHandle(const wxChar *protocol,
+    bool CanHandle(const wxString& protocol,

                    wxStreamProtocolType type
                    = wxSTREAM_PROTOCOL) const;
 
 protected:
                    wxStreamProtocolType type
                    = wxSTREAM_PROTOCOL) const;
 
 protected:

-    wxString::size_type FindExtension(const wxChar *location) const;
+    wxString::size_type FindExtension(const wxString& location) const;

 
     DECLARE_ABSTRACT_CLASS(wxFilterClassFactoryBase)
 };
 
     DECLARE_ABSTRACT_CLASS(wxFilterClassFactoryBase)
 };


@@ -374,7 +374,7 @@ public:
     virtual wxFilterInputStream  *NewStream(wxInputStream *stream)  const = 0;
     virtual wxFilterOutputStream *NewStream(wxOutputStream *stream) const = 0;
 
     virtual wxFilterInputStream  *NewStream(wxInputStream *stream)  const = 0;
     virtual wxFilterOutputStream *NewStream(wxOutputStream *stream) const = 0;
 

-    static const wxFilterClassFactory *Find(const wxChar *protocol,
+    static const wxFilterClassFactory *Find(const wxString& protocol,

                                             wxStreamProtocolType type
                                             = wxSTREAM_PROTOCOL);
 
                                             wxStreamProtocolType type
                                             = wxSTREAM_PROTOCOL);
 


@@ -416,7 +416,23 @@ public:
         read_write
     };
 
         read_write
     };
 

-    wxStreamBuffer(wxStreamBase& stream, BufMode mode);
+    wxStreamBuffer(wxStreamBase& stream, BufMode mode)
+    {
+        InitWithStream(stream, mode);
+    }
+
+    wxStreamBuffer(wxInputStream& stream, size_t bufsize)
+    {
+        InitWithStream(stream, read);
+        SetBufferIO(bufsize);
+    }
+
+    wxStreamBuffer(wxOutputStream& stream, size_t bufsize)
+    {
+        InitWithStream(stream, write);
+        SetBufferIO(bufsize);
+    }
+

     wxStreamBuffer(const wxStreamBuffer& buf);
     virtual ~wxStreamBuffer();
 
     wxStreamBuffer(const wxStreamBuffer& buf);
     virtual ~wxStreamBuffer();
 


@@ -444,7 +460,7 @@ public:
     void *GetBufferStart() const { return m_buffer_start; }
     void *GetBufferEnd() const { return m_buffer_end; }
     void *GetBufferPos() const { return m_buffer_pos; }
     void *GetBufferStart() const { return m_buffer_start; }
     void *GetBufferEnd() const { return m_buffer_end; }
     void *GetBufferPos() const { return m_buffer_pos; }

-    size_t GetBufferSize() const { return m_buffer_size; }
+    size_t GetBufferSize() const { return m_buffer_end - m_buffer_start; }

     size_t GetIntPosition() const { return m_buffer_pos - m_buffer_start; }
     void SetIntPosition(size_t pos) { m_buffer_pos = m_buffer_start + pos; }
     size_t GetLastAccess() const { return m_buffer_end - m_buffer_start; }
     size_t GetIntPosition() const { return m_buffer_pos - m_buffer_start; }
     void SetIntPosition(size_t pos) { m_buffer_pos = m_buffer_start + pos; }
     size_t GetLastAccess() const { return m_buffer_end - m_buffer_start; }


@@ -459,7 +475,7 @@ public:
 
     // misc accessors
     wxStreamBase *GetStream() const { return m_stream; }
 
     // misc accessors
     wxStreamBase *GetStream() const { return m_stream; }

-    bool HasBuffer() const { return m_buffer_size != 0; }
+    bool HasBuffer() const { return m_buffer_start != m_buffer_end; }

 
     bool IsFixed() const { return m_fixed; }
     bool IsFlushable() const { return m_flushable; }
 
     bool IsFixed() const { return m_fixed; }
     bool IsFlushable() const { return m_flushable; }


@@ -487,6 +503,9 @@ protected:
     // common part of several ctors
     void Init();
 
     // common part of several ctors
     void Init();
 

+    // common part of ctors taking wxStreamBase parameter
+    void InitWithStream(wxStreamBase& stream, BufMode mode);
+

     // init buffer variables to be empty
     void InitBuffer();
 
     // init buffer variables to be empty
     void InitBuffer();
 


@@ -499,10 +518,6 @@ protected:
          *m_buffer_end,
          *m_buffer_pos;
 
          *m_buffer_end,
          *m_buffer_pos;
 

-    // the buffer size
-    // FIXME: isn't it the same as m_buffer_end - m_buffer_start? (VZ)
-    size_t m_buffer_size;
-

     // the stream we're associated with
     wxStreamBase *m_stream;
 
     // the stream we're associated with
     wxStreamBase *m_stream;
 


@@ -514,13 +529,8 @@ protected:
          m_fixed,
          m_flushable;
 
          m_fixed,
          m_flushable;
 

-private:
-// Cannot use
-//  DECLARE_NO_COPY_CLASS(wxStreamBuffer)
-// because copy constructor is explicitly declared above;
-// but no copy assignment operator is defined, so declare
-// it private to prevent the compiler from defining it:
-    wxStreamBuffer& operator=(const wxStreamBuffer&);
+
+    DECLARE_NO_ASSIGN_CLASS(wxStreamBuffer)

 };
 
 // ---------------------------------------------------------------------------
 };
 
 // ---------------------------------------------------------------------------


@@ -530,9 +540,19 @@ private:
 class WXDLLIMPEXP_BASE wxBufferedInputStream : public wxFilterInputStream
 {
 public:
 class WXDLLIMPEXP_BASE wxBufferedInputStream : public wxFilterInputStream
 {
 public:

-    // if a non NULL buffer is given to the stream, it will be deleted by it
+    // create a buffered stream on top of the specified low-level stream
+    //
+    // if a non NULL buffer is given to the stream, it will be deleted by it,
+    // otherwise a default 1KB buffer will be used

     wxBufferedInputStream(wxInputStream& stream,
                           wxStreamBuffer *buffer = NULL);
     wxBufferedInputStream(wxInputStream& stream,
                           wxStreamBuffer *buffer = NULL);

+
+    // ctor allowing to specify the buffer size, it's just a more convenient
+    // alternative to creating wxStreamBuffer, calling its SetBufferIO(bufsize)
+    // and using the ctor above
+    wxBufferedInputStream(wxInputStream& stream, size_t bufsize);
+
+

     virtual ~wxBufferedInputStream();
 
     char Peek();
     virtual ~wxBufferedInputStream();
 
     char Peek();


@@ -569,9 +589,18 @@ protected:
 class WXDLLIMPEXP_BASE wxBufferedOutputStream : public wxFilterOutputStream
 {
 public:
 class WXDLLIMPEXP_BASE wxBufferedOutputStream : public wxFilterOutputStream
 {
 public:

-    // if a non NULL buffer is given to the stream, it will be deleted by it
+    // create a buffered stream on top of the specified low-level stream
+    //
+    // if a non NULL buffer is given to the stream, it will be deleted by it,
+    // otherwise a default 1KB buffer will be used

     wxBufferedOutputStream(wxOutputStream& stream,
                            wxStreamBuffer *buffer = NULL);
     wxBufferedOutputStream(wxOutputStream& stream,
                            wxStreamBuffer *buffer = NULL);

+
+    // ctor allowing to specify the buffer size, it's just a more convenient
+    // alternative to creating wxStreamBuffer, calling its SetBufferIO(bufsize)
+    // and using the ctor above
+    wxBufferedOutputStream(wxOutputStream& stream, size_t bufsize);
+

     virtual ~wxBufferedOutputStream();
 
     wxOutputStream& Write(const void *buffer, size_t size);
     virtual ~wxBufferedOutputStream();
 
     wxOutputStream& Write(const void *buffer, size_t size);