include/wx/vector.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/vector.h
   3 // Purpose:     STL vector clone
   4 // Author:      Lindsay Mathieson
   5 // Modified by: Vaclav Slavik - make it a template
   6 // Created:     30.07.2001
   7 // Copyright:   (c) 2001 Lindsay Mathieson <lindsay@mathieson.org>,
   8 //                  2007 Vaclav Slavik <vslavik@fastmail.fm>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_VECTOR_H_
  13 #define _WX_VECTOR_H_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_STL
  18
  19 #include <vector>
  20 #define wxVector std::vector
  21
  22 #else // !wxUSE_STL
  23
  24 #include "wx/utils.h"
  25 #include "wx/scopeguard.h"
  26 #include "wx/meta/movable.h"
  27 #include "wx/meta/if.h"
  28
  29 #include "wx/beforestd.h"
  30 #include <new> // for placement new
  31 #include "wx/afterstd.h"
  32
  33 namespace wxPrivate
  34 {
  35
  36 // These templates encapsulate memory operations for use by wxVector; there are
  37 // two implementations, both in generic way for any C++ types and as an
  38 // optimized version for "movable" types that uses realloc() and memmove().
  39
  40 // version for movable types:
  41 template<typename T>
  42 struct wxVectorMemOpsMovable
  43 {
  44     static void Free(T* array)
  45         { free(array); }
  46
  47     static T* Realloc(T* old, size_t newCapacity, size_t WXUNUSED(occupiedSize))
  48         { return (T*)realloc(old, newCapacity * sizeof(T)); }
  49
  50     static void MemmoveBackward(T* dest, T* source, size_t count)
  51         { memmove(dest, source, count * sizeof(T)); }
  52
  53     static void MemmoveForward(T* dest, T* source, size_t count)
  54         { memmove(dest, source, count * sizeof(T)); }
  55 };
  56
  57 // generic version for non-movable types:
  58 template<typename T>
  59 struct wxVectorMemOpsGeneric
  60 {
  61     static void Free(T* array)
  62         { ::operator delete(array); }
  63
  64     static T* Realloc(T* old, size_t newCapacity, size_t occupiedSize)
  65     {
  66         T *mem = (T*)::operator new(newCapacity * sizeof(T));
  67         for ( size_t i = 0; i < occupiedSize; i++ )
  68         {
  69             ::new(mem + i) T(old[i]);
  70             old[i].~T();
  71         }
  72         ::operator delete(old);
  73         return mem;
  74     }
  75
  76     static void MemmoveBackward(T* dest, T* source, size_t count)
  77     {
  78         wxASSERT( dest < source );
  79         T* destptr = dest;
  80         T* sourceptr = source;
  81         for ( size_t i = count; i > 0; --i, ++destptr, ++sourceptr )
  82         {
  83             ::new(destptr) T(*sourceptr);
  84             sourceptr->~T();
  85         }
  86     }
  87
  88     static void MemmoveForward(T* dest, T* source, size_t count)
  89     {
  90         wxASSERT( dest > source );
  91         T* destptr = dest + count - 1;
  92         T* sourceptr = source + count - 1;
  93         for ( size_t i = count; i > 0; --i, --destptr, --sourceptr )
  94         {
  95             ::new(destptr) T(*sourceptr);
  96             sourceptr->~T();
  97         }
  98     }
  99 };
 100
 101
 102 } // namespace wxPrivate
 103
 104 template<typename T>
 105 class wxVector
 106 {
 107 private:
 108     // This cryptic expression means "typedef Ops to wxVectorMemOpsMovable if
 109     // type T is movable type, otherwise to wxVectorMemOpsGeneric".
 110     //
 111     // Note that we use typedef instead of privately deriving from this (which
 112     // would allowed us to omit "Ops::" prefixes below) to keep VC6 happy,
 113     // it can't compile code that derives from wxIf<...>::value.
 114     typedef typename wxIf< wxIsMovable<T>::value,
 115                            wxPrivate::wxVectorMemOpsMovable<T>,
 116                            wxPrivate::wxVectorMemOpsGeneric<T> >::value
 117             Ops;
 118
 119 public:
 120     typedef size_t size_type;
 121     typedef size_t difference_type;
 122     typedef T value_type;
 123     typedef value_type* pointer;
 124     typedef value_type* iterator;
 125     typedef const value_type* const_iterator;
 126     typedef value_type& reference;
 127
 128     class reverse_iterator
 129     {
 130     public:
 131         reverse_iterator() : m_ptr(NULL) { }
 132         wxEXPLICIT reverse_iterator(iterator it) : m_ptr(it) { }
 133         reverse_iterator(const reverse_iterator& it) : m_ptr(it.m_ptr) { }
 134
 135         reference operator*() const { return *m_ptr; }
 136         pointer operator->() const { return m_ptr; }
 137
 138         iterator base() const { return m_ptr; }
 139
 140         reverse_iterator& operator++()
 141             { --m_ptr; return *this; }
 142         reverse_iterator operator++(int)
 143             { reverse_iterator tmp = *this; --m_ptr; return tmp; }
 144         reverse_iterator& operator--()
 145             { ++m_ptr; return *this; }
 146         reverse_iterator operator--(int)
 147             { reverse_iterator tmp = *this; ++m_ptr; return tmp; }
 148
 149         reverse_iterator operator+(difference_type n) const
 150             { return reverse_iterator(m_ptr - n); }
 151         reverse_iterator& operator+=(difference_type n)
 152             { m_ptr -= n; return *this; }
 153         reverse_iterator operator-(difference_type n) const
 154             { return reverse_iterator(m_ptr + n); }
 155         reverse_iterator& operator-=(difference_type n)
 156             { m_ptr += n; return *this; }
 157
 158         reference operator[](difference_type n) const
 159             { return *(*this + n); }
 160
 161         bool operator ==(const reverse_iterator& it) const
 162             { return m_ptr == it.m_ptr; }
 163         bool operator !=(const reverse_iterator& it) const
 164             { return m_ptr != it.m_ptr; }
 165
 166     private:
 167         value_type *m_ptr;
 168     };
 169
 170     wxVector() : m_size(0), m_capacity(0), m_values(NULL) {}
 171
 172     wxVector(const wxVector& c) : m_size(0), m_capacity(0), m_values(NULL)
 173     {
 174         Copy(c);
 175     }
 176
 177     ~wxVector()
 178     {
 179         clear();
 180     }
 181
 182     void clear()
 183     {
 184         // call destructors of stored objects:
 185         for ( size_type i = 0; i < m_size; i++ )
 186         {
 187             m_values[i].~T();
 188         }
 189
 190         Ops::Free(m_values);
 191         m_values = NULL;
 192         m_size =
 193         m_capacity = 0;
 194     }
 195
 196     void reserve(size_type n)
 197     {
 198         if ( n <= m_capacity )
 199             return;
 200
 201         // increase the size twice, unless we're already too big or unless
 202         // more is requested
 203         //
 204         // NB: casts to size_type are needed to suppress mingw32 warnings about
 205         //     mixing enums and ints in the same expression
 206         const size_type increment = m_size > 0
 207                                      ? wxMin(m_size, (size_type)ALLOC_MAX_SIZE)
 208                                      : (size_type)ALLOC_INITIAL_SIZE;
 209         if ( m_capacity + increment > n )
 210             n = m_capacity + increment;
 211
 212         m_values = Ops::Realloc(m_values, n * sizeof(value_type), m_size);
 213         m_capacity = n;
 214     }
 215
 216     size_type size() const
 217     {
 218         return m_size;
 219     }
 220
 221     size_type capacity() const
 222     {
 223         return m_capacity;
 224     }
 225
 226     bool empty() const
 227     {
 228         return size() == 0;
 229     }
 230
 231     wxVector& operator=(const wxVector& vb)
 232     {
 233         clear();
 234         Copy(vb);
 235         return *this;
 236     }
 237
 238     void push_back(const value_type& v)
 239     {
 240         reserve(size() + 1);
 241
 242         // use placement new to initialize new object in preallocated place in
 243         // m_values and store 'v' in it:
 244         void* const place = m_values + m_size;
 245         ::new(place) value_type(v);
 246
 247         // only increase m_size if the ctor didn't throw an exception; notice
 248         // that if it _did_ throw, everything is OK, because we only increased
 249         // vector's capacity so far and possibly written some data to
 250         // uninitialized memory at the end of m_values
 251         m_size++;
 252     }
 253
 254     void pop_back()
 255     {
 256         erase(end() - 1);
 257     }
 258
 259     const value_type& at(size_type idx) const
 260     {
 261         wxASSERT(idx < m_size);
 262         return m_values[idx];
 263     }
 264
 265     value_type& at(size_type idx)
 266     {
 267         wxASSERT(idx < m_size);
 268         return m_values[idx];
 269     }
 270
 271     const value_type& operator[](size_type idx) const  { return at(idx); }
 272     value_type& operator[](size_type idx) { return at(idx); }
 273     const value_type& front() const { return at(0); }
 274     value_type& front() { return at(0); }
 275     const value_type& back() const { return at(size() - 1); }
 276     value_type& back() { return at(size() - 1); }
 277
 278     const_iterator begin() const { return m_values; }
 279     iterator begin() { return m_values; }
 280     const_iterator end() const { return m_values + size(); }
 281     iterator end() { return m_values + size(); }
 282
 283     reverse_iterator rbegin() { return reverse_iterator(end() - 1); }
 284     reverse_iterator rend() { return reverse_iterator(begin() - 1); }
 285
 286     iterator insert(iterator it, const value_type& v = value_type())
 287     {
 288         // NB: this must be done before reserve(), because reserve()
 289         //     invalidates iterators!
 290         const size_t idx = it - begin();
 291         const size_t after = end() - it;
 292
 293         reserve(size() + 1);
 294
 295         // the place where the new element is going to be inserted
 296         value_type * const place = m_values + idx;
 297
 298         // unless we're inserting at the end, move following elements out of
 299         // the way:
 300         if ( after > 0 )
 301             Ops::MemmoveForward(place + 1, place, after);
 302
 303         // if the ctor called below throws an exception, we need to move all
 304         // the elements back to their original positions in m_values
 305         wxScopeGuard moveBack = wxMakeGuard(
 306                 Ops::MemmoveBackward, place, place + 1, after);
 307         if ( !after )
 308             moveBack.Dismiss();
 309
 310         // use placement new to initialize new object in preallocated place in
 311         // m_values and store 'v' in it:
 312         ::new(place) value_type(v);
 313
 314         // now that we did successfully add the new element, increment the size
 315         // and disable moving the items back
 316         moveBack.Dismiss();
 317         m_size++;
 318
 319         return begin() + idx;
 320     }
 321
 322     iterator erase(iterator it)
 323     {
 324         return erase(it, it + 1);
 325     }
 326
 327     iterator erase(iterator first, iterator last)
 328     {
 329         if ( first == last )
 330             return first;
 331         wxASSERT( first < end() && last <= end() );
 332
 333         const size_type idx = first - begin();
 334         const size_type count = last - first;
 335         const size_type after = end() - last;
 336
 337         // erase elements by calling their destructors:
 338         for ( iterator i = first; i < last; ++i )
 339             i->~T();
 340
 341         // once that's done, move following elements over to the freed space:
 342         if ( after > 0 )
 343         {
 344             Ops::MemmoveBackward(m_values + idx, m_values + idx + count, after);
 345         }
 346
 347         m_size -= count;
 348
 349         return begin() + idx;
 350     }
 351
 352 #if WXWIN_COMPATIBILITY_2_8
 353     wxDEPRECATED( size_type erase(size_type n) );
 354 #endif // WXWIN_COMPATIBILITY_2_8
 355
 356 private:
 357     // VC6 can't compile static const int members
 358     enum { ALLOC_INITIAL_SIZE = 16 };
 359     enum { ALLOC_MAX_SIZE = 4096 };
 360
 361     void Copy(const wxVector& vb)
 362     {
 363         reserve(vb.size());
 364
 365         for ( const_iterator i = vb.begin(); i != vb.end(); ++i )
 366             push_back(*i);
 367     }
 368
 369 private:
 370     size_type m_size,
 371               m_capacity;
 372     value_type *m_values;
 373 };
 374
 375 #if WXWIN_COMPATIBILITY_2_8
 376 template<typename T>
 377 inline typename wxVector<T>::size_type wxVector<T>::erase(size_type n)
 378 {
 379     erase(begin() + n);
 380     return n;
 381 }
 382 #endif // WXWIN_COMPATIBILITY_2_8
 383
 384 #endif // wxUSE_STL/!wxUSE_STL
 385
 386 #if WXWIN_COMPATIBILITY_2_8
 387     #define WX_DECLARE_VECTORBASE(obj, cls) typedef wxVector<obj> cls
 388     #define _WX_DECLARE_VECTOR(obj, cls, exp) WX_DECLARE_VECTORBASE(obj, cls)
 389     #define WX_DECLARE_VECTOR(obj, cls) WX_DECLARE_VECTORBASE(obj, cls)
 390 #endif // WXWIN_COMPATIBILITY_2_8
 391
 392 #endif // _WX_VECTOR_H_