include/wx/dynarray.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        dynarray.h
   3 // Purpose:     auto-resizable (i.e. dynamic) array support
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     12.09.97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _DYNARRAY_H
  13 #define   _DYNARRAY_H
  14
  15 #if defined(__GNUG__) && !defined(__APPLE__) && \
  16     !(defined(__MINGW32__) && __GNUC__ == 3 && __GNUC_MINOR__ == 2)
  17 #pragma interface "dynarray.h"
  18 #endif
  19
  20 #include "wx/defs.h"
  21
  22 #if wxUSE_STL
  23     #include "wx/beforestd.h"
  24     #include <vector>
  25     #include <algorithm>
  26     #include "wx/afterstd.h"
  27 #endif
  28
  29 /*
  30   This header defines the dynamic arrays and object arrays (i.e. arrays which
  31   own their elements). Dynamic means that the arrays grow automatically as
  32   needed.
  33
  34   These macros are ugly (especially if you look in the sources ;-), but they
  35   allow us to define "template" classes without actually using templates and so
  36   this works with all compilers (and may be also much faster to compile even
  37   with a compiler which does support templates). The arrays defined with these
  38   macros are type-safe.
  39
  40   Range checking is performed in debug build for both arrays and objarrays but
  41   not in release build - so using an invalid index will just lead to a crash
  42   then.
  43
  44   Note about memory usage: arrays never shrink automatically (although you may
  45   use Shrink() function explicitly), they only grow, so loading 10 millions in
  46   an array only to delete them 2 lines below might be a bad idea if the array
  47   object is not going to be destroyed soon. However, as it does free memory
  48   when destroyed, it is ok if the array is a local variable.
  49  */
  50
  51 // ----------------------------------------------------------------------------
  52 // constants
  53 // ----------------------------------------------------------------------------
  54
  55 /*
  56    The initial size by which an array grows when an element is added default
  57    value avoids allocate one or two bytes when the array is created which is
  58    rather inefficient
  59 */
  60 #define WX_ARRAY_DEFAULT_INITIAL_SIZE    (16)
  61
  62 // ----------------------------------------------------------------------------
  63 // types
  64 // ----------------------------------------------------------------------------
  65
  66 /*
  67     Callback compare function for quick sort.
  68
  69     It must return negative value, 0 or positive value if the first item is
  70     less than, equal to or greater than the second one.
  71  */
  72 extern "C"
  73 {
  74 typedef int (wxCMPFUNC_CONV *CMPFUNC)(const void* pItem1, const void* pItem2);
  75 }
  76
  77 // ----------------------------------------------------------------------------
  78 // Base class managing data having size of type 'long' (not used directly)
  79 //
  80 // NB: for efficiency this often used class has no virtual functions (hence no
  81 //     virtual table), even dtor is *not* virtual. If used as expected it
  82 //     won't create any problems because ARRAYs from DEFINE_ARRAY have no dtor
  83 //     at all, so it's not too important if it's not called (this happens when
  84 //     you cast "SomeArray *" as "BaseArray *" and then delete it)
  85 // ----------------------------------------------------------------------------
  86
  87 #if wxUSE_STL
  88
  89 template<class T>
  90 class WXDLLIMPEXP_BASE wxArray_SortFunction
  91 {
  92 public:
  93     typedef int (wxCMPFUNC_CONV *CMPFUNC)(T* pItem1, T* pItem2);
  94
  95     wxArray_SortFunction(CMPFUNC f) : m_f(f) { }
  96     bool operator()(const T& i1, const T& i2)
  97       { return m_f((T*)&i1, (T*)&i2) < 0; }
  98 private:
  99     CMPFUNC m_f;
 100 };
 101
 102 template<class T, typename F>
 103 class WXDLLIMPEXP_BASE wxSortedArray_SortFunction
 104 {
 105 public:
 106     typedef F CMPFUNC;
 107
 108     wxSortedArray_SortFunction(CMPFUNC f) : m_f(f) { }
 109     bool operator()(const T& i1, const T& i2)
 110       { return m_f(i1, i2) < 0; }
 111 private:
 112     CMPFUNC m_f;
 113 };
 114
 115 #define  _WX_DECLARE_BASEARRAY(T, name, classexp)                   \
 116    typedef int (wxCMPFUNC_CONV *CMPFUN##name)(T pItem1, T pItem2);  \
 117    typedef wxSortedArray_SortFunction<T, CMPFUN##name> name##_Predicate; \
 118    _WX_DECLARE_BASEARRAY_2(T, name, name##_Predicate, classexp)
 119
 120 #define  _WX_DECLARE_BASEARRAY_2(T, name, predicate, classexp)      \
 121 classexp name : public std::vector<T>                               \
 122 {                                                                   \
 123   typedef predicate Predicate;                                      \
 124   typedef predicate::CMPFUNC SCMPFUNC;                              \
 125 public:                                                             \
 126   typedef wxArray_SortFunction<T>::CMPFUNC CMPFUNC;                 \
 127 public:                                                             \
 128   void Empty() { clear(); }                                         \
 129   void Clear() { clear(); }                                         \
 130   void Alloc(size_t uiSize) { reserve(uiSize); }                    \
 131   void Shrink();                                                    \
 132                                                                     \
 133   size_t GetCount() const { return size(); }                        \
 134   void SetCount(size_t n, T v = T()) { resize(n, v); }              \
 135   bool IsEmpty() const { return empty(); }                          \
 136   size_t Count() const { return size(); }                           \
 137                                                                     \
 138   typedef T base_type;                                              \
 139                                                                     \
 140 protected:                                                          \
 141   T& Item(size_t uiIndex) const                                     \
 142     { wxASSERT( uiIndex < size() ); return (T&)operator[](uiIndex); }   \
 143                                                                     \
 144   int Index(T e, bool bFromEnd = FALSE) const;                      \
 145   int Index(T lItem, CMPFUNC fnCompare) const;                      \
 146   size_t IndexForInsert(T lItem, CMPFUNC fnCompare) const;          \
 147   void Add(T lItem, size_t nInsert = 1)                             \
 148     { insert(end(), nInsert, lItem); }                              \
 149   size_t Add(T lItem, CMPFUNC fnCompare);                           \
 150   void Insert(T lItem, size_t uiIndex, size_t nInsert = 1)          \
 151     { insert(begin() + uiIndex, nInsert, lItem); }                  \
 152   void Remove(T lItem);                                             \
 153   void RemoveAt(size_t uiIndex, size_t nRemove = 1)                 \
 154     { erase(begin() + uiIndex, begin() + uiIndex + nRemove); }      \
 155                                                                     \
 156   void Sort(CMPFUNC fCmp)                                           \
 157   {                                                                 \
 158     wxArray_SortFunction<T> p(fCmp);                                \
 159     std::sort(begin(), end(), p);                                   \
 160   }                                                                 \
 161 }
 162
 163 #else // if !wxUSE_STL
 164
 165 #define  _WX_DECLARE_BASEARRAY(T, name, classexp)                   \
 166 classexp name                                                       \
 167 {                                                                   \
 168   typedef CMPFUNC SCMPFUNC; /* for compatibility wuth wxUSE_STL */  \
 169 public:                                                             \
 170   name();                                                           \
 171   name(const name& array);                                          \
 172   name& operator=(const name& src);                                 \
 173   ~name();                                                          \
 174                                                                     \
 175   void Empty() { m_nCount = 0; }                                    \
 176   void Clear();                                                     \
 177   void Alloc(size_t uiSize);                                        \
 178   void Shrink();                                                    \
 179                                                                     \
 180   size_t GetCount() const { return m_nCount; }                      \
 181   void SetCount(size_t n, T defval = T(0));                         \
 182   bool IsEmpty() const { return m_nCount == 0; }                    \
 183   size_t Count() const { return m_nCount; }                         \
 184                                                                     \
 185   typedef T base_type;                                              \
 186                                                                     \
 187 protected:                                                          \
 188   T& Item(size_t uiIndex) const                                     \
 189     { wxASSERT( uiIndex < m_nCount ); return m_pItems[uiIndex]; }   \
 190   T& operator[](size_t uiIndex) const { return Item(uiIndex); }     \
 191                                                                     \
 192   int Index(T lItem, bool bFromEnd = FALSE) const;                  \
 193   int Index(T lItem, CMPFUNC fnCompare) const;                      \
 194   size_t IndexForInsert(T lItem, CMPFUNC fnCompare) const;          \
 195   void Add(T lItem, size_t nInsert = 1);                            \
 196   size_t Add(T lItem, CMPFUNC fnCompare);                           \
 197   void Insert(T lItem, size_t uiIndex, size_t nInsert = 1);         \
 198   void Remove(T lItem);                                             \
 199   void RemoveAt(size_t uiIndex, size_t nRemove = 1);                \
 200                                                                     \
 201   void Sort(CMPFUNC fnCompare);                                     \
 202                                                                     \
 203   /* *minimal* STL-ish interface, for derived classes */            \
 204   typedef T value_type;                                             \
 205   typedef value_type* iterator;                                     \
 206   typedef const value_type* const_iterator;                         \
 207   typedef value_type& reference;                                    \
 208   typedef const value_type& const_reference;                        \
 209   typedef int difference_type;                                      \
 210   typedef size_t size_type;                                         \
 211                                                                     \
 212   void assign(const_iterator first, const_iterator last);           \
 213   void assign(size_type n, const_reference v);                      \
 214   size_type capacity() const { return m_nSize; }                    \
 215   void clear() { Clear(); }                                         \
 216   bool empty() const { return IsEmpty(); }                          \
 217   iterator erase(iterator first, iterator last)                     \
 218   {                                                                 \
 219     size_type idx = first - begin();                                \
 220     RemoveAt(idx, last - first);                                    \
 221     return begin() + idx;                                           \
 222   }                                                                 \
 223   iterator erase(iterator it) { return erase(it, it + 1); }         \
 224   void insert(iterator it, size_type n, const value_type& v)        \
 225     { Insert(v, it - begin(), n); }                                 \
 226   iterator insert(iterator it, const value_type& v = value_type())  \
 227   {                                                                 \
 228     size_type idx = it - begin();                                   \
 229     Insert(v, idx);                                                 \
 230     return begin() + idx;                                           \
 231   }                                                                 \
 232   void insert(iterator it, const_iterator first, const_iterator last);\
 233   size_type max_size() const { return INT_MAX; }                    \
 234   void pop_back() { RemoveAt(size() - 1); }                         \
 235   void push_back(const value_type& v) { Add(v); }                   \
 236   void reserve(size_type n) { if(n > m_nSize) Realloc(n); }         \
 237   void resize(size_type n, value_type v = value_type());            \
 238   size_type size() const { return GetCount(); }                     \
 239                                                                     \
 240   iterator begin() { return m_pItems; }                             \
 241   iterator end() { return m_pItems + m_nCount; }                    \
 242   const_iterator begin() const { return m_pItems; }                 \
 243   const_iterator end() const { return m_pItems + m_nCount; }        \
 244 private:                                                            \
 245   void Grow(size_t nIncrement = 0);                                 \
 246   bool Realloc(size_t nSize);                                       \
 247                                                                     \
 248   size_t  m_nSize,                                                  \
 249           m_nCount;                                                 \
 250                                                                     \
 251   T      *m_pItems;                                                 \
 252 }
 253
 254 #endif // !wxUSE_STL
 255
 256 // ============================================================================
 257 // The private helper macros containing the core of the array classes
 258 // ============================================================================
 259
 260 // Implementation notes:
 261 //
 262 // JACS: Salford C++ doesn't like 'var->operator=' syntax, as in:
 263 //          { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
 264 //       so using a temporary variable instead.
 265 //
 266 // The classes need a (even trivial) ~name() to link under Mac X
 267 //
 268 // _WX_ERROR_REMOVE is needed to resolve the name conflict between the wxT()
 269 // macro and T typedef: we can't use wxT() inside WX_DEFINE_ARRAY!
 270
 271 #define _WX_ERROR_REMOVE wxT("removing inexisting element in wxArray::Remove")
 272
 273 // ----------------------------------------------------------------------------
 274 // _WX_DEFINE_TYPEARRAY: array for simple types
 275 // ----------------------------------------------------------------------------
 276
 277 #if wxUSE_STL
 278
 279 #define  _WX_DEFINE_TYPEARRAY(T, name, base, classexp)                \
 280 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2);         \
 281 classexp name : public base                                           \
 282 {                                                                     \
 283 public:                                                               \
 284   T& operator[](size_t uiIndex) const                                 \
 285     { return (T&)(base::operator[](uiIndex)); }                       \
 286   T& Item(size_t uiIndex) const                                       \
 287     { return (T&)/*const cast*/base::operator[](uiIndex); }           \
 288   T& Last() const                                                     \
 289     { return Item(Count() - 1); }                                     \
 290                                                                       \
 291   int Index(T e, bool bFromEnd = FALSE) const                         \
 292     { return base::Index(e, bFromEnd); }                              \
 293                                                                       \
 294   void Add(T Item, size_t nInsert = 1)                                \
 295     { insert(end(), nInsert, Item); }                                 \
 296   void Insert(T Item, size_t uiIndex, size_t nInsert = 1)             \
 297     { insert(begin() + uiIndex, nInsert, Item); }                     \
 298                                                                       \
 299   void RemoveAt(size_t uiIndex, size_t nRemove = 1)                   \
 300     { base::RemoveAt(uiIndex, nRemove); }                             \
 301   void Remove(T Item)                                                 \
 302     { int iIndex = Index(Item);                                       \
 303       wxCHECK2_MSG( iIndex != wxNOT_FOUND, return,                    \
 304          _WX_ERROR_REMOVE);                                           \
 305       RemoveAt((size_t)iIndex); }                                     \
 306                                                                       \
 307   void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC)fCmp); }           \
 308 }
 309
 310 #define  _WX_DEFINE_TYPEARRAY_NO_PTR(T, name, base, classexp)         \
 311                 _WX_DEFINE_TYPEARRAY(T, name, base, classexp)
 312
 313 #else // if !wxUSE_STL
 314
 315 // common declaration used by both _WX_DEFINE_TYPEARRAY and
 316 // _WX_DEFINE_TYPEARRAY_NO_PTR
 317 #define  _WX_DEFINE_TYPEARRAY_HELPER(T, name, base, classexp, ptrop)  \
 318 wxCOMPILE_TIME_ASSERT2(sizeof(T) <= sizeof(base::base_type),          \
 319                        TypeTooBigToBeStoredIn##base,                  \
 320                        name);                                         \
 321 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2);         \
 322 classexp name : public base                                           \
 323 {                                                                     \
 324 public:                                                               \
 325   name() { }                                                          \
 326   ~name() { }                                                         \
 327                                                                       \
 328   name& operator=(const name& src)                                    \
 329     { base* temp = (base*) this;                                      \
 330       (*temp) = ((const base&)src);                                   \
 331       return *this; }                                                 \
 332                                                                       \
 333   T& operator[](size_t uiIndex) const                                 \
 334     { return (T&)(base::operator[](uiIndex)); }                       \
 335   T& Item(size_t uiIndex) const                                       \
 336     { return (T&)(base::operator[](uiIndex)); }                       \
 337   T& Last() const                                                     \
 338     { return (T&)(base::operator[](Count() - 1)); }                   \
 339                                                                       \
 340   int Index(T Item, bool bFromEnd = FALSE) const                      \
 341     { return base::Index((base_type)Item, bFromEnd); }                \
 342                                                                       \
 343   void Add(T Item, size_t nInsert = 1)                                \
 344     { base::Add((base_type)Item, nInsert); }                          \
 345   void Insert(T Item, size_t uiIndex, size_t nInsert = 1)             \
 346     { base::Insert((base_type)Item, uiIndex, nInsert) ; }             \
 347                                                                       \
 348   void RemoveAt(size_t uiIndex, size_t nRemove = 1)                   \
 349     { base::RemoveAt(uiIndex, nRemove); }                             \
 350   void Remove(T Item)                                                 \
 351     { int iIndex = Index(Item);                                       \
 352       wxCHECK2_MSG( iIndex != wxNOT_FOUND, return,                    \
 353          _WX_ERROR_REMOVE);                                           \
 354       base::RemoveAt((size_t)iIndex); }                               \
 355                                                                       \
 356   void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC)fCmp); }           \
 357                                                                       \
 358   /* STL-like interface */                                            \
 359 private:                                                              \
 360   typedef base::iterator biterator;                                   \
 361   typedef base::const_iterator bconst_iterator;                       \
 362   typedef base::value_type bvalue_type;                               \
 363   typedef base::const_reference bconst_reference;                     \
 364 public:                                                               \
 365   typedef T value_type;                                               \
 366   typedef value_type* pointer;                                        \
 367   typedef const value_type* const_pointer;                            \
 368   typedef value_type* iterator;                                       \
 369   typedef const value_type* const_iterator;                           \
 370   typedef value_type& reference;                                      \
 371   typedef const value_type& const_reference;                          \
 372   typedef base::difference_type difference_type;                      \
 373   typedef base::size_type size_type;                                  \
 374                                                                       \
 375   class reverse_iterator                                              \
 376   {                                                                   \
 377     typedef T value_type;                                             \
 378     typedef value_type& reference;                                    \
 379     typedef value_type* pointer;                                      \
 380     typedef reverse_iterator itor;                                    \
 381     friend inline itor operator+(int o, const itor& it)               \
 382         { return it.m_ptr - o; }                                      \
 383     friend inline itor operator+(const itor& it, int o)               \
 384         { return it.m_ptr - o; }                                      \
 385     friend inline itor operator-(const itor& it, int o)               \
 386         { return it.m_ptr + o; }                                      \
 387     friend inline difference_type operator-(const itor& i1,           \
 388                                             const itor& i2)           \
 389         { return i1.m_ptr - i2.m_ptr; }                               \
 390                                                                       \
 391   public:                                                             \
 392     pointer m_ptr;                                                    \
 393     reverse_iterator() : m_ptr(NULL) { }                              \
 394     reverse_iterator(pointer ptr) : m_ptr(ptr) { }                    \
 395     reverse_iterator(const itor& it) : m_ptr(it.m_ptr) { }            \
 396     reference operator*() const { return *m_ptr; }                    \
 397     ptrop                                                             \
 398     itor operator++() { --m_ptr; return *this; }                      \
 399     itor operator++(int)                                              \
 400       { reverse_iterator tmp = *this; --m_ptr; return tmp; }          \
 401     itor operator--() { ++m_ptr; return *this; }                      \
 402     itor operator--(int) { itor tmp = *this; ++m_ptr; return tmp; }   \
 403     bool operator ==(const itor& it) { return m_ptr == it.m_ptr; }    \
 404     bool operator !=(const itor& it) { return m_ptr != it.m_ptr; }    \
 405   };                                                                  \
 406                                                                       \
 407   class const_reverse_iterator                                        \
 408   {                                                                   \
 409     typedef T value_type;                                             \
 410     typedef const value_type& reference;                              \
 411     typedef const value_type* pointer;                                \
 412     typedef const_reverse_iterator itor;                              \
 413     friend inline itor operator+(int o, const itor& it)               \
 414         { return it.m_ptr - o; }                                      \
 415     friend inline itor operator+(const itor& it, int o)               \
 416         { return it.m_ptr - o; }                                      \
 417     friend inline itor operator-(const itor& it, int o)               \
 418         { return it.m_ptr + o; }                                      \
 419     friend inline difference_type operator-(const itor& i1,           \
 420                                             const itor& i2)           \
 421         { return i1.m_ptr - i2.m_ptr; }                               \
 422                                                                       \
 423   public:                                                             \
 424     pointer m_ptr;                                                    \
 425     const_reverse_iterator() : m_ptr(NULL) { }                        \
 426     const_reverse_iterator(pointer ptr) : m_ptr(ptr) { }              \
 427     const_reverse_iterator(const itor& it) : m_ptr(it.m_ptr) { }      \
 428     const_reverse_iterator(const reverse_iterator& it) : m_ptr(it.m_ptr) { }\
 429     reference operator*() const { return *m_ptr; }                    \
 430     ptrop                                                             \
 431     itor operator++() { --m_ptr; return *this; }                      \
 432     itor operator++(int)                                              \
 433       { itor tmp = *this; --m_ptr; return tmp; }                      \
 434     itor operator--() { ++m_ptr; return *this; }                      \
 435     itor operator--(int) { itor tmp = *this; ++m_ptr; return tmp; }   \
 436     bool operator ==(const itor& it) { return m_ptr == it.m_ptr; }    \
 437     bool operator !=(const itor& it) { return m_ptr != it.m_ptr; }    \
 438   };                                                                  \
 439                                                                       \
 440   void assign(const_iterator first, const_iterator last)              \
 441     { base::assign((bconst_iterator)first, (bconst_iterator)last); }  \
 442   void assign(size_type n, const_reference v)                         \
 443     { base::assign(n, (bconst_reference)v); }                         \
 444   reference back() { return *(end() - 1); }                           \
 445   const_reference back() const { return *(end() - 1); }               \
 446   iterator begin() { return (iterator)base::begin(); }                \
 447   const_iterator begin() const { return (const_iterator)base::begin(); }\
 448   size_type capacity() const { return base::capacity(); }             \
 449   void clear() { base::clear(); }                                     \
 450   bool empty() const { return base::empty(); }                        \
 451   iterator end() { return (iterator)base::end(); }                    \
 452   const_iterator end() const { return (const_iterator)base::end(); }  \
 453   iterator erase(iterator first, iterator last)                       \
 454     { return (iterator)base::erase((biterator)first, (biterator)last); }\
 455   iterator erase(iterator it)                                         \
 456     { return (iterator)base::erase((biterator)it); }                  \
 457   reference front() { return *begin(); }                              \
 458   const_reference front() const { return *begin(); }                  \
 459   void insert(iterator it, size_type n, const_reference v)            \
 460     { base::insert((biterator)it, n, (bconst_reference)v); }          \
 461   iterator insert(iterator it, const_reference v = value_type())      \
 462     { return (iterator)base::insert((biterator)it, (bconst_reference)v); }\
 463   void insert(iterator it, const_iterator first, const_iterator last) \
 464     { base::insert((biterator)it, (bconst_iterator)first,             \
 465                    (bconst_iterator)last); }                          \
 466   size_type max_size() const { return base::max_size(); }             \
 467   void pop_back() { base::pop_back(); }                               \
 468   void push_back(const_reference v)                                   \
 469     { base::push_back((bconst_reference)v); }                         \
 470   reverse_iterator rbegin() { return reverse_iterator(end() - 1); }   \
 471   const_reverse_iterator rbegin() const;                              \
 472   reverse_iterator rend() { return reverse_iterator(begin() - 1); }   \
 473   const_reverse_iterator rend() const;                                \
 474   void reserve(size_type n) { base::reserve(n); };                    \
 475   void resize(size_type n, value_type v = value_type());              \
 476   size_type size() const { return base::size(); }                     \
 477 }
 478
 479 #define _WX_PTROP pointer operator->() const { return m_ptr; }
 480 #define _WX_PTROP_NONE
 481
 482 #define _WX_DEFINE_TYPEARRAY(T, name, base, classexp)                 \
 483     _WX_DEFINE_TYPEARRAY_HELPER(T, name, base, classexp, _WX_PTROP)
 484 #define _WX_DEFINE_TYPEARRAY_NO_PTR(T, name, base, classexp)          \
 485     _WX_DEFINE_TYPEARRAY_HELPER(T, name, base, classexp, _WX_PTROP_NONE)
 486
 487 #endif // !wxUSE_STL
 488
 489 // ----------------------------------------------------------------------------
 490 // _WX_DEFINE_SORTED_TYPEARRAY: sorted array for simple data types
 491 //    cannot handle types with size greater than pointer because of sorting
 492 // ----------------------------------------------------------------------------
 493
 494 #define _WX_DEFINE_SORTED_TYPEARRAY_2(T, name, base, defcomp, classexp, comptype)\
 495 wxCOMPILE_TIME_ASSERT2(sizeof(T) <= sizeof(base::base_type),          \
 496                        TypeTooBigToBeStoredInSorted##base,            \
 497                        name);                                         \
 498 classexp name : public base                                           \
 499 {                                                                     \
 500   typedef comptype SCMPFUNC;                                          \
 501 public:                                                               \
 502   name(comptype fn defcomp) { m_fnCompare = fn; }                     \
 503                                                                       \
 504   name& operator=(const name& src)                                    \
 505     { base* temp = (base*) this;                                      \
 506       (*temp) = ((const base&)src);                                   \
 507       m_fnCompare = src.m_fnCompare;                                  \
 508       return *this; }                                                 \
 509                                                                       \
 510   T& operator[](size_t uiIndex) const                                 \
 511     { return (T&)(base::operator[](uiIndex)); }                       \
 512   T& Item(size_t uiIndex) const                                       \
 513     { return (T&)(base::operator[](uiIndex)); }                       \
 514   T& Last() const                                                     \
 515     { return (T&)(base::operator[](size() - 1)); }                    \
 516                                                                       \
 517   int Index(T Item) const                                             \
 518     { return base::Index(Item, (CMPFUNC)m_fnCompare); }               \
 519                                                                       \
 520   size_t IndexForInsert(T Item) const                                 \
 521     { return base::IndexForInsert(Item, (CMPFUNC)m_fnCompare); }      \
 522                                                                       \
 523   void AddAt(T item, size_t index)                                    \
 524     { base::insert(begin() + index, item); }                          \
 525                                                                       \
 526   size_t Add(T Item)                                                  \
 527     { return base::Add(Item, (CMPFUNC)m_fnCompare); }                 \
 528                                                                       \
 529   void RemoveAt(size_t uiIndex, size_t nRemove = 1)                   \
 530     { base::erase(begin() + uiIndex, begin() + uiIndex + nRemove); }  \
 531   void Remove(T Item)                                                 \
 532     { int iIndex = Index(Item);                                       \
 533       wxCHECK2_MSG( iIndex != wxNOT_FOUND, return,                    \
 534         _WX_ERROR_REMOVE );                                           \
 535       base::erase(begin() + iIndex); }                                \
 536                                                                       \
 537 private:                                                              \
 538   comptype m_fnCompare;                                               \
 539 }
 540
 541
 542 // ----------------------------------------------------------------------------
 543 // _WX_DECLARE_OBJARRAY: an array for pointers to type T with owning semantics
 544 // ----------------------------------------------------------------------------
 545
 546 #define _WX_DECLARE_OBJARRAY(T, name, base, classexp)                    \
 547 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T **pItem1, T **pItem2);          \
 548 classexp name : protected base                                           \
 549 {                                                                        \
 550 typedef int (CMPFUNC_CONV *CMPFUNC##base)(void **pItem1, void **pItem2); \
 551 typedef base base_array;                                                 \
 552 public:                                                                  \
 553   name() { }                                                             \
 554   name(const name& src);                                                 \
 555   name& operator=(const name& src);                                      \
 556                                                                          \
 557   ~name();                                                               \
 558                                                                          \
 559   void Alloc(size_t count) { reserve(count); }                           \
 560   size_t GetCount() const { return base_array::size(); }                 \
 561   size_t size() const { return base_array::size(); }                     \
 562   bool IsEmpty() const { return base_array::empty(); }                   \
 563   size_t Count() const { return base_array::size(); }                    \
 564   void Shrink() { base::Shrink(); }                                      \
 565                                                                          \
 566   T& operator[](size_t uiIndex) const                                    \
 567     { return *(T*)base::operator[](uiIndex); }                           \
 568   T& Item(size_t uiIndex) const                                          \
 569     { return *(T*)base::operator[](uiIndex); }                           \
 570   T& Last() const                                                        \
 571     { return *(T*)(base::operator[](size() - 1)); }                      \
 572                                                                          \
 573   int Index(const T& Item, bool bFromEnd = FALSE) const;                 \
 574                                                                          \
 575   void Add(const T& Item, size_t nInsert = 1);                           \
 576   void Add(const T* pItem)                                               \
 577     { base::push_back((T*)pItem); }                                      \
 578   void push_back(const T* pItem)                                         \
 579     { base::push_back((T*)pItem); }                                      \
 580   void push_back(const T& Item)                                          \
 581     { Add(Item); }                                                       \
 582                                                                          \
 583   void Insert(const T& Item,  size_t uiIndex, size_t nInsert = 1);       \
 584   void Insert(const T* pItem, size_t uiIndex)                            \
 585     { base::insert(begin() + uiIndex, (T*)pItem); }                      \
 586                                                                          \
 587   void Empty() { DoEmpty(); base::clear(); }                             \
 588   void Clear() { DoEmpty(); base::clear(); }                             \
 589                                                                          \
 590   T* Detach(size_t uiIndex)                                              \
 591     { T* p = (T*)base::operator[](uiIndex);                              \
 592       base::erase(begin() + uiIndex); return p; }                        \
 593   void RemoveAt(size_t uiIndex, size_t nRemove = 1);                     \
 594                                                                          \
 595   void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC##base)fCmp); }        \
 596                                                                          \
 597 private:                                                                 \
 598   void DoEmpty();                                                        \
 599   void DoCopy(const name& src);                                          \
 600 }
 601
 602 // ============================================================================
 603 // The public macros for declaration and definition of the dynamic arrays
 604 // ============================================================================
 605
 606 // Please note that for each macro WX_FOO_ARRAY we also have
 607 // WX_FOO_EXPORTED_ARRAY and WX_FOO_USER_EXPORTED_ARRAY which are exactly the
 608 // same except that they use an additional __declspec(dllexport) or equivalent
 609 // under Windows if needed.
 610 //
 611 // The first (just EXPORTED) macros do it if wxWindows was compiled as a DLL
 612 // and so must be used used inside the library. The second kind (USER_EXPORTED)
 613 // allow the user code to do it when it wants. This is needed if you have a dll
 614 // that wants to export a wxArray daubed with your own import/export goo.
 615 //
 616 // Finally, you can define the macro below as something special to modify the
 617 // arrays defined by a simple WX_FOO_ARRAY as well. By default is is empty.
 618 #define wxARRAY_DEFAULT_EXPORT
 619
 620 // ----------------------------------------------------------------------------
 621 // WX_DECLARE_BASEARRAY(T, name) declare an array class named "name" containing
 622 // the elements of type T
 623 // ----------------------------------------------------------------------------
 624
 625 #define WX_DECLARE_BASEARRAY(T, name)                             \
 626     WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, wxARRAY_DEFAULT_EXPORT)
 627
 628 #define WX_DECLARE_EXPORTED_BASEARRAY(T, name)                    \
 629     WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, WXDLLEXPORT)
 630
 631 #define WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, expmode)      \
 632     typedef T _wxArray##name;                                     \
 633     _WX_DECLARE_BASEARRAY(_wxArray##name, name, class expmode)
 634
 635 // ----------------------------------------------------------------------------
 636 // WX_DEFINE_TYPEARRAY(T, name, base) define an array class named "name" deriving
 637 // from class "base" containing the elements of type T
 638 //
 639 // Note that the class defined has only inline function and doesn't take any
 640 // space at all so there is no size penalty for defining multiple array classes
 641 // ----------------------------------------------------------------------------
 642
 643 #define WX_DEFINE_TYPEARRAY(T, name, base)                        \
 644     WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, class wxARRAY_DEFAULT_EXPORT)
 645
 646 #define WX_DEFINE_TYPEARRAY_NO_PTR(T, name, base)                        \
 647     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, base, class wxARRAY_DEFAULT_EXPORT)
 648
 649 #define WX_DEFINE_EXPORTED_TYPEARRAY(T, name, base)               \
 650     WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, class WXDLLEXPORT)
 651
 652 #define WX_DEFINE_EXPORTED_TYPEARRAY_NO_PTR(T, name, base)               \
 653     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, base, class WXDLLEXPORT)
 654
 655 #define WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, base, expdecl) \
 656     WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, class expdecl)
 657
 658 #define WX_DEFINE_USER_EXPORTED_TYPEARRAY_NO_PTR(T, name, base, expdecl) \
 659     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, base, class expdecl)
 660
 661 #define WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, classdecl) \
 662     typedef T _wxArray##name;                                   \
 663     _WX_DEFINE_TYPEARRAY(_wxArray##name, name, base, classdecl)
 664
 665 #define WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, base, classdecl) \
 666     typedef T _wxArray##name;                                          \
 667     _WX_DEFINE_TYPEARRAY_NO_PTR(_wxArray##name, name, base, classdecl)
 668
 669 // ----------------------------------------------------------------------------
 670 // WX_DEFINE_SORTED_TYPEARRAY: this is the same as the previous macro, but it
 671 // defines a sorted array.
 672 //
 673 // Differences:
 674 //  1) it must be given a COMPARE function in ctor which takes 2 items of type
 675 //     T* and should return -1, 0 or +1 if the first one is less/greater
 676 //     than/equal to the second one.
 677 //  2) the Add() method inserts the item in such was that the array is always
 678 //     sorted (it uses the COMPARE function)
 679 //  3) it has no Sort() method because it's always sorted
 680 //  4) Index() method is much faster (the sorted arrays use binary search
 681 //     instead of linear one), but Add() is slower.
 682 //  5) there is no Insert() method because you can't insert an item into the
 683 //     given position in a sorted array but there is IndexForInsert()/AddAt()
 684 //     pair which may be used to optimize a common operation of "insert only if
 685 //     not found"
 686 //
 687 // Note that you have to specify the comparison function when creating the
 688 // objects of this array type. If, as in 99% of cases, the comparison function
 689 // is the same for all objects of a class, WX_DEFINE_SORTED_TYPEARRAY_CMP below
 690 // is more convenient.
 691 //
 692 // Summary: use this class when the speed of Index() function is important, use
 693 // the normal arrays otherwise.
 694 // ----------------------------------------------------------------------------
 695
 696 #define wxARRAY_EMPTY_CMP
 697
 698 #define WX_DEFINE_SORTED_TYPEARRAY(T, name, base)                         \
 699     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base,               \
 700                                              wxARRAY_DEFAULT_EXPORT)
 701
 702 #define WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, base)                \
 703     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, WXDLLEXPORT)
 704
 705 #define WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, expmode)  \
 706     typedef T _wxArray##name;                                             \
 707     typedef int (CMPFUNC_CONV *SCMPFUNC##name)(T pItem1, T pItem2);       \
 708     _WX_DEFINE_SORTED_TYPEARRAY_2(_wxArray##name, name, base,             \
 709                                 wxARRAY_EMPTY_CMP, class expmode, SCMPFUNC##name)
 710
 711 // ----------------------------------------------------------------------------
 712 // WX_DEFINE_SORTED_TYPEARRAY_CMP: exactly the same as above but the comparison
 713 // function is provided by this macro and the objects of this class have a
 714 // default constructor which just uses it.
 715 //
 716 // The arguments are: the element type, the comparison function and the array
 717 // name
 718 //
 719 // NB: this is, of course, how WX_DEFINE_SORTED_TYPEARRAY() should have worked
 720 //     from the very beginning - unfortunately I didn't think about this earlier
 721 // ----------------------------------------------------------------------------
 722
 723 #define WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, base)               \
 724     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base,     \
 725                                                  wxARRAY_DEFAULT_EXPORT)
 726
 727 #define WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base)      \
 728     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base,     \
 729                                                  WXDLLEXPORT)
 730
 731 #define WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base, \
 732                                                      expmode)                \
 733     typedef T _wxArray##name;                                                \
 734     typedef int (CMPFUNC_CONV *SCMPFUNC##name)(T pItem1, T pItem2);          \
 735     _WX_DEFINE_SORTED_TYPEARRAY_2(_wxArray##name, name, base, = cmpfunc,     \
 736                                 class expmode, SCMPFUNC##name)
 737
 738 // ----------------------------------------------------------------------------
 739 // WX_DECLARE_OBJARRAY(T, name): this macro generates a new array class
 740 // named "name" which owns the objects of type T it contains, i.e. it will
 741 // delete them when it is destroyed.
 742 //
 743 // An element is of type T*, but arguments of type T& are taken (see below!)
 744 // and T& is returned.
 745 //
 746 // Don't use this for simple types such as "int" or "long"!
 747 //
 748 // Note on Add/Insert functions:
 749 //  1) function(T*) gives the object to the array, i.e. it will delete the
 750 //     object when it's removed or in the array's dtor
 751 //  2) function(T&) will create a copy of the object and work with it
 752 //
 753 // Also:
 754 //  1) Remove() will delete the object after removing it from the array
 755 //  2) Detach() just removes the object from the array (returning pointer to it)
 756 //
 757 // NB1: Base type T should have an accessible copy ctor if Add(T&) is used
 758 // NB2: Never ever cast a array to it's base type: as dtor is not virtual
 759 //      and so you risk having at least the memory leaks and probably worse
 760 //
 761 // Some functions of this class are not inline, so it takes some space to
 762 // define new class from this template even if you don't use it - which is not
 763 // the case for the simple (non-object) array classes
 764 //
 765 // To use an objarray class you must
 766 //      #include "dynarray.h"
 767 //      WX_DECLARE_OBJARRAY(element_type, list_class_name)
 768 //      #include "arrimpl.cpp"
 769 //      WX_DEFINE_OBJARRAY(list_class_name) // name must be the same as above!
 770 //
 771 // This is necessary because at the moment of DEFINE_OBJARRAY class parsing the
 772 // element_type must be fully defined (i.e. forward declaration is not
 773 // enough), while WX_DECLARE_OBJARRAY may be done anywhere. The separation of
 774 // two allows to break cicrcular dependencies with classes which have member
 775 // variables of objarray type.
 776 // ----------------------------------------------------------------------------
 777
 778 #define WX_DECLARE_OBJARRAY(T, name)                        \
 779     WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, wxARRAY_DEFAULT_EXPORT)
 780
 781 #define WX_DECLARE_EXPORTED_OBJARRAY(T, name)               \
 782     WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, WXDLLEXPORT)
 783
 784 #define WX_DECLARE_OBJARRAY_WITH_DECL(T, name, decl) \
 785     typedef T _wxObjArray##name;                            \
 786     _WX_DECLARE_OBJARRAY(_wxObjArray##name, name, wxArrayPtrVoid, decl)
 787
 788 #define WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, expmode) \
 789     WX_DECLARE_OBJARRAY_WITH_DECL(T, name, class expmode)
 790
 791 // WX_DEFINE_OBJARRAY is going to be redefined when arrimpl.cpp is included,
 792 // try to provoke a human-understandable error if it used incorrectly.
 793 //
 794 // there is no real need for 3 different macros in the DEFINE case but do it
 795 // anyhow for consistency
 796 #define WX_DEFINE_OBJARRAY(name) DidYouIncludeArrimplCpp
 797 #define WX_DEFINE_EXPORTED_OBJARRAY(name)   WX_DEFINE_OBJARRAY(name)
 798 #define WX_DEFINE_USER_EXPORTED_OBJARRAY(name)   WX_DEFINE_OBJARRAY(name)
 799
 800 // ----------------------------------------------------------------------------
 801 // Some commonly used predefined base arrays
 802 // ----------------------------------------------------------------------------
 803
 804 WX_DECLARE_USER_EXPORTED_BASEARRAY(const void *, wxBaseArrayPtrVoid,
 805                                    WXDLLIMPEXP_BASE);
 806 WX_DECLARE_USER_EXPORTED_BASEARRAY(short, wxBaseArrayShort, WXDLLIMPEXP_BASE);
 807 WX_DECLARE_USER_EXPORTED_BASEARRAY(int, wxBaseArrayInt, WXDLLIMPEXP_BASE);
 808 WX_DECLARE_USER_EXPORTED_BASEARRAY(long, wxBaseArrayLong, WXDLLIMPEXP_BASE);
 809 WX_DECLARE_USER_EXPORTED_BASEARRAY(double, wxBaseArrayDouble, WXDLLIMPEXP_BASE);
 810
 811 // ----------------------------------------------------------------------------
 812 // Convenience macros to define arrays from base arrays
 813 // ----------------------------------------------------------------------------
 814
 815 #define WX_DEFINE_ARRAY(T, name)                                       \
 816     WX_DEFINE_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
 817 #define WX_DEFINE_ARRAY_NO_PTR(T, name)                                \
 818     WX_DEFINE_TYPEARRAY_NO_PTR(T, name, wxBaseArrayPtrVoid)
 819 #define WX_DEFINE_EXPORTED_ARRAY(T, name)                              \
 820     WX_DEFINE_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
 821 #define WX_DEFINE_EXPORTED_ARRAY_NO_PTR(T, name)                       \
 822     WX_DEFINE_EXPORTED_TYPEARRAY_NO_PTR(T, name, wxBaseArrayPtrVoid)
 823 #define WX_DEFINE_ARRAY_WITH_DECL_NO_PTR(T, name, decl)                \
 824     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, wxBaseArrayPtrVoid, decl)
 825 #define WX_DEFINE_USER_EXPORTED_ARRAY(T, name, expmode)                \
 826     WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, wxBaseArrayPtrVoid, expmode)
 827 #define WX_DEFINE_USER_EXPORTED_ARRAY_NO_PTR(T, name, expmode)         \
 828     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, wxBaseArrayPtrVoid, expmode)
 829
 830 #define WX_DEFINE_ARRAY_SHORT(T, name)                                 \
 831     WX_DEFINE_TYPEARRAY_NO_PTR(T, name, wxBaseArrayShort)
 832 #define WX_DEFINE_EXPORTED_ARRAY_SHORT(T, name)                        \
 833     WX_DEFINE_EXPORTED_TYPEARRAY_NO_PTR(T, name, wxBaseArrayShort)
 834 #define WX_DEFINE_USER_EXPORTED_ARRAY_SHORT(T, name, expmode)          \
 835     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, wxBaseArrayShort, expmode)
 836
 837 #define WX_DEFINE_ARRAY_INT(T, name)                                   \
 838     WX_DEFINE_TYPEARRAY_NO_PTR(T, name, wxBaseArrayInt)
 839 #define WX_DEFINE_EXPORTED_ARRAY_INT(T, name)                          \
 840     WX_DEFINE_EXPORTED_TYPEARRAY_NO_PTR(T, name, wxBaseArrayInt)
 841 #define WX_DEFINE_USER_EXPORTED_ARRAY_INT(T, name, expmode)            \
 842     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, wxBaseArrayInt, expmode)
 843
 844 #define WX_DEFINE_ARRAY_LONG(T, name)                                  \
 845     WX_DEFINE_TYPEARRAY_NO_PTR(T, name, wxBaseArrayLong)
 846 #define WX_DEFINE_EXPORTED_ARRAY_LONG(T, name)                         \
 847     WX_DEFINE_EXPORTED_TYPEARRAY_NO_PTR(T, name, wxBaseArrayLong)
 848 #define WX_DEFINE_USER_EXPORTED_ARRAY_LONG(T, name, expmode)           \
 849     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, wxBaseArrayLong, expmode)
 850
 851 #define WX_DEFINE_ARRAY_DOUBLE(T, name)                                \
 852     WX_DEFINE_TYPEARRAY_NO_PTR(T, name, wxBaseArrayDouble)
 853 #define WX_DEFINE_EXPORTED_ARRAY_DOUBLE(T, name)                       \
 854     WX_DEFINE_EXPORTED_TYPEARRAY_NO_PTR(T, name, wxBaseArrayDouble)
 855 #define WX_DEFINE_USER_EXPORTED_ARRAY_DOUBLE(T, name, expmode)         \
 856     WX_DEFINE_TYPEARRAY_WITH_DECL_NO_PTR(T, name, wxBaseArrayDouble, expmode)
 857
 858 // ----------------------------------------------------------------------------
 859 // Convenience macros to define sorted arrays from base arrays
 860 // ----------------------------------------------------------------------------
 861
 862 #define WX_DEFINE_SORTED_ARRAY(T, name)                                \
 863     WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
 864 #define WX_DEFINE_SORTED_EXPORTED_ARRAY(T, name)                       \
 865     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
 866 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(T, name, expmode)         \
 867     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid, expmode)
 868
 869 #define WX_DEFINE_SORTED_ARRAY_SHORT(T, name)                          \
 870     WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayShort)
 871 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_SHORT(T, name)                 \
 872     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort)
 873 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SHORT(T, name, expmode)   \
 874     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort, expmode)
 875
 876 #define WX_DEFINE_SORTED_ARRAY_INT(T, name)                            \
 877     WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayInt)
 878 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_INT(T, name)                   \
 879     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt)
 880 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT(T, name, expmode)     \
 881     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt, expmode)
 882
 883 #define WX_DEFINE_SORTED_ARRAY_LONG(T, name)                           \
 884     WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayLong)
 885 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_LONG(T, name)                  \
 886     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong)
 887 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_LONG(T, name, expmode)    \
 888     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong, expmode)
 889
 890 // ----------------------------------------------------------------------------
 891 // Convenience macros to define sorted arrays from base arrays
 892 // ----------------------------------------------------------------------------
 893
 894 #define WX_DEFINE_SORTED_ARRAY_CMP(T, cmpfunc, name)                   \
 895     WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayPtrVoid)
 896 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP(T, cmpfunc, name)          \
 897     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayPtrVoid)
 898 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP(T, cmpfunc,           \
 899                                                      name, expmode)    \
 900     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name,     \
 901                                                  wxBaseArrayPtrVoid, expmode)
 902
 903 #define WX_DEFINE_SORTED_ARRAY_CMP_SHORT(T, cmpfunc, name)             \
 904     WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayShort)
 905 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_SHORT(T, cmpfunc, name)    \
 906     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayShort)
 907 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_SHORT(T, cmpfunc,     \
 908                                                        name, expmode)  \
 909     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name,     \
 910                                                  wxBaseArrayShort, expmode)
 911
 912 #define WX_DEFINE_SORTED_ARRAY_CMP_INT(T, cmpfunc, name)               \
 913     WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayInt)
 914 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_INT(T, cmpfunc, name)      \
 915     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayInt)
 916 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_INT(T, cmpfunc,       \
 917                                                      name, expmode)    \
 918     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name,     \
 919                                                  wxBaseArrayInt, expmode)
 920
 921 #define WX_DEFINE_SORTED_ARRAY_CMP_LONG(T, cmpfunc, name)              \
 922     WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayLong)
 923 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_LONG(T, cmpfunc, name)     \
 924     WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayLong)
 925 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_LONG(T, cmpfunc,      \
 926                                                       name, expmode)   \
 927     WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name,     \
 928                                                  wxBaseArrayLong, expmode)
 929
 930 // ----------------------------------------------------------------------------
 931 // Some commonly used predefined arrays
 932 // ----------------------------------------------------------------------------
 933
 934 WX_DEFINE_USER_EXPORTED_ARRAY_SHORT(short, wxArrayShort, class WXDLLIMPEXP_BASE);
 935 WX_DEFINE_USER_EXPORTED_ARRAY_INT(int, wxArrayInt, class WXDLLIMPEXP_BASE);
 936 WX_DEFINE_USER_EXPORTED_ARRAY_LONG(long, wxArrayLong, class WXDLLIMPEXP_BASE);
 937 WX_DEFINE_USER_EXPORTED_ARRAY_NO_PTR(void *, wxArrayPtrVoid, class WXDLLIMPEXP_BASE);
 938
 939 // -----------------------------------------------------------------------------
 940 // convenience macros
 941 // -----------------------------------------------------------------------------
 942
 943 // append all element of one array to another one
 944 #define WX_APPEND_ARRAY(array, other)                                         \
 945     {                                                                         \
 946         size_t count = (other).size();                                        \
 947         for ( size_t n = 0; n < count; n++ )                                  \
 948         {                                                                     \
 949             (array).push_back((other)[n]);                                    \
 950         }                                                                     \
 951     }
 952
 953 // delete all array elements
 954 //
 955 // NB: the class declaration of the array elements must be visible from the
 956 //     place where you use this macro, otherwise the proper destructor may not
 957 //     be called (a decent compiler should give a warning about it, but don't
 958 //     count on it)!
 959 #define WX_CLEAR_ARRAY(array)                                                 \
 960     {                                                                         \
 961         size_t count = (array).size();                                        \
 962         for ( size_t n = 0; n < count; n++ )                                  \
 963         {                                                                     \
 964             delete (array)[n];                                                \
 965         }                                                                     \
 966                                                                               \
 967         (array).clear();                                                      \
 968     }
 969
 970 #endif // _DYNARRAY_H
 971