1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxList, wxStringList classes
4 // Author: Julian Smart
5 // Modified by: VZ at 16/11/98: WX_DECLARE_LIST() and typesafe lists added
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
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
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
28 // -----------------------------------------------------------------------------
30 // -----------------------------------------------------------------------------
33 #include "wx/object.h"
34 #include "wx/string.h"
37 #include "wx/beforestd.h"
41 #include "wx/afterstd.h"
44 // ----------------------------------------------------------------------------
46 // ----------------------------------------------------------------------------
48 // type of compare function for list sort operation (as in 'qsort'): it should
49 // return a negative value, 0 or positive value if the first element is less
50 // than, equal or greater than the second
54 typedef int (* LINKAGEMODE wxSortCompareFunction
)(const void *elem1
, const void *elem2
);
57 class WXDLLIMPEXP_FWD_BASE wxObjectListNode
;
58 typedef wxObjectListNode wxNode
;
61 typedef int (* LINKAGEMODE wxListIterateFunction
)(void *current
);
65 #define wxLIST_COMPATIBILITY
67 #define WX_DECLARE_LIST_3(elT, dummy1, liT, dummy2, decl) \
68 WX_DECLARE_LIST_WITH_DECL(elT, liT, decl)
69 #define WX_DECLARE_LIST_PTR_3(elT, dummy1, liT, dummy2, decl) \
70 WX_DECLARE_LIST_3(elT, dummy1, liT, dummy2, decl)
72 #define WX_DECLARE_LIST_2(elT, liT, dummy, decl) \
73 WX_DECLARE_LIST_WITH_DECL(elT, liT, decl)
74 #define WX_DECLARE_LIST_PTR_2(elT, liT, dummy, decl) \
75 WX_DECLARE_LIST_2(elT, liT, dummy, decl) \
77 #define WX_DECLARE_LIST_WITH_DECL(elT, liT, decl) \
78 WX_DECLARE_LIST_XO(elT*, liT, decl)
80 #if !defined(__VISUALC__) || __VISUALC__ >= 1300 // == !VC6
83 class WXDLLIMPEXP_BASE wxList_SortFunction
86 wxList_SortFunction(wxSortCompareFunction f
) : m_f(f
) { }
87 bool operator()(const T
& i1
, const T
& i2
)
88 { return m_f((T
*)&i1
, (T
*)&i2
) < 0; }
90 wxSortCompareFunction m_f
;
93 #define WX_LIST_SORTFUNCTION( elT, f ) wxList_SortFunction<elT>(f)
94 #define WX_LIST_VC6_WORKAROUND(elT, liT, decl)
96 #else // if defined( __VISUALC__ ) && __VISUALC__ < 1300 // == VC6
98 #define WX_LIST_SORTFUNCTION( elT, f ) std::greater<elT>( f )
99 #define WX_LIST_VC6_WORKAROUND(elT, liT, decl) \
102 /* Workaround for broken VC6 STL incorrectly requires a std::greater<> */ \
103 /* to be passed into std::list::sort() */ \
105 struct std::greater<elT> \
108 wxSortCompareFunction m_CompFunc; \
110 greater( wxSortCompareFunction compfunc = NULL ) \
111 : m_CompFunc( compfunc ) {} \
112 bool operator()(const elT X, const elT Y) const \
114 return m_CompFunc ? \
115 ( m_CompFunc( wxListCastElementToVoidPtr(X), \
116 wxListCastElementToVoidPtr(Y) ) < 0 ) : \
121 // helper for std::greater<elT> above:
123 inline const void *wxListCastElementToVoidPtr(const T
* ptr
) { return ptr
; }
124 inline const void *wxListCastElementToVoidPtr(const wxString
& str
)
125 { return (const char*)str
; }
130 Note 1: the outer helper class _WX_LIST_HELPER_##liT below is a workaround
131 for mingw 3.2.3 compiler bug that prevents a static function of liT class
132 from being exported into dll. A minimal code snippet reproducing the bug:
134 struct WXDLLEXPORT Foo
137 struct SomeInnerClass
139 friend class Foo; // comment this out to make it link
147 The program does not link under mingw_gcc 3.2.3 producing undefined
148 reference to Foo::Bar() function
151 Note 2: the EmptyList is needed to allow having a NULL pointer-like
152 invalid iterator. We used to use just an uninitialized iterator object
153 instead but this fails with some debug/checked versions of STL, notably the
154 glibc version activated with _GLIBCXX_DEBUG, so we need to have a separate
158 // the real wxList-class declaration
159 #define WX_DECLARE_LIST_XO(elT, liT, decl) \
160 decl _WX_LIST_HELPER_##liT \
162 typedef elT _WX_LIST_ITEM_TYPE_##liT; \
164 static void DeleteFunction( _WX_LIST_ITEM_TYPE_##liT X ); \
167 WX_LIST_VC6_WORKAROUND(elT, liT, decl) \
168 decl liT : public std::list<elT> \
171 typedef std::list<elT> BaseListType; \
172 static BaseListType EmptyList; \
177 decl compatibility_iterator \
180 /* Workaround for broken VC6 nested class name resolution */ \
181 typedef std::list<elT>::iterator iterator; \
188 compatibility_iterator() \
189 : m_iter(EmptyList.end()), m_list( NULL ) {} \
190 compatibility_iterator( liT* li, iterator i ) \
191 : m_iter( i ), m_list( li ) {} \
192 compatibility_iterator( const liT* li, iterator i ) \
193 : m_iter( i ), m_list( const_cast< liT* >( li ) ) {} \
195 compatibility_iterator* operator->() { return this; } \
196 const compatibility_iterator* operator->() const { return this; } \
198 bool operator==(const compatibility_iterator& i) const \
200 wxASSERT_MSG( m_list && i.m_list, \
201 _T("comparing invalid iterators is illegal") ); \
202 return (m_list == i.m_list) && (m_iter == i.m_iter); \
204 bool operator!=(const compatibility_iterator& i) const \
205 { return !( operator==( i ) ); } \
206 operator bool() const \
207 { return m_list ? m_iter != m_list->end() : false; } \
208 bool operator !() const \
209 { return !( operator bool() ); } \
211 elT GetData() const \
212 { return *m_iter; } \
213 void SetData( elT e ) \
216 compatibility_iterator GetNext() const \
218 iterator i = m_iter; \
219 return compatibility_iterator( m_list, ++i ); \
221 compatibility_iterator GetPrevious() const \
223 if ( m_iter == m_list->begin() ) \
224 return compatibility_iterator(); \
226 iterator i = m_iter; \
227 return compatibility_iterator( m_list, --i ); \
229 int IndexOf() const \
231 return *this ? std::distance( m_list->begin(), m_iter ) \
236 liT() : m_destroy( false ) {} \
238 compatibility_iterator Find( const elT e ) const \
240 liT* _this = const_cast< liT* >( this ); \
241 return compatibility_iterator( _this, \
242 std::find( _this->begin(), _this->end(), e ) ); \
245 bool IsEmpty() const \
246 { return empty(); } \
247 size_t GetCount() const \
250 { return static_cast< int >( GetCount() ); } \
252 compatibility_iterator Item( size_t idx ) const \
254 iterator i = const_cast< liT* >(this)->begin(); \
255 std::advance( i, idx ); \
256 return compatibility_iterator( this, i ); \
258 elT operator[](size_t idx) const \
260 return Item(idx).GetData(); \
263 compatibility_iterator GetFirst() const \
265 return compatibility_iterator( this, \
266 const_cast< liT* >(this)->begin() ); \
268 compatibility_iterator GetLast() const \
270 iterator i = const_cast< liT* >(this)->end(); \
271 return compatibility_iterator( this, !empty() ? --i : i ); \
273 compatibility_iterator Member( elT e ) const \
274 { return Find( e ); } \
275 compatibility_iterator Nth( int n ) const \
276 { return Item( n ); } \
277 int IndexOf( elT e ) const \
278 { return Find( e ).IndexOf(); } \
280 compatibility_iterator Append( elT e ) \
285 compatibility_iterator Insert( elT e ) \
288 return compatibility_iterator( this, begin() ); \
290 compatibility_iterator Insert( compatibility_iterator & i, elT e ) \
292 return compatibility_iterator( this, insert( i.m_iter, e ) ); \
294 compatibility_iterator Insert( size_t idx, elT e ) \
296 return compatibility_iterator( this, \
297 insert( Item( idx ).m_iter, e ) ); \
300 void DeleteContents( bool destroy ) \
301 { m_destroy = destroy; } \
302 bool GetDeleteContents() const \
303 { return m_destroy; } \
304 void Erase( const compatibility_iterator& i ) \
307 _WX_LIST_HELPER_##liT::DeleteFunction( i->GetData() ); \
310 bool DeleteNode( const compatibility_iterator& i ) \
319 bool DeleteObject( elT e ) \
321 return DeleteNode( Find( e ) ); \
326 std::for_each( begin(), end(), \
327 _WX_LIST_HELPER_##liT::DeleteFunction ); \
330 /* Workaround for broken VC6 std::list::sort() see above */ \
331 void Sort( wxSortCompareFunction compfunc ) \
332 { sort( WX_LIST_SORTFUNCTION( elT, compfunc ) ); } \
333 ~liT() { Clear(); } \
335 /* It needs access to our EmptyList */ \
336 friend class compatibility_iterator; \
339 #define WX_DECLARE_LIST(elementtype, listname) \
340 WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class)
341 #define WX_DECLARE_LIST_PTR(elementtype, listname) \
342 WX_DECLARE_LIST(elementtype, listname)
344 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname) \
345 WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class WXDLLEXPORT)
346 #define WX_DECLARE_EXPORTED_LIST_PTR(elementtype, listname) \
347 WX_DECLARE_EXPORTED_LIST(elementtype, listname)
349 #define WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo) \
350 WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class usergoo)
351 #define WX_DECLARE_USER_EXPORTED_LIST_PTR(elementtype, listname, usergoo) \
352 WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo)
354 // this macro must be inserted in your program after
355 // #include "wx/listimpl.cpp"
356 #define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
358 #define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
359 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
361 #else // if !wxUSE_STL
364 // undef it to get rid of old, deprecated functions
365 #define wxLIST_COMPATIBILITY
367 // -----------------------------------------------------------------------------
368 // key stuff: a list may be optionally keyed on integer or string key
369 // -----------------------------------------------------------------------------
377 // a struct which may contain both types of keys
379 // implementation note: on one hand, this class allows to have only one function
380 // for any keyed operation instead of 2 almost equivalent. OTOH, it's needed to
381 // resolve ambiguity which we would otherwise have with wxStringList::Find() and
382 // wxList::Find(const char *).
383 class WXDLLIMPEXP_BASE wxListKey
387 wxListKey() : m_keyType(wxKEY_NONE
)
389 wxListKey(long i
) : m_keyType(wxKEY_INTEGER
)
390 { m_key
.integer
= i
; }
391 wxListKey(const wxString
& s
) : m_keyType(wxKEY_STRING
)
392 { m_key
.string
= new wxString(s
); }
393 wxListKey(const char *s
) : m_keyType(wxKEY_STRING
)
394 { m_key
.string
= new wxString(s
); }
395 wxListKey(const wchar_t *s
) : m_keyType(wxKEY_STRING
)
396 { m_key
.string
= new wxString(s
); }
399 wxKeyType
GetKeyType() const { return m_keyType
; }
400 const wxString
GetString() const
401 { wxASSERT( m_keyType
== wxKEY_STRING
); return *m_key
.string
; }
402 long GetNumber() const
403 { wxASSERT( m_keyType
== wxKEY_INTEGER
); return m_key
.integer
; }
406 // Note: implementation moved to list.cpp to prevent BC++ inline
407 // expansion warning.
408 bool operator==(wxListKeyValue value
) const ;
413 if ( m_keyType
== wxKEY_STRING
)
419 wxListKeyValue m_key
;
422 // -----------------------------------------------------------------------------
423 // wxNodeBase class is a (base for) node in a double linked list
424 // -----------------------------------------------------------------------------
426 extern WXDLLIMPEXP_DATA_BASE(wxListKey
) wxDefaultListKey
;
428 class WXDLLIMPEXP_FWD_BASE wxListBase
;
430 class WXDLLIMPEXP_BASE wxNodeBase
432 friend class wxListBase
;
435 wxNodeBase(wxListBase
*list
= (wxListBase
*)NULL
,
436 wxNodeBase
*previous
= (wxNodeBase
*)NULL
,
437 wxNodeBase
*next
= (wxNodeBase
*)NULL
,
439 const wxListKey
& key
= wxDefaultListKey
);
441 virtual ~wxNodeBase();
443 // FIXME no check is done that the list is really keyed on strings
444 wxString
GetKeyString() const { return *m_key
.string
; }
445 long GetKeyInteger() const { return m_key
.integer
; }
447 // Necessary for some existing code
448 void SetKeyString(const wxString
& s
) { m_key
.string
= new wxString(s
); }
449 void SetKeyInteger(long i
) { m_key
.integer
= i
; }
451 #ifdef wxLIST_COMPATIBILITY
452 // compatibility methods, use Get* instead.
453 wxDEPRECATED( wxNode
*Next() const );
454 wxDEPRECATED( wxNode
*Previous() const );
455 wxDEPRECATED( wxObject
*Data() const );
456 #endif // wxLIST_COMPATIBILITY
459 // all these are going to be "overloaded" in the derived classes
460 wxNodeBase
*GetNext() const { return m_next
; }
461 wxNodeBase
*GetPrevious() const { return m_previous
; }
463 void *GetData() const { return m_data
; }
464 void SetData(void *data
) { m_data
= data
; }
466 // get 0-based index of this node within the list or wxNOT_FOUND
469 virtual void DeleteData() { }
471 // for wxList::iterator
472 void** GetDataPtr() const { return &(((wxNodeBase
*)this)->m_data
); }
474 // optional key stuff
475 wxListKeyValue m_key
;
477 void *m_data
; // user data
478 wxNodeBase
*m_next
, // next and previous nodes in the list
481 wxListBase
*m_list
; // list we belong to
483 DECLARE_NO_COPY_CLASS(wxNodeBase
)
486 // -----------------------------------------------------------------------------
487 // a double-linked list class
488 // -----------------------------------------------------------------------------
490 class WXDLLIMPEXP_FWD_BASE wxList
;
492 class WXDLLIMPEXP_BASE wxListBase
: public wxObject
494 friend class wxNodeBase
; // should be able to call DetachNode()
495 friend class wxHashTableBase
; // should be able to call untyped Find()
498 // default ctor & dtor
499 wxListBase(wxKeyType keyType
= wxKEY_NONE
)
501 virtual ~wxListBase();
504 // count of items in the list
505 size_t GetCount() const { return m_count
; }
507 // return true if this list is empty
508 bool IsEmpty() const { return m_count
== 0; }
515 // instruct it to destroy user data when deleting nodes
516 void DeleteContents(bool destroy
) { m_destroy
= destroy
; }
518 // query if to delete
519 bool GetDeleteContents() const
520 { return m_destroy
; }
523 wxKeyType
GetKeyType() const
524 { return m_keyType
; }
526 // set the keytype (required by the serial code)
527 void SetKeyType(wxKeyType keyType
)
528 { wxASSERT( m_count
==0 ); m_keyType
= keyType
; }
530 #ifdef wxLIST_COMPATIBILITY
531 // compatibility methods from old wxList
532 wxDEPRECATED( int Number() const ); // use GetCount instead.
533 wxDEPRECATED( wxNode
*First() const ); // use GetFirst
534 wxDEPRECATED( wxNode
*Last() const ); // use GetLast
535 wxDEPRECATED( wxNode
*Nth(size_t n
) const ); // use Item
537 // kludge for typesafe list migration in core classes.
538 wxDEPRECATED( operator wxList
&() const );
539 #endif // wxLIST_COMPATIBILITY
543 // all methods here are "overloaded" in derived classes to provide compile
544 // time type checking
546 // create a node for the list of this type
547 virtual wxNodeBase
*CreateNode(wxNodeBase
*prev
, wxNodeBase
*next
,
549 const wxListKey
& key
= wxDefaultListKey
) = 0;
551 // Can't access these from derived classes otherwise (bug in Salford C++?)
558 wxListBase(size_t count
, void *elements
[]);
559 // from a sequence of objects
560 wxListBase(void *object
, ... /* terminate with NULL */);
563 void Assign(const wxListBase
& list
)
564 { Clear(); DoCopy(list
); }
566 // get list head/tail
567 wxNodeBase
*GetFirst() const { return m_nodeFirst
; }
568 wxNodeBase
*GetLast() const { return m_nodeLast
; }
570 // by (0-based) index
571 wxNodeBase
*Item(size_t index
) const;
573 // get the list item's data
574 void *operator[](size_t n
) const
576 wxNodeBase
*node
= Item(n
);
578 return node
? node
->GetData() : (wxNodeBase
*)NULL
;
582 // append to end of list
583 wxNodeBase
*Prepend(void *object
)
584 { return (wxNodeBase
*)wxListBase::Insert(object
); }
585 // append to beginning of list
586 wxNodeBase
*Append(void *object
);
587 // insert a new item at the beginning of the list
588 wxNodeBase
*Insert(void *object
) { return Insert( (wxNodeBase
*)NULL
, object
); }
589 // insert a new item at the given position
590 wxNodeBase
*Insert(size_t pos
, void *object
)
591 { return pos
== GetCount() ? Append(object
)
592 : Insert(Item(pos
), object
); }
593 // insert before given node or at front of list if prev == NULL
594 wxNodeBase
*Insert(wxNodeBase
*prev
, void *object
);
597 wxNodeBase
*Append(long key
, void *object
);
598 wxNodeBase
*Append(const wxString
& key
, void *object
);
600 // removes node from the list but doesn't delete it (returns pointer
601 // to the node or NULL if it wasn't found in the list)
602 wxNodeBase
*DetachNode(wxNodeBase
*node
);
603 // delete element from list, returns false if node not found
604 bool DeleteNode(wxNodeBase
*node
);
605 // finds object pointer and deletes node (and object if DeleteContents
606 // is on), returns false if object not found
607 bool DeleteObject(void *object
);
609 // search (all return NULL if item not found)
611 wxNodeBase
*Find(const void *object
) const;
614 wxNodeBase
*Find(const wxListKey
& key
) const;
616 // get 0-based index of object or wxNOT_FOUND
617 int IndexOf( void *object
) const;
619 // this function allows the sorting of arbitrary lists by giving
620 // a function to compare two list elements. The list is sorted in place.
621 void Sort(const wxSortCompareFunction compfunc
);
623 // functions for iterating over the list
624 void *FirstThat(wxListIterateFunction func
);
625 void ForEach(wxListIterateFunction func
);
626 void *LastThat(wxListIterateFunction func
);
628 // for STL interface, "last" points to one after the last node
629 // of the controlled sequence (NULL for the end of the list)
631 void DeleteNodes(wxNodeBase
* first
, wxNodeBase
* last
);
634 // common part of all ctors
635 void Init(wxKeyType keyType
= wxKEY_NONE
);
638 // common part of copy ctor and assignment operator
639 void DoCopy(const wxListBase
& list
);
640 // common part of all Append()s
641 wxNodeBase
*AppendCommon(wxNodeBase
*node
);
642 // free node's data and node itself
643 void DoDeleteNode(wxNodeBase
*node
);
645 size_t m_count
; // number of elements in the list
646 bool m_destroy
; // destroy user data when deleting list items?
647 wxNodeBase
*m_nodeFirst
, // pointers to the head and tail of the list
650 wxKeyType m_keyType
; // type of our keys (may be wxKEY_NONE)
653 // -----------------------------------------------------------------------------
654 // macros for definition of "template" list type
655 // -----------------------------------------------------------------------------
657 // and now some heavy magic...
659 // declare a list type named 'name' and containing elements of type 'T *'
660 // (as a by product of macro expansion you also get wx##name##Node
661 // wxNode-derived type)
663 // implementation details:
664 // 1. We define _WX_LIST_ITEM_TYPE_##name typedef to save in it the item type
665 // for the list of given type - this allows us to pass only the list name
666 // to WX_DEFINE_LIST() even if it needs both the name and the type
668 // 2. We redefine all non-type-safe wxList functions with type-safe versions
669 // which don't take any space (everything is inline), but bring compile
670 // time error checking.
672 // 3. The macro which is usually used (WX_DECLARE_LIST) is defined in terms of
673 // a more generic WX_DECLARE_LIST_2 macro which, in turn, uses the most
674 // generic WX_DECLARE_LIST_3 one. The last macro adds a sometimes
675 // interesting capability to store polymorphic objects in the list and is
676 // particularly useful with, for example, "wxWindow *" list where the
677 // wxWindowBase pointers are put into the list, but wxWindow pointers are
678 // retrieved from it.
680 // 4. final hack is that WX_DECLARE_LIST_3 is defined in terms of
681 // WX_DECLARE_LIST_4 to allow defining classes without operator->() as
682 // it results in compiler warnings when this operator doesn't make sense
683 // (i.e. stored elements are not pointers)
685 // common part of WX_DECLARE_LIST_3 and WX_DECLARE_LIST_PTR_3
686 #define WX_DECLARE_LIST_4(T, Tbase, name, nodetype, classexp, ptrop) \
687 typedef int (*wxSortFuncFor_##name)(const T **, const T **); \
689 classexp nodetype : public wxNodeBase \
692 nodetype(wxListBase *list = (wxListBase *)NULL, \
693 nodetype *previous = (nodetype *)NULL, \
694 nodetype *next = (nodetype *)NULL, \
695 T *data = (T *)NULL, \
696 const wxListKey& key = wxDefaultListKey) \
697 : wxNodeBase(list, previous, next, data, key) { } \
699 nodetype *GetNext() const \
700 { return (nodetype *)wxNodeBase::GetNext(); } \
701 nodetype *GetPrevious() const \
702 { return (nodetype *)wxNodeBase::GetPrevious(); } \
705 { return (T *)wxNodeBase::GetData(); } \
706 void SetData(T *data) \
707 { wxNodeBase::SetData(data); } \
710 virtual void DeleteData(); \
712 DECLARE_NO_COPY_CLASS(nodetype) \
715 classexp name : public wxListBase \
718 typedef nodetype Node; \
719 classexp compatibility_iterator \
722 compatibility_iterator(Node *ptr = NULL) : m_ptr(ptr) { } \
724 Node *operator->() const { return m_ptr; } \
725 operator Node *() const { return m_ptr; } \
731 name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType) \
733 name(const name& list) : wxListBase(list.GetKeyType()) \
735 name(size_t count, T *elements[]) \
736 : wxListBase(count, (void **)elements) { } \
738 name& operator=(const name& list) \
739 { Assign(list); return *this; } \
741 nodetype *GetFirst() const \
742 { return (nodetype *)wxListBase::GetFirst(); } \
743 nodetype *GetLast() const \
744 { return (nodetype *)wxListBase::GetLast(); } \
746 nodetype *Item(size_t index) const \
747 { return (nodetype *)wxListBase::Item(index); } \
749 T *operator[](size_t index) const \
751 nodetype *node = Item(index); \
752 return node ? (T*)(node->GetData()) : (T*)NULL; \
755 nodetype *Append(Tbase *object) \
756 { return (nodetype *)wxListBase::Append(object); } \
757 nodetype *Insert(Tbase *object) \
758 { return (nodetype *)Insert((nodetype*)NULL, object); } \
759 nodetype *Insert(size_t pos, Tbase *object) \
760 { return (nodetype *)wxListBase::Insert(pos, object); } \
761 nodetype *Insert(nodetype *prev, Tbase *object) \
762 { return (nodetype *)wxListBase::Insert(prev, object); } \
764 nodetype *Append(long key, void *object) \
765 { return (nodetype *)wxListBase::Append(key, object); } \
766 nodetype *Append(const wxChar *key, void *object) \
767 { return (nodetype *)wxListBase::Append(key, object); } \
769 nodetype *DetachNode(nodetype *node) \
770 { return (nodetype *)wxListBase::DetachNode(node); } \
771 bool DeleteNode(nodetype *node) \
772 { return wxListBase::DeleteNode(node); } \
773 bool DeleteObject(Tbase *object) \
774 { return wxListBase::DeleteObject(object); } \
775 void Erase(nodetype *it) \
776 { DeleteNode(it); } \
778 nodetype *Find(const Tbase *object) const \
779 { return (nodetype *)wxListBase::Find(object); } \
781 virtual nodetype *Find(const wxListKey& key) const \
782 { return (nodetype *)wxListBase::Find(key); } \
784 int IndexOf(Tbase *object) const \
785 { return wxListBase::IndexOf(object); } \
787 void Sort(wxSortCompareFunction func) \
788 { wxListBase::Sort(func); } \
789 void Sort(wxSortFuncFor_##name func) \
790 { Sort((wxSortCompareFunction)func); } \
793 virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next, \
795 const wxListKey& key = wxDefaultListKey) \
797 return new nodetype(this, \
798 (nodetype *)prev, (nodetype *)next, \
801 /* STL interface */ \
803 typedef size_t size_type; \
804 typedef int difference_type; \
805 typedef T* value_type; \
806 typedef Tbase* base_value_type; \
807 typedef value_type& reference; \
808 typedef const value_type& const_reference; \
809 typedef base_value_type& base_reference; \
810 typedef const base_value_type& const_base_reference; \
816 typedef nodetype Node; \
817 typedef iterator itor; \
818 typedef T* value_type; \
819 typedef value_type* ptr_type; \
820 typedef value_type& reference; \
825 typedef reference reference_type; \
826 typedef ptr_type pointer_type; \
828 iterator(Node* node, Node* init) : m_node(node), m_init(init) {}\
829 iterator() : m_node(NULL), m_init(NULL) { } \
830 reference_type operator*() const \
831 { return *(pointer_type)m_node->GetDataPtr(); } \
833 itor& operator++() { m_node = m_node->GetNext(); return *this; }\
834 const itor operator++(int) \
835 { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
838 m_node = m_node ? m_node->GetPrevious() : m_init; \
841 const itor operator--(int) \
844 m_node = m_node ? m_node->GetPrevious() : m_init; \
847 bool operator!=(const itor& it) const \
848 { return it.m_node != m_node; } \
849 bool operator==(const itor& it) const \
850 { return it.m_node == m_node; } \
852 classexp const_iterator \
856 typedef nodetype Node; \
857 typedef T* value_type; \
858 typedef const value_type& const_reference; \
859 typedef const_iterator itor; \
860 typedef value_type* ptr_type; \
865 typedef const_reference reference_type; \
866 typedef const ptr_type pointer_type; \
868 const_iterator(Node* node, Node* init) \
869 : m_node(node), m_init(init) { } \
870 const_iterator() : m_node(NULL), m_init(NULL) { } \
871 const_iterator(const iterator& it) \
872 : m_node(it.m_node), m_init(it.m_init) { } \
873 reference_type operator*() const \
874 { return *(pointer_type)m_node->GetDataPtr(); } \
876 itor& operator++() { m_node = m_node->GetNext(); return *this; }\
877 const itor operator++(int) \
878 { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
881 m_node = m_node ? m_node->GetPrevious() : m_init; \
884 const itor operator--(int) \
887 m_node = m_node ? m_node->GetPrevious() : m_init; \
890 bool operator!=(const itor& it) const \
891 { return it.m_node != m_node; } \
892 bool operator==(const itor& it) const \
893 { return it.m_node == m_node; } \
895 classexp reverse_iterator \
899 typedef nodetype Node; \
900 typedef T* value_type; \
901 typedef reverse_iterator itor; \
902 typedef value_type* ptr_type; \
903 typedef value_type& reference; \
908 typedef reference reference_type; \
909 typedef ptr_type pointer_type; \
911 reverse_iterator(Node* node, Node* init) \
912 : m_node(node), m_init(init) { } \
913 reverse_iterator() : m_node(NULL), m_init(NULL) { } \
914 reference_type operator*() const \
915 { return *(pointer_type)m_node->GetDataPtr(); } \
918 { m_node = m_node->GetPrevious(); return *this; } \
919 const itor operator++(int) \
920 { itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\
922 { m_node = m_node ? m_node->GetNext() : m_init; return *this; } \
923 const itor operator--(int) \
926 m_node = m_node ? m_node->GetNext() : m_init; \
929 bool operator!=(const itor& it) const \
930 { return it.m_node != m_node; } \
931 bool operator==(const itor& it) const \
932 { return it.m_node == m_node; } \
934 classexp const_reverse_iterator \
938 typedef nodetype Node; \
939 typedef T* value_type; \
940 typedef const_reverse_iterator itor; \
941 typedef value_type* ptr_type; \
942 typedef const value_type& const_reference; \
947 typedef const_reference reference_type; \
948 typedef const ptr_type pointer_type; \
950 const_reverse_iterator(Node* node, Node* init) \
951 : m_node(node), m_init(init) { } \
952 const_reverse_iterator() : m_node(NULL), m_init(NULL) { } \
953 const_reverse_iterator(const reverse_iterator& it) \
954 : m_node(it.m_node), m_init(it.m_init) { } \
955 reference_type operator*() const \
956 { return *(pointer_type)m_node->GetDataPtr(); } \
959 { m_node = m_node->GetPrevious(); return *this; } \
960 const itor operator++(int) \
961 { itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\
963 { m_node = m_node ? m_node->GetNext() : m_init; return *this;}\
964 const itor operator--(int) \
967 m_node = m_node ? m_node->GetNext() : m_init; \
970 bool operator!=(const itor& it) const \
971 { return it.m_node != m_node; } \
972 bool operator==(const itor& it) const \
973 { return it.m_node == m_node; } \
976 wxEXPLICIT name(size_type n, const_reference v = value_type()) \
978 name(const const_iterator& first, const const_iterator& last) \
979 { assign(first, last); } \
980 iterator begin() { return iterator(GetFirst(), GetLast()); } \
981 const_iterator begin() const \
982 { return const_iterator(GetFirst(), GetLast()); } \
983 iterator end() { return iterator(NULL, GetLast()); } \
984 const_iterator end() const { return const_iterator(NULL, GetLast()); }\
985 reverse_iterator rbegin() \
986 { return reverse_iterator(GetLast(), GetFirst()); } \
987 const_reverse_iterator rbegin() const \
988 { return const_reverse_iterator(GetLast(), GetFirst()); } \
989 reverse_iterator rend() { return reverse_iterator(NULL, GetFirst()); }\
990 const_reverse_iterator rend() const \
991 { return const_reverse_iterator(NULL, GetFirst()); } \
992 void resize(size_type n, value_type v = value_type()) \
999 size_type size() const { return GetCount(); } \
1000 size_type max_size() const { return INT_MAX; } \
1001 bool empty() const { return IsEmpty(); } \
1002 reference front() { return *begin(); } \
1003 const_reference front() const { return *begin(); } \
1004 reference back() { iterator tmp = end(); return *--tmp; } \
1005 const_reference back() const { const_iterator tmp = end(); return *--tmp; }\
1006 void push_front(const_reference v = value_type()) \
1007 { Insert(GetFirst(), (const_base_reference)v); } \
1008 void pop_front() { DeleteNode(GetFirst()); } \
1009 void push_back(const_reference v = value_type()) \
1010 { Append((const_base_reference)v); } \
1011 void pop_back() { DeleteNode(GetLast()); } \
1012 void assign(const_iterator first, const const_iterator& last) \
1015 for(; first != last; ++first) \
1016 Append((const_base_reference)*first); \
1018 void assign(size_type n, const_reference v = value_type()) \
1021 for(size_type i = 0; i < n; ++i) \
1022 Append((const_base_reference)v); \
1024 iterator insert(const iterator& it, const_reference v = value_type())\
1026 Insert(it.m_node, (const_base_reference)v); \
1027 iterator itprev(it); \
1030 void insert(const iterator& it, size_type n, const_reference v = value_type())\
1032 for(size_type i = 0; i < n; ++i) \
1033 Insert(it.m_node, (const_base_reference)v); \
1035 void insert(const iterator& it, const_iterator first, const const_iterator& last)\
1037 for(; first != last; ++first) \
1038 Insert(it.m_node, (const_base_reference)*first); \
1040 iterator erase(const iterator& it) \
1042 iterator next = iterator(it.m_node->GetNext(), GetLast()); \
1043 DeleteNode(it.m_node); return next; \
1045 iterator erase(const iterator& first, const iterator& last) \
1047 iterator next = last; ++next; \
1048 DeleteNodes(first.m_node, last.m_node); \
1051 void clear() { Clear(); } \
1052 void splice(const iterator& it, name& l, const iterator& first, const iterator& last)\
1053 { insert(it, first, last); l.erase(first, last); } \
1054 void splice(const iterator& it, name& l) \
1055 { splice(it, l, l.begin(), l.end() ); } \
1056 void splice(const iterator& it, name& l, const iterator& first) \
1058 iterator tmp = first; ++tmp; \
1059 if(it == first || it == tmp) return; \
1060 insert(it, *first); \
1063 void remove(const_reference v) \
1064 { DeleteObject((const_base_reference)v); } \
1067 /* void swap(name& l) \
1069 { size_t t = m_count; m_count = l.m_count; l.m_count = t; } \
1070 { bool t = m_destroy; m_destroy = l.m_destroy; l.m_destroy = t; }\
1071 { wxNodeBase* t = m_nodeFirst; m_nodeFirst = l.m_nodeFirst; l.m_nodeFirst = t; }\
1072 { wxNodeBase* t = m_nodeLast; m_nodeLast = l.m_nodeLast; l.m_nodeLast = t; }\
1073 { wxKeyType t = m_keyType; m_keyType = l.m_keyType; l.m_keyType = t; }\
1077 #define WX_LIST_PTROP \
1078 pointer_type operator->() const \
1079 { return (pointer_type)m_node->GetDataPtr(); }
1080 #define WX_LIST_PTROP_NONE
1082 #define WX_DECLARE_LIST_3(T, Tbase, name, nodetype, classexp) \
1083 WX_DECLARE_LIST_4(T, Tbase, name, nodetype, classexp, WX_LIST_PTROP_NONE)
1084 #define WX_DECLARE_LIST_PTR_3(T, Tbase, name, nodetype, classexp) \
1085 WX_DECLARE_LIST_4(T, Tbase, name, nodetype, classexp, WX_LIST_PTROP)
1087 #define WX_DECLARE_LIST_2(elementtype, listname, nodename, classexp) \
1088 WX_DECLARE_LIST_3(elementtype, elementtype, listname, nodename, classexp)
1089 #define WX_DECLARE_LIST_PTR_2(elementtype, listname, nodename, classexp) \
1090 WX_DECLARE_LIST_PTR_3(elementtype, elementtype, listname, nodename, classexp)
1092 #define WX_DECLARE_LIST(elementtype, listname) \
1093 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1094 WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class)
1095 #define WX_DECLARE_LIST_PTR(elementtype, listname) \
1096 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1097 WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class)
1099 #define WX_DECLARE_LIST_WITH_DECL(elementtype, listname, decl) \
1100 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1101 WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, decl)
1103 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname) \
1104 WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class WXDLLEXPORT)
1106 #define WX_DECLARE_EXPORTED_LIST_PTR(elementtype, listname) \
1107 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1108 WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class WXDLLEXPORT)
1110 #define WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo) \
1111 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1112 WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class usergoo)
1113 #define WX_DECLARE_USER_EXPORTED_LIST_PTR(elementtype, listname, usergoo) \
1114 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1115 WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class usergoo)
1117 // this macro must be inserted in your program after
1118 // #include "wx/listimpl.cpp"
1119 #define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
1121 #define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
1122 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
1124 #endif // !wxUSE_STL
1126 // ============================================================================
1127 // now we can define classes 100% compatible with the old ones
1128 // ============================================================================
1130 // ----------------------------------------------------------------------------
1131 // commonly used list classes
1132 // ----------------------------------------------------------------------------
1134 #if defined(wxLIST_COMPATIBILITY)
1136 // inline compatibility functions
1140 // ----------------------------------------------------------------------------
1141 // wxNodeBase deprecated methods
1142 // ----------------------------------------------------------------------------
1144 inline wxNode
*wxNodeBase::Next() const { return (wxNode
*)GetNext(); }
1145 inline wxNode
*wxNodeBase::Previous() const { return (wxNode
*)GetPrevious(); }
1146 inline wxObject
*wxNodeBase::Data() const { return (wxObject
*)GetData(); }
1148 // ----------------------------------------------------------------------------
1149 // wxListBase deprecated methods
1150 // ----------------------------------------------------------------------------
1152 inline int wxListBase::Number() const { return (int)GetCount(); }
1153 inline wxNode
*wxListBase::First() const { return (wxNode
*)GetFirst(); }
1154 inline wxNode
*wxListBase::Last() const { return (wxNode
*)GetLast(); }
1155 inline wxNode
*wxListBase::Nth(size_t n
) const { return (wxNode
*)Item(n
); }
1156 inline wxListBase::operator wxList
&() const { return *(wxList
*)this; }
1160 // define this to make a lot of noise about use of the old wxList classes.
1161 //#define wxWARN_COMPAT_LIST_USE
1163 // ----------------------------------------------------------------------------
1164 // wxList compatibility class: in fact, it's a list of wxObjects
1165 // ----------------------------------------------------------------------------
1167 WX_DECLARE_LIST_2(wxObject
, wxObjectList
, wxObjectListNode
,
1168 class WXDLLIMPEXP_BASE
);
1170 class WXDLLIMPEXP_BASE wxList
: public wxObjectList
1173 #if defined(wxWARN_COMPAT_LIST_USE) && !wxUSE_STL
1175 wxDEPRECATED( wxList(int key_type
) );
1177 wxList(int key_type
= wxKEY_NONE
);
1180 // this destructor is required for Darwin
1184 wxList
& operator=(const wxList
& list
)
1185 { (void) wxListBase::operator=(list
); return *this; }
1187 // compatibility methods
1188 void Sort(wxSortCompareFunction compfunc
) { wxListBase::Sort(compfunc
); }
1193 wxNode
*Member(wxObject
*object
) const { return (wxNode
*)Find(object
); }
1198 DECLARE_DYNAMIC_CLASS(wxList
)
1204 // -----------------------------------------------------------------------------
1205 // wxStringList class for compatibility with the old code
1206 // -----------------------------------------------------------------------------
1207 WX_DECLARE_LIST_2(wxChar
, wxStringListBase
, wxStringListNode
, class WXDLLIMPEXP_BASE
);
1209 class WXDLLIMPEXP_BASE wxStringList
: public wxStringListBase
1214 #ifdef wxWARN_COMPAT_LIST_USE
1216 wxDEPRECATED( wxStringList(const wxChar
*first
...) ); // FIXME-UTF8
1219 wxStringList(const wxChar
*first
...); // FIXME-UTF8
1222 // copying the string list: the strings are copied, too (extremely
1224 wxStringList(const wxStringList
& other
) : wxStringListBase() { DeleteContents(true); DoCopy(other
); }
1225 wxStringList
& operator=(const wxStringList
& other
)
1226 { Clear(); DoCopy(other
); return *this; }
1229 // makes a copy of the string
1230 wxNode
*Add(const wxChar
*s
);
1232 // Append to beginning of list
1233 wxNode
*Prepend(const wxChar
*s
);
1235 bool Delete(const wxChar
*s
);
1237 wxChar
**ListToArray(bool new_copies
= false) const;
1238 bool Member(const wxChar
*s
) const;
1244 void DoCopy(const wxStringList
&); // common part of copy ctor and operator=
1246 DECLARE_DYNAMIC_CLASS(wxStringList
)
1249 #else // if wxUSE_STL
1251 WX_DECLARE_LIST_XO(wxString
, wxStringListBase
, class WXDLLIMPEXP_BASE
);
1253 class WXDLLIMPEXP_BASE wxStringList
: public wxStringListBase
1256 compatibility_iterator
Append(wxChar
* s
)
1257 { wxString tmp
= s
; delete[] s
; return wxStringListBase::Append(tmp
); }
1258 compatibility_iterator
Insert(wxChar
* s
)
1259 { wxString tmp
= s
; delete[] s
; return wxStringListBase::Insert(tmp
); }
1260 compatibility_iterator
Insert(size_t pos
, wxChar
* s
)
1264 return wxStringListBase::Insert(pos
, tmp
);
1266 compatibility_iterator
Add(const wxChar
* s
)
1267 { push_back(s
); return GetLast(); }
1268 compatibility_iterator
Prepend(const wxChar
* s
)
1269 { push_front(s
); return GetFirst(); }
1274 #endif // wxLIST_COMPATIBILITY
1276 // delete all list elements
1278 // NB: the class declaration of the list elements must be visible from the
1279 // place where you use this macro, otherwise the proper destructor may not
1280 // be called (a decent compiler should give a warning about it, but don't
1282 #define WX_CLEAR_LIST(type, list) \
1284 type::iterator it, en; \
1285 for( it = (list).begin(), en = (list).end(); it != en; ++it ) \
1290 #endif // _WX_LISTH__