some wxArtProv docs

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

diff --git a/include/wx/buffer.h b/include/wx/buffer.h
index c2aaa0c09b727ef7289ece05c2a3d4526bda9aad..dac2adf1bdc2a681970141424bd2ac85bfc61e00 100644 (file)
--- a/include/wx/buffer.h
+++ b/include/wx/buffer.h
@@ -126,6 +126,119 @@ private:
     #define wxWX2WCbuf wxWCharBuffer
 #endif // Unicode/ANSI
 
     #define wxWX2WCbuf wxWCharBuffer
 #endif // Unicode/ANSI
 

+
+
+// ----------------------------------------------------------------------------
+// A class for holding growable data buffers (not necessarily strings)
+// ----------------------------------------------------------------------------
+
+class wxMemoryBuffer
+{
+public:
+    enum { BLOCK_SIZE = 1024 };
+    wxMemoryBuffer(size_t size=wxMemoryBuffer::BLOCK_SIZE)
+    {
+        wxASSERT(size > 0);
+        m_data = malloc(size);
+        wxASSERT(m_data != NULL);
+        m_size = size;
+        m_len  = 0;
+    }
+
+    ~wxMemoryBuffer() { free(m_data); }
+
+    // Accessors
+    void*  GetData() const    { return m_data; }
+    size_t GetBufSize() const { return m_size; }
+    size_t GetDataLen() const { return m_len; }
+
+    void   SetBufSize(size_t size) { ResizeIfNeeded(size); }
+    void   SetDataLen(size_t len)
+    {
+        wxASSERT(len <= m_size);
+        m_len = len;
+    }
+
+    // Ensure the buffer is big enough and return a pointer to it
+    void* GetWriteBuf(size_t sizeNeeded)
+    {
+        ResizeIfNeeded(sizeNeeded);
+        return m_data;
+    }
+    // Update the length after the write
+    void  UngetWriteBuf(size_t sizeUsed) { SetDataLen(sizeUsed); }
+
+    // Like the above, but appends to the buffer
+    void* GetAppendBuf(size_t sizeNeeded)
+    {
+        ResizeIfNeeded(m_len + sizeNeeded);
+        return (char*)m_data + m_len;
+    }
+    void  UngetAppendBuf(size_t sizeUsed) { SetDataLen(m_len + sizeUsed); }
+
+    // Other ways to append to the buffer
+    void  AppendByte(char data) {
+        ResizeIfNeeded(m_len + 1);
+        *(((char*)m_data)+m_len) = data;
+        m_len += 1;
+    }
+    void  AppendData(void* data, size_t len)
+    {
+        memcpy(GetAppendBuf(len), data, len);
+        UngetAppendBuf(len);
+    }
+
+    operator const char *() const { return (const char*)m_data; }
+
+
+    // Copy and assignment
+    wxMemoryBuffer(const wxMemoryBuffer& src)
+    {
+        m_data = src.m_data;
+        m_size = src.m_size;
+        m_len  = src.m_len;
+
+        // no reference count yet...
+        ((wxMemoryBuffer*)&src)->m_data = NULL;
+        ((wxMemoryBuffer*)&src)->m_size = 0;
+        ((wxMemoryBuffer*)&src)->m_len  = 0;
+    }
+
+    wxMemoryBuffer& operator=(const wxMemoryBuffer& src)
+    {
+        m_data = src.m_data;
+        m_size = src.m_size;
+        m_len  = src.m_len;
+
+        // no reference count yet...
+        ((wxMemoryBuffer*)&src)->m_data = NULL;
+        ((wxMemoryBuffer*)&src)->m_size = 0;
+        ((wxMemoryBuffer*)&src)->m_len  = 0;
+
+        return *this;
+   }
+
+
+protected:
+
+    void ResizeIfNeeded(size_t newSize)
+    {
+        if (newSize > m_size)
+        {
+            m_data = realloc(m_data, newSize + wxMemoryBuffer::BLOCK_SIZE);
+            wxASSERT(m_data != NULL);
+            m_size = newSize + wxMemoryBuffer::BLOCK_SIZE;
+        }
+    }
+
+private:
+    void*       m_data;
+    size_t      m_size;
+    size_t      m_len;
+};
+
+
+

 // ----------------------------------------------------------------------------
 // template class for any kind of data
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // template class for any kind of data
 // ----------------------------------------------------------------------------