include/wx/list.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        list.h
   3 // Purpose:     wxList, wxStringList classes
   4 // Author:      Julian Smart
   5 // Modified by: VZ at 16/11/98: WX_DECLARE_LIST() and typesafe lists added
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Julian Smart
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 /*
  13   All this is quite ugly but serves two purposes:
  14     1. Be almost 100% compatible with old, untyped, wxList class
  15     2. Ensure compile-time type checking for the linked lists
  16
  17   The idea is to have one base class (wxListBase) working with "void *" data,
  18   but to hide these untyped functions - i.e. make them protected, so they
  19   can only be used from derived classes which have inline member functions
  20   working with right types. This achieves the 2nd goal. As for the first one,
  21   we provide a special derivation of wxListBase called wxList which looks just
  22   like the old class.
  23 */
  24
  25 #ifndef _WX_LISTH__
  26 #define _WX_LISTH__
  27
  28 #ifdef __GNUG__
  29 #pragma interface "list.h"
  30 #endif
  31
  32 // -----------------------------------------------------------------------------
  33 // headers
  34 // -----------------------------------------------------------------------------
  35
  36 #include "wx/defs.h"
  37 #include "wx/object.h"
  38 #include "wx/string.h"
  39
  40 // due to circular header dependencies this function has to be declared here
  41 // (normally it's found in utils.h which includes itself list.h...)
  42 extern WXDLLEXPORT wxChar* copystring(const wxChar *s);
  43
  44 class WXDLLEXPORT wxObjectListNode;
  45 typedef wxObjectListNode wxNode;
  46
  47 // undef it to get rid of old, deprecated functions
  48 #define wxLIST_COMPATIBILITY
  49
  50 // -----------------------------------------------------------------------------
  51 // constants
  52 // -----------------------------------------------------------------------------
  53 enum wxKeyType
  54 {
  55     wxKEY_NONE,
  56     wxKEY_INTEGER,
  57     wxKEY_STRING
  58 };
  59
  60 // -----------------------------------------------------------------------------
  61 // types
  62 // -----------------------------------------------------------------------------
  63
  64 // type of compare function for list sort operation (as in 'qsort'): it should
  65 // return a negative value, 0 or positive value if the first element is less
  66 // than, equal or greater than the second
  67 extern "C"
  68 {
  69 typedef int (* LINKAGEMODE wxSortCompareFunction)(const void *elem1, const void *elem2);
  70 }
  71
  72 //
  73 typedef int (* LINKAGEMODE wxListIterateFunction)(void *current);
  74
  75 // -----------------------------------------------------------------------------
  76 // key stuff: a list may be optionally keyed on integer or string key
  77 // -----------------------------------------------------------------------------
  78
  79 union wxListKeyValue
  80 {
  81     long integer;
  82     wxChar *string;
  83 };
  84
  85 // a struct which may contain both types of keys
  86 //
  87 // implementation note: on one hand, this class allows to have only one function
  88 // for any keyed operation instead of 2 almost equivalent. OTOH, it's needed to
  89 // resolve ambiguity which we would otherwise have with wxStringList::Find() and
  90 // wxList::Find(const char *).
  91 class WXDLLEXPORT wxListKey
  92 {
  93 public:
  94     // implicit ctors
  95     wxListKey()
  96         { m_keyType = wxKEY_NONE; }
  97     wxListKey(long i)
  98         { m_keyType = wxKEY_INTEGER; m_key.integer = i; }
  99     wxListKey(const wxChar *s)
 100         { m_keyType = wxKEY_STRING; m_key.string = wxStrdup(s); }
 101     wxListKey(const wxString& s)
 102         { m_keyType = wxKEY_STRING; m_key.string = wxStrdup(s.c_str()); }
 103
 104     // accessors
 105     wxKeyType GetKeyType() const { return m_keyType; }
 106     const wxChar *GetString() const
 107         { wxASSERT( m_keyType == wxKEY_STRING ); return m_key.string; }
 108     long GetNumber() const
 109         { wxASSERT( m_keyType == wxKEY_INTEGER ); return m_key.integer; }
 110
 111     // comparison
 112     // Note: implementation moved to list.cpp to prevent BC++ inline
 113     // expansion warning.
 114     bool operator==(wxListKeyValue value) const ;
 115
 116     // dtor
 117     ~wxListKey()
 118     {
 119         if ( m_keyType == wxKEY_STRING )
 120             free(m_key.string);
 121     }
 122
 123 private:
 124     wxKeyType m_keyType;
 125     wxListKeyValue m_key;
 126 };
 127
 128 // -----------------------------------------------------------------------------
 129 // wxNodeBase class is a (base for) node in a double linked list
 130 // -----------------------------------------------------------------------------
 131
 132 WXDLLEXPORT_DATA(extern wxListKey) wxDefaultListKey;
 133
 134 class WXDLLEXPORT wxNodeBase
 135 {
 136 friend class wxListBase;
 137 public:
 138     // ctor
 139     wxNodeBase(wxListBase *list = (wxListBase *)NULL,
 140                wxNodeBase *previous = (wxNodeBase *)NULL,
 141                wxNodeBase *next = (wxNodeBase *)NULL,
 142                void *data = NULL,
 143                const wxListKey& key = wxDefaultListKey);
 144
 145     virtual ~wxNodeBase();
 146
 147     // FIXME no check is done that the list is really keyed on strings
 148     const wxChar *GetKeyString() const { return m_key.string; }
 149     long GetKeyInteger() const { return m_key.integer; }
 150
 151     // Necessary for some existing code
 152     void SetKeyString(wxChar* s) { m_key.string = s; }
 153     void SetKeyInteger(long i) { m_key.integer = i; }
 154
 155 #ifdef wxLIST_COMPATIBILITY
 156     // compatibility methods
 157     wxNode *Next() const { return (wxNode *)GetNext(); }
 158     wxNode *Previous() const { return (wxNode *)GetPrevious(); }
 159     wxObject *Data() const { return (wxObject *)GetData(); }
 160 #endif // wxLIST_COMPATIBILITY
 161
 162 protected:
 163     // all these are going to be "overloaded" in the derived classes
 164     wxNodeBase *GetNext() const { return m_next; }
 165     wxNodeBase *GetPrevious() const { return m_previous; }
 166
 167     void *GetData() const { return m_data; }
 168     void SetData(void *data) { m_data = data; }
 169
 170     // get 0-based index of this node within the list or wxNOT_FOUND
 171     int IndexOf() const;
 172
 173     virtual void DeleteData() { }
 174
 175 private:
 176     // optional key stuff
 177     wxListKeyValue m_key;
 178
 179     void        *m_data;        // user data
 180     wxNodeBase  *m_next,        // next and previous nodes in the list
 181                 *m_previous;
 182
 183     wxListBase  *m_list;        // list we belong to
 184 };
 185
 186 // -----------------------------------------------------------------------------
 187 // a double-linked list class
 188 // -----------------------------------------------------------------------------
 189 class WXDLLEXPORT wxListBase : public wxObject
 190 {
 191 friend class wxNodeBase;        // should be able to call DetachNode()
 192 friend class wxHashTableBase;   // should be able to call untyped Find()
 193 private:
 194         // common part of all ctors
 195     void Init(wxKeyType keyType = wxKEY_NONE); // Must be declared before it's used (for VC++ 1.5)
 196 public:
 197     // default ctor & dtor
 198     wxListBase(wxKeyType keyType = wxKEY_NONE) { Init(keyType); }
 199     virtual ~wxListBase();
 200
 201     // accessors
 202         // count of items in the list
 203     size_t GetCount() const { return m_count; }
 204
 205     // operations
 206
 207         // delete all nodes
 208     void Clear();
 209
 210         // instruct it to destroy user data when deleting nodes
 211     void DeleteContents(bool destroy) { m_destroy = destroy; }
 212
 213        // query if to delete
 214     bool GetDeleteContents() const
 215         { return m_destroy; }
 216
 217       // get the keytype
 218     wxKeyType GetKeyType() const
 219         { return m_keyType; }
 220
 221       // set the keytype (required by the serial code)
 222     void SetKeyType(wxKeyType keyType)
 223         { wxASSERT( m_count==0 ); m_keyType = keyType; }
 224
 225 #ifdef wxLIST_COMPATIBILITY
 226     int Number() const { return GetCount(); }
 227     wxNode *First() const { return (wxNode *)GetFirst(); }
 228     wxNode *Last() const { return (wxNode *)GetLast(); }
 229     wxNode *Nth(size_t index) const { return (wxNode *)Item(index); }
 230 #endif // wxLIST_COMPATIBILITY
 231
 232 protected:
 233
 234     // all methods here are "overloaded" in derived classes to provide compile
 235     // time type checking
 236
 237     // create a node for the list of this type
 238     virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,
 239                                    void *data,
 240                                    const wxListKey& key = wxDefaultListKey) = 0;
 241
 242 // Can't access these from derived classes otherwise (bug in Salford C++?)
 243 #ifdef __SALFORDC__
 244 public:
 245 #endif
 246
 247     // ctors
 248         // from an array
 249     wxListBase(size_t count, void *elements[]);
 250         // from a sequence of objects
 251     wxListBase(void *object, ... /* terminate with NULL */);
 252
 253 protected:
 254         // copy ctor and assignment operator
 255     wxListBase(const wxListBase& list) : wxObject()
 256         { Init(); DoCopy(list); }
 257     wxListBase& operator=(const wxListBase& list)
 258         { Clear(); DoCopy(list); return *this; }
 259
 260         // get list head/tail
 261     wxNodeBase *GetFirst() const { return m_nodeFirst; }
 262     wxNodeBase *GetLast() const { return m_nodeLast; }
 263
 264         // by (0-based) index
 265     wxNodeBase *Item(size_t index) const;
 266
 267         // get the list item's data
 268     void *operator[](size_t index) const
 269         { wxNodeBase *node = Item(index); return node ? node->GetData() : (wxNodeBase*)NULL; }
 270
 271     // operations
 272         // append to end of list
 273     wxNodeBase *Append(void *object);
 274         // insert a new item at the beginning of the list
 275     wxNodeBase *Insert(void *object) { return Insert( (wxNodeBase*)NULL, object); }
 276         // insert a new item at the given position
 277     wxNodeBase *Insert(size_t pos, void *object)
 278         { return pos == GetCount() ? Append(object)
 279                                    : Insert(Item(pos), object); }
 280         // insert before given node or at front of list if prev == NULL
 281     wxNodeBase *Insert(wxNodeBase *prev, void *object);
 282
 283         // keyed append
 284     wxNodeBase *Append(long key, void *object);
 285     wxNodeBase *Append(const wxChar *key, void *object);
 286
 287         // removes node from the list but doesn't delete it (returns pointer
 288         // to the node or NULL if it wasn't found in the list)
 289     wxNodeBase *DetachNode(wxNodeBase *node);
 290         // delete element from list, returns FALSE if node not found
 291     bool DeleteNode(wxNodeBase *node);
 292         // finds object pointer and deletes node (and object if DeleteContents
 293         // is on), returns FALSE if object not found
 294     bool DeleteObject(void *object);
 295
 296     // search (all return NULL if item not found)
 297         // by data
 298     wxNodeBase *Find(void *object) const;
 299
 300         // by key
 301     wxNodeBase *Find(const wxListKey& key) const;
 302
 303     // get 0-based index of object or wxNOT_FOUND
 304     int IndexOf( void *object ) const;
 305
 306     // this function allows the sorting of arbitrary lists by giving
 307     // a function to compare two list elements. The list is sorted in place.
 308     void Sort(const wxSortCompareFunction compfunc);
 309
 310     // functions for iterating over the list
 311     void *FirstThat(wxListIterateFunction func);
 312     void ForEach(wxListIterateFunction func);
 313     void *LastThat(wxListIterateFunction func);
 314
 315 private:
 316     // helpers
 317         // common part of copy ctor and assignment operator
 318     void DoCopy(const wxListBase& list);
 319         // common part of all Append()s
 320     wxNodeBase *AppendCommon(wxNodeBase *node);
 321         // free node's data and node itself
 322     void DoDeleteNode(wxNodeBase *node);
 323
 324     size_t m_count;             // number of elements in the list
 325     bool m_destroy;             // destroy user data when deleting list items?
 326     wxNodeBase *m_nodeFirst,    // pointers to the head and tail of the list
 327                *m_nodeLast;
 328
 329     wxKeyType m_keyType;        // type of our keys (may be wxKEY_NONE)
 330 };
 331
 332 // -----------------------------------------------------------------------------
 333 // macros for definition of "template" list type
 334 // -----------------------------------------------------------------------------
 335
 336 // and now some heavy magic...
 337
 338 // declare a list type named 'name' and containing elements of type 'T *'
 339 // (as a by product of macro expansion you also get wx##name##Node
 340 // wxNode-derived type)
 341 //
 342 // implementation details:
 343 //  1. We define _WX_LIST_ITEM_TYPE_##name typedef to save in it the item type
 344 //     for the list of given type - this allows us to pass only the list name
 345 //     to WX_DEFINE_LIST() even if it needs both the name and the type
 346 //
 347 //  2. We redefine all non-type-safe wxList functions with type-safe versions
 348 //     which don't take any space (everything is inline), but bring compile
 349 //     time error checking.
 350 //
 351 //  3. The macro which is usually used (WX_DECLARE_LIST) is defined in terms of
 352 //     a more generic WX_DECLARE_LIST_2 macro which, in turn, uses the most
 353 //     generic WX_DECLARE_LIST_3 one. The last macro adds a sometimes
 354 //     interesting capability to store polymorphic objects in the list and is
 355 //     particularly useful with, for example, "wxWindow *" list where the
 356 //     wxWindowBase pointers are put into the list, but wxWindow pointers are
 357 //     retrieved from it.
 358
 359 #define WX_DECLARE_LIST_3(T, Tbase, name, nodetype, classexp)               \
 360     typedef int (*wxSortFuncFor_##name)(const T **, const T **);            \
 361                                                                             \
 362     classexp nodetype : public wxNodeBase                                   \
 363     {                                                                       \
 364     public:                                                                 \
 365         nodetype(wxListBase *list = (wxListBase *)NULL,                     \
 366                  nodetype *previous = (nodetype *)NULL,                     \
 367                  nodetype *next = (nodetype *)NULL,                         \
 368                  T *data = (T *)NULL,                                       \
 369                  const wxListKey& key = wxDefaultListKey)                   \
 370             : wxNodeBase(list, previous, next, data, key) { }               \
 371                                                                             \
 372         nodetype *GetNext() const                                           \
 373             { return (nodetype *)wxNodeBase::GetNext(); }                   \
 374         nodetype *GetPrevious() const                                       \
 375             { return (nodetype *)wxNodeBase::GetPrevious(); }               \
 376                                                                             \
 377         T *GetData() const                                                  \
 378             { return (T *)wxNodeBase::GetData(); }                          \
 379         void SetData(T *data)                                               \
 380             { wxNodeBase::SetData(data); }                                  \
 381                                                                             \
 382         virtual void DeleteData();                                          \
 383     };                                                                      \
 384                                                                             \
 385     classexp name : public wxListBase                                       \
 386     {                                                                       \
 387     public:                                                                 \
 388         typedef nodetype Node;                                              \
 389                                                                             \
 390         name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType)          \
 391             { }                                                             \
 392         name(size_t count, T *elements[])                                   \
 393             : wxListBase(count, (void **)elements) { }                      \
 394                                                                             \
 395         name& operator=(const name& list)                                   \
 396             { return (name&)wxListBase::operator=(list); }                  \
 397                                                                             \
 398         nodetype *GetFirst() const                                          \
 399             { return (nodetype *)wxListBase::GetFirst(); }                  \
 400         nodetype *GetLast() const                                           \
 401             { return (nodetype *)wxListBase::GetLast(); }                   \
 402                                                                             \
 403         nodetype *Item(size_t index) const                                  \
 404             { return (nodetype *)wxListBase::Item(index); }                 \
 405                                                                             \
 406         T *operator[](size_t index) const                                   \
 407         {                                                                   \
 408             nodetype *node = Item(index);                                   \
 409             return node ? (T*)(node->GetData()) : (T*)NULL;                 \
 410         }                                                                   \
 411                                                                             \
 412         nodetype *Append(Tbase *object)                                     \
 413             { return (nodetype *)wxListBase::Append(object); }              \
 414         nodetype *Insert(Tbase *object)                                     \
 415             { return (nodetype *)Insert((nodetype*)NULL, object); }         \
 416         nodetype *Insert(size_t pos, Tbase *object)                         \
 417             { return (nodetype *)wxListBase::Insert(pos, object); }         \
 418         nodetype *Insert(nodetype *prev, Tbase *object)                     \
 419             { return (nodetype *)wxListBase::Insert(prev, object); }        \
 420                                                                             \
 421         nodetype *Append(long key, void *object)                            \
 422             { return (nodetype *)wxListBase::Append(key, object); }         \
 423         nodetype *Append(const wxChar *key, void *object)                   \
 424             { return (nodetype *)wxListBase::Append(key, object); }         \
 425                                                                             \
 426         nodetype *DetachNode(nodetype *node)                                \
 427             { return (nodetype *)wxListBase::DetachNode(node); }            \
 428         bool DeleteNode(nodetype *node)                                     \
 429             { return wxListBase::DeleteNode(node); }                        \
 430         bool DeleteObject(Tbase *object)                                    \
 431             { return wxListBase::DeleteObject(object); }                    \
 432                                                                             \
 433         nodetype *Find(Tbase *object) const                                 \
 434             { return (nodetype *)wxListBase::Find(object); }                \
 435                                                                             \
 436         virtual nodetype *Find(const wxListKey& key) const                  \
 437             { return (nodetype *)wxListBase::Find(key); }                   \
 438                                                                             \
 439         int IndexOf(Tbase *object) const                                    \
 440             { return wxListBase::IndexOf(object); }                         \
 441                                                                             \
 442         void Sort(wxSortFuncFor_##name func)                                \
 443             { wxListBase::Sort((wxSortCompareFunction)func); }              \
 444                                                                             \
 445     protected:                                                              \
 446         virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,  \
 447                                void *data,                                  \
 448                                const wxListKey& key = wxDefaultListKey)     \
 449             {                                                               \
 450                 return new nodetype(this,                                   \
 451                                     (nodetype *)prev, (nodetype *)next,     \
 452                                     (T *)data, key);                        \
 453             }                                                               \
 454     }
 455
 456 #define WX_DECLARE_LIST_2(elementtype, listname, nodename, classexp)        \
 457     WX_DECLARE_LIST_3(elementtype, elementtype, listname, nodename, classexp)
 458
 459 #define WX_DECLARE_LIST(elementtype, listname)                              \
 460     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 461     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class)
 462
 463 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname)                     \
 464     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 465     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class WXDLLEXPORT)
 466
 467 #define WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo)       \
 468     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 469     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class usergoo)
 470
 471 // this macro must be inserted in your program after
 472 //      #include <wx/listimpl.cpp>
 473 #define WX_DEFINE_LIST(name)    "don't forget to include listimpl.cpp!"
 474
 475 #define WX_DEFINE_EXPORTED_LIST(name)      WX_DEFINE_LIST(name)
 476 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
 477
 478
 479 // =============================================================================
 480 // now we can define classes 100% compatible with the old ones
 481 // =============================================================================
 482
 483 // ----------------------------------------------------------------------------
 484 // commonly used list classes
 485 // ----------------------------------------------------------------------------
 486
 487 #ifdef wxLIST_COMPATIBILITY
 488
 489 // -----------------------------------------------------------------------------
 490 // wxList compatibility class: in fact, it's a list of wxObjects
 491 // -----------------------------------------------------------------------------
 492
 493 WX_DECLARE_LIST_2(wxObject, wxObjectList, wxObjectListNode, class WXDLLEXPORT);
 494
 495 class WXDLLEXPORT wxList : public wxObjectList
 496 {
 497 public:
 498     wxList(int key_type = wxKEY_NONE) : wxObjectList((wxKeyType)key_type) { }
 499     // this destructor is required for Darwin
 500    ~wxList() { }
 501
 502     wxList& operator=(const wxList& list)
 503         { return (wxList&)wxListBase::operator=(list); }
 504
 505     // compatibility methods
 506     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
 507
 508     wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
 509 };
 510
 511 // -----------------------------------------------------------------------------
 512 // wxStringList class for compatibility with the old code
 513 // -----------------------------------------------------------------------------
 514
 515 WX_DECLARE_LIST_2(wxChar, wxStringListBase, wxStringListNode, class WXDLLEXPORT);
 516
 517 class WXDLLEXPORT wxStringList : public wxStringListBase
 518 {
 519 public:
 520     // ctors and such
 521         // default
 522     wxStringList() { DeleteContents(TRUE); }
 523     wxStringList(const wxChar *first ...);
 524
 525         // copying the string list: the strings are copied, too (extremely
 526         // inefficient!)
 527     wxStringList(const wxStringList& other) : wxStringListBase() { DeleteContents(TRUE); DoCopy(other); }
 528     wxStringList& operator=(const wxStringList& other)
 529         { Clear(); DoCopy(other); return *this; }
 530
 531     // operations
 532         // makes a copy of the string
 533     wxNode *Add(const wxChar *s)
 534         { return (wxNode *)wxStringListBase::Append(copystring(s)); }
 535
 536     bool Delete(const wxChar *s);
 537
 538     wxChar **ListToArray(bool new_copies = FALSE) const;
 539     bool Member(const wxChar *s) const;
 540
 541     // alphabetic sort
 542     void Sort();
 543
 544 private:
 545     void DoCopy(const wxStringList&); // common part of copy ctor and operator=
 546 };
 547
 548 #endif // wxLIST_COMPATIBILITY
 549
 550 #endif
 551     // _WX_LISTH__