git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15274 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
		
			
				
	
	
		
			627 lines
		
	
	
		
			35 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			627 lines
		
	
	
		
			35 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
///////////////////////////////////////////////////////////////////////////////
 | 
						|
// Name:        dynarray.h
 | 
						|
// Purpose:     auto-resizable (i.e. dynamic) array support
 | 
						|
// Author:      Vadim Zeitlin
 | 
						|
// Modified by:
 | 
						|
// Created:     12.09.97
 | 
						|
// RCS-ID:      $Id$
 | 
						|
// Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 | 
						|
// Licence:     wxWindows license
 | 
						|
///////////////////////////////////////////////////////////////////////////////
 | 
						|
 | 
						|
#ifndef   _DYNARRAY_H
 | 
						|
#define   _DYNARRAY_H
 | 
						|
 | 
						|
#ifdef __GNUG__
 | 
						|
#pragma interface "dynarray.h"
 | 
						|
#endif
 | 
						|
 | 
						|
#include "wx/defs.h"
 | 
						|
 | 
						|
/*
 | 
						|
  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 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)
 | 
						|
 | 
						|
// ----------------------------------------------------------------------------
 | 
						|
// types
 | 
						|
// ----------------------------------------------------------------------------
 | 
						|
 | 
						|
/*
 | 
						|
    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.
 | 
						|
 */
 | 
						|
extern "C"
 | 
						|
{
 | 
						|
typedef int (wxCMPFUNC_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
 | 
						|
//     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_DECLARE_BASEARRAY(T, name, classexp)                   \
 | 
						|
classexp name                                                       \
 | 
						|
{                                                                   \
 | 
						|
public:                                                             \
 | 
						|
  name();                                                           \
 | 
						|
  name(const name& array);                                          \
 | 
						|
  name& operator=(const name& src);                                 \
 | 
						|
  ~name();                                                          \
 | 
						|
                                                                    \
 | 
						|
  void Empty() { m_nCount = 0; }                                    \
 | 
						|
  void Clear();                                                     \
 | 
						|
  void Alloc(size_t uiSize);                                        \
 | 
						|
  void Shrink();                                                    \
 | 
						|
                                                                    \
 | 
						|
  size_t  GetCount() const { return m_nCount; }                     \
 | 
						|
  bool  IsEmpty() const { return m_nCount == 0; }                   \
 | 
						|
  size_t  Count() const { return m_nCount; }                        \
 | 
						|
                                                                    \
 | 
						|
  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); }     \
 | 
						|
                                                                    \
 | 
						|
  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, size_t nInsert = 1);                            \
 | 
						|
  void Add(T lItem, CMPFUNC fnCompare);                             \
 | 
						|
  void Insert(T lItem, size_t uiIndex, size_t nInsert = 1);         \
 | 
						|
  void Remove(T lItem);                                             \
 | 
						|
  void RemoveAt(size_t uiIndex, size_t nRemove = 1);                \
 | 
						|
                                                                    \
 | 
						|
  void Sort(CMPFUNC fnCompare);                                     \
 | 
						|
                                                                    \
 | 
						|
private:                                                            \
 | 
						|
                                                                    \
 | 
						|
  void    Grow(size_t nIncrement = 0);                              \
 | 
						|
                                                                    \
 | 
						|
  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, size_t nInsert = 1)                                \
 | 
						|
    { base::Add(Item, nInsert); }                                     \
 | 
						|
  void Insert(T Item, size_t uiIndex, size_t nInsert = 1)             \
 | 
						|
    { base::Insert(Item, uiIndex, nInsert) ; }                        \
 | 
						|
                                                                      \
 | 
						|
  void RemoveAt(size_t uiIndex, size_t nRemove = 1)                   \
 | 
						|
    { base::RemoveAt(uiIndex, nRemove); }                             \
 | 
						|
  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); }           \
 | 
						|
}
 | 
						|
 | 
						|
// ----------------------------------------------------------------------------
 | 
						|
// _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, size_t nRemove = 1)                   \
 | 
						|
    { base::RemoveAt(uiIndex, nRemove); }                             \
 | 
						|
  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, size_t nInsert = 1);                           \
 | 
						|
  void Add(const T* pItem)                                               \
 | 
						|
    { base::Add((T*)pItem); }                                            \
 | 
						|
                                                                         \
 | 
						|
  void Insert(const T& Item,  size_t uiIndex, size_t nInsert = 1);       \
 | 
						|
  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, size_t nRemove = 1);                     \
 | 
						|
                                                                         \
 | 
						|
  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
 | 
						|
//     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.
 | 
						|
//  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: 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_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)
 | 
						|
 | 
						|
// ----------------------------------------------------------------------------
 | 
						|
// 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_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
 | 
						|
// ----------------------------------------------------------------------------
 | 
						|
 | 
						|
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
 | 
						|
 |