X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fbcb41664baa3006deb0a6d27ad1193fa792ea5e..19e30148e18cc99296b26503c155e5cef59045f4:/include/wx/dynarray.h
diff --git a/include/wx/dynarray.h b/include/wx/dynarray.h
index 022701069e..1a7bf28d2f 100644
--- a/include/wx/dynarray.h
+++ b/include/wx/dynarray.h
@@ -17,189 +17,326 @@
#endif
#include "wx/defs.h"
-#include "wx/debug.h"
-/** @name Dynamic arrays and lists
- @memo Arrays which grow on demand and do range checking (only in debug)
- */
-//@{
+/*
+ This header defines the dynamic arrays and object arrays (i.e. arrays which
+ own their elements). Dynamic means that the arrays grow automatically as
+ needed.
+
+ These macros are ugly (especially if you look in the sources ;-), but they
+ allow us to define "template" classes without actually using templates and so
+ this works with all compilers (and may be also much faster to compile even
+ with a compiler which does support templates). The arrays defined with these
+ macros are type-safe.
+
+ Range checking is performed in debug build for both arrays and objarrays but
+ not in release build - so using an invalid index will just lead to a crash
+ then.
+
+ Note about memory usage: arrays never shrink automatically (although you may
+ use Shrink() function explicitly), they only grow, so loading 10 millions in
+ an array only to delete them 2 lines below might be a bad idea if the array
+ object is not going to be destroyed soon. However, as it does free memory
+ when destroyed, it is ok if the array is a local variable.
+ */
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
-/**
- the initial size by which an array/list grows when an element is added
- default value avoids allocate one or two bytes when the array is created
- which is rather inefficient
+/*
+ The initial size by which an array grows when an element is added default
+ value avoids allocate one or two bytes when the array is created which is
+ rather inefficient
*/
-#define WX_ARRAY_DEFAULT_INITIAL_SIZE (16)
+#define WX_ARRAY_DEFAULT_INITIAL_SIZE (16)
// ----------------------------------------------------------------------------
// types
// ----------------------------------------------------------------------------
-/**
- callback compare function for quick sort
- must return negative value, 0 or positive value if pItem1 <, = or > pItem2
+/*
+ Callback compare function for quick sort.
+
+ It must return negative value, 0 or positive value if the first item is
+ less than, equal to or greater than the second one.
*/
-
-#ifdef __VISUALC__
- #define CMPFUNC_CONV _cdecl
-#else // !Visual C++
- #define CMPFUNC_CONV
-#endif // compiler
-typedef int (CMPFUNC_CONV *CMPFUNC)(const void* pItem1, const void* pItem2);
-
-// ----------------------------------------------------------------------------
-/**
- base class managing data having size of type 'long' (not used directly)
-
- NB: for efficiency this often used class has no virtual functions (hence no
- VTBL), even dtor is not virtual. If used as expected it won't
- create any problems because ARRAYs from DEFINE_ARRAY have no dtor at all,
- so it's not too important if it's not called (this happens when you cast
- "SomeArray *" as "BaseArray *" and then delete it)
-
- @memo Base class for template array and list classes
-*/
-// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxBaseArray
+extern "C"
{
-public:
- /** @name ctors and dtor */
- //@{
- /// default ctor
- wxBaseArray();
- /// copy ctor
- wxBaseArray(const wxBaseArray& array);
- /// assignment operator
- wxBaseArray& operator=(const wxBaseArray& src);
- /// not virtual, see above
- /// EXCEPT for Gnu compiler to reduce warnings...
-#ifdef __GNUG__
- virtual
-#endif
- ~wxBaseArray();
- //@}
-
- /** @name memory management */
- //@{
- /// empties the list, but doesn't release memory
- void Empty() { m_uiCount = 0; }
- /// empties the list and releases memory
- void Clear();
- /// preallocates memory for given number of items
- void Alloc(size_t uiSize);
- //@}
-
- /** @name simple accessors */
- //@{
- /// number of elements in the array
- size_t Count() const { return m_uiCount; }
- size_t GetCount() const { return m_uiCount; }
- /// is it empty?
- bool IsEmpty() const { return m_uiCount == 0; }
- //@}
-
-protected:
- // these methods are protected because if they were public one could
- // mistakenly call one of them instead of DEFINE_ARRAY's or LIST's
- // type safe methods
-
- /** @name items access */
- //@{
- /// get item at position uiIndex (range checking is done in debug version)
- long& Item(size_t uiIndex) const
- { wxASSERT( uiIndex < m_uiCount ); return m_pItems[uiIndex]; }
- /// same as Item()
- long& operator[](size_t uiIndex) const { return Item(uiIndex); }
- //@}
-
- /** @name item management */
- //@{
- /**
- Search the element in the array, starting from the either side
- @param bFromEnd if TRUE, start from the end
- @return index of the first item matched or NOT_FOUND
- @see NOT_FOUND
- */
- int Index(long lItem, bool bFromEnd = FALSE) const;
- /// search for an item using binary search in a sorted array
- int Index(long lItem, CMPFUNC fnCompare) const;
- /// add new element at the end
- void Add(long lItem);
- /// add item assuming the array is sorted with fnCompare function
- void Add(long lItem, CMPFUNC fnCompare);
- /// add new element at given position (it becomes Item[uiIndex])
- void Insert(long lItem, size_t uiIndex);
- /// remove first item matching this value
- void Remove(long lItem);
- /// remove item by index
- void Remove(size_t uiIndex);
- //@}
-
- /// sort array elements using given compare function
- void Sort(CMPFUNC fnCompare);
-
-private:
- void Grow(); // makes array bigger if needed
-
- size_t m_uiSize, // current size of the array
- m_uiCount; // current number of elements
-
- long *m_pItems; // pointer to data
-};
-
-// ============================================================================
-// template classes
-// ============================================================================
+typedef int (wxCMPFUNC_CONV *CMPFUNC)(const void* pItem1, const void* pItem2);
+}
// ----------------------------------------------------------------------------
-// This macro generates a new array class. It is intended for storage of simple
-// types of sizeof()<=sizeof(long) or pointers if sizeof(pointer)<=sizeof(long)
+// Base class managing data having size of type 'long' (not used directly)
//
-// NB: it has only inline functions => takes no space at all
+// NB: for efficiency this often used class has no virtual functions (hence no
+// virtual table), even dtor is *not* virtual. If used as expected it
+// won't create any problems because ARRAYs from DEFINE_ARRAY have no dtor
+// at all, so it's not too important if it's not called (this happens when
+// you cast "SomeArray *" as "BaseArray *" and then delete it)
// ----------------------------------------------------------------------------
-#define _WX_DEFINE_ARRAY(T, name) \
-typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2); \
-class WXDLLEXPORTLOCAL name : public wxBaseArray \
+
+#define _WX_DECLARE_BASEARRAY(T, name, classexp) \
+classexp name \
{ \
public: \
- name() \
- { wxASSERT( sizeof(T) <= sizeof(long) ); } \
+ name(); \
+ name(const name& array); \
+ name& operator=(const name& src); \
+ ~name(); \
\
- name& operator=(const name& src) \
- { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src); \
- return *this; } \
+ void Empty() { m_nCount = 0; } \
+ void Clear(); \
+ void Alloc(size_t uiSize); \
+ void Shrink(); \
\
- T& operator[](size_t uiIndex) const \
- { return (T&)(wxBaseArray::Item(uiIndex)); } \
- T& Item(size_t uiIndex) const \
- { return (T&)(wxBaseArray::Item(uiIndex)); } \
- T& Last() const \
- { return (T&)(wxBaseArray::Item(Count() - 1)); } \
+ size_t GetCount() const { return m_nCount; } \
+ bool IsEmpty() const { return m_nCount == 0; } \
+ size_t Count() const { return m_nCount; } \
\
- int Index(T Item, bool bFromEnd = FALSE) const \
- { return wxBaseArray::Index((long)Item, bFromEnd); } \
+ typedef T base_type; \
+protected: \
+ T& Item(size_t uiIndex) const \
+ { wxASSERT( uiIndex < m_nCount ); return m_pItems[uiIndex]; } \
+ T& operator[](size_t uiIndex) const { return Item(uiIndex); } \
\
- void Add(T Item) \
- { wxBaseArray::Add((long)Item); } \
- void Insert(T Item, size_t uiIndex) \
- { wxBaseArray::Insert((long)Item, uiIndex) ; } \
+ int Index(T lItem, bool bFromEnd = FALSE) const; \
+ int Index(T lItem, CMPFUNC fnCompare) const; \
+ size_t IndexForInsert(T lItem, CMPFUNC fnCompare) const; \
+ void Add(T lItem); \
+ void Add(T lItem, CMPFUNC fnCompare); \
+ void Insert(T lItem, size_t uiIndex); \
+ void Remove(T lItem); \
+ void RemoveAt(size_t uiIndex); \
\
- void Remove(size_t uiIndex) { wxBaseArray::Remove(uiIndex); } \
- void Remove(T Item) \
- { int iIndex = Index(Item); \
- wxCHECK2_MSG( iIndex != NOT_FOUND, return, \
- "removing inexisting element in wxArray::Remove" ); \
- wxBaseArray::Remove((size_t)iIndex); } \
+ void Sort(CMPFUNC fnCompare); \
\
- void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); } \
+private: \
+ \
+ void Grow(); \
+ \
+ size_t m_nSize, \
+ m_nCount; \
+ \
+ T *m_pItems; \
+};
+
+// ============================================================================
+// The private helper macros containing the core of the array classes
+// ============================================================================
+
+// Implementation notes:
+//
+// JACS: Salford C++ doesn't like 'var->operator=' syntax, as in:
+// { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
+// so using a temporary variable instead.
+//
+// The classes need a (even trivial) ~name() to link under Mac X
+//
+// _WX_ERROR_REMOVE is needed to resolve the name conflict between the wxT()
+// macro and T typedef: we can't use wxT() inside WX_DEFINE_ARRAY!
+
+#define _WX_ERROR_REMOVE wxT("removing inexisting element in wxArray::Remove")
+
+// ----------------------------------------------------------------------------
+// _WX_DEFINE_TYPEARRAY: array for simple types
+// ----------------------------------------------------------------------------
+
+#define _WX_DEFINE_TYPEARRAY(T, name, base, classexp) \
+wxCOMPILE_TIME_ASSERT2(sizeof(T) <= sizeof(base::base_type), \
+ TypeTooBigToBeStoredIn##base, \
+ name); \
+typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2); \
+classexp name : public base \
+{ \
+public: \
+ name() { } \
+ ~name() { } \
+ \
+ name& operator=(const name& src) \
+ { base* temp = (base*) this; \
+ (*temp) = ((const base&)src); \
+ return *this; } \
+ \
+ T& operator[](size_t uiIndex) const \
+ { return (T&)(base::Item(uiIndex)); } \
+ T& Item(size_t uiIndex) const \
+ { return (T&)(base::Item(uiIndex)); } \
+ T& Last() const \
+ { return (T&)(base::Item(Count() - 1)); } \
+ \
+ int Index(T Item, bool bFromEnd = FALSE) const \
+ { return base::Index(Item, bFromEnd); } \
+ \
+ void Add(T Item) \
+ { base::Add(Item); } \
+ void Insert(T Item, size_t uiIndex) \
+ { base::Insert(Item, uiIndex) ; } \
+ \
+ void RemoveAt(size_t uiIndex) { base::RemoveAt(uiIndex); } \
+ void Remove(T Item) \
+ { int iIndex = Index(Item); \
+ wxCHECK2_MSG( iIndex != wxNOT_FOUND, return, \
+ _WX_ERROR_REMOVE); \
+ base::RemoveAt((size_t)iIndex); } \
+ \
+ void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC)fCmp); } \
}
// ----------------------------------------------------------------------------
-// This is the same as the previous macro, but it defines a sorted array.
+// _WX_DEFINE_SORTED_TYPEARRAY: sorted array for simple data types
+// cannot handle types with size greater than pointer because of sorting
+// ----------------------------------------------------------------------------
+
+#define _WX_DEFINE_SORTED_TYPEARRAY(T, name, base, defcomp, classexp) \
+wxCOMPILE_TIME_ASSERT2(sizeof(T) <= sizeof(void *), \
+ TypeTooBigToBeStoredInSorted##base, \
+ name); \
+typedef int (CMPFUNC_CONV *SCMPFUNC##T)(T pItem1, T pItem2); \
+classexp name : public base \
+{ \
+public: \
+ name(SCMPFUNC##T fn defcomp) { m_fnCompare = fn; } \
+ \
+ name& operator=(const name& src) \
+ { base* temp = (base*) this; \
+ (*temp) = ((const base&)src); \
+ m_fnCompare = src.m_fnCompare; \
+ return *this; } \
+ \
+ T& operator[](size_t uiIndex) const \
+ { return (T&)(base::Item(uiIndex)); } \
+ T& Item(size_t uiIndex) const \
+ { return (T&)(base::Item(uiIndex)); } \
+ T& Last() const \
+ { return (T&)(base::Item(Count() - 1)); } \
+ \
+ int Index(T Item) const \
+ { return base::Index(Item, (CMPFUNC)m_fnCompare); } \
+ \
+ size_t IndexForInsert(T Item) const \
+ { return base::IndexForInsert(Item, (CMPFUNC)m_fnCompare); } \
+ \
+ void AddAt(T item, size_t index) \
+ { base::Insert(item, index); } \
+ \
+ void Add(T Item) \
+ { base::Add(Item, (CMPFUNC)m_fnCompare); } \
+ \
+ void RemoveAt(size_t uiIndex) { base::RemoveAt(uiIndex); } \
+ void Remove(T Item) \
+ { int iIndex = Index(Item); \
+ wxCHECK2_MSG( iIndex != wxNOT_FOUND, return, \
+ _WX_ERROR_REMOVE ); \
+ base::RemoveAt((size_t)iIndex); } \
+ \
+private: \
+ SCMPFUNC##T m_fnCompare; \
+}
+
+// ----------------------------------------------------------------------------
+// _WX_DECLARE_OBJARRAY: an array for pointers to type T with owning semantics
+// ----------------------------------------------------------------------------
+
+#define _WX_DECLARE_OBJARRAY(T, name, base, classexp) \
+typedef int (CMPFUNC_CONV *CMPFUNC##T)(T **pItem1, T **pItem2); \
+classexp name : public base \
+{ \
+typedef int (CMPFUNC_CONV *CMPFUNC##base)(void **pItem1, void **pItem2); \
+public: \
+ name() { } \
+ name(const name& src); \
+ name& operator=(const name& src); \
+ \
+ ~name(); \
+ \
+ T& operator[](size_t uiIndex) const \
+ { return *(T*)base::Item(uiIndex); } \
+ T& Item(size_t uiIndex) const \
+ { return *(T*)base::Item(uiIndex); } \
+ T& Last() const \
+ { return *(T*)(base::Item(Count() - 1)); } \
+ \
+ int Index(const T& Item, bool bFromEnd = FALSE) const; \
+ \
+ void Add(const T& Item); \
+ void Add(const T* pItem) \
+ { base::Add((T*)pItem); } \
+ \
+ void Insert(const T& Item, size_t uiIndex); \
+ void Insert(const T* pItem, size_t uiIndex) \
+ { base::Insert((T*)pItem, uiIndex); } \
+ \
+ void Empty() { DoEmpty(); base::Empty(); } \
+ void Clear() { DoEmpty(); base::Clear(); } \
+ \
+ T* Detach(size_t uiIndex) \
+ { T* p = (T*)base::Item(uiIndex); \
+ base::RemoveAt(uiIndex); return p; } \
+ void RemoveAt(size_t uiIndex); \
+ \
+ void Sort(CMPFUNC##T fCmp) { base::Sort((CMPFUNC##base)fCmp); } \
+ \
+private: \
+ void DoEmpty(); \
+ void DoCopy(const name& src); \
+}
+
+// ============================================================================
+// The public macros for declaration and definition of the dynamic arrays
+// ============================================================================
+
+// Please note that for each macro WX_FOO_ARRAY we also have
+// WX_FOO_EXPORTED_ARRAY and WX_FOO_USER_EXPORTED_ARRAY which are exactly the
+// same except that they use an additional __declspec(dllexport) or equivalent
+// under Windows if needed.
+//
+// The first (just EXPORTED) macros do it if wxWindows was compiled as a DLL
+// and so must be used used inside the library. The second kind (USER_EXPORTED)
+// allow the user code to do it when it wants. This is needed if you have a dll
+// that wants to export a wxArray daubed with your own import/export goo.
+//
+// Finally, you can define the macro below as something special to modify the
+// arrays defined by a simple WX_FOO_ARRAY as well. By default is is empty.
+#define wxARRAY_DEFAULT_EXPORT
+
+// ----------------------------------------------------------------------------
+// WX_DECLARE_BASEARRAY(T, name) declare an array class named "name" containing
+// the elements of type T
+// ----------------------------------------------------------------------------
+
+#define WX_DECLARE_BASEARRAY(T, name) \
+ WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, wxARRAY_DEFAULT_EXPORT)
+
+#define WX_DECLARE_EXPORTED_BASEARRAY(T, name) \
+ WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, WXDLLEXPORT)
+
+#define WX_DECLARE_USER_EXPORTED_BASEARRAY(T, name, expmode) \
+ typedef T _wxArray##name; \
+ _WX_DECLARE_BASEARRAY(_wxArray##name, name, class expmode)
+
+// ----------------------------------------------------------------------------
+// WX_DEFINE_TYPEARRAY(T, name, base) define an array class named "name" deriving
+// from class "base" containing the elements of type T
+//
+// Note that the class defined has only inline function and doesn't take any
+// space at all so there is no size penalty for defining multiple array classes
+// ----------------------------------------------------------------------------
+
+#define WX_DEFINE_TYPEARRAY(T, name, base) \
+ WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, base, wxARRAY_DEFAULT_EXPORT)
+
+#define WX_DEFINE_EXPORTED_TYPEARRAY(T, name, base) \
+ WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, base, WXDLLEXPORT)
+
+#define WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, base, expmode) \
+ typedef T _wxArray##name; \
+ _WX_DEFINE_TYPEARRAY(_wxArray##name, name, base, class expmode)
+
+// ----------------------------------------------------------------------------
+// WX_DEFINE_SORTED_TYPEARRAY: this is the same as the previous macro, but it
+// defines a sorted array.
+//
// Differences:
// 1) it must be given a COMPARE function in ctor which takes 2 items of type
// T* and should return -1, 0 or +1 if the first one is less/greater
@@ -209,205 +346,279 @@ public: \
// 3) it has no Sort() method because it's always sorted
// 4) Index() method is much faster (the sorted arrays use binary search
// instead of linear one), but Add() is slower.
+// 5) there is no Insert() method because you can't insert an item into the
+// given position in a sorted array but there is IndexForInsert()/AddAt()
+// pair which may be used to optimize a common operation of "insert only if
+// not found"
+//
+// Note that you have to specify the comparison function when creating the
+// objects of this array type. If, as in 99% of cases, the comparison function
+// is the same for all objects of a class, WX_DEFINE_SORTED_TYPEARRAY_CMP below
+// is more convenient.
//
// Summary: use this class when the speed of Index() function is important, use
// the normal arrays otherwise.
+// ----------------------------------------------------------------------------
+
+#define wxARRAY_EMPTY_CMP
+
+#define WX_DEFINE_SORTED_TYPEARRAY(T, name, base) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, \
+ wxARRAY_DEFAULT_EXPORT)
+
+#define WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, base) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, WXDLLEXPORT)
+
+#define WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, base, expmode) \
+ typedef T _wxArray##name; \
+ _WX_DEFINE_SORTED_TYPEARRAY(_wxArray##name, name, base, \
+ wxARRAY_EMPTY_CMP, class expmode)
+
+// ----------------------------------------------------------------------------
+// WX_DEFINE_SORTED_TYPEARRAY_CMP: exactly the same as above but the comparison
+// function is provided by this macro and the objects of this class have a
+// default constructor which just uses it.
+//
+// The arguments are: the element type, the comparison function and the array
+// name
//
-// NB: it has only inline functions => takes no space at all
+// NB: this is, of course, how WX_DEFINE_SORTED_TYPEARRAY() should have worked
+// from the very beginning - unfortunately I didn't think about this earlier
// ----------------------------------------------------------------------------
-#define _WX_DEFINE_SORTED_ARRAY(T, name) \
-typedef int (CMPFUNC_CONV *SCMPFUNC##T)(T pItem1, T pItem2); \
-class WXDLLEXPORTLOCAL name : public wxBaseArray \
-{ \
-public: \
- name(SCMPFUNC##T fn) \
- { wxASSERT( sizeof(T) <= sizeof(long) ); m_fnCompare = fn; } \
- \
- name& operator=(const name& src) \
- { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src); \
- m_fnCompare = src.m_fnCompare; \
- return *this; } \
- \
- T& operator[](size_t uiIndex) const \
- { return (T&)(wxBaseArray::Item(uiIndex)); } \
- T& Item(size_t uiIndex) const \
- { return (T&)(wxBaseArray::Item(uiIndex)); } \
- T& Last() const \
- { return (T&)(wxBaseArray::Item(Count() - 1)); } \
- \
- int Index(T Item) const \
- { return wxBaseArray::Index((long)Item, (CMPFUNC)m_fnCompare); }\
- \
- void Add(T Item) \
- { wxBaseArray::Add((long)Item, (CMPFUNC)m_fnCompare); } \
- \
- void Remove(size_t uiIndex) { wxBaseArray::Remove(uiIndex); } \
- void Remove(T Item) \
- { int iIndex = Index(Item); \
- wxCHECK2_MSG( iIndex != NOT_FOUND, return, \
- "removing inexisting element in wxArray::Remove" ); \
- wxBaseArray::Remove((size_t)iIndex); } \
- \
-private: \
- SCMPFUNC##T m_fnCompare; \
-}
+
+#define WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, base) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base, \
+ wxARRAY_DEFAULT_EXPORT)
+
+#define WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base, \
+ WXDLLEXPORT)
+
+#define WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, base, \
+ expmode) \
+ typedef T _wxArray##name; \
+ _WX_DEFINE_SORTED_TYPEARRAY(_wxArray##name, name, base, = cmpfunc, \
+ class expmode)
// ----------------------------------------------------------------------------
-// see WX_DECLARE_LIST and WX_DEFINE_LIST
+// WX_DECLARE_OBJARRAY(T, name): this macro generates a new array class
+// named "name" which owns the objects of type T it contains, i.e. it will
+// delete them when it is destroyed.
+//
+// An element is of type T*, but arguments of type T& are taken (see below!)
+// and T& is returned.
+//
+// Don't use this for simple types such as "int" or "long"!
+//
+// Note on Add/Insert functions:
+// 1) function(T*) gives the object to the array, i.e. it will delete the
+// object when it's removed or in the array's dtor
+// 2) function(T&) will create a copy of the object and work with it
+//
+// Also:
+// 1) Remove() will delete the object after removing it from the array
+// 2) Detach() just removes the object from the array (returning pointer to it)
+//
+// NB1: Base type T should have an accessible copy ctor if Add(T&) is used
+// NB2: Never ever cast a array to it's base type: as dtor is not virtual
+// and so you risk having at least the memory leaks and probably worse
+//
+// Some functions of this class are not inline, so it takes some space to
+// define new class from this template even if you don't use it - which is not
+// the case for the simple (non-object) array classes
+//
+// To use an objarray class you must
+// #include "dynarray.h"
+// WX_DECLARE_OBJARRAY(element_type, list_class_name)
+// #include "arrimpl.cpp"
+// WX_DEFINE_OBJARRAY(list_class_name) // name must be the same as above!
+//
+// This is necessary because at the moment of DEFINE_OBJARRAY class parsing the
+// element_type must be fully defined (i.e. forward declaration is not
+// enough), while WX_DECLARE_OBJARRAY may be done anywhere. The separation of
+// two allows to break cicrcular dependencies with classes which have member
+// variables of objarray type.
// ----------------------------------------------------------------------------
-#define _WX_DECLARE_LIST(T, name) \
-typedef int (CMPFUNC_CONV *CMPFUNC##T)(T** pItem1, T** pItem2); \
-class WXDLLEXPORTLOCAL name : public wxBaseArray \
-{ \
-public: \
- name() { } \
- name(const name& src); \
- name& operator=(const name& src); \
- \
- ~name(); \
- \
- T& operator[](size_t uiIndex) const \
- { return *(T*)wxBaseArray::Item(uiIndex); } \
- T& Item(size_t uiIndex) const \
- { return *(T*)wxBaseArray::Item(uiIndex); } \
- T& Last() const \
- { return *(T*)(wxBaseArray::Item(Count() - 1)); } \
- \
- int Index(const T& Item, bool bFromEnd = FALSE) const; \
- \
- void Add(const T& Item); \
- void Add(const T* pItem) \
- { wxBaseArray::Add((long)pItem); } \
- \
- void Insert(const T& Item, size_t uiIndex); \
- void Insert(const T* pItem, size_t uiIndex) \
- { wxBaseArray::Insert((long)pItem, uiIndex); } \
- \
- void Empty(); \
- \
- T* Detach(size_t uiIndex) \
- { T* p = (T*)wxBaseArray::Item(uiIndex); \
- wxBaseArray::Remove(uiIndex); return p; } \
- void Remove(size_t uiIndex); \
- \
- void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); } \
- \
-private: \
- void DoCopy(const name& src); \
-}
+#define WX_DECLARE_OBJARRAY(T, name) \
+ WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, wxARRAY_DEFAULT_EXPORT)
+
+#define WX_DECLARE_EXPORTED_OBJARRAY(T, name) \
+ WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, WXDLLEXPORT)
+
+#define WX_DECLARE_USER_EXPORTED_OBJARRAY(T, name, expmode) \
+ typedef T _wxObjArray##name; \
+ _WX_DECLARE_OBJARRAY(_wxObjArray##name, name, wxArrayPtrVoid, class expmode)
+
+// WX_DEFINE_OBJARRAY is going to be redefined when arrimpl.cpp is included,
+// try to provoke a human-understandable error if it used incorrectly.
+//
+// there is no real need for 3 different macros in the DEFINE case but do it
+// anyhow for consistency
+#define WX_DEFINE_OBJARRAY(name) DidYouIncludeArrimplCpp
+#define WX_DEFINE_EXPORTED_OBJARRAY(name) WX_DEFINE_OBJARRAY(name)
+#define WX_DEFINE_USER_EXPORTED_OBJARRAY(name) WX_DEFINE_OBJARRAY(name)
+
+// ----------------------------------------------------------------------------
+// Some commonly used predefined base arrays
// ----------------------------------------------------------------------------
-/** @name Macros for definition of dynamic arrays and lists
- These macros are ugly (especially if you look in the sources ;-), but they
- allow us to define 'template' classes without actually using templates.
-
-
- Range checking is performed in debug build for both arrays and lists. Type
- checking is done at compile-time. Warning: arrays never shrink, they
- only grow, so loading 10 millions in an array only to delete them 2 lines
- below is not recommended. However, it does free memory when it's
- destroyed, so if you destroy array also, it's ok.
- */
-// ----------------------------------------------------------------------------
-
-//@{
- /**
- This macro generates a new array class. It is intended for storage of simple
- types of sizeof()<=sizeof(long) or pointers if sizeof(pointer)<=sizeof(long)
-
- NB: it has only inline functions => takes no space at all
-
-
- @memo declare and define array class 'name' containing elements of type 'T'
- */
-#define WX_DEFINE_ARRAY(T, name) typedef T _A##name; \
- _WX_DEFINE_ARRAY(_A##name, name)
-
- /**
- This macro does the same as WX_DEFINE_ARRAY except that the array will be
- sorted with the specified compare function.
- */
-#define WX_DEFINE_SORTED_ARRAY(T, name) typedef T _A##name; \
- _WX_DEFINE_SORTED_ARRAY(_A##name, name)
-
- /**
- This macro generates a new list class which owns the objects it contains,
- i.e. it will delete them when it is destroyed. An element is of type T*,
- but arguments of type T& are taken (see below!) and T& is returned.
-
- Don't use this for simple types such as "int" or "long"!
- You _may_ use it for "double" but it's awfully inefficient.
-
-
- Note on Add/Insert functions:
-
- 1) function(T*) gives the object to the list, i.e. it will delete the
- object when it's removed or in the list's dtor
-
- 2) function(T&) will create a copy of the object and work with it
-
-
- Also:
-
- 1) Remove() will delete the object after removing it from the list
-
- 2) Detach() just removes the object from the list (returning pointer to it)
-
-
- NB1: Base type T should have an accessible copy ctor if Add(T&) is used,
-
- NB2: Never ever cast a list to it's base type: as dtor is not virtual
- it will provoke memory leaks
-
-
- some functions of this class are not inline, so it takes some space to
- define new class from this template.
-
- @memo declare list class 'name' containing elements of type 'T'
- */
-#define WX_DECLARE_LIST(T, name) typedef T _L##name; \
- _WX_DECLARE_LIST(_L##name, name)
- /**
- To use a list class you must
-
- #include "dynarray.h"
- DECLARE_LIST(element_type, list_class_name)
- #include "listimpl.cpp"
- DEFINE_LIST(list_class_name) // same as above!
-
-
- This is necessary because at the moment of DEFINE_LIST class element_type
- must be fully defined (i.e. forward declaration is not enough), while
- DECLARE_LIST may be done anywhere. The separation of two allows to break
- cicrcular dependencies with classes which have member variables of list
- type.
-
- @memo define (must include listimpl.cpp!) list class 'name'
- */
-#define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
-//@}
-
-// ----------------------------------------------------------------------------
-/** @name Some commonly used predefined arrays */
-// # overhead if not used?
-// ----------------------------------------------------------------------------
-
-#define WXDLLEXPORTLOCAL WXDLLEXPORT
-
-//@{
- /** @name ArrayInt */
-WX_DEFINE_ARRAY(int, wxArrayInt);
- /** @name ArrayLong */
-WX_DEFINE_ARRAY(long, wxArrayLong);
- /** @name ArrayPtrVoid */
-WX_DEFINE_ARRAY(void *, wxArrayPtrVoid);
-//@}
-
-//@}
-
-#undef WXDLLEXPORTLOCAL
-#define WXDLLEXPORTLOCAL
+WX_DECLARE_EXPORTED_BASEARRAY(const void *, wxBaseArrayPtrVoid);
+WX_DECLARE_EXPORTED_BASEARRAY(short, wxBaseArrayShort);
+WX_DECLARE_EXPORTED_BASEARRAY(int, wxBaseArrayInt);
+WX_DECLARE_EXPORTED_BASEARRAY(long, wxBaseArrayLong);
+WX_DECLARE_EXPORTED_BASEARRAY(double, wxBaseArrayDouble);
+
+// ----------------------------------------------------------------------------
+// Convenience macros to define arrays from base arrays
+// ----------------------------------------------------------------------------
+
+#define WX_DEFINE_ARRAY(T, name) \
+ WX_DEFINE_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
+#define WX_DEFINE_EXPORTED_ARRAY(T, name) \
+ WX_DEFINE_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
+#define WX_DEFINE_USER_EXPORTED_ARRAY(T, name, expmode) \
+ WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid, expmode)
+
+#define WX_DEFINE_ARRAY_SHORT(T, name) \
+ WX_DEFINE_TYPEARRAY(T, name, wxBaseArrayShort)
+#define WX_DEFINE_EXPORTED_ARRAY_SHORT(T, name) \
+ WX_DEFINE_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort)
+#define WX_DEFINE_USER_EXPORTED_ARRAY_SHORT(T, name, expmode) \
+ WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort, expmode)
+
+#define WX_DEFINE_ARRAY_INT(T, name) \
+ WX_DEFINE_TYPEARRAY(T, name, wxBaseArrayInt)
+#define WX_DEFINE_EXPORTED_ARRAY_INT(T, name) \
+ WX_DEFINE_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt)
+#define WX_DEFINE_USER_EXPORTED_ARRAY_INT(T, name, expmode) \
+ WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt, expmode)
+
+#define WX_DEFINE_ARRAY_LONG(T, name) \
+ WX_DEFINE_TYPEARRAY(T, name, wxBaseArrayLong)
+#define WX_DEFINE_EXPORTED_ARRAY_LONG(T, name) \
+ WX_DEFINE_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong)
+#define WX_DEFINE_USER_EXPORTED_ARRAY_LONG(T, name, expmode) \
+ WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong, expmode)
+
+#define WX_DEFINE_ARRAY_DOUBLE(T, name) \
+ WX_DEFINE_TYPEARRAY(T, name, wxBaseArrayDouble)
+#define WX_DEFINE_EXPORTED_ARRAY_DOUBLE(T, name) \
+ WX_DEFINE_EXPORTED_TYPEARRAY(T, name, wxBaseArrayDouble)
+#define WX_DEFINE_USER_EXPORTED_ARRAY_DOUBLE(T, name, expmode) \
+ WX_DEFINE_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayDouble, expmode)
+
+// ----------------------------------------------------------------------------
+// Convenience macros to define sorted arrays from base arrays
+// ----------------------------------------------------------------------------
+
+#define WX_DEFINE_SORTED_ARRAY(T, name) \
+ WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY(T, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(T, name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayPtrVoid, expmode)
+
+#define WX_DEFINE_SORTED_ARRAY_SHORT(T, name) \
+ WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayShort)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY_SHORT(T, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SHORT(T, name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayShort, expmode)
+
+#define WX_DEFINE_SORTED_ARRAY_INT(T, name) \
+ WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayInt)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY_INT(T, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT(T, name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayInt, expmode)
+
+#define WX_DEFINE_SORTED_ARRAY_LONG(T, name) \
+ WX_DEFINE_SORTED_TYPEARRAY(T, name, wxBaseArrayLong)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY_LONG(T, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_LONG(T, name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY(T, name, wxBaseArrayLong, expmode)
+
+// ----------------------------------------------------------------------------
+// Convenience macros to define sorted arrays from base arrays
+// ----------------------------------------------------------------------------
+
+#define WX_DEFINE_SORTED_ARRAY_CMP(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayPtrVoid)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayPtrVoid)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP(T, cmpfunc, \
+ name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
+ wxBaseArrayPtrVoid, expmode)
+
+#define WX_DEFINE_SORTED_ARRAY_CMP_SHORT(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayShort)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_SHORT(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayShort)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_SHORT(T, cmpfunc, \
+ name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
+ wxBaseArrayShort, expmode)
+
+#define WX_DEFINE_SORTED_ARRAY_CMP_INT(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayInt)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_INT(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayInt)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_INT(T, cmpfunc, \
+ name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
+ wxBaseArrayInt, expmode)
+
+#define WX_DEFINE_SORTED_ARRAY_CMP_LONG(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayLong)
+#define WX_DEFINE_SORTED_EXPORTED_ARRAY_CMP_LONG(T, cmpfunc, name) \
+ WX_DEFINE_SORTED_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, wxBaseArrayLong)
+#define WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_CMP_LONG(T, cmpfunc, \
+ name, expmode) \
+ WX_DEFINE_SORTED_USER_EXPORTED_TYPEARRAY_CMP(T, cmpfunc, name, \
+ wxBaseArrayLong, expmode)
+
+// ----------------------------------------------------------------------------
+// Some commonly used predefined arrays
+// ----------------------------------------------------------------------------
+
+WX_DEFINE_EXPORTED_ARRAY_SHORT (short, wxArrayShort);
+WX_DEFINE_EXPORTED_ARRAY_INT (int, wxArrayInt);
+WX_DEFINE_EXPORTED_ARRAY_LONG (long, wxArrayLong);
+WX_DEFINE_EXPORTED_ARRAY (void *, wxArrayPtrVoid);
+
+// -----------------------------------------------------------------------------
+// convenience macros
+// -----------------------------------------------------------------------------
+
+// append all element of one array to another one
+#define WX_APPEND_ARRAY(array, other) \
+ { \
+ size_t count = (other).Count(); \
+ for ( size_t n = 0; n < count; n++ ) \
+ { \
+ (array).Add((other)[n]); \
+ } \
+ }
+
+// delete all array elements
+//
+// NB: the class declaration of the array elements must be visible from the
+// place where you use this macro, otherwise the proper destructor may not
+// be called (a decent compiler should give a warning about it, but don't
+// count on it)!
+#define WX_CLEAR_ARRAY(array) \
+ { \
+ size_t count = (array).Count(); \
+ for ( size_t n = 0; n < count; n++ ) \
+ { \
+ delete (array)[n]; \
+ } \
+ \
+ (array).Empty(); \
+ }
#endif // _DYNARRAY_H