#include "wx/defs.h"
#include "wx/debug.h"
-/** @name Dynamic arrays and lists
+/** @name Dynamic arrays and object arrays (array which own their elements)
@memo Arrays which grow on demand and do range checking (only in debug)
*/
//@{
// ----------------------------------------------------------------------------
/**
- the initial size by which an array/list grows when an element is added
+ 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
*/
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
+ @memo Base class for template array classes
*/
// ----------------------------------------------------------------------------
-class wxBaseArray
+class WXDLLEXPORT wxBaseArray
{
public:
/** @name ctors and dtor */
/** @name memory management */
//@{
- /// empties the list, but doesn't release memory
- void Empty() { m_uiCount = 0; }
- /// empties the list and releases memory
+ /// empties the array, but doesn't release memory
+ void Empty() { m_nCount = 0; }
+ /// empties the array and releases memory
void Clear();
/// preallocates memory for given number of items
void Alloc(size_t uiSize);
+ /// minimizes the memory used by the array (frees unused memory)
+ void Shrink();
//@}
/** @name simple accessors */
//@{
/// number of elements in the array
- size_t Count() const { return m_uiCount; }
- size_t GetCount() const { return m_uiCount; }
+ size_t Count() const { return m_nCount; }
+ size_t GetCount() const { return m_nCount; }
/// is it empty?
- bool IsEmpty() const { return m_uiCount == 0; }
+ bool IsEmpty() const { return m_nCount == 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
+ // mistakenly call one of them instead of DEFINE_ARRAY's or OBJARRAY'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]; }
+ { wxASSERT( uiIndex < m_nCount ); return m_pItems[uiIndex]; }
/// same as Item()
long& operator[](size_t uiIndex) const { return Item(uiIndex); }
//@}
private:
void Grow(); // makes array bigger if needed
- size_t m_uiSize, // current size of the array
- m_uiCount; // current number of elements
+ size_t m_nSize, // current size of the array
+ m_nCount; // current number of elements
long *m_pItems; // pointer to data
};
// ----------------------------------------------------------------------------
#define _WX_DEFINE_ARRAY(T, name) \
typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2); \
-class name : public wxBaseArray \
+class WXDLLEXPORTLOCAL name : public wxBaseArray \
{ \
public: \
name() \
{ ((wxBaseArray *)this)->operator=((const wxBaseArray&)src); \
return *this; } \
\
- T& operator[](size_t uiIndex) const \
+ T& operator[](size_t uiIndex) const \
{ return (T&)(wxBaseArray::Item(uiIndex)); } \
- T& Item(size_t uiIndex) const \
+ T& Item(size_t uiIndex) const \
{ return (T&)(wxBaseArray::Item(uiIndex)); } \
T& Last() const \
{ return (T&)(wxBaseArray::Item(Count() - 1)); } \
\
void Add(T Item) \
{ wxBaseArray::Add((long)Item); } \
- void Insert(T Item, size_t uiIndex) \
+ void Insert(T Item, size_t uiIndex) \
{ wxBaseArray::Insert((long)Item, uiIndex) ; } \
\
- void Remove(size_t uiIndex) { wxBaseArray::Remove(uiIndex); } \
+ void Remove(size_t uiIndex) { wxBaseArray::Remove(uiIndex); } \
void Remove(T Item) \
{ int iIndex = Index(Item); \
wxCHECK2_MSG( iIndex != NOT_FOUND, return, \
// ----------------------------------------------------------------------------
#define _WX_DEFINE_SORTED_ARRAY(T, name) \
typedef int (CMPFUNC_CONV *SCMPFUNC##T)(T pItem1, T pItem2); \
-class name : public wxBaseArray \
+class WXDLLEXPORTLOCAL name : public wxBaseArray \
{ \
public: \
name(SCMPFUNC##T fn) \
m_fnCompare = src.m_fnCompare; \
return *this; } \
\
- T& operator[](size_t uiIndex) const \
+ T& operator[](size_t uiIndex) const \
{ return (T&)(wxBaseArray::Item(uiIndex)); } \
- T& Item(size_t uiIndex) const \
+ T& Item(size_t uiIndex) const \
{ return (T&)(wxBaseArray::Item(uiIndex)); } \
T& Last() const \
{ return (T&)(wxBaseArray::Item(Count() - 1)); } \
void Add(T Item) \
{ wxBaseArray::Add((long)Item, (CMPFUNC)m_fnCompare); } \
\
- void Remove(size_t uiIndex) { wxBaseArray::Remove(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); } \
+ wxBaseArray::Remove((size_t)iIndex); } \
\
private: \
SCMPFUNC##T m_fnCompare; \
}
// ----------------------------------------------------------------------------
-// see WX_DECLARE_LIST and WX_DEFINE_LIST
+// see WX_DECLARE_OBJARRAY and WX_DEFINE_OBJARRAY
// ----------------------------------------------------------------------------
-#define _WX_DECLARE_LIST(T, name) \
+#define _WX_DECLARE_OBJARRAY(T, name) \
typedef int (CMPFUNC_CONV *CMPFUNC##T)(T** pItem1, T** pItem2); \
-class name : public wxBaseArray \
+class WXDLLEXPORTLOCAL name : public wxBaseArray \
{ \
public: \
name() { } \
\
~name(); \
\
- T& operator[](size_t uiIndex) const \
+ T& operator[](size_t uiIndex) const \
{ return *(T*)wxBaseArray::Item(uiIndex); } \
- T& Item(size_t uiIndex) const \
+ T& Item(size_t uiIndex) const \
{ return *(T*)wxBaseArray::Item(uiIndex); } \
T& Last() const \
{ return *(T*)(wxBaseArray::Item(Count() - 1)); } \
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) \
+ 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* Detach(size_t uiIndex) \
{ T* p = (T*)wxBaseArray::Item(uiIndex); \
wxBaseArray::Remove(uiIndex); return p; } \
- void Remove(size_t uiIndex); \
+ void Remove(size_t uiIndex); \
\
void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); } \
\
}
// ----------------------------------------------------------------------------
-/** @name Macros for definition of dynamic arrays and lists
+/** @name Macros for definition of dynamic arrays and objarrays
These macros are ugly (especially if you look in the sources ;-), but they
allow us to define 'template' classes without actually using templates.
<BR>
<BR>
- Range checking is performed in debug build for both arrays and lists. Type
- checking is done at compile-time. Warning: arrays <I>never</I> shrink, they
- only grow, so loading 10 millions in an array only to delete them 2 lines
- below is <I>not</I> recommended. However, it does free memory when it's
- destroyed, so if you destroy array also, it's ok.
+ Range checking is performed in debug build for both arrays and objarrays.
+ Type checking is done at compile-time. Warning: arrays <I>never</I> shrink,
+ they only grow, so loading 10 millions in an array only to delete them 2
+ lines below is <I>not</I> recommended. However, it does free memory when
+ it's destroyed, so if you destroy array also, it's ok.
*/
// ----------------------------------------------------------------------------
_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.
- <BR>
+ This macro generates a new objarrays 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. <BR>
Don't use this for simple types such as "int" or "long"!
You _may_ use it for "double" but it's awfully inefficient.
<BR>
<BR>
Note on Add/Insert functions:
<BR>
- 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
+ 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
<BR>
2) function(T&) will create a copy of the object and work with it
<BR>
<BR>
Also:
<BR>
- 1) Remove() will delete the object after removing it from the list
+ 1) Remove() will delete the object after removing it from the array
<BR>
- 2) Detach() just removes the object from the list (returning pointer to it)
+ 2) Detach() just removes the object from the array (returning pointer to it)
<BR>
<BR>
NB1: Base type T should have an accessible copy ctor if Add(T&) is used,
<BR>
- NB2: Never ever cast a list to it's base type: as dtor is <B>not</B> virtual
+ NB2: Never ever cast a array to it's base type: as dtor is <B>not</B> virtual
it will provoke memory leaks
<BR>
<BR>
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'
+ @memo declare objarray class 'name' containing elements of type 'T'
*/
-#define WX_DECLARE_LIST(T, name) typedef T _L##name; \
- _WX_DECLARE_LIST(_L##name, name)
+#define WX_DECLARE_OBJARRAY(T, name) typedef T _L##name; \
+ _WX_DECLARE_LIST(_L##name, name)
/**
- To use a list class you must
+ To use an objarray class you must
<ll>
<li>#include "dynarray.h"
- <li>DECLARE_LIST(element_type, list_class_name)
- <li>#include "listimpl.cpp"
- <li>DEFINE_LIST(list_class_name) // same as above!
+ <li>WX_DECLARE_OBJARRAY(element_type, list_class_name)
+ <li>#include "arrimpl.cpp"
+ <li>WX_DEFINE_OBJARRAY(list_class_name) // same as above!
</ll>
<BR><BR>
- 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.
+ This is necessary because at the moment of DEFINE_OBJARRAY class
+ 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.
- @memo define (must include listimpl.cpp!) list class 'name'
+ @memo define (must include arrimpl.cpp!) objarray class 'name'
*/
-#define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
+#define WX_DEFINE_OBJARRAY(name) "don't forget to include arrimpl.cpp!"
//@}
// ----------------------------------------------------------------------------
// # overhead if not used?
// ----------------------------------------------------------------------------
+#define WXDLLEXPORTLOCAL WXDLLEXPORT
+
//@{
/** @name ArrayInt */
WX_DEFINE_ARRAY(int, wxArrayInt);
//@}
+#undef WXDLLEXPORTLOCAL
+#define WXDLLEXPORTLOCAL
+
#endif // _DYNARRAY_H
projects / wxWidgets.git / blobdiff