Merge branch 'array-less-macros'

Use templates to implement the legacy dynamic array classes as much as
possible instead of doing it in macros.

This makes the code much more maintainable and readable as well as
easier to debug.

It also allows to avoid casts between function pointers of incompatible
types, which triggered many -Wcast-function-type warnings from g++ 8.
This commit is contained in:
Vadim Zeitlin
2018-06-10 15:02:08 +02:00
6 changed files with 449 additions and 1057 deletions

View File

@@ -632,13 +632,13 @@ these classes provide a subset or almost complete STL API.
Related Overviews: @ref overview_container
@li wxArray<T>: A type-safe dynamic array implementation (macro based)
@li wxArray<T>: Legacy dynamic array, use srd::vector or wxVector instead.
@li wxArrayString: An efficient container for storing wxString objects
@li wxHashMap<T>: A type-safe hash map implementation (macro based)
@li wxHashSet<T>: A type-safe hash set implementation(macro based)
@li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
@li wxList<T>: A type-safe linked list implementation (macro based)
@li wxVector<T>: Template base vector implementation identical to std::vector
@li wxVector<T>: Template base vector implementation identical to std::vector.

View File

@@ -9,7 +9,7 @@
///////////////////////////////////////////////////////////////////////////////
/*****************************************************************************
* Purpose: implements methods of "template" class declared in *
* Purpose: implements helper functions used by the template class used by *
* DECLARE_OBJARRAY macro and which couldn't be implemented inline *
* (because they need the full definition of type T in scope) *
* *
@@ -19,101 +19,15 @@
* 4) WX_DEFINE_OBJARRAY *
*****************************************************************************/
// needed to resolve the conflict between global T and macro parameter T
#define _WX_ERROR_REMOVE2(x) wxT("bad index in ") wxT(#x) wxT("::RemoveAt()")
// macro implements remaining (not inline) methods of template list
// (it's private to this file)
#undef _DEFINE_OBJARRAY
#define _DEFINE_OBJARRAY(T, name) \
name::~name() \
{ \
Empty(); \
} \
\
void name::DoCopy(const name& src) \
{ \
for ( size_t ui = 0; ui < src.size(); ui++ ) \
Add(src[ui]); \
} \
\
name& name::operator=(const name& src) \
{ \
Empty(); \
DoCopy(src); \
\
return *this; \
} \
\
name::name(const name& src) : wxArrayPtrVoid() \
{ \
DoCopy(src); \
} \
\
void name::DoEmpty() \
{ \
for ( size_t ui = 0; ui < size(); ui++ ) \
delete (T*)base_array::operator[](ui); \
} \
\
void name::RemoveAt(size_t uiIndex, size_t nRemove) \
{ \
wxCHECK_RET( uiIndex < size(), _WX_ERROR_REMOVE2(name) ); \
\
for (size_t i = 0; i < nRemove; i++ ) \
delete (T*)base_array::operator[](uiIndex + i); \
\
base_array::erase(begin() + uiIndex, begin() + uiIndex + nRemove); \
} \
\
void name::Add(const T& item, size_t nInsert) \
{ \
if (nInsert == 0) \
return; \
T* pItem = new T(item); \
size_t nOldSize = size(); \
if ( pItem != NULL ) \
base_array::insert(end(), nInsert, pItem); \
for (size_t i = 1; i < nInsert; i++) \
base_array::operator[](nOldSize + i) = new T(item); \
} \
\
void name::Insert(const T& item, size_t uiIndex, size_t nInsert) \
{ \
if (nInsert == 0) \
return; \
T* pItem = new T(item); \
if ( pItem != NULL ) \
base_array::insert(begin() + uiIndex, nInsert, pItem); \
for (size_t i = 1; i < nInsert; i++) \
base_array::operator[](uiIndex + i) = new T(item); \
} \
\
int name::Index(const T& item, bool bFromEnd) const \
{ \
if ( bFromEnd ) { \
if ( size() > 0 ) { \
size_t ui = size() - 1; \
do { \
if ( (T*)base_array::operator[](ui) == &item ) \
return static_cast<int>(ui); \
ui--; \
} \
while ( ui != 0 ); \
} \
} \
else { \
for( size_t ui = 0; ui < size(); ui++ ) { \
if( (T*)base_array::operator[](ui) == &item ) \
return static_cast<int>(ui); \
} \
} \
\
return wxNOT_FOUND; \
}
// redefine the macro so that now it will generate the class implementation
// old value would provoke a compile-time error if this file is not included
#undef WX_DEFINE_OBJARRAY
#define WX_DEFINE_OBJARRAY(name) _DEFINE_OBJARRAY(_wxObjArray##name, name)
#define WX_DEFINE_OBJARRAY(name) \
name::value_type* \
wxObjectArrayTraitsFor##name::Clone(const name::value_type& item) \
{ \
return new name::value_type(item); \
} \
\
void wxObjectArrayTraitsFor##name::Free(name::value_type* p) \
{ \
delete p; \
}

View File

@@ -13,6 +13,7 @@
#include "wx/defs.h"
#include "wx/string.h"
#include "wx/dynarray.h"
#if wxUSE_STD_CONTAINERS_COMPATIBLY
#include <vector>
@@ -49,15 +50,9 @@ wxDictionaryStringSortDescending(const wxString& s1, const wxString& s2)
#if wxUSE_STD_CONTAINERS
#include "wx/dynarray.h"
typedef int (wxCMPFUNC_CONV *CMPFUNCwxString)(wxString*, wxString*);
typedef wxString _wxArraywxBaseArrayStringBase;
_WX_DECLARE_BASEARRAY_2(_wxArraywxBaseArrayStringBase, wxBaseArrayStringBase,
wxArray_SortFunction<wxString>,
class WXDLLIMPEXP_BASE);
WX_DEFINE_USER_EXPORTED_TYPEARRAY(wxString, wxArrayStringBase,
wxBaseArrayStringBase, WXDLLIMPEXP_BASE);
wxARRAY_DUMMY_BASE, WXDLLIMPEXP_BASE);
class WXDLLIMPEXP_BASE wxArrayString : public wxArrayStringBase
{
@@ -86,7 +81,7 @@ public:
};
_WX_DEFINE_SORTED_TYPEARRAY_2(wxString, wxSortedArrayStringBase,
wxBaseArrayStringBase, = wxStringSortAscending,
wxArrayStringBase, = wxStringSortAscending,
class WXDLLIMPEXP_BASE, wxArrayString::CompareFunction);
class WXDLLIMPEXP_BASE wxSortedArrayString : public wxSortedArrayStringBase

File diff suppressed because it is too large Load Diff

View File

@@ -6,6 +6,8 @@
/////////////////////////////////////////////////////////////////////////////
/**
The legacy dynamic array class, existing for compatibility only and @e NOT
to be used in the new code.
This section describes the so called @e "dynamic arrays". This is a C
array-like type safe data structure i.e. the member access time is constant

View File

@@ -24,368 +24,7 @@
#include "wx/intl.h"
#endif //WX_PRECOMP
#include <stdlib.h>
#include <string.h> // for memmove
#if !wxUSE_STD_CONTAINERS
// we cast the value to long from which we cast it to void * in IndexForInsert:
// this can't work if the pointers are not big enough
wxCOMPILE_TIME_ASSERT( sizeof(wxUIntPtr) <= sizeof(void *),
wxArraySizeOfPtrLessSizeOfLong ); // < 32 symbols
// ============================================================================
// constants
// ============================================================================
// size increment = max(50% of current size, ARRAY_MAXSIZE_INCREMENT)
#define ARRAY_MAXSIZE_INCREMENT 4096
// ============================================================================
// implementation
// ============================================================================
// ----------------------------------------------------------------------------
// wxBaseArray - dynamic array of 'T's
// ----------------------------------------------------------------------------
#define _WX_DEFINE_BASEARRAY(T, name) \
/* searches the array for an item (forward or backwards) */ \
int name::Index(T lItem, bool bFromEnd) const \
{ \
if ( bFromEnd ) { \
if ( size() > 0 ) { \
size_t n = size(); \
do { \
if ( (*this)[--n] == lItem ) \
return n; \
} \
while ( n != 0 ); \
} \
} \
else { \
for( size_t n = 0; n < size(); n++ ) { \
if( (*this)[n] == lItem ) \
return n; \
} \
} \
\
return wxNOT_FOUND; \
} \
\
/* add item assuming the array is sorted with fnCompare function */ \
size_t name::Add(T lItem, CMPFUNC fnCompare) \
{ \
size_t idx = IndexForInsert(lItem, fnCompare); \
Insert(lItem, idx); \
return idx; \
} \
\
/* ctor */ \
name::name() \
{ \
m_nSize = \
m_nCount = 0; \
m_pItems = NULL; \
} \
\
/* copy ctor */ \
name::name(const name& src) \
{ \
m_nSize = /* not src.m_nSize to save memory */ \
m_nCount = src.m_nCount; \
\
if ( m_nSize != 0 ) { \
m_pItems = new T[m_nSize]; \
/* only copy if allocation succeeded */ \
if ( m_pItems ) { \
memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(T)); \
} \
else { \
m_nSize = 0; \
} \
} \
else \
m_pItems = NULL; \
} \
\
/* assignment operator */ \
name& name::operator=(const name& src) \
{ \
wxDELETEA(m_pItems); \
\
m_nSize = /* not src.m_nSize to save memory */ \
m_nCount = src.m_nCount; \
\
if ( m_nSize != 0 ){ \
m_pItems = new T[m_nSize]; \
/* only copy if allocation succeeded */ \
if ( m_pItems ) { \
memcpy(m_pItems, src.m_pItems, m_nCount*sizeof(T)); \
} \
else { \
m_nSize = 0; \
} \
} \
else \
m_pItems = NULL; \
\
return *this; \
} \
\
/* allocate new buffer of the given size and move our data to it */ \
bool name::Realloc(size_t nSize) \
{ \
T *pNew = new T[nSize]; \
/* only grow if allocation succeeded */ \
if ( !pNew ) \
return false; \
\
m_nSize = nSize; \
/* copy data to new location */ \
memcpy(pNew, m_pItems, m_nCount*sizeof(T)); \
delete [] m_pItems; \
m_pItems = pNew; \
\
return true; \
} \
\
/* grow the array */ \
void name::Grow(size_t nIncrement) \
{ \
/* only do it if no more place */ \
if( (m_nCount == m_nSize) || ((m_nSize - m_nCount) < nIncrement) ) { \
if( m_nSize == 0 ) { \
/* was empty, determine initial size */ \
size_t sz = WX_ARRAY_DEFAULT_INITIAL_SIZE; \
if (sz < nIncrement) sz = nIncrement; \
/* allocate some memory */ \
m_pItems = new T[sz]; \
/* only grow if allocation succeeded */ \
if ( m_pItems ) { \
m_nSize = sz; \
} \
} \
else \
{ \
/* add at least 50% but not too much */ \
size_t ndefIncrement = m_nSize < WX_ARRAY_DEFAULT_INITIAL_SIZE \
? WX_ARRAY_DEFAULT_INITIAL_SIZE : m_nSize >> 1; \
if ( ndefIncrement > ARRAY_MAXSIZE_INCREMENT ) \
ndefIncrement = ARRAY_MAXSIZE_INCREMENT; \
if ( nIncrement < ndefIncrement ) \
nIncrement = ndefIncrement; \
Realloc(m_nSize + nIncrement); \
} \
} \
} \
\
/* make sure that the array has at least count elements */ \
void name::SetCount(size_t count, T defval) \
{ \
if ( m_nSize < count ) \
{ \
/* need to realloc memory: don't overallocate it here as if */ \
/* SetCount() is called, it probably means that the caller */ \
/* knows in advance how many elements there will be in the */ \
/* array and so it won't be necessary to realloc it later */ \
if ( !Realloc(count) ) \
{ \
/* out of memory -- what can we do? */ \
return; \
} \
} \
\
/* add new elements if we extend the array */ \
while ( m_nCount < count ) \
{ \
m_pItems[m_nCount++] = defval; \
} \
} \
\
/* dtor */ \
name::~name() \
{ \
wxDELETEA(m_pItems); \
} \
\
/* clears the list */ \
void name::Clear() \
{ \
m_nSize = \
m_nCount = 0; \
\
wxDELETEA(m_pItems); \
} \
\
/* minimizes the memory usage by freeing unused memory */ \
void name::Shrink() \
{ \
/* only do it if we have some memory to free */ \
if( m_nCount < m_nSize ) { \
/* allocates exactly as much memory as we need */ \
T *pNew = new T[m_nCount]; \
/* only shrink if allocation succeeded */ \
if ( pNew ) { \
/* copy data to new location */ \
memcpy(pNew, m_pItems, m_nCount*sizeof(T)); \
delete [] m_pItems; \
m_pItems = pNew; \
\
/* update the size of the new block */ \
m_nSize = m_nCount; \
} \
/* else: don't do anything, better keep old memory block! */ \
} \
} \
\
/* add item at the end */ \
void name::Add(T lItem, size_t nInsert) \
{ \
if (nInsert == 0) \
return; \
Grow(nInsert); \
for (size_t i = 0; i < nInsert; i++) \
m_pItems[m_nCount++] = lItem; \
} \
\
/* add item at the given position */ \
void name::Insert(T lItem, size_t nIndex, size_t nInsert) \
{ \
wxCHECK_RET( nIndex <= m_nCount, wxT("bad index in wxArray::Insert") ); \
wxCHECK_RET( m_nCount <= m_nCount + nInsert, \
wxT("array size overflow in wxArray::Insert") ); \
\
if (nInsert == 0) \
return; \
Grow(nInsert); \
\
memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex], \
(m_nCount - nIndex)*sizeof(T)); \
for (size_t i = 0; i < nInsert; i++) \
m_pItems[nIndex + i] = lItem; \
m_nCount += nInsert; \
} \
\
/* search for a place to insert item into sorted array (binary search) */ \
size_t name::IndexForInsert(T lItem, CMPFUNC fnCompare) const \
{ \
size_t i, \
lo = 0, \
hi = m_nCount; \
int res; \
\
while ( lo < hi ) { \
i = (lo + hi)/2; \
\
res = (*fnCompare)((const void *)(wxUIntPtr)lItem, \
(const void *)(wxUIntPtr)(m_pItems[i])); \
if ( res < 0 ) \
hi = i; \
else if ( res > 0 ) \
lo = i + 1; \
else { \
lo = i; \
break; \
} \
} \
\
return lo; \
} \
\
/* search for an item in a sorted array (binary search) */ \
int name::Index(T lItem, CMPFUNC fnCompare) const \
{ \
size_t n = IndexForInsert(lItem, fnCompare); \
\
return (n >= m_nCount || \
(*fnCompare)((const void *)(wxUIntPtr)lItem, \
((const void *)(wxUIntPtr)m_pItems[n]))) \
? wxNOT_FOUND \
: (int)n; \
} \
\
/* removes item from array (by index) */ \
void name::RemoveAt(size_t nIndex, size_t nRemove) \
{ \
wxCHECK_RET( nIndex < m_nCount, wxT("bad index in wxArray::RemoveAt") ); \
wxCHECK_RET( nIndex + nRemove <= m_nCount, \
wxT("removing too many elements in wxArray::RemoveAt") ); \
\
memmove(&m_pItems[nIndex], &m_pItems[nIndex + nRemove], \
(m_nCount - nIndex - nRemove)*sizeof(T)); \
m_nCount -= nRemove; \
} \
\
/* removes item from array (by value) */ \
void name::Remove(T lItem) \
{ \
int iIndex = Index(lItem); \
\
wxCHECK_RET( iIndex != wxNOT_FOUND, \
wxT("removing inexistent item in wxArray::Remove") ); \
\
RemoveAt((size_t)iIndex); \
} \
\
/* sort array elements using passed comparaison function */ \
void name::Sort(CMPFUNC fCmp) \
{ \
qsort(m_pItems, m_nCount, sizeof(T), fCmp); \
} \
\
void name::assign(const_iterator first, const_iterator last) \
{ \
clear(); \
reserve(last - first); \
for(; first != last; ++first) \
push_back(*first); \
} \
\
void name::assign(size_type n, const_reference v) \
{ \
clear(); \
reserve(n); \
for( size_type i = 0; i < n; ++i ) \
push_back(v); \
} \
\
void name::insert(iterator it, const_iterator first, const_iterator last) \
{ \
size_t nInsert = last - first, nIndex = it - begin(); \
if (nInsert == 0) \
return; \
Grow(nInsert); \
\
/* old iterator could have been invalidated by Grow(). */ \
it = begin() + nIndex; \
\
memmove(&m_pItems[nIndex + nInsert], &m_pItems[nIndex], \
(m_nCount - nIndex)*sizeof(T)); \
for (size_t i = 0; i < nInsert; ++i, ++it, ++first) \
*it = *first; \
m_nCount += nInsert; \
}
#ifdef __INTELC__
#pragma warning(push)
#pragma warning(disable: 1684)
#pragma warning(disable: 1572)
#endif
_WX_DEFINE_BASEARRAY(const void *, wxBaseArrayPtrVoid)
_WX_DEFINE_BASEARRAY(char, wxBaseArrayChar)
_WX_DEFINE_BASEARRAY(short, wxBaseArrayShort)
_WX_DEFINE_BASEARRAY(int, wxBaseArrayInt)
_WX_DEFINE_BASEARRAY(long, wxBaseArrayLong)
_WX_DEFINE_BASEARRAY(size_t, wxBaseArraySizeT)
_WX_DEFINE_BASEARRAY(double, wxBaseArrayDouble)
#ifdef __INTELC__
#pragma warning(pop)
#endif
#else // wxUSE_STD_CONTAINERS
#if wxUSE_STD_CONTAINERS
#include "wx/arrstr.h"
@@ -493,4 +132,4 @@ int wxSortedArrayString::Index(const wxString& str,
return it - begin();
}
#endif // !wxUSE_STD_CONTAINERS/wxUSE_STD_CONTAINERS
#endif // wxUSE_STD_CONTAINERS