X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e93e5b0bb68da7a2b9b002f6af5f40e41d4711ed..a2ee1945871d7b9d71ec18954ffb2f0f239c2e57:/include/wx/buffer.h

diff --git a/include/wx/buffer.h b/include/wx/buffer.h
index 3b770e32af..51214ee997 100644
--- a/include/wx/buffer.h
+++ b/include/wx/buffer.h
@@ -6,220 +6,448 @@
 // Created:     12.04.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-// these classes are for private use only for now, they're not documented
-
 #ifndef _WX_BUFFER_H
 #define _WX_BUFFER_H
 
-#include "wx/wxchar.h"
+#include "wx/chartype.h"
+#include "wx/wxcrtbase.h"
+
+#ifndef __WXPALMOS5__
+#include <stdlib.h>             // malloc() and free()
+#endif // ! __WXPALMOS5__
 
-#include <string.h> // strdup
+class WXDLLIMPEXP_FWD_BASE wxCStrData;
 
 // ----------------------------------------------------------------------------
 // Special classes for (wide) character strings: they use malloc/free instead
 // of new/delete
 // ----------------------------------------------------------------------------
 
-class wxCharBuffer
+// helpers used by wxCharTypeBuffer
+namespace wxPrivate
+{
+
+struct UntypedBufferData
+{
+    enum Kind
+    {
+        Owned,
+        NonOwned
+    };
+
+    UntypedBufferData(void *str, Kind kind = Owned)
+        : m_str(str), m_ref(1), m_owned(kind == Owned) {}
+
+    ~UntypedBufferData()
+    {
+        if ( m_owned )
+            free(m_str);
+    }
+
+    void *m_str;
+
+    // "short" to have sizeof(Data)=8 on 32bit archs
+    unsigned short m_ref;
+
+    bool m_owned;
+};
+
+// this has to be defined inside the DLL (and not e.g. as a static variable
+// inside an inline function) as otherwise MSVC gives link errors when the
+// functions are effectively inlined (i.e. in non-debug build)
+//
+// NB: this is defined in string.cpp and not the (non-existent) buffer.cpp
+extern WXDLLIMPEXP_DATA_BASE(UntypedBufferData * const) untypedNullDataPtr;
+
+} // namespace wxPrivate
+
+template <typename T>
+class wxCharTypeBuffer
 {
 public:
-    wxCharBuffer(const char *str)
-        : m_str(str ? strdup(str) : NULL)
+    typedef T CharType;
+
+    wxCharTypeBuffer(const CharType *str = NULL)
     {
+        if ( str )
+            m_data = new Data(wxStrdup(str));
+        else
+            m_data = GetNullData();
     }
 
-    wxCharBuffer(size_t len)
-        : m_str((char *)malloc((len + 1)*sizeof(char)))
+    wxCharTypeBuffer(size_t len)
     {
-        m_str[len] = '\0';
+        m_data = new Data((CharType *)malloc((len + 1)*sizeof(CharType)));
+        m_data->Get()[len] = (CharType)0;
     }
 
-    // no need to check for NULL, free() does it
-    ~wxCharBuffer() { free(m_str); }
+    static const wxCharTypeBuffer CreateNonOwned(const CharType *str)
+    {
+        wxCharTypeBuffer buf;
+        if ( str )
+            buf.m_data = new Data(const_cast<CharType*>(str), Data::NonOwned);
+        return buf;
+    }
 
-    wxCharBuffer(const wxCharBuffer& src)
-        : m_str(src.m_str)
+    ~wxCharTypeBuffer()
     {
-        // no reference count yet...
-        ((wxCharBuffer*)&src)->m_str = (char *)NULL;
+        DecRef();
     }
-    wxCharBuffer& operator=(const wxCharBuffer& src)
+
+    // NB: this method is only const for backward compatibility. It used to
+    //     be needed for auto_ptr-like semantics of the copy ctor, but now
+    //     that ref-counting is used, it's not really needed.
+    CharType *release() const
+    {
+        if ( m_data == GetNullData() )
+            return NULL;
+
+        wxASSERT_MSG( m_data->m_owned, _T("can't release non-owned buffer") );
+        wxASSERT_MSG( m_data->m_ref == 1, _T("can't release shared buffer") );
+
+        CharType * const p = m_data->Get();
+
+        wxCharTypeBuffer *self = const_cast<wxCharTypeBuffer*>(this);
+        self->m_data->Set(NULL);
+        self->DecRef();
+
+        return p;
+    }
+
+    void reset()
     {
-        m_str = src.m_str;
-        // no reference count yet...
-        ((wxCharBuffer*)&src)->m_str = (char *)NULL;
+        DecRef();
+    }
+
+    wxCharTypeBuffer(const wxCharTypeBuffer& src)
+    {
+        m_data = src.m_data;
+        IncRef();
+    }
+
+    wxCharTypeBuffer& operator=(const CharType *str)
+    {
+        DecRef();
+
+        if ( str )
+            m_data = new Data(wxStrdup(str));
         return *this;
     }
 
-    const char *data() const { return m_str; }
-    operator const char *() const { return m_str; }
-    char operator[](size_t n) const { return m_str[n]; }
+    wxCharTypeBuffer& operator=(const wxCharTypeBuffer& src)
+    {
+        if ( &src == this )
+            return *this;
 
-private:
-    char *m_str;
-};
+        DecRef();
+        m_data = src.m_data;
+        IncRef();
 
-#if wxUSE_WCHAR_T
+        return *this;
+    }
 
-class wxWCharBuffer
-{
-public:
-    wxWCharBuffer(const wchar_t *wcs)
-        : m_wcs((wchar_t *)NULL)
+    bool extend(size_t len)
     {
-        if (wcs) {
-          size_t siz = (wxWcslen(wcs) + 1)*sizeof(wchar_t);
-          m_wcs = (wchar_t *)malloc(siz);
-          memcpy(m_wcs, wcs, siz);
+        wxASSERT_MSG( m_data->m_owned, _T("cannot extend non-owned buffer") );
+        wxASSERT_MSG( m_data->m_ref == 1, _T("can't extend shared buffer") );
+
+        CharType *str =
+            (CharType *)realloc(data(), (len + 1) * sizeof(CharType));
+        if ( !str )
+            return false;
+
+        if ( m_data == GetNullData() )
+        {
+            m_data = new Data(str);
         }
+        else
+        {
+            m_data->Set(str);
+            m_data->m_owned = true;
+        }
+
+        return true;
     }
-    wxWCharBuffer(size_t len)
-        : m_wcs((wchar_t *)malloc((len + 1)*sizeof(wchar_t)))
+
+    CharType *data() { return m_data->Get(); }
+    const CharType *data() const { return  m_data->Get(); }
+    operator const CharType *() const { return data(); }
+    CharType operator[](size_t n) const { return data()[n]; }
+
+private:
+    // reference-counted data
+    struct Data : public wxPrivate::UntypedBufferData
     {
-        m_wcs[len] = L'\0';
-    }
+        Data(CharType *str, Kind kind = Owned)
+            : wxPrivate::UntypedBufferData(str, kind)
+        {
+        }
 
-    // no need to check for NULL, free() does it
-    ~wxWCharBuffer() { free(m_wcs); }
+        CharType *Get() const { return static_cast<CharType *>(m_str); }
+        void Set(CharType *str) { m_str = str; }
+    };
 
-    wxWCharBuffer(const wxWCharBuffer& src)
-        : m_wcs(src.m_wcs)
+    // placeholder for NULL string, to simplify this code
+    static Data *GetNullData()
     {
-       // no reference count yet...
-       ((wxWCharBuffer*)&src)->m_wcs = (wchar_t *)NULL;
+        return static_cast<Data *>(wxPrivate::untypedNullDataPtr);
     }
-    wxWCharBuffer& operator=(const wxWCharBuffer& src)
+
+    void IncRef()
     {
-        m_wcs = src.m_wcs;
-        // no reference count yet...
-        ((wxWCharBuffer*)&src)->m_wcs = (wchar_t *)NULL;
-        return *this;
+        if ( m_data == GetNullData() ) // exception, not ref-counted
+            return;
+        m_data->m_ref++;
     }
 
-    const wchar_t *data() const { return m_wcs; }
-    operator const wchar_t *() const { return m_wcs; }
-    wchar_t operator[](size_t n) const { return m_wcs[n]; }
+    void DecRef()
+    {
+        if ( m_data == GetNullData() ) // exception, not ref-counted
+            return;
+        if ( --m_data->m_ref == 0 )
+            delete m_data;
+        m_data = GetNullData();
+    }
 
 private:
-    wchar_t *m_wcs;
+    Data *m_data;
 };
 
+WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE( wxCharTypeBuffer<char> )
+
+class wxCharBuffer : public wxCharTypeBuffer<char>
+{
+public:
+    typedef wxCharTypeBuffer<char> wxCharTypeBufferBase;
+
+    wxCharBuffer(const wxCharTypeBufferBase& buf)
+        : wxCharTypeBufferBase(buf) {}
+
+    wxCharBuffer(const CharType *str = NULL) : wxCharTypeBufferBase(str) {}
+    wxCharBuffer(size_t len) : wxCharTypeBufferBase(len) {}
+
+    wxCharBuffer(const wxCStrData& cstr);
+};
+
+#if wxUSE_WCHAR_T
+WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE( wxCharTypeBuffer<wchar_t> )
+
+class wxWCharBuffer : public wxCharTypeBuffer<wchar_t>
+{
+public:
+    typedef wxCharTypeBuffer<wchar_t> wxCharTypeBufferBase;
+
+    wxWCharBuffer(const wxCharTypeBufferBase& buf)
+        : wxCharTypeBufferBase(buf) {}
+
+    wxWCharBuffer(const CharType *str = NULL) : wxCharTypeBufferBase(str) {}
+    wxWCharBuffer(size_t len) : wxCharTypeBufferBase(len) {}
+
+    wxWCharBuffer(const wxCStrData& cstr);
+};
 #endif // wxUSE_WCHAR_T
 
+// wxCharTypeBuffer<T> implicitly convertible to T*
+template <typename T>
+class wxWritableCharTypeBuffer : public wxCharTypeBuffer<T>
+{
+public:
+    typedef typename wxCharTypeBuffer<T>::CharType CharType;
+
+    wxWritableCharTypeBuffer(const wxCharTypeBuffer<T>& src)
+        : wxCharTypeBuffer<T>(src) {}
+    // FIXME-UTF8: this won't be needed after converting mb_str()/wc_str() to
+    //             always return a buffer
+    wxWritableCharTypeBuffer(const CharType *str = NULL)
+        : wxCharTypeBuffer<T>(str) {}
+
+    operator CharType*() { return this->data(); }
+};
+
+typedef wxWritableCharTypeBuffer<char> wxWritableCharBuffer;
+typedef wxWritableCharTypeBuffer<wchar_t> wxWritableWCharBuffer;
+
+
 #if wxUSE_UNICODE
+    #define wxWxCharBuffer wxWCharBuffer
+
     #define wxMB2WXbuf wxWCharBuffer
     #define wxWX2MBbuf wxCharBuffer
-    #define wxWC2WXbuf wxChar*
-    #define wxWX2WCbuf wxChar*
+    #if wxUSE_UNICODE_WCHAR
+        #define wxWC2WXbuf wxChar*
+        #define wxWX2WCbuf wxChar*
+    #elif wxUSE_UNICODE_UTF8
+        #define wxWC2WXbuf wxWCharBuffer
+        #define wxWX2WCbuf wxWCharBuffer
+    #endif
 #else // ANSI
+    #define wxWxCharBuffer wxCharBuffer
+
     #define wxMB2WXbuf wxChar*
     #define wxWX2MBbuf wxChar*
     #define wxWC2WXbuf wxCharBuffer
     #define wxWX2WCbuf wxWCharBuffer
 #endif // Unicode/ANSI
 
+// type of the value returned by wxString::utf8_str()
+#if wxUSE_UNICODE_UTF8
+    #define wxUTF8Buf char *
+#else
+    #define wxUTF8Buf wxCharBuffer
+#endif
+
 // ----------------------------------------------------------------------------
 // A class for holding growable data buffers (not necessarily strings)
 // ----------------------------------------------------------------------------
 
-class wxMemoryBuffer
+// This class manages the actual data buffer pointer and is ref-counted.
+class wxMemoryBufferData
 {
 public:
-    enum { BLOCK_SIZE = 1024 };
-    wxMemoryBuffer(size_t size = wxMemoryBuffer::BLOCK_SIZE)
-        : m_data(malloc(size)), m_size(size), m_len(0)
+    // the initial size and also the size added by ResizeIfNeeded()
+    enum { DefBufSize = 1024 };
+
+    friend class wxMemoryBuffer;
+
+    // everyting is private as it can only be used by wxMemoryBuffer
+private:
+    wxMemoryBufferData(size_t size = wxMemoryBufferData::DefBufSize)
+        : m_data(size ? malloc(size) : NULL), m_size(size), m_len(0), m_ref(0)
     {
     }
+    ~wxMemoryBufferData() { free(m_data); }
 
-    ~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)
+    void ResizeIfNeeded(size_t newSize)
     {
-        wxASSERT(len <= m_size);
-        m_len = len;
+        if (newSize > m_size)
+        {
+            void *dataOld = m_data;
+            m_data = realloc(m_data, newSize + wxMemoryBufferData::DefBufSize);
+            if ( !m_data )
+            {
+                free(dataOld);
+            }
+
+            m_size = newSize + wxMemoryBufferData::DefBufSize;
+        }
     }
 
-    // Ensure the buffer is big enough and return a pointer to it
-    void* GetWriteBuf(size_t sizeNeeded)
+    void IncRef() { m_ref += 1; }
+    void DecRef()
     {
-        ResizeIfNeeded(sizeNeeded);
-        return m_data;
+        m_ref -= 1;
+        if (m_ref == 0)  // are there no more references?
+            delete this;
     }
-    // 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)
+
+    // the buffer containing the data
+    void  *m_data;
+
+    // the size of the buffer
+    size_t m_size;
+
+    // the amount of data currently in the buffer
+    size_t m_len;
+
+    // the reference count
+    size_t m_ref;
+
+    wxDECLARE_NO_COPY_CLASS(wxMemoryBufferData);
+};
+
+
+class wxMemoryBuffer
+{
+public:
+    // ctor and dtor
+    wxMemoryBuffer(size_t size = wxMemoryBufferData::DefBufSize)
     {
-        ResizeIfNeeded(m_len + sizeNeeded);
-        return (char*)m_data + m_len;
+        m_bufdata = new wxMemoryBufferData(size);
+        m_bufdata->IncRef();
     }
-    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;
+    ~wxMemoryBuffer() { m_bufdata->DecRef(); }
+
+
+    // copy and assignment
+    wxMemoryBuffer(const wxMemoryBuffer& src)
+        : m_bufdata(src.m_bufdata)
+    {
+        m_bufdata->IncRef();
     }
-    void  AppendData(void* data, size_t len)
+
+    wxMemoryBuffer& operator=(const wxMemoryBuffer& src)
     {
-        memcpy(GetAppendBuf(len), data, len);
-        UngetAppendBuf(len);
+        if (&src != this)
+        {
+            m_bufdata->DecRef();
+            m_bufdata = src.m_bufdata;
+            m_bufdata->IncRef();
+        }
+        return *this;
     }
 
-    operator const char *() const { return (const char*)m_data; }
 
+    // Accessors
+    void  *GetData() const    { return m_bufdata->m_data; }
+    size_t GetBufSize() const { return m_bufdata->m_size; }
+    size_t GetDataLen() const { return m_bufdata->m_len; }
 
-    // Copy and assignment
-    wxMemoryBuffer(const wxMemoryBuffer& src)
-        : m_data(src.m_data), m_size(src.m_size), m_len(src.m_len)
+    void   SetBufSize(size_t size) { m_bufdata->ResizeIfNeeded(size); }
+    void   SetDataLen(size_t len)
     {
-        // no reference count yet...
-        ((wxMemoryBuffer*)&src)->m_data = NULL;
-        ((wxMemoryBuffer*)&src)->m_size = 0;
-        ((wxMemoryBuffer*)&src)->m_len  = 0;
+        wxASSERT(len <= m_bufdata->m_size);
+        m_bufdata->m_len = len;
     }
 
-    wxMemoryBuffer& operator=(const wxMemoryBuffer& src)
+    // Ensure the buffer is big enough and return a pointer to it
+    void *GetWriteBuf(size_t sizeNeeded)
     {
-        m_data = src.m_data;
-        m_size = src.m_size;
-        m_len  = src.m_len;
+        m_bufdata->ResizeIfNeeded(sizeNeeded);
+        return m_bufdata->m_data;
+    }
+
+    // Update the length after the write
+    void  UngetWriteBuf(size_t sizeUsed) { SetDataLen(sizeUsed); }
 
-        // no reference count yet...
-        ((wxMemoryBuffer*)&src)->m_data = NULL;
-        ((wxMemoryBuffer*)&src)->m_size = 0;
-        ((wxMemoryBuffer*)&src)->m_len  = 0;
+    // Like the above, but appends to the buffer
+    void *GetAppendBuf(size_t sizeNeeded)
+    {
+        m_bufdata->ResizeIfNeeded(m_bufdata->m_len + sizeNeeded);
+        return (char*)m_bufdata->m_data + m_bufdata->m_len;
+    }
 
-        return *this;
-   }
+    // Update the length after the append
+    void  UngetAppendBuf(size_t sizeUsed)
+    {
+        SetDataLen(m_bufdata->m_len + sizeUsed);
+    }
 
+    // Other ways to append to the buffer
+    void  AppendByte(char data)
+    {
+        wxCHECK_RET( m_bufdata->m_data, _T("invalid wxMemoryBuffer") );
 
-protected:
-    void ResizeIfNeeded(size_t newSize)
+        m_bufdata->ResizeIfNeeded(m_bufdata->m_len + 1);
+        *(((char*)m_bufdata->m_data) + m_bufdata->m_len) = data;
+        m_bufdata->m_len += 1;
+    }
+
+    void  AppendData(const void *data, size_t len)
     {
-        if (newSize > m_size)
-        {
-            m_data = realloc(m_data, newSize + wxMemoryBuffer::BLOCK_SIZE);
-            wxASSERT(m_data != NULL);
-            m_size = newSize + wxMemoryBuffer::BLOCK_SIZE;
-        }
+        memcpy(GetAppendBuf(len), data, len);
+        UngetAppendBuf(len);
     }
 
+    operator const char *() const { return (const char*)GetData(); }
+
 private:
-    void*       m_data;
-    size_t      m_size;
-    size_t      m_len;
+    wxMemoryBufferData*  m_bufdata;
 };
 
 // ----------------------------------------------------------------------------