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() : m_keyType(wxKEY_NONE)
  96         { }
  97     wxListKey(long i) : m_keyType(wxKEY_INTEGER)
  98         { m_key.integer = i; }
  99     wxListKey(const wxChar *s) : m_keyType(wxKEY_STRING)
 100         { m_key.string = wxStrdup(s); }
 101     wxListKey(const wxString& s) : m_keyType(wxKEY_STRING)
 102         { 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 wxListBase;
 135
 136 class WXDLLEXPORT wxNodeBase
 137 {
 138 friend class wxListBase;
 139 public:
 140     // ctor
 141     wxNodeBase(wxListBase *list = (wxListBase *)NULL,
 142                wxNodeBase *previous = (wxNodeBase *)NULL,
 143                wxNodeBase *next = (wxNodeBase *)NULL,
 144                void *data = NULL,
 145                const wxListKey& key = wxDefaultListKey);
 146
 147     virtual ~wxNodeBase();
 148
 149     // FIXME no check is done that the list is really keyed on strings
 150     const wxChar *GetKeyString() const { return m_key.string; }
 151     long GetKeyInteger() const { return m_key.integer; }
 152
 153     // Necessary for some existing code
 154     void SetKeyString(wxChar* s) { m_key.string = s; }
 155     void SetKeyInteger(long i) { m_key.integer = i; }
 156
 157 #ifdef wxLIST_COMPATIBILITY
 158     // compatibility methods
 159     wxNode *Next() const { return (wxNode *)GetNext(); }
 160     wxNode *Previous() const { return (wxNode *)GetPrevious(); }
 161     wxObject *Data() const { return (wxObject *)GetData(); }
 162 #endif // wxLIST_COMPATIBILITY
 163
 164 protected:
 165     // all these are going to be "overloaded" in the derived classes
 166     wxNodeBase *GetNext() const { return m_next; }
 167     wxNodeBase *GetPrevious() const { return m_previous; }
 168
 169     void *GetData() const { return m_data; }
 170     void SetData(void *data) { m_data = data; }
 171
 172     // get 0-based index of this node within the list or wxNOT_FOUND
 173     int IndexOf() const;
 174
 175     virtual void DeleteData() { }
 176
 177 private:
 178     // optional key stuff
 179     wxListKeyValue m_key;
 180
 181     void        *m_data;        // user data
 182     wxNodeBase  *m_next,        // next and previous nodes in the list
 183                 *m_previous;
 184
 185     wxListBase  *m_list;        // list we belong to
 186
 187     DECLARE_NO_COPY_CLASS(wxNodeBase)
 188 };
 189
 190 // -----------------------------------------------------------------------------
 191 // a double-linked list class
 192 // -----------------------------------------------------------------------------
 193
 194 class WXDLLEXPORT wxListBase : public wxObject
 195 {
 196 friend class wxNodeBase;        // should be able to call DetachNode()
 197 friend class wxHashTableBase;   // should be able to call untyped Find()
 198 private:
 199         // common part of all ctors
 200     void Init(wxKeyType keyType = wxKEY_NONE); // Must be declared before it's used (for VC++ 1.5)
 201 public:
 202     // default ctor & dtor
 203     wxListBase(wxKeyType keyType = wxKEY_NONE)
 204         { Init(keyType); }
 205     virtual ~wxListBase();
 206
 207     // accessors
 208         // count of items in the list
 209     size_t GetCount() const { return m_count; }
 210
 211     // operations
 212
 213         // delete all nodes
 214     void Clear();
 215
 216         // instruct it to destroy user data when deleting nodes
 217     void DeleteContents(bool destroy) { m_destroy = destroy; }
 218
 219        // query if to delete
 220     bool GetDeleteContents() const
 221         { return m_destroy; }
 222
 223       // get the keytype
 224     wxKeyType GetKeyType() const
 225         { return m_keyType; }
 226
 227       // set the keytype (required by the serial code)
 228     void SetKeyType(wxKeyType keyType)
 229         { wxASSERT( m_count==0 ); m_keyType = keyType; }
 230
 231 #ifdef wxLIST_COMPATIBILITY
 232     int Number() const { return GetCount(); }
 233     wxNode *First() const { return (wxNode *)GetFirst(); }
 234     wxNode *Last() const { return (wxNode *)GetLast(); }
 235     wxNode *Nth(size_t index) const { return (wxNode *)Item(index); }
 236 #endif // wxLIST_COMPATIBILITY
 237
 238 protected:
 239
 240     // all methods here are "overloaded" in derived classes to provide compile
 241     // time type checking
 242
 243     // create a node for the list of this type
 244     virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,
 245                                    void *data,
 246                                    const wxListKey& key = wxDefaultListKey) = 0;
 247
 248 // Can't access these from derived classes otherwise (bug in Salford C++?)
 249 #ifdef __SALFORDC__
 250 public:
 251 #endif
 252
 253     // ctors
 254         // from an array
 255     wxListBase(size_t count, void *elements[]);
 256         // from a sequence of objects
 257     wxListBase(void *object, ... /* terminate with NULL */);
 258
 259 protected:
 260         // copy ctor and assignment operator
 261     wxListBase(const wxListBase& list) : wxObject()
 262         { Init(); DoCopy(list); }
 263     wxListBase& operator=(const wxListBase& list)
 264         { Clear(); DoCopy(list); return *this; }
 265
 266         // get list head/tail
 267     wxNodeBase *GetFirst() const { return m_nodeFirst; }
 268     wxNodeBase *GetLast() const { return m_nodeLast; }
 269
 270         // by (0-based) index
 271     wxNodeBase *Item(size_t index) const;
 272
 273         // get the list item's data
 274     void *operator[](size_t index) const
 275         { wxNodeBase *node = Item(index); return node ? node->GetData() : (wxNodeBase*)NULL; }
 276
 277     // operations
 278         // append to end of list
 279     wxNodeBase *Prepend(void *object)
 280         { return (wxNodeBase *)wxListBase::Insert(object); }
 281         // append to beginning of list
 282     wxNodeBase *Append(void *object);
 283         // insert a new item at the beginning of the list
 284     wxNodeBase *Insert(void *object) { return Insert( (wxNodeBase*)NULL, object); }
 285         // insert a new item at the given position
 286     wxNodeBase *Insert(size_t pos, void *object)
 287         { return pos == GetCount() ? Append(object)
 288                                    : Insert(Item(pos), object); }
 289         // insert before given node or at front of list if prev == NULL
 290     wxNodeBase *Insert(wxNodeBase *prev, void *object);
 291
 292         // keyed append
 293     wxNodeBase *Append(long key, void *object);
 294     wxNodeBase *Append(const wxChar *key, void *object);
 295
 296         // removes node from the list but doesn't delete it (returns pointer
 297         // to the node or NULL if it wasn't found in the list)
 298     wxNodeBase *DetachNode(wxNodeBase *node);
 299         // delete element from list, returns FALSE if node not found
 300     bool DeleteNode(wxNodeBase *node);
 301         // finds object pointer and deletes node (and object if DeleteContents
 302         // is on), returns FALSE if object not found
 303     bool DeleteObject(void *object);
 304
 305     // search (all return NULL if item not found)
 306         // by data
 307     wxNodeBase *Find(void *object) const;
 308
 309         // by key
 310     wxNodeBase *Find(const wxListKey& key) const;
 311
 312     // get 0-based index of object or wxNOT_FOUND
 313     int IndexOf( void *object ) const;
 314
 315     // this function allows the sorting of arbitrary lists by giving
 316     // a function to compare two list elements. The list is sorted in place.
 317     void Sort(const wxSortCompareFunction compfunc);
 318
 319     // functions for iterating over the list
 320     void *FirstThat(wxListIterateFunction func);
 321     void ForEach(wxListIterateFunction func);
 322     void *LastThat(wxListIterateFunction func);
 323
 324 private:
 325     // helpers
 326         // common part of copy ctor and assignment operator
 327     void DoCopy(const wxListBase& list);
 328         // common part of all Append()s
 329     wxNodeBase *AppendCommon(wxNodeBase *node);
 330         // free node's data and node itself
 331     void DoDeleteNode(wxNodeBase *node);
 332
 333     size_t m_count;             // number of elements in the list
 334     bool m_destroy;             // destroy user data when deleting list items?
 335     wxNodeBase *m_nodeFirst,    // pointers to the head and tail of the list
 336                *m_nodeLast;
 337
 338     wxKeyType m_keyType;        // type of our keys (may be wxKEY_NONE)
 339 };
 340
 341 // -----------------------------------------------------------------------------
 342 // macros for definition of "template" list type
 343 // -----------------------------------------------------------------------------
 344
 345 // and now some heavy magic...
 346
 347 // declare a list type named 'name' and containing elements of type 'T *'
 348 // (as a by product of macro expansion you also get wx##name##Node
 349 // wxNode-derived type)
 350 //
 351 // implementation details:
 352 //  1. We define _WX_LIST_ITEM_TYPE_##name typedef to save in it the item type
 353 //     for the list of given type - this allows us to pass only the list name
 354 //     to WX_DEFINE_LIST() even if it needs both the name and the type
 355 //
 356 //  2. We redefine all non-type-safe wxList functions with type-safe versions
 357 //     which don't take any space (everything is inline), but bring compile
 358 //     time error checking.
 359 //
 360 //  3. The macro which is usually used (WX_DECLARE_LIST) is defined in terms of
 361 //     a more generic WX_DECLARE_LIST_2 macro which, in turn, uses the most
 362 //     generic WX_DECLARE_LIST_3 one. The last macro adds a sometimes
 363 //     interesting capability to store polymorphic objects in the list and is
 364 //     particularly useful with, for example, "wxWindow *" list where the
 365 //     wxWindowBase pointers are put into the list, but wxWindow pointers are
 366 //     retrieved from it.
 367
 368 #define WX_DECLARE_LIST_3(T, Tbase, name, nodetype, classexp)               \
 369     typedef int (*wxSortFuncFor_##name)(const T **, const T **);            \
 370                                                                             \
 371     classexp nodetype : public wxNodeBase                                   \
 372     {                                                                       \
 373     public:                                                                 \
 374         nodetype(wxListBase *list = (wxListBase *)NULL,                     \
 375                  nodetype *previous = (nodetype *)NULL,                     \
 376                  nodetype *next = (nodetype *)NULL,                         \
 377                  T *data = (T *)NULL,                                       \
 378                  const wxListKey& key = wxDefaultListKey)                   \
 379             : wxNodeBase(list, previous, next, data, key) { }               \
 380                                                                             \
 381         nodetype *GetNext() const                                           \
 382             { return (nodetype *)wxNodeBase::GetNext(); }                   \
 383         nodetype *GetPrevious() const                                       \
 384             { return (nodetype *)wxNodeBase::GetPrevious(); }               \
 385                                                                             \
 386         T *GetData() const                                                  \
 387             { return (T *)wxNodeBase::GetData(); }                          \
 388         void SetData(T *data)                                               \
 389             { wxNodeBase::SetData(data); }                                  \
 390                                                                             \
 391         virtual void DeleteData();                                          \
 392     };                                                                      \
 393                                                                             \
 394     classexp name : public wxListBase                                       \
 395     {                                                                       \
 396     public:                                                                 \
 397         typedef nodetype Node;                                              \
 398                                                                             \
 399         name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType)          \
 400             { }                                                             \
 401         name(size_t count, T *elements[])                                   \
 402             : wxListBase(count, (void **)elements) { }                      \
 403                                                                             \
 404         name& operator=(const name& list)                                   \
 405             { (void) wxListBase::operator=(list); return *this; }           \
 406                                                                             \
 407         nodetype *GetFirst() const                                          \
 408             { return (nodetype *)wxListBase::GetFirst(); }                  \
 409         nodetype *GetLast() const                                           \
 410             { return (nodetype *)wxListBase::GetLast(); }                   \
 411                                                                             \
 412         nodetype *Item(size_t index) const                                  \
 413             { return (nodetype *)wxListBase::Item(index); }                 \
 414                                                                             \
 415         T *operator[](size_t index) const                                   \
 416         {                                                                   \
 417             nodetype *node = Item(index);                                   \
 418             return node ? (T*)(node->GetData()) : (T*)NULL;                 \
 419         }                                                                   \
 420                                                                             \
 421         nodetype *Append(Tbase *object)                                     \
 422             { return (nodetype *)wxListBase::Append(object); }              \
 423         nodetype *Insert(Tbase *object)                                     \
 424             { return (nodetype *)Insert((nodetype*)NULL, object); }         \
 425         nodetype *Insert(size_t pos, Tbase *object)                         \
 426             { return (nodetype *)wxListBase::Insert(pos, object); }         \
 427         nodetype *Insert(nodetype *prev, Tbase *object)                     \
 428             { return (nodetype *)wxListBase::Insert(prev, object); }        \
 429                                                                             \
 430         nodetype *Append(long key, void *object)                            \
 431             { return (nodetype *)wxListBase::Append(key, object); }         \
 432         nodetype *Append(const wxChar *key, void *object)                   \
 433             { return (nodetype *)wxListBase::Append(key, object); }         \
 434                                                                             \
 435         nodetype *DetachNode(nodetype *node)                                \
 436             { return (nodetype *)wxListBase::DetachNode(node); }            \
 437         bool DeleteNode(nodetype *node)                                     \
 438             { return wxListBase::DeleteNode(node); }                        \
 439         bool DeleteObject(Tbase *object)                                    \
 440             { return wxListBase::DeleteObject(object); }                    \
 441                                                                             \
 442         nodetype *Find(Tbase *object) const                                 \
 443             { return (nodetype *)wxListBase::Find(object); }                \
 444                                                                             \
 445         virtual nodetype *Find(const wxListKey& key) const                  \
 446             { return (nodetype *)wxListBase::Find(key); }                   \
 447                                                                             \
 448         int IndexOf(Tbase *object) const                                    \
 449             { return wxListBase::IndexOf(object); }                         \
 450                                                                             \
 451         void Sort(wxSortFuncFor_##name func)                                \
 452             { wxListBase::Sort((wxSortCompareFunction)func); }              \
 453                                                                             \
 454     protected:                                                              \
 455         virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,  \
 456                                void *data,                                  \
 457                                const wxListKey& key = wxDefaultListKey)     \
 458             {                                                               \
 459                 return new nodetype(this,                                   \
 460                                     (nodetype *)prev, (nodetype *)next,     \
 461                                     (T *)data, key);                        \
 462             }                                                               \
 463     }
 464
 465 #define WX_DECLARE_LIST_2(elementtype, listname, nodename, classexp)        \
 466     WX_DECLARE_LIST_3(elementtype, elementtype, listname, nodename, classexp)
 467
 468 #define WX_DECLARE_LIST(elementtype, listname)                              \
 469     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 470     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class)
 471
 472 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname)                     \
 473     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 474     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class WXDLLEXPORT)
 475
 476 #define WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo)       \
 477     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 478     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class usergoo)
 479
 480 // this macro must be inserted in your program after
 481 //      #include <wx/listimpl.cpp>
 482 #define WX_DEFINE_LIST(name)    "don't forget to include listimpl.cpp!"
 483
 484 #define WX_DEFINE_EXPORTED_LIST(name)      WX_DEFINE_LIST(name)
 485 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
 486
 487
 488 // =============================================================================
 489 // now we can define classes 100% compatible with the old ones
 490 // =============================================================================
 491
 492 // ----------------------------------------------------------------------------
 493 // commonly used list classes
 494 // ----------------------------------------------------------------------------
 495
 496 #ifdef wxLIST_COMPATIBILITY
 497
 498 // -----------------------------------------------------------------------------
 499 // wxList compatibility class: in fact, it's a list of wxObjects
 500 // -----------------------------------------------------------------------------
 501
 502 WX_DECLARE_LIST_2(wxObject, wxObjectList, wxObjectListNode, class WXDLLEXPORT);
 503
 504 class WXDLLEXPORT wxList : public wxObjectList
 505 {
 506 public:
 507     wxList(int key_type = wxKEY_NONE) : wxObjectList((wxKeyType)key_type) { }
 508     // this destructor is required for Darwin
 509    ~wxList() { }
 510
 511     wxList& operator=(const wxList& list)
 512         { (void) wxListBase::operator=(list); return *this; }
 513
 514     // compatibility methods
 515     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
 516
 517     wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
 518
 519 private:
 520     DECLARE_DYNAMIC_CLASS(wxList)
 521 };
 522
 523 // -----------------------------------------------------------------------------
 524 // wxStringList class for compatibility with the old code
 525 // -----------------------------------------------------------------------------
 526
 527 WX_DECLARE_LIST_2(wxChar, wxStringListBase, wxStringListNode, class WXDLLEXPORT);
 528
 529 class WXDLLEXPORT wxStringList : public wxStringListBase
 530 {
 531 public:
 532     // ctors and such
 533         // default
 534     wxStringList() { DeleteContents(TRUE); }
 535     wxStringList(const wxChar *first ...);
 536
 537         // copying the string list: the strings are copied, too (extremely
 538         // inefficient!)
 539     wxStringList(const wxStringList& other) : wxStringListBase() { DeleteContents(TRUE); DoCopy(other); }
 540     wxStringList& operator=(const wxStringList& other)
 541         { Clear(); DoCopy(other); return *this; }
 542
 543     // operations
 544         // makes a copy of the string
 545     wxNode *Add(const wxChar *s)
 546         { return (wxNode *)wxStringListBase::Append(copystring(s)); }
 547
 548         // Append to beginning of list
 549     wxNode *Prepend(const wxChar *s)
 550         { return (wxNode *)wxStringListBase::Insert(copystring(s)); }
 551
 552     bool Delete(const wxChar *s);
 553
 554     wxChar **ListToArray(bool new_copies = FALSE) const;
 555     bool Member(const wxChar *s) const;
 556
 557     // alphabetic sort
 558     void Sort();
 559
 560 private:
 561     void DoCopy(const wxStringList&); // common part of copy ctor and operator=
 562
 563     DECLARE_DYNAMIC_CLASS(wxStringList)
 564 };
 565
 566 #endif // wxLIST_COMPATIBILITY
 567
 568 #endif
 569     // _WX_LISTH__