1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: auto-resizable (i.e. dynamic) array support
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && \
16 !(defined(__MINGW32__) && __GNUC__ == 3 && __GNUC_MINOR__ == 2)
17 #pragma interface "dynarray.h"
23 #include "wx/beforestd.h"
26 #include "wx/afterstd.h"
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
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
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
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.
51 // ----------------------------------------------------------------------------
53 // ----------------------------------------------------------------------------
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
60 #define WX_ARRAY_DEFAULT_INITIAL_SIZE (16)
62 // ----------------------------------------------------------------------------
64 // ----------------------------------------------------------------------------
67 Callback compare function for quick sort.
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.
74 typedef int (wxCMPFUNC_CONV
*CMPFUNC
)(const void* pItem1
, const void* pItem2
);
77 // ----------------------------------------------------------------------------
78 // Base class managing data having size of type 'long' (not used directly)
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 // ----------------------------------------------------------------------------
90 class WXDLLIMPEXP_BASE wxArray_SortFunction
93 typedef int (wxCMPFUNC_CONV
*CMPFUNC
)(T
* pItem1
, T
* pItem2
);
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; }
102 template<class T
, typename F
>
103 class WXDLLIMPEXP_BASE wxSortedArray_SortFunction
108 wxSortedArray_SortFunction(CMPFUNC f
) : m_f(f
) { }
109 bool operator()(const T
& i1
, const T
& i2
)
110 { return m_f(i1
, i2
) < 0; }
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)
120 #define _WX_DECLARE_BASEARRAY_2(T, name, predicate, classexp) \
121 classexp name : public std::vector<T> \
123 typedef predicate Predicate; \
124 typedef predicate::CMPFUNC SCMPFUNC; \
126 typedef wxArray_SortFunction<T>::CMPFUNC CMPFUNC; \
128 void Empty() { clear(); } \
129 void Clear() { clear(); } \
130 void Alloc(size_t uiSize) { reserve(uiSize); } \
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(); } \
138 typedef T base_type; \
141 T& Item(size_t uiIndex) const \
142 { wxASSERT( uiIndex < size() ); return (T&)operator[](uiIndex); } \
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); } \
156 void Sort(CMPFUNC fCmp) \
158 wxArray_SortFunction<T> p(fCmp); \
159 std::sort(begin(), end(), p); \
163 #else // if !wxUSE_STL
165 #define _WX_DECLARE_BASEARRAY(T, name, classexp) \
168 typedef CMPFUNC SCMPFUNC; /* for compatibility wuth wxUSE_STL */ \
171 name(const name& array); \
172 name& operator=(const name& src); \
175 void Empty() { m_nCount = 0; } \
177 void Alloc(size_t uiSize); \
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; } \
185 typedef T base_type; \
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); } \
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); \
201 void Sort(CMPFUNC fnCompare); \
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; \
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 iterator erase(iterator first, iterator last) \
217 size_type idx = first - begin(); \
218 RemoveAt(idx, last - first); \
219 return begin() + idx; \
221 iterator erase(iterator it) { return erase(it, it + 1); } \
222 void insert(iterator it, size_type n, const value_type& v) \
223 { Insert(v, it - begin(), n); } \
224 iterator insert(iterator it, const value_type& v = value_type()) \
226 size_type idx = it - begin(); \
228 return begin() + idx; \
230 void insert(iterator it, const_iterator first, const_iterator last);\
231 void pop_back() { RemoveAt(size() - 1); } \
232 void push_back(const value_type& v) { Add(v); } \
233 void reserve(size_type n) { if(n > m_nSize) Realloc(n); } \
234 void resize(size_type n, value_type v = value_type()); \
236 iterator begin() { return m_pItems; } \
237 iterator end() { return m_pItems + m_nCount; } \
238 const_iterator begin() const { return m_pItems; } \
239 const_iterator end() const { return m_pItems + m_nCount; } \
241 /* the following functions may be made directly public because */ \
242 /* they don't use the type of the elements at all */ \
244 void clear() { Clear(); } \
245 bool empty() const { return IsEmpty(); } \
246 size_type max_size() const { return INT_MAX; } \
247 size_type size() const { return GetCount(); } \
250 void Grow(size_t nIncrement = 0); \
251 bool Realloc(size_t nSize); \
261 // ============================================================================
262 // The private helper macros containing the core of the array classes
263 // ============================================================================
265 // Implementation notes:
267 // JACS: Salford C++ doesn't like 'var->operator=' syntax, as in:
268 // { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
269 // so using a temporary variable instead.
271 // The classes need a (even trivial) ~name() to link under Mac X
273 // _WX_ERROR_REMOVE is needed to resolve the name conflict between the wxT()
274 // macro and T typedef: we can't use wxT() inside WX_DEFINE_ARRAY!
276 #define _WX_ERROR_REMOVE wxT("removing inexisting element in wxArray::Remove")
278 // ----------------------------------------------------------------------------
279 // _WX_DEFINE_TYPEARRAY: array for simple types
280 // ----------------------------------------------------------------------------
284 #define _WX_DEFINE_TYPEARRAY(T, name, base, classexp) \
285 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2); \
286 classexp name : public base \
289 T& operator[](size_t uiIndex) const \
290 { return (T&)(base::operator[](uiIndex)); } \
291 T& Item(size_t uiIndex) const \
292 { return (T&)/*const cast*/base::operator[](uiIndex); } \
294 { return Item(Count() - 1); } \
296 int Index(T e, bool bFromEnd = FALSE) const \
297 { return base::Index(e, bFromEnd); } \
299 void Add(T Item, size_t nInsert = 1) \
300 { insert(end(), nInsert, Item); } \
301 void Insert(T Item, size_t uiIndex, size_t nInsert = 1) \
302 { insert(begin() + uiIndex, nInsert, Item); } \
304 void RemoveAt(size_t uiIndex, size_t nRemove = 1) \
305 { base::RemoveAt(uiIndex, nRemove); } \
306 void Remove(T Item) \
307 { int iIndex = Index(Item); \
308 wxCHECK2_MSG( iIndex != wxNOT_FOUND, return, \
310 RemoveAt((size_t)iIndex); } \
312 void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC)fCmp); } \
315 #define _WX_DEFINE_TYPEARRAY_PTR(T, name, base, classexp) \
316 _WX_DEFINE_TYPEARRAY(T, name, base, classexp)
318 #else // if !wxUSE_STL
320 // common declaration used by both _WX_DEFINE_TYPEARRAY and
321 // _WX_DEFINE_TYPEARRAY_PTR
322 #define _WX_DEFINE_TYPEARRAY_HELPER(T, name, base, classexp, ptrop) \
323 wxCOMPILE_TIME_ASSERT2(sizeof(T) <= sizeof(base::base_type), \
324 TypeTooBigToBeStoredIn##base, \
326 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2); \
327 classexp name : public base \
333 name& operator=(const name& src) \
334 { base* temp = (base*) this; \
335 (*temp) = ((const base&)src); \
338 T& operator[](size_t uiIndex) const \
339 { return (T&)(base::operator[](uiIndex)); } \
340 T& Item(size_t uiIndex) const \
341 { return (T&)(base::operator[](uiIndex)); } \
343 { return (T&)(base::operator[](Count() - 1)); } \
345 int Index(T Item, bool bFromEnd = FALSE) const \
346 { return base::Index((base_type)Item, bFromEnd); } \
348 void Add(T Item, size_t nInsert = 1) \
349 { base::Add((base_type)Item, nInsert); } \
350 void Insert(T Item, size_t uiIndex, size_t nInsert = 1) \
351 { base::Insert((base_type)Item, uiIndex, nInsert) ; } \
353 void RemoveAt(size_t uiIndex, size_t nRemove = 1) \
354 { base::RemoveAt(uiIndex, nRemove); } \
355 void Remove(T Item) \
356 { int iIndex = Index(Item); \
357 wxCHECK2_MSG( iIndex != wxNOT_FOUND, return, \
359 base::RemoveAt((size_t)iIndex); } \
361 void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC)fCmp); } \
363 /* STL-like interface */ \
365 typedef base::iterator biterator; \
366 typedef base::const_iterator bconst_iterator; \
367 typedef base::value_type bvalue_type; \
368 typedef base::const_reference bconst_reference; \
370 typedef T value_type; \
371 typedef value_type* pointer; \
372 typedef const value_type* const_pointer; \
373 typedef value_type* iterator; \
374 typedef const value_type* const_iterator; \
375 typedef value_type& reference; \
376 typedef const value_type& const_reference; \
377 typedef base::difference_type difference_type; \
378 typedef base::size_type size_type; \
380 class reverse_iterator \
382 typedef T value_type; \
383 typedef value_type& reference; \
384 typedef value_type* pointer; \
385 typedef reverse_iterator itor; \
386 friend inline itor operator+(int o, const itor& it) \
387 { return it.m_ptr - o; } \
388 friend inline itor operator+(const itor& it, int o) \
389 { return it.m_ptr - o; } \
390 friend inline itor operator-(const itor& it, int o) \
391 { return it.m_ptr + o; } \
392 friend inline difference_type operator-(const itor& i1, \
394 { return i1.m_ptr - i2.m_ptr; } \
398 reverse_iterator() : m_ptr(NULL) { } \
399 reverse_iterator(pointer ptr) : m_ptr(ptr) { } \
400 reverse_iterator(const itor& it) : m_ptr(it.m_ptr) { } \
401 reference operator*() const { return *m_ptr; } \
403 itor operator++() { --m_ptr; return *this; } \
404 itor operator++(int) \
405 { reverse_iterator tmp = *this; --m_ptr; return tmp; } \
406 itor operator--() { ++m_ptr; return *this; } \
407 itor operator--(int) { itor tmp = *this; ++m_ptr; return tmp; } \
408 bool operator ==(const itor& it) { return m_ptr == it.m_ptr; } \
409 bool operator !=(const itor& it) { return m_ptr != it.m_ptr; } \
412 class const_reverse_iterator \
414 typedef T value_type; \
415 typedef const value_type& reference; \
416 typedef const value_type* pointer; \
417 typedef const_reverse_iterator itor; \
418 friend inline itor operator+(int o, const itor& it) \
419 { return it.m_ptr - o; } \
420 friend inline itor operator+(const itor& it, int o) \
421 { return it.m_ptr - o; } \
422 friend inline itor operator-(const itor& it, int o) \
423 { return it.m_ptr + o; } \
424 friend inline difference_type operator-(const itor& i1, \
426 { return i1.m_ptr - i2.m_ptr; } \
430 const_reverse_iterator() : m_ptr(NULL) { } \
431 const_reverse_iterator(pointer ptr) : m_ptr(ptr) { } \
432 const_reverse_iterator(const itor& it) : m_ptr(it.m_ptr) { } \
433 const_reverse_iterator(const reverse_iterator& it) : m_ptr(it.m_ptr) { }\
434 reference operator*() const { return *m_ptr; } \
436 itor operator++() { --m_ptr; return *this; } \
437 itor operator++(int) \
438 { itor tmp = *this; --m_ptr; return tmp; } \
439 itor operator--() { ++m_ptr; return *this; } \
440 itor operator--(int) { itor tmp = *this; ++m_ptr; return tmp; } \
441 bool operator ==(const itor& it) { return m_ptr == it.m_ptr; } \
442 bool operator !=(const itor& it) { return m_ptr != it.m_ptr; } \
445 name(size_type n, const_reference v) { assign(n, v); } \
446 name(const_iterator first, const_iterator last) \
447 { assign(first, last); } \
448 void assign(const_iterator first, const_iterator last) \
449 { base::assign((bconst_iterator)first, (bconst_iterator)last); } \
450 void assign(size_type n, const_reference v) \
451 { base::assign(n, (bconst_reference)v); } \
452 reference back() { return *(end() - 1); } \
453 const_reference back() const { return *(end() - 1); } \
454 iterator begin() { return (iterator)base::begin(); } \
455 const_iterator begin() const { return (const_iterator)base::begin(); }\
456 size_type capacity() const { return base::capacity(); } \
457 iterator end() { return (iterator)base::end(); } \
458 const_iterator end() const { return (const_iterator)base::end(); } \
459 iterator erase(iterator first, iterator last) \
460 { return (iterator)base::erase((biterator)first, (biterator)last); }\
461 iterator erase(iterator it) \
462 { return (iterator)base::erase((biterator)it); } \
463 reference front() { return *begin(); } \
464 const_reference front() const { return *begin(); } \
465 void insert(iterator it, size_type n, const_reference v) \
466 { base::insert((biterator)it, n, (bconst_reference)v); } \
467 iterator insert(iterator it, const_reference v = value_type()) \
468 { return (iterator)base::insert((biterator)it, (bconst_reference)v); }\
469 void insert(iterator it, const_iterator first, const_iterator last) \
470 { base::insert((biterator)it, (bconst_iterator)first, \
471 (bconst_iterator)last); } \
472 void pop_back() { base::pop_back(); } \
473 void push_back(const_reference v) \
474 { base::push_back((bconst_reference)v); } \
475 reverse_iterator rbegin() { return reverse_iterator(end() - 1); } \
476 const_reverse_iterator rbegin() const; \
477 reverse_iterator rend() { return reverse_iterator(begin() - 1); } \
478 const_reverse_iterator rend() const; \
479 void reserve(size_type n) { base::reserve(n); }; \
480 void resize(size_type n, value_type v = value_type()); \
483 #define _WX_PTROP pointer operator->() const { return m_ptr; }
484 #define _WX_PTROP_NONE
486 #define _WX_DEFINE_TYPEARRAY(T, name, base, classexp) \
487 _WX_DEFINE_TYPEARRAY_HELPER(T, name, base, classexp, _WX_PTROP)
488 #define _WX_DEFINE_TYPEARRAY_PTR(T, name, base, classexp) \
489 _WX_DEFINE_TYPEARRAY_HELPER(T, name, base, classexp, _WX_PTROP_NONE)
493 // ----------------------------------------------------------------------------
494 // _WX_DEFINE_SORTED_TYPEARRAY: sorted array for simple data types
495 // cannot handle types with size greater than pointer because of sorting
496 // ----------------------------------------------------------------------------
498 #define _WX_DEFINE_SORTED_TYPEARRAY_2(T, name, base, defcomp, classexp, comptype)\
499 wxCOMPILE_TIME_ASSERT2(sizeof(T) <= sizeof(base::base_type), \
500 TypeTooBigToBeStoredInSorted##base, \
502 classexp name : public base \
504 typedef comptype SCMPFUNC; \
506 name(comptype fn defcomp) { m_fnCompare = fn; } \
508 name& operator=(const name& src) \
509 { base* temp = (base*) this; \
510 (*temp) = ((const base&)src); \
511 m_fnCompare = src.m_fnCompare; \
514 T& operator[](size_t uiIndex) const \
515 { return (T&)(base::operator[](uiIndex)); } \
516 T& Item(size_t uiIndex) const \
517 { return (T&)(base::operator[](uiIndex)); } \
519 { return (T&)(base::operator[](size() - 1)); } \
521 int Index(T Item) const \
522 { return base::Index(Item, (CMPFUNC)m_fnCompare); } \
524 size_t IndexForInsert(T Item) const \
525 { return base::IndexForInsert(Item, (CMPFUNC)m_fnCompare); } \
527 void AddAt(T item, size_t index) \
528 { base::insert(begin() + index, item); } \
531 { return base::Add(Item, (CMPFUNC)m_fnCompare); } \
533 void RemoveAt(size_t uiIndex, size_t nRemove = 1) \
534 { base::erase(begin() + uiIndex, begin() + uiIndex + nRemove); } \
535 void Remove(T Item) \
536 { int iIndex = Index(Item); \
537 wxCHECK2_MSG( iIndex != wxNOT_FOUND, return, \
538 _WX_ERROR_REMOVE ); \
539 base::erase(begin() + iIndex); } \
542 comptype m_fnCompare; \
546 // ----------------------------------------------------------------------------
547 // _WX_DECLARE_OBJARRAY: an array for pointers to type T with owning semantics
548 // ----------------------------------------------------------------------------
550 #define _WX_DECLARE_OBJARRAY(T, name, base, classexp) \
551 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T **pItem1, T **pItem2); \
552 classexp name : protected base \
554 typedef int (CMPFUNC_CONV *CMPFUNC##base)(void **pItem1, void **pItem2); \
555 typedef base base_array; \
558 name(const name& src); \
559 name& operator=(const name& src); \
563 void Alloc(size_t count) { reserve(count); } \
564 size_t GetCount() const { return base_array::size(); } \
565 size_t size() const { return base_array::size(); } \
566 bool IsEmpty() const { return base_array::empty(); } \
567 size_t Count() const { return base_array::size(); } \
568 void Shrink() { base::Shrink(); } \
570 T& operator[](size_t uiIndex) const \
571 { return *(T*)base::operator[](uiIndex); } \
572 T& Item(size_t uiIndex) const \
573 { return *(T*)base::operator[](uiIndex); } \
575 { return *(T*)(base::operator[](size() - 1)); } \
577 int Index(const T& Item, bool bFromEnd = FALSE) const; \
579 void Add(const T& Item, size_t nInsert = 1); \
580 void Add(const T* pItem) \
581 { base::push_back((T*)pItem); } \
582 void push_back(const T* pItem) \
583 { base::push_back((T*)pItem); } \
584 void push_back(const T& Item) \
587 void Insert(const T& Item, size_t uiIndex, size_t nInsert = 1); \
588 void Insert(const T* pItem, size_t uiIndex) \
589 { base::insert(begin() + uiIndex, (T*)pItem); } \
591 void Empty() { DoEmpty(); base::clear(); } \
592 void Clear() { DoEmpty(); base::clear(); } \
594 T* Detach(size_t uiIndex) \
595 { T* p = (T*)base::operator[](uiIndex); \
596 base::erase(begin() + uiIndex); return p; } \
597 void RemoveAt(size_t uiIndex, size_t nRemove = 1); \
599 void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC##base)fCmp); } \
603 void DoCopy(const name& src); \
606 // ============================================================================
607 // The public macros for declaration and definition of the dynamic arrays
608 // ============================================================================
610 // Please note that for each macro WX_FOO_ARRAY we also have
611 // WX_FOO_EXPORTED_ARRAY and WX_FOO_USER_EXPORTED_ARRAY which are exactly the
612 // same except that they use an additional __declspec(dllexport) or equivalent
613 // under Windows if needed.
615 // The first (just EXPORTED) macros do it if wxWindows was compiled as a DLL
616 // and so must be used used inside the library. The second kind (USER_EXPORTED)
617 // allow the user code to do it when it wants. This is needed if you have a dll
618 // that wants to export a wxArray daubed with your own import/export goo.
620 // Finally, you can define the macro below as something special to modify the
621 // arrays defined by a simple WX_FOO_ARRAY as well. By default is is empty.
622 #define wxARRAY_DEFAULT_EXPORT
624 // ----------------------------------------------------------------------------
625 // WX_DECLARE_BASEARRAY(T, name) declare an array class named "name" containing
626 // the elements of type T
627 // ----------------------------------------------------------------------------
629 #define WX_DECLARE_BASEARRAY(T, name) \
630 WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, wxARRAY_DEFAULT_EXPORT)
632 #define WX_DECLARE_EXPORTED_BASEARRAY(T, name) \
633 WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, WXDLLEXPORT)
635 #define WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, expmode) \
636 typedef T _wxArray##name; \
637 _WX_DECLARE_BASEARRAY(_wxArray##name, name, class expmode)
639 // ----------------------------------------------------------------------------
640 // WX_DEFINE_TYPEARRAY(T, name, base) define an array class named "name" deriving
641 // from class "base" containing the elements of type T
643 // Note that the class defined has only inline function and doesn't take any
644 // space at all so there is no size penalty for defining multiple array classes
645 // ----------------------------------------------------------------------------
647 #define WX_DEFINE_TYPEARRAY(T, name, base) \
648 WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, class wxARRAY_DEFAULT_EXPORT)
650 #define WX_DEFINE_TYPEARRAY_PTR(T, name, base) \
651 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, base, class wxARRAY_DEFAULT_EXPORT)
653 #define WX_DEFINE_EXPORTED_TYPEARRAY(T, name, base) \
654 WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, class WXDLLEXPORT)
656 #define WX_DEFINE_EXPORTED_TYPEARRAY_PTR(T, name, base) \
657 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, base, class WXDLLEXPORT)
659 #define WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, base, expdecl) \
660 WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, class expdecl)
662 #define WX_DEFINE_USER_EXPORTED_TYPEARRAY_PTR(T, name, base, expdecl) \
663 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, base, class expdecl)
665 #define WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, base, classdecl) \
666 typedef T _wxArray##name; \
667 _WX_DEFINE_TYPEARRAY(_wxArray##name, name, base, classdecl)
669 #define WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, base, classdecl) \
670 typedef T _wxArray##name; \
671 _WX_DEFINE_TYPEARRAY_PTR(_wxArray##name, name, base, classdecl)
673 // ----------------------------------------------------------------------------
674 // WX_DEFINE_SORTED_TYPEARRAY: this is the same as the previous macro, but it
675 // defines a sorted array.
678 // 1) it must be given a COMPARE function in ctor which takes 2 items of type
679 // T* and should return -1, 0 or +1 if the first one is less/greater
680 // than/equal to the second one.
681 // 2) the Add() method inserts the item in such was that the array is always
682 // sorted (it uses the COMPARE function)
683 // 3) it has no Sort() method because it's always sorted
684 // 4) Index() method is much faster (the sorted arrays use binary search
685 // instead of linear one), but Add() is slower.
686 // 5) there is no Insert() method because you can't insert an item into the
687 // given position in a sorted array but there is IndexForInsert()/AddAt()
688 // pair which may be used to optimize a common operation of "insert only if
691 // Note that you have to specify the comparison function when creating the
692 // objects of this array type. If, as in 99% of cases, the comparison function
693 // is the same for all objects of a class, WX_DEFINE_SORTED_TYPEARRAY_CMP below
694 // is more convenient.
696 // Summary: use this class when the speed of Index() function is important, use
697 // the normal arrays otherwise.
698 // ----------------------------------------------------------------------------
700 #define wxARRAY_EMPTY_CMP
702 #define WX_DEFINE_SORTED_TYPEARRAY(T, name, base) \
703 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, \
704 wxARRAY_DEFAULT_EXPORT)
706 #define WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, base) \
707 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, WXDLLEXPORT)
709 #define WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, expmode) \
710 typedef T _wxArray##name; \
711 typedef int (CMPFUNC_CONV *SCMPFUNC##name)(T pItem1, T pItem2); \
712 _WX_DEFINE_SORTED_TYPEARRAY_2(_wxArray##name, name, base, \
713 wxARRAY_EMPTY_CMP, class expmode, SCMPFUNC##name)
715 // ----------------------------------------------------------------------------
716 // WX_DEFINE_SORTED_TYPEARRAY_CMP: exactly the same as above but the comparison
717 // function is provided by this macro and the objects of this class have a
718 // default constructor which just uses it.
720 // The arguments are: the element type, the comparison function and the array
723 // NB: this is, of course, how WX_DEFINE_SORTED_TYPEARRAY() should have worked
724 // from the very beginning - unfortunately I didn't think about this earlier
725 // ----------------------------------------------------------------------------
727 #define WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, base) \
728 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base, \
729 wxARRAY_DEFAULT_EXPORT)
731 #define WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base) \
732 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base, \
735 #define WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base, \
737 typedef T _wxArray##name; \
738 typedef int (CMPFUNC_CONV *SCMPFUNC##name)(T pItem1, T pItem2); \
739 _WX_DEFINE_SORTED_TYPEARRAY_2(_wxArray##name, name, base, = cmpfunc, \
740 class expmode, SCMPFUNC##name)
742 // ----------------------------------------------------------------------------
743 // WX_DECLARE_OBJARRAY(T, name): this macro generates a new array class
744 // named "name" which owns the objects of type T it contains, i.e. it will
745 // delete them when it is destroyed.
747 // An element is of type T*, but arguments of type T& are taken (see below!)
748 // and T& is returned.
750 // Don't use this for simple types such as "int" or "long"!
752 // Note on Add/Insert functions:
753 // 1) function(T*) gives the object to the array, i.e. it will delete the
754 // object when it's removed or in the array's dtor
755 // 2) function(T&) will create a copy of the object and work with it
758 // 1) Remove() will delete the object after removing it from the array
759 // 2) Detach() just removes the object from the array (returning pointer to it)
761 // NB1: Base type T should have an accessible copy ctor if Add(T&) is used
762 // NB2: Never ever cast a array to it's base type: as dtor is not virtual
763 // and so you risk having at least the memory leaks and probably worse
765 // Some functions of this class are not inline, so it takes some space to
766 // define new class from this template even if you don't use it - which is not
767 // the case for the simple (non-object) array classes
769 // To use an objarray class you must
770 // #include "dynarray.h"
771 // WX_DECLARE_OBJARRAY(element_type, list_class_name)
772 // #include "arrimpl.cpp"
773 // WX_DEFINE_OBJARRAY(list_class_name) // name must be the same as above!
775 // This is necessary because at the moment of DEFINE_OBJARRAY class parsing the
776 // element_type must be fully defined (i.e. forward declaration is not
777 // enough), while WX_DECLARE_OBJARRAY may be done anywhere. The separation of
778 // two allows to break cicrcular dependencies with classes which have member
779 // variables of objarray type.
780 // ----------------------------------------------------------------------------
782 #define WX_DECLARE_OBJARRAY(T, name) \
783 WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, wxARRAY_DEFAULT_EXPORT)
785 #define WX_DECLARE_EXPORTED_OBJARRAY(T, name) \
786 WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, WXDLLEXPORT)
788 #define WX_DECLARE_OBJARRAY_WITH_DECL(T, name, decl) \
789 typedef T _wxObjArray##name; \
790 _WX_DECLARE_OBJARRAY(_wxObjArray##name, name, wxArrayPtrVoid, decl)
792 #define WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, expmode) \
793 WX_DECLARE_OBJARRAY_WITH_DECL(T, name, class expmode)
795 // WX_DEFINE_OBJARRAY is going to be redefined when arrimpl.cpp is included,
796 // try to provoke a human-understandable error if it used incorrectly.
798 // there is no real need for 3 different macros in the DEFINE case but do it
799 // anyhow for consistency
800 #define WX_DEFINE_OBJARRAY(name) DidYouIncludeArrimplCpp
801 #define WX_DEFINE_EXPORTED_OBJARRAY(name) WX_DEFINE_OBJARRAY(name)
802 #define WX_DEFINE_USER_EXPORTED_OBJARRAY(name) WX_DEFINE_OBJARRAY(name)
804 // ----------------------------------------------------------------------------
805 // Some commonly used predefined base arrays
806 // ----------------------------------------------------------------------------
808 WX_DECLARE_USER_EXPORTED_BASEARRAY(const void *, wxBaseArrayPtrVoid
,
810 WX_DECLARE_USER_EXPORTED_BASEARRAY(short, wxBaseArrayShort
, WXDLLIMPEXP_BASE
);
811 WX_DECLARE_USER_EXPORTED_BASEARRAY(int, wxBaseArrayInt
, WXDLLIMPEXP_BASE
);
812 WX_DECLARE_USER_EXPORTED_BASEARRAY(long, wxBaseArrayLong
, WXDLLIMPEXP_BASE
);
813 WX_DECLARE_USER_EXPORTED_BASEARRAY(double, wxBaseArrayDouble
, WXDLLIMPEXP_BASE
);
815 // ----------------------------------------------------------------------------
816 // Convenience macros to define arrays from base arrays
817 // ----------------------------------------------------------------------------
819 #define WX_DEFINE_ARRAY(T, name) \
820 WX_DEFINE_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
821 #define WX_DEFINE_ARRAY_PTR(T, name) \
822 WX_DEFINE_TYPEARRAY_PTR(T, name, wxBaseArrayPtrVoid)
823 #define WX_DEFINE_EXPORTED_ARRAY(T, name) \
824 WX_DEFINE_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
825 #define WX_DEFINE_EXPORTED_ARRAY_PTR(T, name) \
826 WX_DEFINE_EXPORTED_TYPEARRAY_PTR(T, name, wxBaseArrayPtrVoid)
827 #define WX_DEFINE_ARRAY_WITH_DECL_PTR(T, name, decl) \
828 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, wxBaseArrayPtrVoid, decl)
829 #define WX_DEFINE_USER_EXPORTED_ARRAY(T, name, expmode) \
830 WX_DEFINE_TYPEARRAY_WITH_DECL(T, name, wxBaseArrayPtrVoid, expmode)
831 #define WX_DEFINE_USER_EXPORTED_ARRAY_PTR(T, name, expmode) \
832 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, wxBaseArrayPtrVoid, expmode)
834 #define WX_DEFINE_ARRAY_SHORT(T, name) \
835 WX_DEFINE_TYPEARRAY_PTR(T, name, wxBaseArrayShort)
836 #define WX_DEFINE_EXPORTED_ARRAY_SHORT(T, name) \
837 WX_DEFINE_EXPORTED_TYPEARRAY_PTR(T, name, wxBaseArrayShort)
838 #define WX_DEFINE_USER_EXPORTED_ARRAY_SHORT(T, name, expmode) \
839 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, wxBaseArrayShort, expmode)
841 #define WX_DEFINE_ARRAY_INT(T, name) \
842 WX_DEFINE_TYPEARRAY_PTR(T, name, wxBaseArrayInt)
843 #define WX_DEFINE_EXPORTED_ARRAY_INT(T, name) \
844 WX_DEFINE_EXPORTED_TYPEARRAY_PTR(T, name, wxBaseArrayInt)
845 #define WX_DEFINE_USER_EXPORTED_ARRAY_INT(T, name, expmode) \
846 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, wxBaseArrayInt, expmode)
848 #define WX_DEFINE_ARRAY_LONG(T, name) \
849 WX_DEFINE_TYPEARRAY_PTR(T, name, wxBaseArrayLong)
850 #define WX_DEFINE_EXPORTED_ARRAY_LONG(T, name) \
851 WX_DEFINE_EXPORTED_TYPEARRAY_PTR(T, name, wxBaseArrayLong)
852 #define WX_DEFINE_USER_EXPORTED_ARRAY_LONG(T, name, expmode) \
853 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, wxBaseArrayLong, expmode)
855 #define WX_DEFINE_ARRAY_DOUBLE(T, name) \
856 WX_DEFINE_TYPEARRAY_PTR(T, name, wxBaseArrayDouble)
857 #define WX_DEFINE_EXPORTED_ARRAY_DOUBLE(T, name) \
858 WX_DEFINE_EXPORTED_TYPEARRAY_PTR(T, name, wxBaseArrayDouble)
859 #define WX_DEFINE_USER_EXPORTED_ARRAY_DOUBLE(T, name, expmode) \
860 WX_DEFINE_TYPEARRAY_WITH_DECL_PTR(T, name, wxBaseArrayDouble, expmode)
862 // ----------------------------------------------------------------------------
863 // Convenience macros to define sorted arrays from base arrays
864 // ----------------------------------------------------------------------------
866 #define WX_DEFINE_SORTED_ARRAY(T, name) \
867 WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
868 #define WX_DEFINE_SORTED_EXPORTED_ARRAY(T, name) \
869 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
870 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(T, name, expmode) \
871 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid, expmode)
873 #define WX_DEFINE_SORTED_ARRAY_SHORT(T, name) \
874 WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayShort)
875 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_SHORT(T, name) \
876 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort)
877 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SHORT(T, name, expmode) \
878 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort, expmode)
880 #define WX_DEFINE_SORTED_ARRAY_INT(T, name) \
881 WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayInt)
882 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_INT(T, name) \
883 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt)
884 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT(T, name, expmode) \
885 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt, expmode)
887 #define WX_DEFINE_SORTED_ARRAY_LONG(T, name) \
888 WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayLong)
889 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_LONG(T, name) \
890 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong)
891 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_LONG(T, name, expmode) \
892 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong, expmode)
894 // ----------------------------------------------------------------------------
895 // Convenience macros to define sorted arrays from base arrays
896 // ----------------------------------------------------------------------------
898 #define WX_DEFINE_SORTED_ARRAY_CMP(T, cmpfunc, name) \
899 WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayPtrVoid)
900 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP(T, cmpfunc, name) \
901 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayPtrVoid)
902 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP(T, cmpfunc, \
904 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
905 wxBaseArrayPtrVoid, expmode)
907 #define WX_DEFINE_SORTED_ARRAY_CMP_SHORT(T, cmpfunc, name) \
908 WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayShort)
909 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_SHORT(T, cmpfunc, name) \
910 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayShort)
911 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_SHORT(T, cmpfunc, \
913 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
914 wxBaseArrayShort, expmode)
916 #define WX_DEFINE_SORTED_ARRAY_CMP_INT(T, cmpfunc, name) \
917 WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayInt)
918 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_INT(T, cmpfunc, name) \
919 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayInt)
920 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_INT(T, cmpfunc, \
922 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
923 wxBaseArrayInt, expmode)
925 #define WX_DEFINE_SORTED_ARRAY_CMP_LONG(T, cmpfunc, name) \
926 WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayLong)
927 #define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_LONG(T, cmpfunc, name) \
928 WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayLong)
929 #define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_LONG(T, cmpfunc, \
931 WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
932 wxBaseArrayLong, expmode)
934 // ----------------------------------------------------------------------------
935 // Some commonly used predefined arrays
936 // ----------------------------------------------------------------------------
938 WX_DEFINE_USER_EXPORTED_ARRAY_SHORT(short, wxArrayShort
, class WXDLLIMPEXP_BASE
);
939 WX_DEFINE_USER_EXPORTED_ARRAY_INT(int, wxArrayInt
, class WXDLLIMPEXP_BASE
);
940 WX_DEFINE_USER_EXPORTED_ARRAY_LONG(long, wxArrayLong
, class WXDLLIMPEXP_BASE
);
941 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(void *, wxArrayPtrVoid
, class WXDLLIMPEXP_BASE
);
943 // -----------------------------------------------------------------------------
944 // convenience macros
945 // -----------------------------------------------------------------------------
947 // append all element of one array to another one
948 #define WX_APPEND_ARRAY(array, other) \
950 size_t count = (other).size(); \
951 for ( size_t n = 0; n < count; n++ ) \
953 (array).push_back((other)[n]); \
957 // delete all array elements
959 // NB: the class declaration of the array elements must be visible from the
960 // place where you use this macro, otherwise the proper destructor may not
961 // be called (a decent compiler should give a warning about it, but don't
963 #define WX_CLEAR_ARRAY(array) \
965 size_t count = (array).size(); \
966 for ( size_t n = 0; n < count; n++ ) \
974 #endif // _DYNARRAY_H