clear up wxStringBuffer docs a bit

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

diff --git a/include/wx/stream.h b/include/wx/stream.h
index 5b80f8766ccb4c6caccff8a3dad5f98074a824ca..3824fd1026e83fac46d0c4f52cae1263c334ce6b 100644 (file)
--- a/include/wx/stream.h
+++ b/include/wx/stream.h
@@ -6,13 +6,13 @@
 // Created:     11/07/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
 // Created:     11/07/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_WXSTREAM_H__
 #define _WX_WXSTREAM_H__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_WXSTREAM_H__
 #define _WX_WXSTREAM_H__
 

-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "stream.h"
 #endif
 
 #pragma interface "stream.h"
 #endif
 


@@ -25,14 +25,14 @@
 #include "wx/string.h"
 #include "wx/filefn.h"  // for off_t, wxInvalidOffset and wxSeekMode
 
 #include "wx/string.h"
 #include "wx/filefn.h"  // for off_t, wxInvalidOffset and wxSeekMode
 

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

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

-WXDLLEXPORT wxOutputStream& wxEndL(wxOutputStream& o_stream);
+WXDLLIMPEXP_BASE wxOutputStream& wxEndL(wxOutputStream& o_stream);

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -67,7 +67,7 @@ enum wxStreamError
 // wxStreamBase: common (but non virtual!) base for all stream classes
 // ---------------------------------------------------------------------------
 
 // wxStreamBase: common (but non virtual!) base for all stream classes
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxStreamBase
+class WXDLLIMPEXP_BASE wxStreamBase

 {
 public:
     wxStreamBase();
 {
 public:
     wxStreamBase();


@@ -81,7 +81,7 @@ public:
     // reset the stream state
     void Reset() { m_lasterror = wxSTREAM_NO_ERROR; }
 
     // reset the stream state
     void Reset() { m_lasterror = wxSTREAM_NO_ERROR; }
 

-    // deprecated (doesn't make sense!), don't use
+    // 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
     virtual size_t GetSize() const { return 0; }
 
 #if WXWIN_COMPATIBILITY_2_2


@@ -91,20 +91,22 @@ public:
 #endif // WXWIN_COMPATIBILITY_2_2
 
 protected:
 #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;
 
     friend class wxStreamBuffer;
 
     size_t m_lastcount;
     wxStreamError m_lasterror;
 
     friend class wxStreamBuffer;

+
+    DECLARE_NO_COPY_CLASS(wxStreamBase)

 };
 
 // ----------------------------------------------------------------------------
 // wxInputStream: base class for the input streams
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // wxInputStream: base class for the input streams
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxInputStream : public wxStreamBase
+class WXDLLIMPEXP_BASE wxInputStream : public wxStreamBase

 {
 public:
     // ctor and dtor, nothing exciting
 {
 public:
     // ctor and dtor, nothing exciting


@@ -157,7 +159,7 @@ public:
     // all the requested data or not
     virtual size_t LastRead() const { return wxStreamBase::m_lastcount; }
 
     // 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;
 
     // calling Read() wouldn't block
     virtual bool CanRead() const;
 


@@ -179,7 +181,7 @@ public:
 
     // put back the specified character in the stream
     //
 
     // 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);
 
 
     bool Ungetch(char c);
 
 


@@ -190,10 +192,10 @@ public:
     // it)
     //
     // returns wxInvalidOffset on error
     // 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
 
     // return the current position of the stream pointer or wxInvalidOffset

-    virtual off_t TellI() const;
+    virtual wxFileOffset TellI() const;

 
 
     // stream-like operators
 
 
     // stream-like operators


@@ -230,13 +232,15 @@ protected:
     size_t m_wbackcur;
 
     friend class wxStreamBuffer;
     size_t m_wbackcur;
 
     friend class wxStreamBuffer;

+
+    DECLARE_NO_COPY_CLASS(wxInputStream)

 };
 
 // ----------------------------------------------------------------------------
 // wxOutputStream: base for the output streams
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // wxOutputStream: base for the output streams
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxOutputStream : public wxStreamBase
+class WXDLLIMPEXP_BASE wxOutputStream : public wxStreamBase

 {
 public:
     wxOutputStream();
 {
 public:
     wxOutputStream();


@@ -246,8 +250,8 @@ public:
     virtual wxOutputStream& Write(const void *buffer, size_t size);
     wxOutputStream& Write(wxInputStream& stream_in);
 
     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 size_t LastWrite() const { return wxStreamBase::m_lastcount; }
 


@@ -262,6 +266,8 @@ protected:
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
 
     friend class wxStreamBuffer;
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
 
     friend class wxStreamBuffer;

+
+    DECLARE_NO_COPY_CLASS(wxOutputStream)

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -272,27 +278,29 @@ protected:
 // A stream for measuring streamed output
 // ---------------------------------------------------------------------------
 
 // A stream for measuring streamed output
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCountingOutputStream : public wxOutputStream
+class WXDLLIMPEXP_BASE wxCountingOutputStream : public wxOutputStream

 {
 public:
     wxCountingOutputStream();
 
     size_t GetSize() const;
 {
 public:
     wxCountingOutputStream();
 
     size_t GetSize() const;

-    bool Ok() const { return TRUE; }
+    bool Ok() 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);

-    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;
 
     size_t m_currentPos;

+
+    DECLARE_NO_COPY_CLASS(wxCountingOutputStream)

 };
 
 // ---------------------------------------------------------------------------
 // "Filter" streams
 // ---------------------------------------------------------------------------
 
 };
 
 // ---------------------------------------------------------------------------
 // "Filter" streams
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFilterInputStream : public wxInputStream
+class WXDLLIMPEXP_BASE wxFilterInputStream : public wxInputStream

 {
 public:
     wxFilterInputStream();
 {
 public:
     wxFilterInputStream();


@@ -307,9 +315,11 @@ public:
 
 protected:
     wxInputStream *m_parent_i_stream;
 
 protected:
     wxInputStream *m_parent_i_stream;

+
+    DECLARE_NO_COPY_CLASS(wxFilterInputStream)

 };
 
 };
 

-class WXDLLEXPORT wxFilterOutputStream : public wxOutputStream
+class WXDLLIMPEXP_BASE wxFilterOutputStream : public wxOutputStream

 {
 public:
     wxFilterOutputStream();
 {
 public:
     wxFilterOutputStream();


@@ -322,6 +332,8 @@ public:
 
 protected:
     wxOutputStream *m_parent_o_stream;
 
 protected:
     wxOutputStream *m_parent_o_stream;

+
+    DECLARE_NO_COPY_CLASS(wxFilterOutputStream)

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -333,7 +345,7 @@ protected:
 // wxBufferedStreams to implement custom buffering
 // ---------------------------------------------------------------------------
 
 // wxBufferedStreams to implement custom buffering
 // ---------------------------------------------------------------------------
 

-class WXDLLEXPORT wxStreamBuffer
+class WXDLLIMPEXP_BASE wxStreamBuffer

 {
 public:
     enum BufMode
 {
 public:
     enum BufMode


@@ -356,16 +368,16 @@ public:
     virtual char Peek();
     virtual char GetChar();
     virtual void PutChar(char c);
     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
 
     // 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; }
     void SetBufferIO(size_t bufsize);
     void *GetBufferStart() const { return m_buffer_start; }
     void *GetBufferEnd() const { return m_buffer_end; }


@@ -437,13 +449,21 @@ protected:
     bool m_destroybuf,      // deallocate buffer?
          m_fixed,
          m_flushable;
     bool m_destroybuf,      // deallocate buffer?
          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&);

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

-class WXDLLEXPORT wxBufferedInputStream : public wxFilterInputStream
+class WXDLLIMPEXP_BASE wxBufferedInputStream : public wxFilterInputStream

 {
 public:
     // if a non NULL buffer is given to the stream, it will be deleted by it
 {
 public:
     // if a non NULL buffer is given to the stream, it will be deleted by it


@@ -455,8 +475,8 @@ public:
     wxInputStream& Read(void *buffer, size_t size);
 
     // Position functions
     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;

 
     // the buffer given to the stream will be deleted by it
     void SetInputStreamBuffer(wxStreamBuffer *buffer);
 
     // the buffer given to the stream will be deleted by it
     void SetInputStreamBuffer(wxStreamBuffer *buffer);


@@ -467,17 +487,19 @@ public:
 
 protected:
     virtual size_t OnSysRead(void *buffer, size_t bufsize);
 
 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;
 
     wxStreamBuffer *m_i_streambuf;

+
+    DECLARE_NO_COPY_CLASS(wxBufferedInputStream)

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

-class WXDLLEXPORT wxBufferedOutputStream : public wxFilterOutputStream
+class WXDLLIMPEXP_BASE wxBufferedOutputStream : public wxFilterOutputStream

 {
 public:
     // if a non NULL buffer is given to the stream, it will be deleted by it
 {
 public:
     // if a non NULL buffer is given to the stream, it will be deleted by it


@@ -488,8 +510,8 @@ public:
     wxOutputStream& Write(const void *buffer, size_t size);
 
     // Position functions
     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;

 
     void Sync();
 
 
     void Sync();
 


@@ -504,10 +526,12 @@ public:
 
 protected:
     virtual size_t OnSysWrite(const void *buffer, size_t bufsize);
 
 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;
 
     wxStreamBuffer *m_o_streambuf;

+
+    DECLARE_NO_COPY_CLASS(wxBufferedOutputStream)

 };
 
 #endif // wxUSE_STREAMS
 };
 
 #endif // wxUSE_STREAMS