X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/655719367ac5e131d9642e5783f3ecf64d1a3385..c23b255ab4b2867efbaf4721311c4c8265dd6098:/include/wx/vector.h

diff --git a/include/wx/vector.h b/include/wx/vector.h
index 2034a9eaa8..ab07ca0f4a 100644
--- a/include/wx/vector.h
+++ b/include/wx/vector.h
@@ -2,9 +2,10 @@
 // Name:        wx/vector.h
 // Purpose:     STL vector clone
 // Author:      Lindsay Mathieson
-// Modified by:
+// Modified by: Vaclav Slavik - make it a template
 // Created:     30.07.2001
-// Copyright:   (c) 2001 Lindsay Mathieson <lindsay@mathieson.org>
+// Copyright:   (c) 2001 Lindsay Mathieson <lindsay@mathieson.org>,
+//                  2007 Vaclav Slavik <vslavik@fastmail.fm>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -13,101 +14,236 @@
 
 #include "wx/defs.h"
 
-class WXDLLIMPEXP_BASE wxVectorBase
+#if wxUSE_STL
+
+#include <vector>
+#define wxVector std::vector
+
+#else // !wxUSE_STL
+
+#include "wx/utils.h"
+#include "wx/scopeguard.h"
+#include "wx/meta/movable.h"
+#include "wx/meta/if.h"
+
+#include "wx/beforestd.h"
+#include <new> // for placement new
+#include "wx/afterstd.h"
+
+namespace wxPrivate
+{
+
+// 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<typename T>
+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<typename T>
+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<typename T>
+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.
+    typedef typename wxIf< wxIsMovable<T>::value,
+                           wxPrivate::wxVectorMemOpsMovable<T>,
+                           wxPrivate::wxVectorMemOpsGeneric<T> >::value
+            Ops;
+
 public:
     typedef size_t size_type;
-private:
-    size_type m_allocsize;
-    size_type m_size,
-              m_capacity;
-    void **m_objects;
-
-protected:
-    bool Alloc(size_type sz)
-    {
-        // work in multiples of m_allocsize;
-        sz = (sz / m_allocsize + 1) * m_allocsize;
-        if (sz <= m_capacity)
-            return true;
-
-        // try to realloc
-        void *mem = realloc(m_objects, sizeof(void *) * sz);
-        if (! mem)
-            return false; // failed
-        // success
-        m_objects = (void **) mem;
-        m_capacity = sz;
-        return true;
+    typedef size_t difference_type;
+    typedef T value_type;
+    typedef value_type* pointer;
+    typedef value_type* iterator;
+    typedef const value_type* const_iterator;
+    typedef value_type& 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;
     };
 
-    // untyped destructor of elements - must be overriden
-    virtual void Free(void *) = 0;
-    // untyped copy constructor of elements - must be overriden
-    virtual void *Copy(const void *) const = 0;
+    wxVector() : m_size(0), m_capacity(0), m_values(NULL) {}
 
-    const void *GetItem(size_type idx) const
+    wxVector(size_type size)
+        : m_size(0), m_capacity(0), m_values(NULL)
     {
-        wxASSERT(idx >= 0 && idx < m_size);
-        return m_objects[idx];
-    };
+        reserve(size);
+        for ( size_t n = 0; n < size; n++ )
+            push_back(value_type());
+    }
 
-    void Append(void *obj)
+    wxVector(size_type size, const value_type& v)
+        : m_size(0), m_capacity(0), m_values(NULL)
     {
-        wxASSERT(m_size < m_capacity);
-        m_objects[m_size] = obj;
-        m_size++;
-    };
+        reserve(size);
+        for ( size_t n = 0; n < size; n++ )
+            push_back(v);
+    }
 
-    void RemoveAt(size_type idx)
+    wxVector(const wxVector& c) : m_size(0), m_capacity(0), m_values(NULL)
     {
-        wxASSERT(idx >= 0 && idx < m_size);
-        Free(m_objects[idx]);
-        if (idx < m_size - 1)
-            memcpy(
-                m_objects + idx,
-                m_objects + idx + 1,
-                ( m_size - idx - 1 ) * sizeof(void*) );
-        m_size--;
-    };
+        Copy(c);
+    }
 
-    bool copy(const wxVectorBase& vb)
+    ~wxVector()
     {
         clear();
-        if (! Alloc(vb.size()))
-            return false;
+    }
 
-        for (size_type i = 0; i < vb.size(); i++)
+    void clear()
+    {
+        // call destructors of stored objects:
+        for ( size_type i = 0; i < m_size; i++ )
         {
-            void *o = vb.Copy(vb.GetItem(i));
-            if (! o)
-                return false;
-            Append(o);
-        };
+            m_values[i].~T();
+        }
 
-        return true;
-    };
+        Ops::Free(m_values);
+        m_values = NULL;
+        m_size =
+        m_capacity = 0;
+    }
 
-public:
-    wxVectorBase() : m_allocsize(16), m_size(0), m_capacity(0), m_objects(0) {}
-    virtual ~wxVectorBase() {} // calm down GCC
+    void reserve(size_type n)
+    {
+        if ( n <= m_capacity )
+            return;
 
-    void clear()
+        // increase the size twice, unless we're already too big or unless
+        // more is requested
+        //
+        // NB: casts to size_type are needed to suppress mingw32 warnings about
+        //     mixing enums and ints in the same expression
+        const size_type increment = m_size > 0
+                                     ? wxMin(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)
     {
-        for (size_type i = 0; i < size(); i++)
-            Free(m_objects[i]);
-        free(m_objects);
-        m_objects = 0;
-        m_size = m_capacity = 0;
-    };
+        if ( n < m_size )
+            Shrink(n);
+        else if ( n > m_size )
+            Extend(n, value_type());
+    }
 
-    void reserve(size_type n)
+    void resize(size_type n, const value_type& v)
     {
-        if ( !Alloc(n) )
-        {
-            wxFAIL_MSG( _T("out of memory in wxVector::reserve()") );
-        }
-    };
+        if ( n < m_size )
+            Shrink(n);
+        else if ( n > m_size )
+            Extend(n, v);
+    }
 
     size_type size() const
     {
@@ -117,96 +253,189 @@ public:
     size_type capacity() const
     {
         return m_capacity;
-    };
+    }
 
     bool empty() const
     {
         return size() == 0;
-    };
+    }
 
-    wxVectorBase& operator = (const wxVectorBase& vb)
+    wxVector& operator=(const wxVector& vb)
     {
-        wxCHECK(copy(vb), *this);
+        if (this != &vb)
+        {
+            clear();
+            Copy(vb);
+        }
         return *this;
     }
+
+    void push_back(const value_type& v)
+    {
+        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()
+    {
+        erase(end() - 1);
+    }
+
+    const value_type& at(size_type idx) const
+    {
+        wxASSERT(idx < m_size);
+        return m_values[idx];
+    }
+
+    value_type& at(size_type idx)
+    {
+        wxASSERT(idx < m_size);
+        return m_values[idx];
+    }
+
+    const value_type& operator[](size_type idx) const  { return at(idx); }
+    value_type& operator[](size_type idx) { return at(idx); }
+    const value_type& front() const { return at(0); }
+    value_type& front() { return at(0); }
+    const value_type& back() const { return at(size() - 1); }
+    value_type& back() { return at(size() - 1); }
+
+    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(); }
+
+    reverse_iterator rbegin() { return reverse_iterator(end() - 1); }
+    reverse_iterator rend() { return reverse_iterator(begin() - 1); }
+
+    iterator insert(iterator it, const value_type& v = value_type())
+    {
+        // 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)
+    {
+        return erase(it, it + 1);
+    }
+
+    iterator erase(iterator first, iterator last)
+    {
+        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:
+    // VC6 can't compile static const int members
+    enum { ALLOC_INITIAL_SIZE = 16 };
+    enum { ALLOC_MAX_SIZE = 4096 };
+
+    void Copy(const wxVector& vb)
+    {
+        reserve(vb.size());
+
+        for ( const_iterator i = vb.begin(); i != vb.end(); ++i )
+            push_back(*i);
+    }
+
+private:
+    void Shrink(size_type n)
+    {
+        for ( size_type i = n; i < m_size; i++ )
+            m_values[i].~T();
+        m_size = n;
+    }
+
+    void Extend(size_type n, const value_type& v)
+    {
+        reserve(n);
+        for ( size_type i = m_size; i < n; i++ )
+            push_back(v);
+    }
+
+    size_type m_size,
+              m_capacity;
+    value_type *m_values;
 };
 
-#define WX_DECLARE_VECTORBASE(obj, cls)\
-private:\
-    virtual void Free(void *o)\
-    {\
-        delete (obj *) o;\
-    };\
-    virtual void *Copy(const void *o) const\
-    {\
-        return new obj(*(obj *) o);\
-    };\
-public:\
-    cls() {}\
-    cls(const cls& c)\
-    {\
-        wxCHECK2(copy(c), return);\
-    }\
-    ~cls()\
-    {\
-        clear();\
-    }
-
-#define _WX_DECLARE_VECTOR(obj, cls, exp)\
-class exp cls : public wxVectorBase\
-{\
-    WX_DECLARE_VECTORBASE(obj, cls);\
-public:\
-    void push_back(const obj& o)\
-    {\
-        wxCHECK2(Alloc(size() + 1), return);\
-        Append(new obj(o));\
-    };\
-    void pop_back()\
-    {\
-        RemoveAt(size() - 1);\
-    };\
-    const obj& at(size_type idx) const\
-    {\
-        return *(obj *) GetItem(idx);\
-    };\
-    obj& at(size_type idx)\
-    {\
-        return *(obj *) GetItem(idx);\
-    };\
-    const obj& operator[](size_type idx) const\
-    {\
-        return at(idx);\
-    };\
-    obj& operator[](size_type idx)\
-    {\
-        return at(idx);\
-    };\
-    const obj& front() const\
-    {\
-        return at(0);\
-    };\
-    obj& front()\
-    {\
-        return at(0);\
-    };\
-    const obj& back() const\
-    {\
-        return at(size() - 1);\
-    };\
-    obj& back()\
-    {\
-        return at(size() - 1);\
-    };\
-    size_type erase(size_type idx)\
-    {\
-        RemoveAt(idx);\
-        return idx;\
-    };\
+#if WXWIN_COMPATIBILITY_2_8
+template<typename T>
+inline typename wxVector<T>::size_type wxVector<T>::erase(size_type n)
+{
+    erase(begin() + n);
+    return n;
 }
+#endif // WXWIN_COMPATIBILITY_2_8
 
-#define WX_DECLARE_VECTOR(obj, cls) \
-  _WX_DECLARE_VECTOR(obj, cls, WXDLLEXPORT)
+#endif // wxUSE_STL/!wxUSE_STL
 
-#endif // _WX_VECTOR_H_
+#if WXWIN_COMPATIBILITY_2_8
+    #define WX_DECLARE_VECTORBASE(obj, cls) typedef wxVector<obj> cls
+    #define _WX_DECLARE_VECTOR(obj, cls, exp) WX_DECLARE_VECTORBASE(obj, cls)
+    #define WX_DECLARE_VECTOR(obj, cls) WX_DECLARE_VECTORBASE(obj, cls)
+#endif // WXWIN_COMPATIBILITY_2_8
 
+#endif // _WX_VECTOR_H_