X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..6d8978f030996c834fcd29d85d95ebe261b8defc:/include/wx/buffer.h diff --git a/include/wx/buffer.h b/include/wx/buffer.h index b913e75100..4cc340aa51 100644 --- a/include/wx/buffer.h +++ b/include/wx/buffer.h @@ -6,125 +6,299 @@ // Created: 12.04.99 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// 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 // malloc() and free() +#endif // ! __WXPALMOS5__ -#include // strdup +class WXDLLIMPEXP_FWD_BASE wxCStrData; // ---------------------------------------------------------------------------- // Special classes for (wide) character strings: they use malloc/free instead // of new/delete // ---------------------------------------------------------------------------- -#define DEFINE_BUFFER(classname, chartype, strdupfunc) \ -class classname \ -{ \ -public: \ - classname(const chartype *str) \ - : m_str(str ? strdupfunc(str) : NULL) \ - { \ - } \ - \ - classname(size_t len) \ - : m_str((chartype *)malloc((len + 1)*sizeof(chartype))) \ - { \ - m_str[len] = (chartype)0; \ - } \ - \ - /* no need to check for NULL, free() does it */ \ - ~classname() { free(m_str); } \ - \ - /* \ - WARNING: \ - \ - the copy ctor and assignment operators change the passed in object \ - even although it is declared as "const", so: \ - \ - a) it shouldn't be really const \ - b) you shouldn't use it afterwards (or know that it was reset) \ - \ - This is very ugly but is unfortunately needed to make the normal use\ - of classname buffer objects possible and is very similar to what \ - std::auto_ptr<> does (as if it were an excuse...) \ - */ \ - \ - /* \ - because of the remark above, release() is declared const even if it \ - isn't really const \ - */ \ - chartype *release() const \ - { \ - chartype *p = m_str; \ - ((classname *)this)->m_str = NULL; \ - return p; \ - } \ - \ - classname(const classname& src) \ - : m_str(src.release()) \ - { \ - } \ - \ - classname& operator=(const chartype *str) \ - { \ - free(m_str); \ - m_str = str ? strdupfunc(str) : NULL; \ - return *this; \ - } \ - \ - classname& operator=(const classname& src) \ - { \ - free(m_str); \ - m_str = src.release(); \ - \ - return *this; \ - } \ - \ - chartype *data() { return m_str; } \ - const chartype *data() const { return m_str; } \ - operator const chartype *() const { return m_str; } \ - chartype operator[](size_t n) const { return m_str[n]; } \ - \ -private: \ - chartype *m_str; \ -} - -DEFINE_BUFFER(wxCharBuffer, char, strdup); +// 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 +class wxCharTypeBuffer +{ +public: + typedef T CharType; + + wxCharTypeBuffer(const CharType *str = NULL) + { + if ( str ) + m_data = new Data(wxStrdup(str)); + else + m_data = GetNullData(); + } + + wxCharTypeBuffer(size_t len) + { + m_data = new Data((CharType *)malloc((len + 1)*sizeof(CharType))); + m_data->Get()[len] = (CharType)0; + } + + static const wxCharTypeBuffer CreateNonOwned(const CharType *str) + { + wxCharTypeBuffer buf; + if ( str ) + buf.m_data = new Data(const_cast(str), Data::NonOwned); + return buf; + } + + ~wxCharTypeBuffer() + { + DecRef(); + } + + // 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(this); + self->m_data->Set(NULL); + self->DecRef(); + + return p; + } + + void reset() + { + 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; + } + + wxCharTypeBuffer& operator=(const wxCharTypeBuffer& src) + { + if ( &src == this ) + return *this; + + DecRef(); + m_data = src.m_data; + IncRef(); + + return *this; + } + + bool extend(size_t len) + { + 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; + } + + 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 + { + Data(CharType *str, Kind kind = Owned) + : wxPrivate::UntypedBufferData(str, kind) + { + } + + CharType *Get() const { return static_cast(m_str); } + void Set(CharType *str) { m_str = str; } + }; + + // placeholder for NULL string, to simplify this code + static Data *GetNullData() + { + return static_cast(wxPrivate::untypedNullDataPtr); + } + + void IncRef() + { + if ( m_data == GetNullData() ) // exception, not ref-counted + return; + m_data->m_ref++; + } + + void DecRef() + { + if ( m_data == GetNullData() ) // exception, not ref-counted + return; + if ( --m_data->m_ref == 0 ) + delete m_data; + m_data = GetNullData(); + } + +private: + Data *m_data; +}; + +WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE( wxCharTypeBuffer ) + +class wxCharBuffer : public wxCharTypeBuffer +{ +public: + typedef wxCharTypeBuffer 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 ) -inline wchar_t *wxWcsdupReplacement(const wchar_t *wcs) +class wxWCharBuffer : public wxCharTypeBuffer { - const size_t siz = (wxWcslen(wcs) + 1)*sizeof(wchar_t); - wchar_t *wcsCopy = (wchar_t *)malloc(siz); - memcpy(wcsCopy, wcs, siz); - return wcsCopy; -} +public: + typedef wxCharTypeBuffer wxCharTypeBufferBase; -DEFINE_BUFFER(wxWCharBuffer, wchar_t, wxWcsdupReplacement); + 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 -#undef DEFINE_BUFFER +// wxCharTypeBuffer implicitly convertible to T* +template +class wxWritableCharTypeBuffer : public wxCharTypeBuffer +{ +public: + typedef typename wxCharTypeBuffer::CharType CharType; + + wxWritableCharTypeBuffer(const wxCharTypeBuffer& src) + : wxCharTypeBuffer(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(str) {} + + operator CharType*() { return this->data(); } +}; + +typedef wxWritableCharTypeBuffer wxWritableCharBuffer; +typedef wxWritableCharTypeBuffer 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) // ---------------------------------------------------------------------------- @@ -134,13 +308,13 @@ class wxMemoryBufferData { public: // the initial size and also the size added by ResizeIfNeeded() - enum { BLOCK_SIZE = 1024 }; + enum { DefBufSize = 1024 }; friend class wxMemoryBuffer; // everyting is private as it can only be used by wxMemoryBuffer private: - wxMemoryBufferData(size_t size = wxMemoryBufferData::BLOCK_SIZE) + wxMemoryBufferData(size_t size = wxMemoryBufferData::DefBufSize) : m_data(size ? malloc(size) : NULL), m_size(size), m_len(0), m_ref(0) { } @@ -152,13 +326,13 @@ private: if (newSize > m_size) { void *dataOld = m_data; - m_data = realloc(m_data, newSize + wxMemoryBufferData::BLOCK_SIZE); + m_data = realloc(m_data, newSize + wxMemoryBufferData::DefBufSize); if ( !m_data ) { free(dataOld); } - m_size = newSize + wxMemoryBufferData::BLOCK_SIZE; + m_size = newSize + wxMemoryBufferData::DefBufSize; } } @@ -182,6 +356,8 @@ private: // the reference count size_t m_ref; + + DECLARE_NO_COPY_CLASS(wxMemoryBufferData) }; @@ -189,7 +365,7 @@ class wxMemoryBuffer { public: // ctor and dtor - wxMemoryBuffer(size_t size = wxMemoryBufferData::BLOCK_SIZE) + wxMemoryBuffer(size_t size = wxMemoryBufferData::DefBufSize) { m_bufdata = new wxMemoryBufferData(size); m_bufdata->IncRef(); @@ -207,9 +383,12 @@ public: wxMemoryBuffer& operator=(const wxMemoryBuffer& src) { - m_bufdata->DecRef(); - m_bufdata = src.m_bufdata; - m_bufdata->IncRef(); + if (&src != this) + { + m_bufdata->DecRef(); + m_bufdata = src.m_bufdata; + m_bufdata->IncRef(); + } return *this; } @@ -259,7 +438,7 @@ public: m_bufdata->m_len += 1; } - void AppendData(void* data, size_t len) + void AppendData(const void *data, size_t len) { memcpy(GetAppendBuf(len), data, len); UngetAppendBuf(len);