Fixed wxPropertyGridInterface::SetPropertyValues() documentation

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

diff --git a/include/wx/vector.h b/include/wx/vector.h
index 8cb76a7ee66f9f04fe5b3272b31d1a99535111f8..28230a9ea5c2d609836f9f8ccb890a9cbb2e556b 100644 (file)
--- a/include/wx/vector.h
+++ b/include/wx/vector.h
@@ -22,20 +22,170 @@
 #else // !wxUSE_STL
 
 #include "wx/utils.h"
 #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
 {
 
 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;
 public:
     typedef size_t size_type;

+    typedef size_t difference_type;

     typedef T value_type;
     typedef T value_type;

+    typedef value_type* pointer;

     typedef value_type* iterator;
     typedef const value_type* const_iterator;
     typedef value_type& reference;
 
     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;
+    };
+

     wxVector() : m_size(0), m_capacity(0), m_values(NULL) {}
 
     wxVector() : m_size(0), m_capacity(0), m_values(NULL) {}
 

-    wxVector(const wxVector& c)
+    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(const wxVector& c) : m_size(0), m_capacity(0), m_values(NULL)

     {
         Copy(c);
     }
     {
         Copy(c);
     }


@@ -45,11 +195,25 @@ public:
         clear();
     }
 
         clear();
     }
 

+    void swap(wxVector& v)
+    {
+        wxSwap(m_size, v.m_size);
+        wxSwap(m_capacity, v.m_capacity);
+        wxSwap(m_values, v.m_values);
+    }
+

     void clear()
     {
     void clear()
     {

-        delete[] m_values;
+        // call destructors of stored objects:
+        for ( size_type i = 0; i < m_size; i++ )
+        {
+            m_values[i].~T();
+        }
+
+        Ops::Free(m_values);

         m_values = NULL;
         m_values = NULL;

-        m_size = m_capacity = 0;
+        m_size =
+        m_capacity = 0;

     }
 
     void reserve(size_type n)
     }
 
     void reserve(size_type n)


@@ -59,23 +223,33 @@ public:
 
         // increase the size twice, unless we're already too big or unless
         // more is requested
 
         // increase the size twice, unless we're already too big or unless
         // more is requested

-        const size_type increment = (m_size > 0)
-                                     ? wxMin(m_size, ALLOC_MAX_SIZE)
-                                     : ALLOC_INITIAL_SIZE;
+        //
+        // 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;
 
         if ( m_capacity + increment > n )
             n = m_capacity + increment;
 

-        value_type *mem = new value_type[n];
+        m_values = Ops::Realloc(m_values, n * sizeof(value_type), m_size);
+        m_capacity = n;
+    }

 
 

-        if ( m_values )
-        {
-            for ( size_type i = 0; i < m_size; ++i )
-                mem[i] = m_values[i];
-            delete[] m_values;
-        }
+    void resize(size_type n)
+    {
+        if ( n < m_size )
+            Shrink(n);
+        else if ( n > m_size )
+            Extend(n, value_type());
+    }

 
 

-        m_values = mem;
-        m_capacity = n;
+    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
     }
 
     size_type size() const


@@ -95,14 +269,28 @@ public:
 
     wxVector& operator=(const wxVector& vb)
     {
 
     wxVector& operator=(const wxVector& vb)
     {

-        Copy(vb);
+        if (this != &vb)
+        {
+            clear();
+            Copy(vb);
+        }

         return *this;
     }
 
     void push_back(const value_type& v)
     {
         reserve(size() + 1);
         return *this;
     }
 
     void push_back(const value_type& v)
     {
         reserve(size() + 1);

-        m_values[m_size++] = v;
+
+        // 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()
     }
 
     void pop_back()


@@ -134,18 +322,40 @@ public:
     const_iterator end() const { return m_values + size(); }
     iterator end() { return m_values + size(); }
 
     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())
     {
     iterator insert(iterator it, const value_type& v = value_type())
     {

-        size_t idx = it - begin();
+        // 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);
 
 
         reserve(size() + 1);
 

-        // unless we're inserting at the end, move following values out of
-        // the way:
-        for ( size_t n = m_size; n != idx; --n )
-            m_values[n] = m_values[n-1];
+        // the place where the new element is going to be inserted
+        value_type * const place = m_values + idx;

 
 

-        m_values[idx] = v;
+        // 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;
         m_size++;
 
         return begin() + idx;


@@ -162,20 +372,23 @@ public:
             return first;
         wxASSERT( first < end() && last <= end() );
 
             return first;
         wxASSERT( first < end() && last <= end() );
 

-        size_type index = first - begin();
-        size_type count = last - first;
+        const size_type idx = first - begin();
+        const size_type count = last - first;
+        const size_type after = end() - last;

 
 

-        // move the remaining values over to the freed space:
-        for ( iterator i = last; i < end(); ++i )
-            *(i - count) = *i;
+        // erase elements by calling their destructors:
+        for ( iterator i = first; i < last; ++i )
+            i->~T();

 
 

-        // erase items behind the new end of m_values:
-        for ( iterator j = end() - count; j < end(); ++j )
-            *j = value_type();
+        // 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;
 
 
         m_size -= count;
 

-        return begin() + index;
+        return begin() + idx;

     }
 
 #if WXWIN_COMPATIBILITY_2_8
     }
 
 #if WXWIN_COMPATIBILITY_2_8


@@ -189,7 +402,6 @@ private:
 
     void Copy(const wxVector& vb)
     {
 
     void Copy(const wxVector& vb)
     {

-        clear();

         reserve(vb.size());
 
         for ( const_iterator i = vb.begin(); i != vb.end(); ++i )
         reserve(vb.size());
 
         for ( const_iterator i = vb.begin(); i != vb.end(); ++i )


@@ -197,6 +409,20 @@ private:
     }
 
 private:
     }
 
 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;
     size_type m_size,
               m_capacity;
     value_type *m_values;


@@ -204,7 +430,7 @@ private:
 
 #if WXWIN_COMPATIBILITY_2_8
 template<typename T>
 
 #if WXWIN_COMPATIBILITY_2_8
 template<typename T>

-typename wxVector<T>::size_type wxVector<T>::erase(size_type n)
+inline typename wxVector<T>::size_type wxVector<T>::erase(size_type n)

 {
     erase(begin() + n);
     return n;
 {
     erase(begin() + n);
     return n;