X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/df4aed1cf0fbf5c8be67416a9478132fbb559c72..9c34a216817028bc533e07873d047208a96b05a2:/include/wx/vector.h diff --git a/include/wx/vector.h b/include/wx/vector.h index e3792543e6..dffb19fc9d 100644 --- a/include/wx/vector.h +++ b/include/wx/vector.h @@ -14,27 +14,252 @@ #include "wx/defs.h" -#if wxUSE_STL +#if wxUSE_STD_CONTAINERS #include +#include + #define wxVector std::vector +template +inline void wxVectorSort(wxVector& v) +{ + std::sort(v.begin(), v.end()); +} + +#else // !wxUSE_STD_CONTAINERS + +#include "wx/scopeguard.h" +#include "wx/meta/movable.h" +#include "wx/meta/if.h" + +#include "wx/beforestd.h" +#include // for placement new +#include "wx/afterstd.h" + +// wxQsort is declared in wx/utils.h, but can't include that file here, +// it indirectly includes this file. Just lovely... +typedef int (*wxSortCallback)(const void* pItem1, + const void* pItem2, + const void* user_data); +WXDLLIMPEXP_BASE void wxQsort(void* pbase, size_t total_elems, + size_t size, wxSortCallback cmp, + const void* user_data); + +namespace wxPrivate +{ -#else // !wxUSE_STL +// These templates encapsulate memory operations for use by wxVector; there are +// two implementations, both in generic way for any C++ types and as an +// optimized version for "movable" types that uses realloc() and memmove(). + +// version for movable types: +template +struct wxVectorMemOpsMovable +{ + static void Free(T* array) + { free(array); } + + static T* Realloc(T* old, size_t newCapacity, size_t WXUNUSED(occupiedSize)) + { return (T*)realloc(old, newCapacity * sizeof(T)); } + + static void MemmoveBackward(T* dest, T* source, size_t count) + { memmove(dest, source, count * sizeof(T)); } + + static void MemmoveForward(T* dest, T* source, size_t count) + { memmove(dest, source, count * sizeof(T)); } +}; + +// generic version for non-movable types: +template +struct wxVectorMemOpsGeneric +{ + static void Free(T* array) + { ::operator delete(array); } + + static T* Realloc(T* old, size_t newCapacity, size_t occupiedSize) + { + T *mem = (T*)::operator new(newCapacity * sizeof(T)); + for ( size_t i = 0; i < occupiedSize; i++ ) + { + ::new(mem + i) T(old[i]); + old[i].~T(); + } + ::operator delete(old); + return mem; + } + + static void MemmoveBackward(T* dest, T* source, size_t count) + { + wxASSERT( dest < source ); + T* destptr = dest; + T* sourceptr = source; + for ( size_t i = count; i > 0; --i, ++destptr, ++sourceptr ) + { + ::new(destptr) T(*sourceptr); + sourceptr->~T(); + } + } + + static void MemmoveForward(T* dest, T* source, size_t count) + { + wxASSERT( dest > source ); + T* destptr = dest + count - 1; + T* sourceptr = source + count - 1; + for ( size_t i = count; i > 0; --i, --destptr, --sourceptr ) + { + ::new(destptr) T(*sourceptr); + sourceptr->~T(); + } + } +}; + + +} // namespace wxPrivate template class wxVector { +private: + // This cryptic expression means "typedef Ops to wxVectorMemOpsMovable if + // type T is movable type, otherwise to wxVectorMemOpsGeneric". + // + // Note that we use typedef instead of privately deriving from this (which + // would allowed us to omit "Ops::" prefixes below) to keep VC6 happy, + // it can't compile code that derives from wxIf<...>::value. + // + // Note that bcc needs the extra parentheses for non-type template + // arguments to compile this expression. + typedef typename wxIf< (wxIsMovable::value), + wxPrivate::wxVectorMemOpsMovable, + wxPrivate::wxVectorMemOpsGeneric >::value + Ops; + public: typedef size_t size_type; + typedef size_t difference_type; typedef T value_type; + typedef value_type* pointer; + typedef const value_type* const_pointer; typedef value_type* iterator; + typedef const value_type* const_iterator; typedef value_type& reference; + typedef const value_type& const_reference; + + class reverse_iterator + { + public: + reverse_iterator() : m_ptr(NULL) { } + wxEXPLICIT reverse_iterator(iterator it) : m_ptr(it) { } + reverse_iterator(const reverse_iterator& it) : m_ptr(it.m_ptr) { } + + reference operator*() const { return *m_ptr; } + pointer operator->() const { return m_ptr; } + + iterator base() const { return m_ptr; } + + reverse_iterator& operator++() + { --m_ptr; return *this; } + reverse_iterator operator++(int) + { reverse_iterator tmp = *this; --m_ptr; return tmp; } + reverse_iterator& operator--() + { ++m_ptr; return *this; } + reverse_iterator operator--(int) + { reverse_iterator tmp = *this; ++m_ptr; return tmp; } + + reverse_iterator operator+(difference_type n) const + { return reverse_iterator(m_ptr - n); } + reverse_iterator& operator+=(difference_type n) + { m_ptr -= n; return *this; } + reverse_iterator operator-(difference_type n) const + { return reverse_iterator(m_ptr + n); } + reverse_iterator& operator-=(difference_type n) + { m_ptr += n; return *this; } + + reference operator[](difference_type n) const + { return *(*this + n); } + + bool operator ==(const reverse_iterator& it) const + { return m_ptr == it.m_ptr; } + bool operator !=(const reverse_iterator& it) const + { return m_ptr != it.m_ptr; } + + private: + value_type *m_ptr; + + friend class const_reverse_iterator; + }; + + class const_reverse_iterator + { + public: + const_reverse_iterator() : m_ptr(NULL) { } + wxEXPLICIT const_reverse_iterator(const_iterator it) : m_ptr(it) { } + const_reverse_iterator(const reverse_iterator& it) : m_ptr(it.m_ptr) { } + const_reverse_iterator(const const_reverse_iterator& it) : m_ptr(it.m_ptr) { } + + const_reference operator*() const { return *m_ptr; } + const_pointer operator->() const { return m_ptr; } + + const_iterator base() const { return m_ptr; } + + const_reverse_iterator& operator++() + { --m_ptr; return *this; } + const_reverse_iterator operator++(int) + { const_reverse_iterator tmp = *this; --m_ptr; return tmp; } + const_reverse_iterator& operator--() + { ++m_ptr; return *this; } + const_reverse_iterator operator--(int) + { const_reverse_iterator tmp = *this; ++m_ptr; return tmp; } + + const_reverse_iterator operator+(difference_type n) const + { return const_reverse_iterator(m_ptr - n); } + const_reverse_iterator& operator+=(difference_type n) + { m_ptr -= n; return *this; } + const_reverse_iterator operator-(difference_type n) const + { return const_reverse_iterator(m_ptr + n); } + const_reverse_iterator& operator-=(difference_type n) + { m_ptr += n; return *this; } + + const_reference operator[](difference_type n) const + { return *(*this + n); } + + bool operator ==(const const_reverse_iterator& it) const + { return m_ptr == it.m_ptr; } + bool operator !=(const const_reverse_iterator& it) const + { return m_ptr != it.m_ptr; } + + protected: + const value_type *m_ptr; + }; + + wxVector() : m_size(0), m_capacity(0), m_values(NULL) {} + + wxVector(size_type p_size) + : m_size(0), m_capacity(0), m_values(NULL) + { + reserve(p_size); + for ( size_t n = 0; n < p_size; n++ ) + push_back(value_type()); + } + + wxVector(size_type p_size, const value_type& v) + : m_size(0), m_capacity(0), m_values(NULL) + { + reserve(p_size); + for ( size_t n = 0; n < p_size; n++ ) + push_back(v); + } - wxVector() : m_allocsize(16), m_size(0), m_capacity(0), m_objects(0) {} + wxVector(const wxVector& c) : m_size(0), m_capacity(0), m_values(NULL) + { + Copy(c); + } - wxVector(const wxVector& c) + template + wxVector(InputIterator first, InputIterator last) + : m_size(0), m_capacity(0), m_values(NULL) { - wxCHECK2(Copy(c), return); + assign(first, last); } ~wxVector() @@ -42,21 +267,84 @@ public: clear(); } - void clear() + void assign(size_type p_size, const value_type& v) { - for (size_type i = 0; i < size(); i++) - delete m_objects[i]; - free(m_objects); - m_objects = 0; - m_size = m_capacity = 0; + clear(); + reserve(p_size); + for ( size_t n = 0; n < p_size; n++ ) + push_back(v); } - void reserve(size_type n) + template + void assign(InputIterator first, InputIterator last) { - if ( !Alloc(n) ) + clear(); + + // Notice that it would be nice to call reserve() here but we can't do + // it for arbitrary input iterators, we should have a dispatch on + // iterator type and call it if possible. + + for ( InputIterator it = first; it != last; ++it ) + push_back(*it); + } + + void swap(wxVector& v) + { + wxSwap(m_size, v.m_size); + wxSwap(m_capacity, v.m_capacity); + wxSwap(m_values, v.m_values); + } + + void clear() + { + // call destructors of stored objects: + for ( size_type i = 0; i < m_size; i++ ) { - wxFAIL_MSG( _T("out of memory in wxVector::reserve()") ); + m_values[i].~T(); } + + Ops::Free(m_values); + m_values = NULL; + m_size = + m_capacity = 0; + } + + void reserve(size_type n) + { + if ( n <= m_capacity ) + return; + + // increase the size twice, unless we're already too big or unless + // more is requested + // + // NB: casts to size_type are needed to suppress warnings about + // mixing enumeral and non-enumeral type in conditional expression + const size_type increment = m_size > 0 + ? m_size < ALLOC_MAX_SIZE + ? m_size + : (size_type)ALLOC_MAX_SIZE + : (size_type)ALLOC_INITIAL_SIZE; + if ( m_capacity + increment > n ) + n = m_capacity + increment; + + m_values = Ops::Realloc(m_values, n * sizeof(value_type), m_size); + m_capacity = n; + } + + void resize(size_type n) + { + if ( n < m_size ) + Shrink(n); + else if ( n > m_size ) + Extend(n, value_type()); + } + + void resize(size_type n, const value_type& v) + { + if ( n < m_size ) + Shrink(n); + else if ( n > m_size ) + Extend(n, v); } size_type size() const @@ -76,31 +364,45 @@ public: wxVector& operator=(const wxVector& vb) { - wxCHECK(Copy(vb), *this); + if (this != &vb) + { + clear(); + Copy(vb); + } return *this; } - void push_back(const value_type& o) + void push_back(const value_type& v) { - wxCHECK2(Alloc(size() + 1), return); - Append(new value_type(o)); + reserve(size() + 1); + + // use placement new to initialize new object in preallocated place in + // m_values and store 'v' in it: + void* const place = m_values + m_size; + ::new(place) value_type(v); + + // only increase m_size if the ctor didn't throw an exception; notice + // that if it _did_ throw, everything is OK, because we only increased + // vector's capacity so far and possibly written some data to + // uninitialized memory at the end of m_values + m_size++; } void pop_back() { - RemoveAt(size() - 1); + erase(end() - 1); } const value_type& at(size_type idx) const { wxASSERT(idx < m_size); - return *m_objects[idx]; + return m_values[idx]; } value_type& at(size_type idx) { wxASSERT(idx < m_size); - return *m_objects[idx]; + return m_values[idx]; } const value_type& operator[](size_type idx) const { return at(idx); } @@ -110,120 +412,168 @@ public: const value_type& back() const { return at(size() - 1); } value_type& back() { return at(size() - 1); } - iterator begin() { return m_objects[0]; } - iterator end() { return m_objects[size()]; } + const_iterator begin() const { return m_values; } + iterator begin() { return m_values; } + const_iterator end() const { return m_values + size(); } + iterator end() { return m_values + size(); } - iterator erase(iterator first, iterator last) + reverse_iterator rbegin() { return reverse_iterator(end() - 1); } + reverse_iterator rend() { return reverse_iterator(begin() - 1); } + + const_reverse_iterator rbegin() const { return const_reverse_iterator(end() - 1); } + const_reverse_iterator rend() const { return const_reverse_iterator(begin() - 1); } + + iterator insert(iterator it, const value_type& v = value_type()) { - size_type idx = first - begin(); - RemoveAt(idx, last - first); + // NB: this must be done before reserve(), because reserve() + // invalidates iterators! + const size_t idx = it - begin(); + const size_t after = end() - it; + + reserve(size() + 1); + + // the place where the new element is going to be inserted + value_type * const place = m_values + idx; + + // unless we're inserting at the end, move following elements out of + // the way: + if ( after > 0 ) + Ops::MemmoveForward(place + 1, place, after); + + // if the ctor called below throws an exception, we need to move all + // the elements back to their original positions in m_values + wxScopeGuard moveBack = wxMakeGuard( + Ops::MemmoveBackward, place, place + 1, after); + if ( !after ) + moveBack.Dismiss(); + + // use placement new to initialize new object in preallocated place in + // m_values and store 'v' in it: + ::new(place) value_type(v); + + // now that we did successfully add the new element, increment the size + // and disable moving the items back + moveBack.Dismiss(); + m_size++; + return begin() + idx; } + iterator erase(iterator it) - { - size_type idx = it - begin(); - RemoveAt(idx); - return begin() + idx; + { + return erase(it, it + 1); } - - iterator insert(iterator it, const value_type& v = value_type()) + + iterator erase(iterator first, iterator last) { - wxCHECK2(Alloc(size() + 1), return 0); - size_type idx = it - begin(); - InsertAt(new value_type(o), idx); + if ( first == last ) + return first; + wxASSERT( first < end() && last <= end() ); + + const size_type idx = first - begin(); + const size_type count = last - first; + const size_type after = end() - last; + + // erase elements by calling their destructors: + for ( iterator i = first; i < last; ++i ) + i->~T(); + + // once that's done, move following elements over to the freed space: + if ( after > 0 ) + { + Ops::MemmoveBackward(m_values + idx, m_values + idx + count, after); + } + + m_size -= count; + return begin() + idx; } +#if WXWIN_COMPATIBILITY_2_8 + wxDEPRECATED( size_type erase(size_type n) ); +#endif // WXWIN_COMPATIBILITY_2_8 + private: - bool Alloc(size_type sz) + // VC6 can't compile static const int members + enum { ALLOC_INITIAL_SIZE = 16 }; + enum { ALLOC_MAX_SIZE = 4096 }; + + void Copy(const wxVector& vb) { - // work in multiples of m_allocsize; - sz = (sz / m_allocsize + 1) * m_allocsize; - if (sz <= m_capacity) - return true; + reserve(vb.size()); - // try to realloc - void *mem = realloc(m_objects, sizeof(value_type*) * sz); - if (! mem) - return false; // failed - // success - m_objects = (value_type **) mem; - m_capacity = sz; - return true; + for ( const_iterator i = vb.begin(); i != vb.end(); ++i ) + push_back(*i); } - void Append(value_type *obj) +private: + void Shrink(size_type n) { - wxASSERT(m_size < m_capacity); - m_objects[m_size] = obj; - m_size++; + for ( size_type i = n; i < m_size; i++ ) + m_values[i].~T(); + m_size = n; } - void InsertAt(size_type idx, value_type *obj) + void Extend(size_type n, const value_type& v) { - wxASSERT(idx <= m_size); - wxASSERT(m_size < m_capacity); - if (idx < m_size) - memmove( - m_objects + idx + 1, - m_objects + idx, - ( m_size - idx ) * sizeof(value_type*) ); - - m_size++; + reserve(n); + for ( size_type i = m_size; i < n; i++ ) + push_back(v); } - void RemoveAt(size_type idx) + size_type m_size, + m_capacity; + value_type *m_values; +}; + +#if WXWIN_COMPATIBILITY_2_8 +template +inline typename wxVector::size_type wxVector::erase(size_type n) +{ + erase(begin() + n); + return n; +} +#endif // WXWIN_COMPATIBILITY_2_8 + + + +namespace wxPrivate +{ + +// This is a helper for the wxVectorSort function, and should not be used +// directly in user's code. +template +struct wxVectorComparator +{ + static int + Compare(const void* pitem1, const void* pitem2, const void* ) { - wxASSERT(idx < m_size); - delete m_objects[idx]; - if (idx < m_size - 1) - memcpy( - m_objects + idx, - m_objects + idx + 1, - ( m_size - idx - 1 ) * sizeof(value_type*) ); - m_size--; - } - - void RemoveAt(size_type idx, size_type count) - { - if (count == 0) - return; - wxASSERT(idx < m_size); - size_type i; - for (i = 0; i < count; i++) - delete m_objects[idx+1]; - if (idx < m_size - count) - memcpy( - m_objects + idx, - m_objects + idx + count, - ( m_size - idx - count ) * sizeof(value_type*) ); - m_size -= count; + const T& item1 = *reinterpret_cast(pitem1); + const T& item2 = *reinterpret_cast(pitem2); + + if (item1 < item2) + return -1; + else if (item2 < item1) + return 1; + else + return 0; } - bool Copy(const wxVector& vb) - { - clear(); - if (! Alloc(vb.size())) - return false; +}; - for (size_type i = 0; i < vb.size(); i++) - { - value_type *o = new value_type(vb.at(i)); - if (! o) - return false; - Append(o); - } +} // namespace wxPrivate + + + +template +void wxVectorSort(wxVector& v) +{ + wxQsort(v.begin(), v.size(), sizeof(T), + wxPrivate::wxVectorComparator::Compare, NULL); +} - return true; - } -private: - size_type m_allocsize; - size_type m_size, - m_capacity; - value_type **m_objects; -}; -#endif // wxUSE_STL/!wxUSE_STL +#endif // wxUSE_STD_CONTAINERS/!wxUSE_STD_CONTAINERS #if WXWIN_COMPATIBILITY_2_8 #define WX_DECLARE_VECTORBASE(obj, cls) typedef wxVector cls