X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c801d85f158c4cba50b588807daabdcbd0ed3853..2aa45cc91981cbf8be5d6c63c3fda99b530cf308:/include/wx/dynarray.h diff --git a/include/wx/dynarray.h b/include/wx/dynarray.h index ef2f64518a..7174148866 100644 --- a/include/wx/dynarray.h +++ b/include/wx/dynarray.h @@ -2,7 +2,7 @@ // Name: dynarray.h // Purpose: auto-resizable (i.e. dynamic) array support // Author: Vadim Zeitlin -// Modified by: +// Modified by: // Created: 12.09.97 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin @@ -17,11 +17,9 @@ #endif #include "wx/defs.h" -#include "wx/utils.h" +#include "wx/debug.h" -typedef bool Bool; - -/** @name Dynamic arrays and lists +/** @name Dynamic arrays and lists @memo Arrays which grow on demand and do range checking (only in debug) */ //@{ @@ -32,7 +30,7 @@ typedef bool Bool; /** 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 + default value avoids allocate one or two bytes when the array is created which is rather inefficient */ #define WX_ARRAY_DEFAULT_INITIAL_SIZE (16) @@ -43,7 +41,7 @@ typedef bool Bool; /** callback compare function for quick sort - must return -1, 0 or +1 if pItem1 <, = or > pItem2 + must return negative value, 0 or positive value if pItem1 <, = or > pItem2 */ #ifdef __VISUALC__ @@ -58,15 +56,15 @@ 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 + 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 wxBaseArray +class WXDLLEXPORT wxBaseArray { public: /** @name ctors and dtor */ @@ -88,33 +86,36 @@ public: /** @name memory management */ //@{ /// empties the list, but doesn't release memory - void Empty() { m_uiCount = 0; } + void Empty() { m_nCount = 0; } /// empties the list and releases memory void Clear(); /// preallocates memory for given number of items - void Alloc(uint uiSize); + 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 - uint Count() 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 + // 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(uint uiIndex) const - { wxASSERT( uiIndex < m_uiCount ); return m_pItems[uiIndex]; } + long& Item(size_t uiIndex) const + { wxASSERT( uiIndex < m_nCount ); return m_pItems[uiIndex]; } /// same as Item() - long& operator[](uint uiIndex) const { return Item(uiIndex); } + long& operator[](size_t uiIndex) const { return Item(uiIndex); } //@} /** @name item management */ @@ -125,25 +126,29 @@ protected: @return index of the first item matched or NOT_FOUND @see NOT_FOUND */ - int Index (long lItem, Bool bFromEnd = FALSE) const; + 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 new element at given position - void Insert(long lItem, uint uiIndex); + 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(uint uiIndex); + void Remove(size_t uiIndex); //@} /// sort array elements using given compare function - void Sort(CMPFUNC fCmp); + void Sort(CMPFUNC fnCompare); private: void Grow(); // makes array bigger if needed - uint 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 }; @@ -155,12 +160,12 @@ private: // ---------------------------------------------------------------------------- // 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 // ---------------------------------------------------------------------------- #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() \ @@ -170,34 +175,91 @@ public: \ { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src); \ return *this; } \ \ - T& operator[](uint uiIndex) const \ + T& operator[](size_t uiIndex) const \ { return (T&)(wxBaseArray::Item(uiIndex)); } \ - T& Item(uint uiIndex) const \ + T& Item(size_t uiIndex) const \ { return (T&)(wxBaseArray::Item(uiIndex)); } \ + T& Last() const \ + { return (T&)(wxBaseArray::Item(Count() - 1)); } \ \ - int Index(T Item, Bool bFromEnd = FALSE) const \ + int Index(T Item, bool bFromEnd = FALSE) const \ { return wxBaseArray::Index((long)Item, bFromEnd); } \ \ void Add(T Item) \ { wxBaseArray::Add((long)Item); } \ - void Insert(T Item, uint uiIndex) \ + void Insert(T Item, size_t uiIndex) \ { wxBaseArray::Insert((long)Item, uiIndex) ; } \ \ - void Remove(uint uiIndex) { wxBaseArray::Remove(uiIndex); } \ + void Remove(size_t uiIndex) { wxBaseArray::Remove(uiIndex); } \ void Remove(T Item) \ { int iIndex = Index(Item); \ - wxCHECK( iIndex != NOT_FOUND ); \ - wxBaseArray::Remove((uint)iIndex); } \ + wxCHECK2_MSG( iIndex != NOT_FOUND, return, \ + "removing inexisting element in wxArray::Remove" ); \ + wxBaseArray::Remove((size_t)iIndex); } \ \ void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); } \ } +// ---------------------------------------------------------------------------- +// 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 +// than/equal to the second one. +// 2) the Add() method inserts the item in such was that the array is always +// sorted (it uses the COMPARE function) +// 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. +// +// Summary: use this class when the speed of Index() function is important, use +// the normal arrays otherwise. +// +// NB: it has only inline functions => takes no space at all +// ---------------------------------------------------------------------------- +#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; \ +} + // ---------------------------------------------------------------------------- // see WX_DECLARE_LIST and WX_DEFINE_LIST // ---------------------------------------------------------------------------- #define _WX_DECLARE_LIST(T, name) \ typedef int (CMPFUNC_CONV *CMPFUNC##T)(T** pItem1, T** pItem2); \ -class name : public wxBaseArray \ +class WXDLLEXPORTLOCAL name : public wxBaseArray \ { \ public: \ name() { } \ @@ -206,27 +268,29 @@ public: \ \ ~name(); \ \ - T& operator[](uint uiIndex) const \ + T& operator[](size_t uiIndex) const \ { return *(T*)wxBaseArray::Item(uiIndex); } \ - T& Item(uint uiIndex) const \ + 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; \ + 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, uint uiIndex); \ - void Insert(const T* pItem, uint 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(uint uiIndex) \ + T* Detach(size_t uiIndex) \ { T* p = (T*)wxBaseArray::Item(uiIndex); \ wxBaseArray::Remove(uiIndex); return p; } \ - void Remove(uint uiIndex); \ + void Remove(size_t uiIndex); \ \ void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); } \ \ @@ -235,7 +299,7 @@ private: \ } // ---------------------------------------------------------------------------- -/** @name Macros for definition of dynamic arrays and lists +/** @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. @@ -244,7 +308,7 @@ private: \ 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 + below is not recommended. However, it does free memory when it's destroyed, so if you destroy array also, it's ok. */ // ---------------------------------------------------------------------------- @@ -261,6 +325,14 @@ private: \ */ #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*, @@ -287,11 +359,11 @@ private: \
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 + 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 + 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' @@ -310,7 +382,7 @@ private: \ 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 + cicrcular dependencies with classes which have member variables of list type. @memo define (must include listimpl.cpp!) list class 'name' @@ -323,6 +395,8 @@ private: \ // # overhead if not used? // ---------------------------------------------------------------------------- +#define WXDLLEXPORTLOCAL WXDLLEXPORT + //@{ /** @name ArrayInt */ WX_DEFINE_ARRAY(int, wxArrayInt); @@ -334,5 +408,8 @@ WX_DEFINE_ARRAY(void *, wxArrayPtrVoid); //@} +#undef WXDLLEXPORTLOCAL +#define WXDLLEXPORTLOCAL + #endif // _DYNARRAY_H