]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/stream.h
bug fixes for using wxTransientPopupWindow and wxDP_ALLOWNONE support from Andreas...
[wxWidgets.git] / include / wx / stream.h
index c868ddb17b63b9ab871a3a43c903fc17cb1dddee..0a6f16e545bc7d19fcdd917adc4d721759aceb6a 100644 (file)
@@ -23,7 +23,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;
@@ -82,17 +82,21 @@ 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; }
+    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; }
 
 #if WXWIN_COMPATIBILITY_2_2
     // deprecated, for compatibility only
-    wxStreamError LastError() const { return m_lasterror; }
-    size_t StreamSize() const { return GetSize(); }
+    wxDEPRECATED( wxStreamError LastError() const );
+    wxDEPRECATED( size_t StreamSize() const );
 #endif // WXWIN_COMPATIBILITY_2_2
 
 protected:
-    virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
-    virtual off_t OnSysTell() const;
+    virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
+    virtual wxFileOffset OnSysTell() const;
 
     size_t m_lastcount;
     wxStreamError m_lasterror;
@@ -159,7 +163,7 @@ public:
     // all the requested data or not
     virtual size_t LastRead() const { return wxStreamBase::m_lastcount; }
 
-    // returns TRUE if some data is available in the stream right now, so that
+    // returns true if some data is available in the stream right now, so that
     // calling Read() wouldn't block
     virtual bool CanRead() const;
 
@@ -181,7 +185,7 @@ public:
 
     // put back the specified character in the stream
     //
-    // returns TRUE if ok, FALSE on error
+    // returns true if ok, false on error
     bool Ungetch(char c);
 
 
@@ -192,10 +196,10 @@ public:
     // it)
     //
     // returns wxInvalidOffset on error
-    virtual off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
+    virtual wxFileOffset SeekI(wxFileOffset pos, wxSeekMode mode = wxFromStart);
 
     // return the current position of the stream pointer or wxInvalidOffset
-    virtual off_t TellI() const;
+    virtual wxFileOffset TellI() const;
 
 
     // stream-like operators
@@ -250,12 +254,13 @@ public:
     virtual wxOutputStream& Write(const void *buffer, size_t size);
     wxOutputStream& Write(wxInputStream& stream_in);
 
-    virtual off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
-    virtual off_t TellO() const;
+    virtual wxFileOffset SeekO(wxFileOffset pos, wxSeekMode mode = wxFromStart);
+    virtual wxFileOffset TellO() const;
 
     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,13 +288,13 @@ class WXDLLIMPEXP_BASE wxCountingOutputStream : public wxOutputStream
 public:
     wxCountingOutputStream();
 
-    size_t GetSize() const;
-    bool Ok() const { return TRUE; }
+    wxFileOffset GetLength() const;
+    bool Ok() const { return true; }
 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t size);
-    virtual off_t OnSysSeek(off_t pos, wxSeekMode mode);
-    virtual off_t OnSysTell() const;
+    virtual wxFileOffset OnSysSeek(wxFileOffset pos, wxSeekMode mode);
+    virtual wxFileOffset OnSysTell() const;
 
     size_t m_currentPos;
 
@@ -309,7 +314,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 +331,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; }
 
@@ -368,16 +373,16 @@ public:
     virtual char Peek();
     virtual char GetChar();
     virtual void PutChar(char c);
-    virtual off_t Tell() const;
-    virtual off_t Seek(off_t pos, wxSeekMode mode);
+    virtual wxFileOffset Tell() const;
+    virtual wxFileOffset Seek(wxFileOffset pos, wxSeekMode mode);
 
     // Buffer control
     void ResetBuffer();
 
     // NB: the buffer must always be allocated with malloc() if takeOwn is
-    //     TRUE as it will be deallocated by free()
-    void SetBufferIO(void *start, void *end, bool takeOwnership = FALSE);
-    void SetBufferIO(void *start, size_t len, bool takeOwnership = FALSE);
+    //     true as it will be deallocated by free()
+    void SetBufferIO(void *start, void *end, bool takeOwnership = false);
+    void SetBufferIO(void *start, size_t len, bool takeOwnership = false);
     void SetBufferIO(size_t bufsize);
     void *GetBufferStart() const { return m_buffer_start; }
     void *GetBufferEnd() const { return m_buffer_end; }
@@ -475,8 +480,9 @@ public:
     wxInputStream& Read(void *buffer, size_t size);
 
     // Position functions
-    off_t SeekI(off_t pos, wxSeekMode mode = wxFromStart);
-    off_t TellI() const;
+    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);
@@ -487,8 +493,8 @@ public:
 
 protected:
     virtual size_t OnSysRead(void *buffer, size_t bufsize);
-    virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
-    virtual off_t OnSysTell() const;
+    virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
+    virtual wxFileOffset OnSysTell() const;
 
     wxStreamBuffer *m_i_streambuf;
 
@@ -510,12 +516,14 @@ public:
     wxOutputStream& Write(const void *buffer, size_t size);
 
     // Position functions
-    off_t SeekO(off_t pos, wxSeekMode mode = wxFromStart);
-    off_t TellO() const;
+    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);
@@ -526,8 +534,8 @@ public:
 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
-    virtual off_t OnSysSeek(off_t seek, wxSeekMode mode);
-    virtual off_t OnSysTell() const;
+    virtual wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
+    virtual wxFileOffset OnSysTell() const;
 
     wxStreamBuffer *m_o_streambuf;