Add tar streams.

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

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 0a6f16e545bc7d19fcdd917adc4d721759aceb6a..505bb3462581544c8466178cd4c946ac4a416487 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -12,10 +12,6 @@
 #ifndef _WX_WXSTREAM_H__
 #define _WX_WXSTREAM_H__
 
 #ifndef _WX_WXSTREAM_H__
 #define _WX_WXSTREAM_H__
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "stream.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_STREAMS
 #include "wx/defs.h"
 
 #if wxUSE_STREAMS


@@ -46,19 +42,6 @@ enum wxStreamError
     wxSTREAM_READ_ERROR         // generic read error
 };
 
     wxSTREAM_READ_ERROR         // generic read error
 };
 

-// compatibility
-#if WXWIN_COMPATIBILITY_2_2
-    #define wxStream_NOERROR    wxSTREAM_NOERROR
-    #define wxStream_EOF        wxSTREAM_EOF
-    #define wxStream_WRITE_ERR  wxSTREAM_WRITE_ERROR
-    #define wxStream_READ_ERR   wxSTREAM_READ_ERROR
-
-    #define wxSTREAM_NO_ERR     wxSTREAM_NO_ERROR
-    #define wxSTREAM_NOERROR    wxSTREAM_NO_ERROR
-    #define wxSTREAM_WRITE_ERR  wxSTREAM_WRITE_ERROR
-    #define wxSTREAM_READ_ERR   wxSTREAM_READ_ERROR
-#endif // WXWIN_COMPATIBILITY_2_2
-

 // ============================================================================
 // base stream classes: wxInputStream and wxOutputStream
 // ============================================================================
 // ============================================================================
 // base stream classes: wxInputStream and wxOutputStream
 // ============================================================================


@@ -75,7 +58,7 @@ public:
 
     // error testing
     wxStreamError GetLastError() const { return m_lasterror; }
 
     // error testing
     wxStreamError GetLastError() const { return m_lasterror; }

-    bool IsOk() const { return GetLastError() == wxSTREAM_NO_ERROR; }
+    virtual bool IsOk() const { return GetLastError() == wxSTREAM_NO_ERROR; }

     bool operator!() const { return !IsOk(); }
 
     // reset the stream state
     bool operator!() const { return !IsOk(); }
 
     // reset the stream state


@@ -88,12 +71,6 @@ public:
     // returns true if the streams supports seeking to arbitrary offsets
     virtual bool IsSeekable() const { return false; }
 
     // returns true if the streams supports seeking to arbitrary offsets
     virtual bool IsSeekable() const { return false; }
 

-#if WXWIN_COMPATIBILITY_2_2
-    // deprecated, for compatibility only
-    wxDEPRECATED( wxStreamError LastError() const );
-    wxDEPRECATED( size_t StreamSize() const );
-#endif // WXWIN_COMPATIBILITY_2_2
-

 protected:
     virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
     virtual wxFileOffset OnSysTell() const;
 protected:
     virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
     virtual wxFileOffset OnSysTell() const;


@@ -211,7 +188,7 @@ public:
 protected:
     // do read up to size bytes of data into the provided buffer
     //
 protected:
     // do read up to size bytes of data into the provided buffer
     //

-    // this method should return 0 if EOF has been reached or an error occured
+    // this method should return 0 if EOF has been reached or an error occurred

     // (m_lasterror should be set accordingly as well) or the number of bytes
     // read
     virtual size_t OnSysRead(void *buffer, size_t size) = 0;
     // (m_lasterror should be set accordingly as well) or the number of bytes
     // read
     virtual size_t OnSysRead(void *buffer, size_t size) = 0;


@@ -289,7 +266,8 @@ public:
     wxCountingOutputStream();
 
     wxFileOffset GetLength() const;
     wxCountingOutputStream();
 
     wxFileOffset GetLength() const;

-    bool Ok() const { return true; }
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const { return true; }

 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t size);
 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t size);


@@ -310,6 +288,7 @@ class WXDLLIMPEXP_BASE wxFilterInputStream : public wxInputStream
 public:
     wxFilterInputStream();
     wxFilterInputStream(wxInputStream& stream);
 public:
     wxFilterInputStream();
     wxFilterInputStream(wxInputStream& stream);

+    wxFilterInputStream(wxInputStream *stream);

     virtual ~wxFilterInputStream();
 
     char Peek() { return m_parent_i_stream->Peek(); }
     virtual ~wxFilterInputStream();
 
     char Peek() { return m_parent_i_stream->Peek(); }


@@ -320,6 +299,7 @@ public:
 
 protected:
     wxInputStream *m_parent_i_stream;
 
 protected:
     wxInputStream *m_parent_i_stream;

+    bool m_owns;

 
     DECLARE_NO_COPY_CLASS(wxFilterInputStream)
 };
 
     DECLARE_NO_COPY_CLASS(wxFilterInputStream)
 };


@@ -329,18 +309,86 @@ class WXDLLIMPEXP_BASE wxFilterOutputStream : public wxOutputStream
 public:
     wxFilterOutputStream();
     wxFilterOutputStream(wxOutputStream& stream);
 public:
     wxFilterOutputStream();
     wxFilterOutputStream(wxOutputStream& stream);

+    wxFilterOutputStream(wxOutputStream *stream);

     virtual ~wxFilterOutputStream();
 
     wxFileOffset GetLength() const { return m_parent_o_stream->GetLength(); }
 
     wxOutputStream *GetFilterOutputStream() const { return m_parent_o_stream; }
 
     virtual ~wxFilterOutputStream();
 
     wxFileOffset GetLength() const { return m_parent_o_stream->GetLength(); }
 
     wxOutputStream *GetFilterOutputStream() const { return m_parent_o_stream; }
 

+    bool Close();
+

 protected:
     wxOutputStream *m_parent_o_stream;
 protected:
     wxOutputStream *m_parent_o_stream;

+    bool m_owns;

 
     DECLARE_NO_COPY_CLASS(wxFilterOutputStream)
 };
 
 
     DECLARE_NO_COPY_CLASS(wxFilterOutputStream)
 };
 

+enum wxStreamProtocolType
+{
+    wxSTREAM_PROTOCOL,      // wxFileSystem protocol (should be only one)
+    wxSTREAM_MIMETYPE,      // Mime types the stream handles
+    wxSTREAM_ENCODING,      // The http Content-Encodings the stream handles
+    wxSTREAM_FILEEXTENSION  // File extensions the stream handles
+};
+
+void WXDLLIMPEXP_BASE wxUseFilterClasses();
+
+class WXDLLIMPEXP_BASE wxFilterClassFactoryBase : public wxObject
+{
+public:
+    virtual ~wxFilterClassFactoryBase() { }
+
+    wxString GetProtocol() const { return wxString(*GetProtocols()); }
+    wxString PopExtension(const wxString& location) const;
+
+    virtual const wxChar * const *GetProtocols(wxStreamProtocolType type
+                                               = wxSTREAM_PROTOCOL) const = 0;
+
+    bool CanHandle(const wxChar *protocol,
+                   wxStreamProtocolType type
+                   = wxSTREAM_PROTOCOL) const;
+
+protected:
+    wxString::size_type FindExtension(const wxChar *location) const;
+
+    DECLARE_ABSTRACT_CLASS(wxFilterClassFactoryBase)
+};
+
+class WXDLLIMPEXP_BASE wxFilterClassFactory : public wxFilterClassFactoryBase
+{
+public:
+    virtual ~wxFilterClassFactory() { }
+
+    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,
+                                            wxStreamProtocolType type
+                                            = wxSTREAM_PROTOCOL);
+
+    static const wxFilterClassFactory *GetFirst();
+    const wxFilterClassFactory *GetNext() const { return m_next; }
+
+    void PushFront() { Remove(); m_next = sm_first; sm_first = this; }
+    void Remove();
+
+protected:
+    wxFilterClassFactory() : m_next(this) { }
+
+    wxFilterClassFactory& operator=(const wxFilterClassFactory&)
+        { return *this; }
+
+private:
+    static wxFilterClassFactory *sm_first;
+    wxFilterClassFactory *m_next;
+
+    DECLARE_ABSTRACT_CLASS(wxFilterClassFactory)
+};
+

 // ============================================================================
 // buffered streams
 // ============================================================================
 // ============================================================================
 // buffered streams
 // ============================================================================


@@ -411,8 +459,10 @@ public:
     wxInputStream *GetInputStream() const;
     wxOutputStream *GetOutputStream() const;
 
     wxInputStream *GetInputStream() const;
     wxOutputStream *GetOutputStream() const;
 

+#if WXWIN_COMPATIBILITY_2_6

     // deprecated, for compatibility only
     // deprecated, for compatibility only

-    wxStreamBase *Stream() { return m_stream; }
+    wxDEPRECATED( wxStreamBase *Stream() );
+#endif // WXWIN_COMPATIBILITY_2_6

 
     // this constructs a dummy wxStreamBuffer, used by (and exists for)
     // wxMemoryStreams only, don't use!
 
     // this constructs a dummy wxStreamBuffer, used by (and exists for)
     // wxMemoryStreams only, don't use!


@@ -488,8 +538,10 @@ public:
     void SetInputStreamBuffer(wxStreamBuffer *buffer);
     wxStreamBuffer *GetInputStreamBuffer() const { return m_i_streambuf; }
 
     void SetInputStreamBuffer(wxStreamBuffer *buffer);
     wxStreamBuffer *GetInputStreamBuffer() const { return m_i_streambuf; }
 

+#if WXWIN_COMPATIBILITY_2_6

     // deprecated, for compatibility only
     // deprecated, for compatibility only

-    wxStreamBuffer *InputStreamBuffer() const { return m_i_streambuf; }
+    wxDEPRECATED( wxStreamBuffer *InputStreamBuffer() const );
+#endif // WXWIN_COMPATIBILITY_2_6

 
 protected:
     virtual size_t OnSysRead(void *buffer, size_t bufsize);
 
 protected:
     virtual size_t OnSysRead(void *buffer, size_t bufsize);


@@ -529,8 +581,10 @@ public:
     void SetOutputStreamBuffer(wxStreamBuffer *buffer);
     wxStreamBuffer *GetOutputStreamBuffer() const { return m_o_streambuf; }
 
     void SetOutputStreamBuffer(wxStreamBuffer *buffer);
     wxStreamBuffer *GetOutputStreamBuffer() const { return m_o_streambuf; }
 

+#if WXWIN_COMPATIBILITY_2_6

     // deprecated, for compatibility only
     // deprecated, for compatibility only

-    wxStreamBuffer *OutputStreamBuffer() const { return m_o_streambuf; }
+    wxDEPRECATED( wxStreamBuffer *OutputStreamBuffer() const );
+#endif // WXWIN_COMPATIBILITY_2_6

 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);


@@ -542,7 +596,12 @@ protected:
     DECLARE_NO_COPY_CLASS(wxBufferedOutputStream)
 };
 
     DECLARE_NO_COPY_CLASS(wxBufferedOutputStream)
 };
 

+#if WXWIN_COMPATIBILITY_2_6
+    inline wxStreamBase *wxStreamBuffer::Stream() { return m_stream; }
+    inline wxStreamBuffer *wxBufferedInputStream::InputStreamBuffer() const { return m_i_streambuf; }
+    inline wxStreamBuffer *wxBufferedOutputStream::OutputStreamBuffer() const { return m_o_streambuf; }
+#endif // WXWIN_COMPATIBILITY_2_6
+

 #endif // wxUSE_STREAMS
 
 #endif // _WX_WXSTREAM_H__
 #endif // wxUSE_STREAMS
 
 #endif // _WX_WXSTREAM_H__

-