include/wx/dynarray.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        dynarray.h
   3 // Purpose:     auto-resizable (i.e. dynamic) array support
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     12.09.97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _DYNARRAY_H
  13 #define   _DYNARRAY_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface "dynarray.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 /** @name Dynamic arrays and object arrays (array which own their elements)
  22     @memo Arrays which grow on demand and do range checking (only in debug)
  23   */
  24 //@{
  25
  26 // ----------------------------------------------------------------------------
  27 // constants
  28 // ----------------------------------------------------------------------------
  29
  30 /**
  31  the initial size by which an array grows when an element is added
  32  default value avoids allocate one or two bytes when the array is created
  33  which is rather inefficient
  34 */
  35 #define   WX_ARRAY_DEFAULT_INITIAL_SIZE    (16)
  36
  37 // ----------------------------------------------------------------------------
  38 // types
  39 // ----------------------------------------------------------------------------
  40
  41 /**
  42  callback compare function for quick sort
  43  must return negative value, 0 or positive value if pItem1 <, = or > pItem2
  44  */
  45 typedef int (wxCMPFUNC_CONV *CMPFUNC)(const void* pItem1, const void* pItem2);
  46
  47 // ----------------------------------------------------------------------------
  48 /**
  49  base class managing data having size of type 'long' (not used directly)
  50
  51  NB: for efficiency this often used class has no virtual functions (hence no
  52      VTBL), even dtor is <B>not</B> virtual. If used as expected it won't
  53      create any problems because ARRAYs from DEFINE_ARRAY have no dtor at all,
  54      so it's not too important if it's not called (this happens when you cast
  55      "SomeArray *" as "BaseArray *" and then delete it)
  56
  57   @memo Base class for template array classes
  58 */
  59 // ----------------------------------------------------------------------------
  60 class WXDLLEXPORT wxBaseArray
  61 {
  62 public:
  63   /** @name ctors and dtor */
  64   //@{
  65     /// default ctor
  66   wxBaseArray();
  67     /// copy ctor
  68   wxBaseArray(const wxBaseArray& array);
  69     /// assignment operator
  70   wxBaseArray& operator=(const wxBaseArray& src);
  71     /// not virtual, see above
  72     /// EXCEPT for Gnu compiler to reduce warnings...
  73 #ifdef __GNUG__
  74  virtual
  75 #endif
  76   ~wxBaseArray();
  77   //@}
  78
  79   /** @name memory management */
  80   //@{
  81     /// empties the array, but doesn't release memory
  82   void Empty() { m_nCount = 0; }
  83     /// empties the array and releases memory
  84   void Clear();
  85     /// preallocates memory for given number of items
  86   void Alloc(size_t uiSize);
  87     /// minimizes the memory used by the array (frees unused memory)
  88   void Shrink();
  89   //@}
  90
  91   /** @name simple accessors */
  92   //@{
  93     /// number of elements in the array
  94   size_t  Count() const   { return m_nCount;      }
  95   size_t  GetCount() const   { return m_nCount;      }
  96     /// is it empty?
  97   bool  IsEmpty() const { return m_nCount == 0; }
  98   //@}
  99
 100 protected:
 101   // these methods are protected because if they were public one could
 102   // mistakenly call one of them instead of DEFINE_ARRAY's or OBJARRAY's
 103   // type safe methods
 104
 105   /** @name items access */
 106   //@{
 107     /// get item at position uiIndex (range checking is done in debug version)
 108   long& Item(size_t uiIndex) const
 109     { wxASSERT( uiIndex < m_nCount ); return m_pItems[uiIndex]; }
 110     /// same as Item()
 111   long& operator[](size_t uiIndex) const { return Item(uiIndex); }
 112   //@}
 113
 114   /** @name item management */
 115   //@{
 116     /**
 117       Search the element in the array, starting from the either side
 118       @param bFromEnd if TRUE, start from the end
 119       @return index of the first item matched or wxNOT_FOUND
 120       @see wxNOT_FOUND
 121      */
 122   int Index(long lItem, bool bFromEnd = FALSE) const;
 123     /// search for an item using binary search in a sorted array
 124   int Index(long lItem, CMPFUNC fnCompare) const;
 125     /// add new element at the end
 126   void Add(long lItem);
 127     /// add item assuming the array is sorted with fnCompare function
 128   void Add(long lItem, CMPFUNC fnCompare);
 129     /// add new element at given position (it becomes Item[uiIndex])
 130   void Insert(long lItem, size_t uiIndex);
 131     /// remove first item matching this value
 132   void Remove(long lItem);
 133     /// remove item by index
 134   void RemoveAt(size_t uiIndex);
 135   //@}
 136
 137   /// sort array elements using given compare function
 138   void Sort(CMPFUNC fnCompare);
 139
 140 private:
 141   void    Grow();     // makes array bigger if needed
 142
 143   size_t  m_nSize,    // current size of the array
 144           m_nCount;   // current number of elements
 145
 146   long   *m_pItems;   // pointer to data
 147 };
 148
 149 // ============================================================================
 150 // template classes
 151 // ============================================================================
 152
 153 // resolves the name conflict between the wxT() macor and T typedef: we can't
 154 // use wxT() inside WX_DEFINE_ARRAY!
 155 #define _WX_ERROR_SIZEOF   wxT("illegal use of DEFINE_ARRAY")
 156 #define _WX_ERROR_REMOVE   wxT("removing inexisting element in wxArray::Remove")
 157
 158 // ----------------------------------------------------------------------------
 159 // This macro generates a new array class. It is intended for storage of simple
 160 // types of sizeof()<=sizeof(long) or pointers if sizeof(pointer)<=sizeof(long)
 161 //
 162 // NB: it has only inline functions => takes no space at all
 163 // Mod by JACS: Salford C++ doesn't like 'var->operator=' syntax, as in:
 164 //    { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
 165 // so using a temporary variable instead.
 166 // ----------------------------------------------------------------------------
 167 #define  _WX_DEFINE_ARRAY(T, name, classexp)                        \
 168 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T *pItem1, T *pItem2);       \
 169 classexp name : public wxBaseArray                                  \
 170 {                                                                   \
 171 public:                                                             \
 172   name()                                                            \
 173   {                                                                 \
 174     size_t type = sizeof(T);                                        \
 175     size_t sizelong = sizeof(long);                                 \
 176     if ( type > sizelong )                                          \
 177       { wxFAIL_MSG( _WX_ERROR_SIZEOF ); }                           \
 178   }                                                                 \
 179                                                                     \
 180   name& operator=(const name& src)                                  \
 181     { wxBaseArray* temp = (wxBaseArray*) this;                      \
 182       (*temp) = ((const wxBaseArray&)src);                          \
 183       return *this; }                                               \
 184                                                                     \
 185   T& operator[](size_t uiIndex) const                               \
 186     { return (T&)(wxBaseArray::Item(uiIndex)); }                    \
 187   T& Item(size_t uiIndex) const                                     \
 188     { return (T&)(wxBaseArray::Item(uiIndex)); }                    \
 189   T& Last() const                                                   \
 190     { return (T&)(wxBaseArray::Item(Count() - 1)); }                \
 191                                                                     \
 192   int Index(T Item, bool bFromEnd = FALSE) const                    \
 193     { return wxBaseArray::Index((long)Item, bFromEnd); }            \
 194                                                                     \
 195   void Add(T Item)                                                  \
 196     { wxBaseArray::Add((long)Item); }                               \
 197   void Insert(T Item, size_t uiIndex)                               \
 198     { wxBaseArray::Insert((long)Item, uiIndex) ; }                  \
 199                                                                     \
 200   void Remove(size_t uiIndex) { RemoveAt(uiIndex); }                \
 201   void RemoveAt(size_t uiIndex) { wxBaseArray::RemoveAt(uiIndex); } \
 202   void Remove(T Item)                                               \
 203     { int iIndex = Index(Item);                                     \
 204       wxCHECK2_MSG( iIndex != wxNOT_FOUND, return,                  \
 205          _WX_ERROR_REMOVE);                                         \
 206       wxBaseArray::RemoveAt((size_t)iIndex); }                      \
 207                                                                     \
 208   void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); }  \
 209 }
 210
 211 // ----------------------------------------------------------------------------
 212 // This is the same as the previous macro, but it defines a sorted array.
 213 // Differences:
 214 //  1) it must be given a COMPARE function in ctor which takes 2 items of type
 215 //     T* and should return -1, 0 or +1 if the first one is less/greater
 216 //     than/equal to the second one.
 217 //  2) the Add() method inserts the item in such was that the array is always
 218 //     sorted (it uses the COMPARE function)
 219 //  3) it has no Sort() method because it's always sorted
 220 //  4) Index() method is much faster (the sorted arrays use binary search
 221 //     instead of linear one), but Add() is slower.
 222 //
 223 // Summary: use this class when the speed of Index() function is important, use
 224 // the normal arrays otherwise.
 225 //
 226 // NB: it has only inline functions => takes no space at all
 227 // Mod by JACS: Salford C++ doesn't like 'var->operator=' syntax, as in:
 228 //    { ((wxBaseArray *)this)->operator=((const wxBaseArray&)src);
 229 // so using a temporary variable instead.
 230 // ----------------------------------------------------------------------------
 231 #define  _WX_DEFINE_SORTED_ARRAY(T, name, classexp)                 \
 232 typedef int (CMPFUNC_CONV *SCMPFUNC##T)(T pItem1, T pItem2);        \
 233 classexp name : public wxBaseArray                                  \
 234 {                                                                   \
 235 public:                                                             \
 236   name(SCMPFUNC##T fn)                                              \
 237   { size_t type = sizeof(T);                                        \
 238     size_t sizelong = sizeof(long);                                 \
 239     if ( type > sizelong )                                          \
 240       { wxFAIL_MSG( _WX_ERROR_SIZEOF ); }                           \
 241     m_fnCompare = fn;                                               \
 242   }                                                                 \
 243                                                                     \
 244   name& operator=(const name& src)                                  \
 245     { wxBaseArray* temp = (wxBaseArray*) this;                      \
 246       (*temp) = ((const wxBaseArray&)src);                          \
 247       m_fnCompare = src.m_fnCompare;                                \
 248       return *this; }                                               \
 249                                                                     \
 250   T& operator[](size_t uiIndex) const                               \
 251     { return (T&)(wxBaseArray::Item(uiIndex)); }                    \
 252   T& Item(size_t uiIndex) const                                     \
 253     { return (T&)(wxBaseArray::Item(uiIndex)); }                    \
 254   T& Last() const                                                   \
 255     { return (T&)(wxBaseArray::Item(Count() - 1)); }                \
 256                                                                     \
 257   int Index(T Item) const                                           \
 258     { return wxBaseArray::Index((long)Item, (CMPFUNC)m_fnCompare); }\
 259                                                                     \
 260   void Add(T Item)                                                  \
 261     { wxBaseArray::Add((long)Item, (CMPFUNC)m_fnCompare); }         \
 262                                                                     \
 263   void Remove(size_t uiIndex) { RemoveAt(uiIndex); }                \
 264   void RemoveAt(size_t uiIndex) { wxBaseArray::RemoveAt(uiIndex); } \
 265   void Remove(T Item)                                               \
 266     { int iIndex = Index(Item);                                     \
 267       wxCHECK2_MSG( iIndex != wxNOT_FOUND, return,                  \
 268         _WX_ERROR_REMOVE );                                         \
 269       wxBaseArray::RemoveAt((size_t)iIndex); }                      \
 270                                                                     \
 271 private:                                                            \
 272   SCMPFUNC##T m_fnCompare;                                          \
 273 }
 274
 275 // ----------------------------------------------------------------------------
 276 // see WX_DECLARE_OBJARRAY and WX_DEFINE_OBJARRAY
 277 // ----------------------------------------------------------------------------
 278 #define _WX_DECLARE_OBJARRAY(T, name, classexp)                     \
 279 typedef int (CMPFUNC_CONV *CMPFUNC##T)(T** pItem1, T** pItem2);     \
 280 classexp name : public wxBaseArray                                  \
 281 {                                                                   \
 282 public:                                                             \
 283   name() { }                                                        \
 284   name(const name& src);                                            \
 285   name& operator=(const name& src);                                 \
 286                                                                     \
 287   ~name();                                                          \
 288                                                                     \
 289   T& operator[](size_t uiIndex) const                               \
 290     { return *(T*)wxBaseArray::Item(uiIndex); }                     \
 291   T& Item(size_t uiIndex) const                                     \
 292     { return *(T*)wxBaseArray::Item(uiIndex); }                     \
 293   T& Last() const                                                   \
 294     { return *(T*)(wxBaseArray::Item(Count() - 1)); }               \
 295                                                                     \
 296   int Index(const T& Item, bool bFromEnd = FALSE) const;            \
 297                                                                     \
 298   void Add(const T& Item);                                          \
 299   void Add(const T* pItem)                                          \
 300     { wxBaseArray::Add((long)pItem); }                              \
 301                                                                     \
 302   void Insert(const T& Item,  size_t uiIndex);                      \
 303   void Insert(const T* pItem, size_t uiIndex)                       \
 304     { wxBaseArray::Insert((long)pItem, uiIndex); }                  \
 305                                                                     \
 306   void Empty() { DoEmpty(); wxBaseArray::Empty(); }                 \
 307   void Clear() { DoEmpty(); wxBaseArray::Clear(); }                 \
 308                                                                     \
 309   T*   Detach(size_t uiIndex)                                       \
 310     { T* p = (T*)wxBaseArray::Item(uiIndex);                        \
 311       wxBaseArray::RemoveAt(uiIndex); return p; }                   \
 312   void Remove(size_t uiIndex) { RemoveAt(uiIndex); }                \
 313   void RemoveAt(size_t uiIndex);                                    \
 314                                                                     \
 315   void Sort(CMPFUNC##T fCmp) { wxBaseArray::Sort((CMPFUNC)fCmp); }  \
 316                                                                     \
 317 private:                                                            \
 318   void DoEmpty();                                                   \
 319   void DoCopy(const name& src);                                     \
 320 }
 321
 322 // ----------------------------------------------------------------------------
 323 /** @name Macros for definition of dynamic arrays and objarrays
 324
 325   These macros are ugly (especially if you look in the sources ;-), but they
 326   allow us to define 'template' classes without actually using templates.
 327   <BR>
 328   <BR>
 329   Range checking is performed in debug build for both arrays and objarrays.
 330   Type checking is done at compile-time. Warning: arrays <I>never</I> shrink,
 331   they only grow, so loading 10 millions in an array only to delete them 2
 332   lines below is <I>not</I> recommended. However, it does free memory when
 333   it's destroyed, so if you destroy array also, it's ok.
 334   */
 335 // ----------------------------------------------------------------------------
 336
 337 //@{
 338   /**
 339    This macro generates a new array class. It is intended for storage of simple
 340    types of sizeof()<=sizeof(long) or pointers if sizeof(pointer)<=sizeof(long)
 341    <BR>
 342    NB: it has only inline functions => takes no space at all
 343    <BR>
 344
 345    @memo declare and define array class 'name' containing elements of type 'T'
 346   */
 347 #define WX_DEFINE_ARRAY(T, name)                \
 348     typedef T _A##name;                         \
 349     _WX_DEFINE_ARRAY(_A##name, name, class)
 350
 351   /**
 352    This macro does the same as WX_DEFINE_ARRAY except that the array will be
 353    sorted with the specified compare function.
 354    */
 355 #define WX_DEFINE_SORTED_ARRAY(T, name)             \
 356     typedef T _A##name;                             \
 357     _WX_DEFINE_SORTED_ARRAY(_A##name, name, class)
 358
 359   /**
 360    This macro generates a new objarrays class which owns the objects it
 361    contains, i.e. it will delete them when it is destroyed. An element is of
 362    type T*, but arguments of type T& are taken (see below!) and T& is
 363    returned. <BR>
 364    Don't use this for simple types such as "int" or "long"!
 365    You _may_ use it for "double" but it's awfully inefficient.
 366    <BR>
 367    <BR>
 368    Note on Add/Insert functions:
 369    <BR>
 370     1) function(T*) gives the object to the array, i.e. it will delete the
 371        object when it's removed or in the array's dtor
 372    <BR>
 373     2) function(T&) will create a copy of the object and work with it
 374    <BR>
 375    <BR>
 376    Also:
 377    <BR>
 378     1) Remove() will delete the object after removing it from the array
 379    <BR>
 380     2) Detach() just removes the object from the array (returning pointer to it)
 381    <BR>
 382    <BR>
 383    NB1: Base type T should have an accessible copy ctor  if  Add(T&) is used,
 384    <BR>
 385    NB2: Never ever cast a array to it's base type: as dtor is <B>not</B> virtual
 386         it will provoke memory leaks
 387    <BR>
 388    <BR>
 389    some functions of this class are not inline, so it takes some space to
 390    define new class from this template.
 391
 392    @memo declare objarray class 'name' containing elements of type 'T'
 393   */
 394 #define WX_DECLARE_OBJARRAY(T, name)            \
 395     typedef T _L##name;                         \
 396     _WX_DECLARE_OBJARRAY(_L##name, name, class)
 397
 398   /**
 399     To use an objarray class you must
 400     <ll>
 401     <li>#include "dynarray.h"
 402     <li>WX_DECLARE_OBJARRAY(element_type, list_class_name)
 403     <li>#include "arrimpl.cpp"
 404     <li>WX_DEFINE_OBJARRAY(list_class_name)   // same as above!
 405     </ll>
 406     <BR><BR>
 407     This is necessary because at the moment of DEFINE_OBJARRAY class
 408     element_type must be fully defined (i.e. forward declaration is not
 409     enough), while WX_DECLARE_OBJARRAY may be done anywhere. The separation of
 410     two allows to break cicrcular dependencies with classes which have member
 411     variables of objarray type.
 412
 413     @memo define (must include arrimpl.cpp!) objarray class 'name'
 414    */
 415 #define WX_DEFINE_OBJARRAY(name)       "don't forget to include arrimpl.cpp!"
 416 //@}
 417
 418 // these macros do the same thing as the WX_XXX ones above, but should be used
 419 // inside the library for user visible classes because otherwise they wouldn't
 420 // be visible from outside (when using wxWindows as DLL under Windows)
 421 #define WX_DEFINE_EXPORTED_ARRAY(T, name)               \
 422     typedef T _A##name;                                 \
 423     _WX_DEFINE_ARRAY(_A##name, name, class WXDLLEXPORT)
 424
 425 #define WX_DEFINE_SORTED_EXPORTED_ARRAY(T, name)        \
 426     typedef T _A##name;                                 \
 427     _WX_DEFINE_SORTED_ARRAY(_A##name, name, class WXDLLEXPORT)
 428
 429 #define WX_DECLARE_EXPORTED_OBJARRAY(T, name)           \
 430     typedef T _L##name;                                 \
 431     _WX_DECLARE_OBJARRAY(_L##name, name, class WXDLLEXPORT)
 432
 433 // ----------------------------------------------------------------------------
 434 /** @name Some commonly used predefined arrays */
 435 // ----------------------------------------------------------------------------
 436
 437 //@{
 438   /** @name ArrayInt */
 439 WX_DEFINE_EXPORTED_ARRAY(int, wxArrayInt);
 440   /** @name ArrayLong */
 441 WX_DEFINE_EXPORTED_ARRAY(long, wxArrayLong);
 442   /** @name ArrayPtrVoid */
 443 WX_DEFINE_EXPORTED_ARRAY(void *, wxArrayPtrVoid);
 444 //@}
 445
 446 //@}
 447
 448 // -----------------------------------------------------------------------------
 449 // convinience macros
 450 // -----------------------------------------------------------------------------
 451
 452 // append all element of one array to another one
 453 #define WX_APPEND_ARRAY(array, other)                                         \
 454     {                                                                         \
 455         size_t count = other.Count();                                         \
 456         for ( size_t n = 0; n < count; n++ )                                  \
 457         {                                                                     \
 458             array.Add(other[n]);                                              \
 459         }                                                                     \
 460     }
 461
 462 // delete all array elements
 463 //
 464 // NB: the class declaration of the array elements must be visible from the
 465 //     place where you use this macro, otherwise the proper destructor may not
 466 //     be called (a decent compiler should give a warning about it, but don't
 467 //     count on it)!
 468 #define WX_CLEAR_ARRAY(array)                                                 \
 469     {                                                                         \
 470         size_t count = array.Count();                                         \
 471         for ( size_t n = 0; n < count; n++ )                                  \
 472         {                                                                     \
 473             delete array[n];                                                  \
 474         }                                                                     \
 475                                                                               \
 476         array.Empty();                                                        \
 477     }
 478
 479 #endif // _DYNARRAY_H
 480