]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/stream.h
Added parent window parameter to wxHelpController constructor
[wxWidgets.git] / include / wx / stream.h
index 3824fd1026e83fac46d0c4f52cae1263c334ce6b..0c91e975f3c91950ddd1feb792f1f465fea3cca3 100644 (file)
 #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
@@ -23,7 +19,7 @@
 #include <stdio.h>
 #include "wx/object.h"
 #include "wx/string.h"
-#include "wx/filefn.h"  // for off_t, wxInvalidOffset and wxSeekMode
+#include "wx/filefn.h"  // for wxFileOffset, wxInvalidOffset and wxSeekMode
 
 class WXDLLIMPEXP_BASE wxStreamBase;
 class WXDLLIMPEXP_BASE wxInputStream;
@@ -46,19 +42,6 @@ enum wxStreamError
     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
 // ============================================================================
@@ -82,13 +65,22 @@ public:
     void Reset() { m_lasterror = wxSTREAM_NO_ERROR; }
 
     // this doesn't make sense for all streams, always test its return value
-    virtual size_t GetSize() const { return 0; }
-
-#if WXWIN_COMPATIBILITY_2_2
-    // deprecated, for compatibility only
-    wxStreamError LastError() const { return m_lasterror; }
-    size_t StreamSize() const { return GetSize(); }
-#endif // WXWIN_COMPATIBILITY_2_2
+    virtual size_t GetSize() const;
+    virtual wxFileOffset GetLength() const { return wxInvalidOffset; }
+
+    // returns true if the streams supports seeking to arbitrary offsets
+    virtual bool IsSeekable() const { return false; }
+
+    // Reserved for future use
+    virtual void ReservedStreamFunc1() {}
+    virtual void ReservedStreamFunc2() {}
+    virtual void ReservedStreamFunc3() {}
+    virtual void ReservedStreamFunc4() {}
+    virtual void ReservedStreamFunc5() {}
+    virtual void ReservedStreamFunc6() {}
+    virtual void ReservedStreamFunc7() {}
+    virtual void ReservedStreamFunc8() {}
+    virtual void ReservedStreamFunc9() {}
 
 protected:
     virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
@@ -207,7 +199,7 @@ public:
 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;
@@ -256,6 +248,7 @@ public:
     virtual size_t LastWrite() const { return wxStreamBase::m_lastcount; }
 
     virtual void Sync();
+    virtual bool Close() { return true; }
 
     wxOutputStream& operator<<(wxInputStream& out) { return Write(out); }
     wxOutputStream& operator<<( __wxOutputManip func) { return func(*this); }
@@ -283,7 +276,7 @@ class WXDLLIMPEXP_BASE wxCountingOutputStream : public wxOutputStream
 public:
     wxCountingOutputStream();
 
-    size_t GetSize() const;
+    wxFileOffset GetLength() const;
     bool Ok() const { return true; }
 
 protected:
@@ -309,7 +302,7 @@ public:
 
     char Peek() { return m_parent_i_stream->Peek(); }
 
-    size_t GetSize() const { return m_parent_i_stream->GetSize(); }
+    wxFileOffset GetLength() const { return m_parent_i_stream->GetLength(); }
 
     wxInputStream *GetFilterInputStream() const { return m_parent_i_stream; }
 
@@ -326,7 +319,7 @@ public:
     wxFilterOutputStream(wxOutputStream& stream);
     virtual ~wxFilterOutputStream();
 
-    size_t GetSize() const { return m_parent_o_stream->GetSize(); }
+    wxFileOffset GetLength() const { return m_parent_o_stream->GetLength(); }
 
     wxOutputStream *GetFilterOutputStream() const { return m_parent_o_stream; }
 
@@ -477,6 +470,7 @@ public:
     // Position functions
     wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart);
     wxFileOffset TellI() const;
+    bool IsSeekable() const { return m_parent_i_stream->IsSeekable(); }
 
     // the buffer given to the stream will be deleted by it
     void SetInputStreamBuffer(wxStreamBuffer *buffer);
@@ -512,10 +506,12 @@ public:
     // Position functions
     wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart);
     wxFileOffset TellO() const;
+    bool IsSeekable() const { return m_parent_o_stream->IsSeekable(); }
 
     void Sync();
+    bool Close();
 
-    size_t GetSize() const;
+    wxFileOffset GetLength() const;
 
     // the buffer given to the stream will be deleted by it
     void SetOutputStreamBuffer(wxStreamBuffer *buffer);