]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/list.h
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...
[wxWidgets.git] / include / wx / list.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/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 licence
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_LIST_H_
26#define _WX_LIST_H_
27
28// -----------------------------------------------------------------------------
29// headers
30// -----------------------------------------------------------------------------
31
32#include "wx/defs.h"
33#include "wx/object.h"
34#include "wx/string.h"
35
36#if wxUSE_STL
37 #include "wx/beforestd.h"
38 #include <algorithm>
39 #include <iterator>
40 #include <list>
41 #include "wx/afterstd.h"
42#endif
43
44// ----------------------------------------------------------------------------
45// types
46// ----------------------------------------------------------------------------
47
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
51
52extern "C"
53{
54typedef int (* LINKAGEMODE wxSortCompareFunction)(const void *elem1, const void *elem2);
55}
56
57class WXDLLIMPEXP_FWD_BASE wxObjectListNode;
58typedef wxObjectListNode wxNode;
59
60//
61typedef int (* LINKAGEMODE wxListIterateFunction)(void *current);
62
63#if wxUSE_STL
64
65#define wxLIST_COMPATIBILITY
66
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)
71
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) \
76
77#define WX_DECLARE_LIST_WITH_DECL(elT, liT, decl) \
78 WX_DECLARE_LIST_XO(elT*, liT, decl)
79
80#if !defined(__VISUALC__) || __VISUALC__ >= 1300 // == !VC6
81
82template<class T>
83class wxList_SortFunction
84{
85public:
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; }
89private:
90 wxSortCompareFunction m_f;
91};
92
93#define WX_LIST_SORTFUNCTION( elT, f ) wxList_SortFunction<elT>(f)
94#define WX_LIST_VC6_WORKAROUND(elT, liT, decl)
95
96#else // if defined( __VISUALC__ ) && __VISUALC__ < 1300 // == VC6
97
98#define WX_LIST_SORTFUNCTION( elT, f ) std::greater<elT>( f )
99#define WX_LIST_VC6_WORKAROUND(elT, liT, decl) \
100 decl liT; \
101 \
102 /* Workaround for broken VC6 STL incorrectly requires a std::greater<> */ \
103 /* to be passed into std::list::sort() */ \
104 template <> \
105 struct std::greater<elT> \
106 { \
107 private: \
108 wxSortCompareFunction m_CompFunc; \
109 public: \
110 greater( wxSortCompareFunction compfunc = NULL ) \
111 : m_CompFunc( compfunc ) {} \
112 bool operator()(const elT X, const elT Y) const \
113 { \
114 return m_CompFunc ? \
115 ( m_CompFunc( wxListCastElementToVoidPtr(X), \
116 wxListCastElementToVoidPtr(Y) ) < 0 ) : \
117 ( X > Y ); \
118 } \
119 };
120
121// helper for std::greater<elT> above:
122template<typename T>
123inline const void *wxListCastElementToVoidPtr(const T* ptr) { return ptr; }
124inline const void *wxListCastElementToVoidPtr(const wxString& str)
125 { return (const char*)str; }
126
127#endif // VC6/!VC6
128
129/*
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:
133
134 struct WXDLLEXPORT Foo
135 {
136 static void Bar();
137 struct SomeInnerClass
138 {
139 friend class Foo; // comment this out to make it link
140 };
141 ~Foo()
142 {
143 Bar();
144 }
145 };
146
147 The program does not link under mingw_gcc 3.2.3 producing undefined
148 reference to Foo::Bar() function
149
150
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
155 invalid iterator.
156 */
157
158// the real wxList-class declaration
159#define WX_DECLARE_LIST_XO(elT, liT, decl) \
160 decl _WX_LIST_HELPER_##liT \
161 { \
162 typedef elT _WX_LIST_ITEM_TYPE_##liT; \
163 public: \
164 static void DeleteFunction( _WX_LIST_ITEM_TYPE_##liT X ); \
165 }; \
166 \
167 WX_LIST_VC6_WORKAROUND(elT, liT, decl) \
168 decl liT : public std::list<elT> \
169 { \
170 private: \
171 typedef std::list<elT> BaseListType; \
172 static BaseListType EmptyList; \
173 \
174 bool m_destroy; \
175 \
176 public: \
177 decl compatibility_iterator \
178 { \
179 private: \
180 /* Workaround for broken VC6 nested class name resolution */ \
181 typedef std::list<elT>::iterator iterator; \
182 friend class liT; \
183 \
184 iterator m_iter; \
185 liT * m_list; \
186 \
187 public: \
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 ) ) {} \
194 \
195 compatibility_iterator* operator->() { return this; } \
196 const compatibility_iterator* operator->() const { return this; } \
197 \
198 bool operator==(const compatibility_iterator& i) const \
199 { \
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); \
203 } \
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() ); } \
210 \
211 elT GetData() const \
212 { return *m_iter; } \
213 void SetData( elT e ) \
214 { *m_iter = e; } \
215 \
216 compatibility_iterator GetNext() const \
217 { \
218 iterator i = m_iter; \
219 return compatibility_iterator( m_list, ++i ); \
220 } \
221 compatibility_iterator GetPrevious() const \
222 { \
223 if ( m_iter == m_list->begin() ) \
224 return compatibility_iterator(); \
225 \
226 iterator i = m_iter; \
227 return compatibility_iterator( m_list, --i ); \
228 } \
229 int IndexOf() const \
230 { \
231 return *this ? std::distance( m_list->begin(), m_iter ) \
232 : wxNOT_FOUND; \
233 } \
234 }; \
235 public: \
236 liT() : m_destroy( false ) {} \
237 \
238 compatibility_iterator Find( const elT e ) const \
239 { \
240 liT* _this = const_cast< liT* >( this ); \
241 return compatibility_iterator( _this, \
242 std::find( _this->begin(), _this->end(), e ) ); \
243 } \
244 \
245 bool IsEmpty() const \
246 { return empty(); } \
247 size_t GetCount() const \
248 { return size(); } \
249 int Number() const \
250 { return static_cast< int >( GetCount() ); } \
251 \
252 compatibility_iterator Item( size_t idx ) const \
253 { \
254 iterator i = const_cast< liT* >(this)->begin(); \
255 std::advance( i, idx ); \
256 return compatibility_iterator( this, i ); \
257 } \
258 elT operator[](size_t idx) const \
259 { \
260 return Item(idx).GetData(); \
261 } \
262 \
263 compatibility_iterator GetFirst() const \
264 { \
265 return compatibility_iterator( this, \
266 const_cast< liT* >(this)->begin() ); \
267 } \
268 compatibility_iterator GetLast() const \
269 { \
270 iterator i = const_cast< liT* >(this)->end(); \
271 return compatibility_iterator( this, !empty() ? --i : i ); \
272 } \
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(); } \
279 \
280 compatibility_iterator Append( elT e ) \
281 { \
282 push_back( e ); \
283 return GetLast(); \
284 } \
285 compatibility_iterator Insert( elT e ) \
286 { \
287 push_front( e ); \
288 return compatibility_iterator( this, begin() ); \
289 } \
290 compatibility_iterator Insert( compatibility_iterator & i, elT e ) \
291 { \
292 return compatibility_iterator( this, insert( i.m_iter, e ) ); \
293 } \
294 compatibility_iterator Insert( size_t idx, elT e ) \
295 { \
296 return compatibility_iterator( this, \
297 insert( Item( idx ).m_iter, e ) ); \
298 } \
299 \
300 void DeleteContents( bool destroy ) \
301 { m_destroy = destroy; } \
302 bool GetDeleteContents() const \
303 { return m_destroy; } \
304 void Erase( const compatibility_iterator& i ) \
305 { \
306 if ( m_destroy ) \
307 _WX_LIST_HELPER_##liT::DeleteFunction( i->GetData() ); \
308 erase( i.m_iter ); \
309 } \
310 bool DeleteNode( const compatibility_iterator& i ) \
311 { \
312 if( i ) \
313 { \
314 Erase( i ); \
315 return true; \
316 } \
317 return false; \
318 } \
319 bool DeleteObject( elT e ) \
320 { \
321 return DeleteNode( Find( e ) ); \
322 } \
323 void Clear() \
324 { \
325 if ( m_destroy ) \
326 std::for_each( begin(), end(), \
327 _WX_LIST_HELPER_##liT::DeleteFunction ); \
328 clear(); \
329 } \
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(); } \
334 \
335 /* It needs access to our EmptyList */ \
336 friend class compatibility_iterator; \
337 }
338
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)
343
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)
348
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)
353
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!"
357
358#define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
359#define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
360
361#else // if !wxUSE_STL
362
363
364// undef it to get rid of old, deprecated functions
365#define wxLIST_COMPATIBILITY
366
367// -----------------------------------------------------------------------------
368// key stuff: a list may be optionally keyed on integer or string key
369// -----------------------------------------------------------------------------
370
371union wxListKeyValue
372{
373 long integer;
374 wxString *string;
375};
376
377// a struct which may contain both types of keys
378//
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 *).
383class WXDLLIMPEXP_BASE wxListKey
384{
385public:
386 // implicit ctors
387 wxListKey() : m_keyType(wxKEY_NONE)
388 { }
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); }
397
398 // accessors
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; }
404
405 // comparison
406 // Note: implementation moved to list.cpp to prevent BC++ inline
407 // expansion warning.
408 bool operator==(wxListKeyValue value) const ;
409
410 // dtor
411 ~wxListKey()
412 {
413 if ( m_keyType == wxKEY_STRING )
414 delete m_key.string;
415 }
416
417private:
418 wxKeyType m_keyType;
419 wxListKeyValue m_key;
420};
421
422// -----------------------------------------------------------------------------
423// wxNodeBase class is a (base for) node in a double linked list
424// -----------------------------------------------------------------------------
425
426extern WXDLLIMPEXP_DATA_BASE(wxListKey) wxDefaultListKey;
427
428class WXDLLIMPEXP_FWD_BASE wxListBase;
429
430class WXDLLIMPEXP_BASE wxNodeBase
431{
432friend class wxListBase;
433public:
434 // ctor
435 wxNodeBase(wxListBase *list = (wxListBase *)NULL,
436 wxNodeBase *previous = (wxNodeBase *)NULL,
437 wxNodeBase *next = (wxNodeBase *)NULL,
438 void *data = NULL,
439 const wxListKey& key = wxDefaultListKey);
440
441 virtual ~wxNodeBase();
442
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; }
446
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; }
450
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
457
458protected:
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; }
462
463 void *GetData() const { return m_data; }
464 void SetData(void *data) { m_data = data; }
465
466 // get 0-based index of this node within the list or wxNOT_FOUND
467 int IndexOf() const;
468
469 virtual void DeleteData() { }
470public:
471 // for wxList::iterator
472 void** GetDataPtr() const { return &(wx_const_cast(wxNodeBase*, this)->m_data); }
473private:
474 // optional key stuff
475 wxListKeyValue m_key;
476
477 void *m_data; // user data
478 wxNodeBase *m_next, // next and previous nodes in the list
479 *m_previous;
480
481 wxListBase *m_list; // list we belong to
482
483 DECLARE_NO_COPY_CLASS(wxNodeBase)
484};
485
486// -----------------------------------------------------------------------------
487// a double-linked list class
488// -----------------------------------------------------------------------------
489
490class WXDLLIMPEXP_FWD_BASE wxList;
491
492class WXDLLIMPEXP_BASE wxListBase
493{
494friend class wxNodeBase; // should be able to call DetachNode()
495friend class wxHashTableBase; // should be able to call untyped Find()
496
497public:
498 // default ctor & dtor
499 wxListBase(wxKeyType keyType = wxKEY_NONE)
500 { Init(keyType); }
501 virtual ~wxListBase();
502
503 // accessors
504 // count of items in the list
505 size_t GetCount() const { return m_count; }
506
507 // return true if this list is empty
508 bool IsEmpty() const { return m_count == 0; }
509
510 // operations
511
512 // delete all nodes
513 void Clear();
514
515 // instruct it to destroy user data when deleting nodes
516 void DeleteContents(bool destroy) { m_destroy = destroy; }
517
518 // query if to delete
519 bool GetDeleteContents() const
520 { return m_destroy; }
521
522 // get the keytype
523 wxKeyType GetKeyType() const
524 { return m_keyType; }
525
526 // set the keytype (required by the serial code)
527 void SetKeyType(wxKeyType keyType)
528 { wxASSERT( m_count==0 ); m_keyType = keyType; }
529
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
536
537 // kludge for typesafe list migration in core classes.
538 wxDEPRECATED( operator wxList&() const );
539#endif // wxLIST_COMPATIBILITY
540
541protected:
542
543 // all methods here are "overloaded" in derived classes to provide compile
544 // time type checking
545
546 // create a node for the list of this type
547 virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,
548 void *data,
549 const wxListKey& key = wxDefaultListKey) = 0;
550
551
552 // ctors
553 // from an array
554 wxListBase(size_t count, void *elements[]);
555 // from a sequence of objects
556 wxListBase(void *object, ... /* terminate with NULL */);
557
558protected:
559 void Assign(const wxListBase& list)
560 { Clear(); DoCopy(list); }
561
562 // get list head/tail
563 wxNodeBase *GetFirst() const { return m_nodeFirst; }
564 wxNodeBase *GetLast() const { return m_nodeLast; }
565
566 // by (0-based) index
567 wxNodeBase *Item(size_t index) const;
568
569 // get the list item's data
570 void *operator[](size_t n) const
571 {
572 wxNodeBase *node = Item(n);
573
574 return node ? node->GetData() : (wxNodeBase *)NULL;
575 }
576
577 // operations
578 // append to end of list
579 wxNodeBase *Prepend(void *object)
580 { return (wxNodeBase *)wxListBase::Insert(object); }
581 // append to beginning of list
582 wxNodeBase *Append(void *object);
583 // insert a new item at the beginning of the list
584 wxNodeBase *Insert(void *object) { return Insert( (wxNodeBase*)NULL, object); }
585 // insert a new item at the given position
586 wxNodeBase *Insert(size_t pos, void *object)
587 { return pos == GetCount() ? Append(object)
588 : Insert(Item(pos), object); }
589 // insert before given node or at front of list if prev == NULL
590 wxNodeBase *Insert(wxNodeBase *prev, void *object);
591
592 // keyed append
593 wxNodeBase *Append(long key, void *object);
594 wxNodeBase *Append(const wxString& key, void *object);
595
596 // removes node from the list but doesn't delete it (returns pointer
597 // to the node or NULL if it wasn't found in the list)
598 wxNodeBase *DetachNode(wxNodeBase *node);
599 // delete element from list, returns false if node not found
600 bool DeleteNode(wxNodeBase *node);
601 // finds object pointer and deletes node (and object if DeleteContents
602 // is on), returns false if object not found
603 bool DeleteObject(void *object);
604
605 // search (all return NULL if item not found)
606 // by data
607 wxNodeBase *Find(const void *object) const;
608
609 // by key
610 wxNodeBase *Find(const wxListKey& key) const;
611
612 // get 0-based index of object or wxNOT_FOUND
613 int IndexOf( void *object ) const;
614
615 // this function allows the sorting of arbitrary lists by giving
616 // a function to compare two list elements. The list is sorted in place.
617 void Sort(const wxSortCompareFunction compfunc);
618
619 // functions for iterating over the list
620 void *FirstThat(wxListIterateFunction func);
621 void ForEach(wxListIterateFunction func);
622 void *LastThat(wxListIterateFunction func);
623
624 // for STL interface, "last" points to one after the last node
625 // of the controlled sequence (NULL for the end of the list)
626 void Reverse();
627 void DeleteNodes(wxNodeBase* first, wxNodeBase* last);
628private:
629
630 // common part of all ctors
631 void Init(wxKeyType keyType = wxKEY_NONE);
632
633 // helpers
634 // common part of copy ctor and assignment operator
635 void DoCopy(const wxListBase& list);
636 // common part of all Append()s
637 wxNodeBase *AppendCommon(wxNodeBase *node);
638 // free node's data and node itself
639 void DoDeleteNode(wxNodeBase *node);
640
641 size_t m_count; // number of elements in the list
642 bool m_destroy; // destroy user data when deleting list items?
643 wxNodeBase *m_nodeFirst, // pointers to the head and tail of the list
644 *m_nodeLast;
645
646 wxKeyType m_keyType; // type of our keys (may be wxKEY_NONE)
647};
648
649// -----------------------------------------------------------------------------
650// macros for definition of "template" list type
651// -----------------------------------------------------------------------------
652
653// and now some heavy magic...
654
655// declare a list type named 'name' and containing elements of type 'T *'
656// (as a by product of macro expansion you also get wx##name##Node
657// wxNode-derived type)
658//
659// implementation details:
660// 1. We define _WX_LIST_ITEM_TYPE_##name typedef to save in it the item type
661// for the list of given type - this allows us to pass only the list name
662// to WX_DEFINE_LIST() even if it needs both the name and the type
663//
664// 2. We redefine all non-type-safe wxList functions with type-safe versions
665// which don't take any space (everything is inline), but bring compile
666// time error checking.
667//
668// 3. The macro which is usually used (WX_DECLARE_LIST) is defined in terms of
669// a more generic WX_DECLARE_LIST_2 macro which, in turn, uses the most
670// generic WX_DECLARE_LIST_3 one. The last macro adds a sometimes
671// interesting capability to store polymorphic objects in the list and is
672// particularly useful with, for example, "wxWindow *" list where the
673// wxWindowBase pointers are put into the list, but wxWindow pointers are
674// retrieved from it.
675//
676// 4. final hack is that WX_DECLARE_LIST_3 is defined in terms of
677// WX_DECLARE_LIST_4 to allow defining classes without operator->() as
678// it results in compiler warnings when this operator doesn't make sense
679// (i.e. stored elements are not pointers)
680
681// common part of WX_DECLARE_LIST_3 and WX_DECLARE_LIST_PTR_3
682#define WX_DECLARE_LIST_4(T, Tbase, name, nodetype, classexp, ptrop) \
683 typedef int (*wxSortFuncFor_##name)(const T **, const T **); \
684 \
685 classexp nodetype : public wxNodeBase \
686 { \
687 public: \
688 nodetype(wxListBase *list = (wxListBase *)NULL, \
689 nodetype *previous = (nodetype *)NULL, \
690 nodetype *next = (nodetype *)NULL, \
691 T *data = (T *)NULL, \
692 const wxListKey& key = wxDefaultListKey) \
693 : wxNodeBase(list, previous, next, data, key) { } \
694 \
695 nodetype *GetNext() const \
696 { return (nodetype *)wxNodeBase::GetNext(); } \
697 nodetype *GetPrevious() const \
698 { return (nodetype *)wxNodeBase::GetPrevious(); } \
699 \
700 T *GetData() const \
701 { return (T *)wxNodeBase::GetData(); } \
702 void SetData(T *data) \
703 { wxNodeBase::SetData(data); } \
704 \
705 protected: \
706 virtual void DeleteData(); \
707 \
708 DECLARE_NO_COPY_CLASS(nodetype) \
709 }; \
710 \
711 classexp name : public wxListBase \
712 { \
713 public: \
714 typedef nodetype Node; \
715 classexp compatibility_iterator \
716 { \
717 public: \
718 compatibility_iterator(Node *ptr = NULL) : m_ptr(ptr) { } \
719 \
720 Node *operator->() const { return m_ptr; } \
721 operator Node *() const { return m_ptr; } \
722 \
723 private: \
724 Node *m_ptr; \
725 }; \
726 \
727 name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType) \
728 { } \
729 name(const name& list) : wxListBase(list.GetKeyType()) \
730 { Assign(list); } \
731 name(size_t count, T *elements[]) \
732 : wxListBase(count, (void **)elements) { } \
733 \
734 name& operator=(const name& list) \
735 { if (&list != this) Assign(list); return *this; } \
736 \
737 nodetype *GetFirst() const \
738 { return (nodetype *)wxListBase::GetFirst(); } \
739 nodetype *GetLast() const \
740 { return (nodetype *)wxListBase::GetLast(); } \
741 \
742 nodetype *Item(size_t index) const \
743 { return (nodetype *)wxListBase::Item(index); } \
744 \
745 T *operator[](size_t index) const \
746 { \
747 nodetype *node = Item(index); \
748 return node ? (T*)(node->GetData()) : (T*)NULL; \
749 } \
750 \
751 nodetype *Append(Tbase *object) \
752 { return (nodetype *)wxListBase::Append(object); } \
753 nodetype *Insert(Tbase *object) \
754 { return (nodetype *)Insert((nodetype*)NULL, object); } \
755 nodetype *Insert(size_t pos, Tbase *object) \
756 { return (nodetype *)wxListBase::Insert(pos, object); } \
757 nodetype *Insert(nodetype *prev, Tbase *object) \
758 { return (nodetype *)wxListBase::Insert(prev, object); } \
759 \
760 nodetype *Append(long key, void *object) \
761 { return (nodetype *)wxListBase::Append(key, object); } \
762 nodetype *Append(const wxChar *key, void *object) \
763 { return (nodetype *)wxListBase::Append(key, object); } \
764 \
765 nodetype *DetachNode(nodetype *node) \
766 { return (nodetype *)wxListBase::DetachNode(node); } \
767 bool DeleteNode(nodetype *node) \
768 { return wxListBase::DeleteNode(node); } \
769 bool DeleteObject(Tbase *object) \
770 { return wxListBase::DeleteObject(object); } \
771 void Erase(nodetype *it) \
772 { DeleteNode(it); } \
773 \
774 nodetype *Find(const Tbase *object) const \
775 { return (nodetype *)wxListBase::Find(object); } \
776 \
777 virtual nodetype *Find(const wxListKey& key) const \
778 { return (nodetype *)wxListBase::Find(key); } \
779 \
780 int IndexOf(Tbase *object) const \
781 { return wxListBase::IndexOf(object); } \
782 \
783 void Sort(wxSortCompareFunction func) \
784 { wxListBase::Sort(func); } \
785 void Sort(wxSortFuncFor_##name func) \
786 { Sort((wxSortCompareFunction)func); } \
787 \
788 protected: \
789 virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next, \
790 void *data, \
791 const wxListKey& key = wxDefaultListKey) \
792 { \
793 return new nodetype(this, \
794 (nodetype *)prev, (nodetype *)next, \
795 (T *)data, key); \
796 } \
797 /* STL interface */ \
798 public: \
799 typedef size_t size_type; \
800 typedef int difference_type; \
801 typedef T* value_type; \
802 typedef Tbase* base_value_type; \
803 typedef value_type& reference; \
804 typedef const value_type& const_reference; \
805 typedef base_value_type& base_reference; \
806 typedef const base_value_type& const_base_reference; \
807 \
808 classexp iterator \
809 { \
810 typedef name list; \
811 public: \
812 typedef nodetype Node; \
813 typedef iterator itor; \
814 typedef T* value_type; \
815 typedef value_type* ptr_type; \
816 typedef value_type& reference; \
817 \
818 Node* m_node; \
819 Node* m_init; \
820 public: \
821 typedef reference reference_type; \
822 typedef ptr_type pointer_type; \
823 \
824 iterator(Node* node, Node* init) : m_node(node), m_init(init) {}\
825 iterator() : m_node(NULL), m_init(NULL) { } \
826 reference_type operator*() const \
827 { return *(pointer_type)m_node->GetDataPtr(); } \
828 ptrop \
829 itor& operator++() { m_node = m_node->GetNext(); return *this; }\
830 const itor operator++(int) \
831 { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
832 itor& operator--() \
833 { \
834 m_node = m_node ? m_node->GetPrevious() : m_init; \
835 return *this; \
836 } \
837 const itor operator--(int) \
838 { \
839 itor tmp = *this; \
840 m_node = m_node ? m_node->GetPrevious() : m_init; \
841 return tmp; \
842 } \
843 bool operator!=(const itor& it) const \
844 { return it.m_node != m_node; } \
845 bool operator==(const itor& it) const \
846 { return it.m_node == m_node; } \
847 }; \
848 classexp const_iterator \
849 { \
850 typedef name list; \
851 public: \
852 typedef nodetype Node; \
853 typedef T* value_type; \
854 typedef const value_type& const_reference; \
855 typedef const_iterator itor; \
856 typedef value_type* ptr_type; \
857 \
858 Node* m_node; \
859 Node* m_init; \
860 public: \
861 typedef const_reference reference_type; \
862 typedef const ptr_type pointer_type; \
863 \
864 const_iterator(Node* node, Node* init) \
865 : m_node(node), m_init(init) { } \
866 const_iterator() : m_node(NULL), m_init(NULL) { } \
867 const_iterator(const iterator& it) \
868 : m_node(it.m_node), m_init(it.m_init) { } \
869 reference_type operator*() const \
870 { return *(pointer_type)m_node->GetDataPtr(); } \
871 ptrop \
872 itor& operator++() { m_node = m_node->GetNext(); return *this; }\
873 const itor operator++(int) \
874 { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
875 itor& operator--() \
876 { \
877 m_node = m_node ? m_node->GetPrevious() : m_init; \
878 return *this; \
879 } \
880 const itor operator--(int) \
881 { \
882 itor tmp = *this; \
883 m_node = m_node ? m_node->GetPrevious() : m_init; \
884 return tmp; \
885 } \
886 bool operator!=(const itor& it) const \
887 { return it.m_node != m_node; } \
888 bool operator==(const itor& it) const \
889 { return it.m_node == m_node; } \
890 }; \
891 classexp reverse_iterator \
892 { \
893 typedef name list; \
894 public: \
895 typedef nodetype Node; \
896 typedef T* value_type; \
897 typedef reverse_iterator itor; \
898 typedef value_type* ptr_type; \
899 typedef value_type& reference; \
900 \
901 Node* m_node; \
902 Node* m_init; \
903 public: \
904 typedef reference reference_type; \
905 typedef ptr_type pointer_type; \
906 \
907 reverse_iterator(Node* node, Node* init) \
908 : m_node(node), m_init(init) { } \
909 reverse_iterator() : m_node(NULL), m_init(NULL) { } \
910 reference_type operator*() const \
911 { return *(pointer_type)m_node->GetDataPtr(); } \
912 ptrop \
913 itor& operator++() \
914 { m_node = m_node->GetPrevious(); return *this; } \
915 const itor operator++(int) \
916 { itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\
917 itor& operator--() \
918 { m_node = m_node ? m_node->GetNext() : m_init; return *this; } \
919 const itor operator--(int) \
920 { \
921 itor tmp = *this; \
922 m_node = m_node ? m_node->GetNext() : m_init; \
923 return tmp; \
924 } \
925 bool operator!=(const itor& it) const \
926 { return it.m_node != m_node; } \
927 bool operator==(const itor& it) const \
928 { return it.m_node == m_node; } \
929 }; \
930 classexp const_reverse_iterator \
931 { \
932 typedef name list; \
933 public: \
934 typedef nodetype Node; \
935 typedef T* value_type; \
936 typedef const_reverse_iterator itor; \
937 typedef value_type* ptr_type; \
938 typedef const value_type& const_reference; \
939 \
940 Node* m_node; \
941 Node* m_init; \
942 public: \
943 typedef const_reference reference_type; \
944 typedef const ptr_type pointer_type; \
945 \
946 const_reverse_iterator(Node* node, Node* init) \
947 : m_node(node), m_init(init) { } \
948 const_reverse_iterator() : m_node(NULL), m_init(NULL) { } \
949 const_reverse_iterator(const reverse_iterator& it) \
950 : m_node(it.m_node), m_init(it.m_init) { } \
951 reference_type operator*() const \
952 { return *(pointer_type)m_node->GetDataPtr(); } \
953 ptrop \
954 itor& operator++() \
955 { m_node = m_node->GetPrevious(); return *this; } \
956 const itor operator++(int) \
957 { itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\
958 itor& operator--() \
959 { m_node = m_node ? m_node->GetNext() : m_init; return *this;}\
960 const itor operator--(int) \
961 { \
962 itor tmp = *this; \
963 m_node = m_node ? m_node->GetNext() : m_init; \
964 return tmp; \
965 } \
966 bool operator!=(const itor& it) const \
967 { return it.m_node != m_node; } \
968 bool operator==(const itor& it) const \
969 { return it.m_node == m_node; } \
970 }; \
971 \
972 wxEXPLICIT name(size_type n, const_reference v = value_type()) \
973 { assign(n, v); } \
974 name(const const_iterator& first, const const_iterator& last) \
975 { assign(first, last); } \
976 iterator begin() { return iterator(GetFirst(), GetLast()); } \
977 const_iterator begin() const \
978 { return const_iterator(GetFirst(), GetLast()); } \
979 iterator end() { return iterator(NULL, GetLast()); } \
980 const_iterator end() const { return const_iterator(NULL, GetLast()); }\
981 reverse_iterator rbegin() \
982 { return reverse_iterator(GetLast(), GetFirst()); } \
983 const_reverse_iterator rbegin() const \
984 { return const_reverse_iterator(GetLast(), GetFirst()); } \
985 reverse_iterator rend() { return reverse_iterator(NULL, GetFirst()); }\
986 const_reverse_iterator rend() const \
987 { return const_reverse_iterator(NULL, GetFirst()); } \
988 void resize(size_type n, value_type v = value_type()) \
989 { \
990 while (n < size()) \
991 pop_back(); \
992 while (n > size()) \
993 push_back(v); \
994 } \
995 size_type size() const { return GetCount(); } \
996 size_type max_size() const { return INT_MAX; } \
997 bool empty() const { return IsEmpty(); } \
998 reference front() { return *begin(); } \
999 const_reference front() const { return *begin(); } \
1000 reference back() { iterator tmp = end(); return *--tmp; } \
1001 const_reference back() const { const_iterator tmp = end(); return *--tmp; }\
1002 void push_front(const_reference v = value_type()) \
1003 { Insert(GetFirst(), (const_base_reference)v); } \
1004 void pop_front() { DeleteNode(GetFirst()); } \
1005 void push_back(const_reference v = value_type()) \
1006 { Append((const_base_reference)v); } \
1007 void pop_back() { DeleteNode(GetLast()); } \
1008 void assign(const_iterator first, const const_iterator& last) \
1009 { \
1010 clear(); \
1011 for(; first != last; ++first) \
1012 Append((const_base_reference)*first); \
1013 } \
1014 void assign(size_type n, const_reference v = value_type()) \
1015 { \
1016 clear(); \
1017 for(size_type i = 0; i < n; ++i) \
1018 Append((const_base_reference)v); \
1019 } \
1020 iterator insert(const iterator& it, const_reference v = value_type())\
1021 { \
1022 Insert(it.m_node, (const_base_reference)v); \
1023 iterator itprev(it); \
1024 return itprev--; \
1025 } \
1026 void insert(const iterator& it, size_type n, const_reference v = value_type())\
1027 { \
1028 for(size_type i = 0; i < n; ++i) \
1029 Insert(it.m_node, (const_base_reference)v); \
1030 } \
1031 void insert(const iterator& it, const_iterator first, const const_iterator& last)\
1032 { \
1033 for(; first != last; ++first) \
1034 Insert(it.m_node, (const_base_reference)*first); \
1035 } \
1036 iterator erase(const iterator& it) \
1037 { \
1038 iterator next = iterator(it.m_node->GetNext(), GetLast()); \
1039 DeleteNode(it.m_node); return next; \
1040 } \
1041 iterator erase(const iterator& first, const iterator& last) \
1042 { \
1043 iterator next = last; ++next; \
1044 DeleteNodes(first.m_node, last.m_node); \
1045 return next; \
1046 } \
1047 void clear() { Clear(); } \
1048 void splice(const iterator& it, name& l, const iterator& first, const iterator& last)\
1049 { insert(it, first, last); l.erase(first, last); } \
1050 void splice(const iterator& it, name& l) \
1051 { splice(it, l, l.begin(), l.end() ); } \
1052 void splice(const iterator& it, name& l, const iterator& first) \
1053 { \
1054 iterator tmp = first; ++tmp; \
1055 if(it == first || it == tmp) return; \
1056 insert(it, *first); \
1057 l.erase(first); \
1058 } \
1059 void remove(const_reference v) \
1060 { DeleteObject((const_base_reference)v); } \
1061 void reverse() \
1062 { Reverse(); } \
1063 /* void swap(name& l) \
1064 { \
1065 { size_t t = m_count; m_count = l.m_count; l.m_count = t; } \
1066 { bool t = m_destroy; m_destroy = l.m_destroy; l.m_destroy = t; }\
1067 { wxNodeBase* t = m_nodeFirst; m_nodeFirst = l.m_nodeFirst; l.m_nodeFirst = t; }\
1068 { wxNodeBase* t = m_nodeLast; m_nodeLast = l.m_nodeLast; l.m_nodeLast = t; }\
1069 { wxKeyType t = m_keyType; m_keyType = l.m_keyType; l.m_keyType = t; }\
1070 } */ \
1071 }
1072
1073#define WX_LIST_PTROP \
1074 pointer_type operator->() const \
1075 { return (pointer_type)m_node->GetDataPtr(); }
1076#define WX_LIST_PTROP_NONE
1077
1078#define WX_DECLARE_LIST_3(T, Tbase, name, nodetype, classexp) \
1079 WX_DECLARE_LIST_4(T, Tbase, name, nodetype, classexp, WX_LIST_PTROP_NONE)
1080#define WX_DECLARE_LIST_PTR_3(T, Tbase, name, nodetype, classexp) \
1081 WX_DECLARE_LIST_4(T, Tbase, name, nodetype, classexp, WX_LIST_PTROP)
1082
1083#define WX_DECLARE_LIST_2(elementtype, listname, nodename, classexp) \
1084 WX_DECLARE_LIST_3(elementtype, elementtype, listname, nodename, classexp)
1085#define WX_DECLARE_LIST_PTR_2(elementtype, listname, nodename, classexp) \
1086 WX_DECLARE_LIST_PTR_3(elementtype, elementtype, listname, nodename, classexp)
1087
1088#define WX_DECLARE_LIST(elementtype, listname) \
1089 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1090 WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class)
1091#define WX_DECLARE_LIST_PTR(elementtype, listname) \
1092 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1093 WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class)
1094
1095#define WX_DECLARE_LIST_WITH_DECL(elementtype, listname, decl) \
1096 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1097 WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, decl)
1098
1099#define WX_DECLARE_EXPORTED_LIST(elementtype, listname) \
1100 WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class WXDLLEXPORT)
1101
1102#define WX_DECLARE_EXPORTED_LIST_PTR(elementtype, listname) \
1103 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1104 WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class WXDLLEXPORT)
1105
1106#define WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo) \
1107 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1108 WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, class usergoo)
1109#define WX_DECLARE_USER_EXPORTED_LIST_PTR(elementtype, listname, usergoo) \
1110 typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
1111 WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class usergoo)
1112
1113// this macro must be inserted in your program after
1114// #include "wx/listimpl.cpp"
1115#define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
1116
1117#define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
1118#define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
1119
1120#endif // !wxUSE_STL
1121
1122// ============================================================================
1123// now we can define classes 100% compatible with the old ones
1124// ============================================================================
1125
1126// ----------------------------------------------------------------------------
1127// commonly used list classes
1128// ----------------------------------------------------------------------------
1129
1130#if defined(wxLIST_COMPATIBILITY)
1131
1132// inline compatibility functions
1133
1134#if !wxUSE_STL
1135
1136// ----------------------------------------------------------------------------
1137// wxNodeBase deprecated methods
1138// ----------------------------------------------------------------------------
1139
1140inline wxNode *wxNodeBase::Next() const { return (wxNode *)GetNext(); }
1141inline wxNode *wxNodeBase::Previous() const { return (wxNode *)GetPrevious(); }
1142inline wxObject *wxNodeBase::Data() const { return (wxObject *)GetData(); }
1143
1144// ----------------------------------------------------------------------------
1145// wxListBase deprecated methods
1146// ----------------------------------------------------------------------------
1147
1148inline int wxListBase::Number() const { return (int)GetCount(); }
1149inline wxNode *wxListBase::First() const { return (wxNode *)GetFirst(); }
1150inline wxNode *wxListBase::Last() const { return (wxNode *)GetLast(); }
1151inline wxNode *wxListBase::Nth(size_t n) const { return (wxNode *)Item(n); }
1152inline wxListBase::operator wxList&() const { return *(wxList*)this; }
1153
1154#endif
1155
1156// define this to make a lot of noise about use of the old wxList classes.
1157//#define wxWARN_COMPAT_LIST_USE
1158
1159// ----------------------------------------------------------------------------
1160// wxList compatibility class: in fact, it's a list of wxObjects
1161// ----------------------------------------------------------------------------
1162
1163WX_DECLARE_LIST_2(wxObject, wxObjectList, wxObjectListNode,
1164 class WXDLLIMPEXP_BASE);
1165
1166class WXDLLIMPEXP_BASE wxList : public wxObjectList
1167{
1168public:
1169#if defined(wxWARN_COMPAT_LIST_USE) && !wxUSE_STL
1170 wxList() { };
1171 wxDEPRECATED( wxList(int key_type) );
1172#elif !wxUSE_STL
1173 wxList(int key_type = wxKEY_NONE);
1174#endif
1175
1176 // this destructor is required for Darwin
1177 ~wxList() { }
1178
1179#if !wxUSE_STL
1180 wxList& operator=(const wxList& list)
1181 { if (&list != this) Assign(list); return *this; }
1182
1183 // compatibility methods
1184 void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
1185#endif
1186
1187#if wxUSE_STL
1188#else
1189 wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
1190#endif
1191};
1192
1193#if !wxUSE_STL
1194
1195// -----------------------------------------------------------------------------
1196// wxStringList class for compatibility with the old code
1197// -----------------------------------------------------------------------------
1198WX_DECLARE_LIST_2(wxChar, wxStringListBase, wxStringListNode, class WXDLLIMPEXP_BASE);
1199
1200class WXDLLIMPEXP_BASE wxStringList : public wxStringListBase
1201{
1202public:
1203 // ctors and such
1204 // default
1205#ifdef wxWARN_COMPAT_LIST_USE
1206 wxStringList();
1207 wxDEPRECATED( wxStringList(const wxChar *first ...) ); // FIXME-UTF8
1208#else
1209 wxStringList();
1210 wxStringList(const wxChar *first ...); // FIXME-UTF8
1211#endif
1212
1213 // copying the string list: the strings are copied, too (extremely
1214 // inefficient!)
1215 wxStringList(const wxStringList& other) : wxStringListBase() { DeleteContents(true); DoCopy(other); }
1216 wxStringList& operator=(const wxStringList& other)
1217 {
1218 if (&other != this)
1219 {
1220 Clear();
1221 DoCopy(other);
1222 }
1223 return *this;
1224 }
1225
1226 // operations
1227 // makes a copy of the string
1228 wxNode *Add(const wxChar *s);
1229
1230 // Append to beginning of list
1231 wxNode *Prepend(const wxChar *s);
1232
1233 bool Delete(const wxChar *s);
1234
1235 wxChar **ListToArray(bool new_copies = false) const;
1236 bool Member(const wxChar *s) const;
1237
1238 // alphabetic sort
1239 void Sort();
1240
1241private:
1242 void DoCopy(const wxStringList&); // common part of copy ctor and operator=
1243};
1244
1245#else // if wxUSE_STL
1246
1247WX_DECLARE_LIST_XO(wxString, wxStringListBase, class WXDLLIMPEXP_BASE);
1248
1249class WXDLLIMPEXP_BASE wxStringList : public wxStringListBase
1250{
1251public:
1252 compatibility_iterator Append(wxChar* s)
1253 { wxString tmp = s; delete[] s; return wxStringListBase::Append(tmp); }
1254 compatibility_iterator Insert(wxChar* s)
1255 { wxString tmp = s; delete[] s; return wxStringListBase::Insert(tmp); }
1256 compatibility_iterator Insert(size_t pos, wxChar* s)
1257 {
1258 wxString tmp = s;
1259 delete[] s;
1260 return wxStringListBase::Insert(pos, tmp);
1261 }
1262 compatibility_iterator Add(const wxChar* s)
1263 { push_back(s); return GetLast(); }
1264 compatibility_iterator Prepend(const wxChar* s)
1265 { push_front(s); return GetFirst(); }
1266};
1267
1268#endif // wxUSE_STL
1269
1270#endif // wxLIST_COMPATIBILITY
1271
1272// delete all list elements
1273//
1274// NB: the class declaration of the list elements must be visible from the
1275// place where you use this macro, otherwise the proper destructor may not
1276// be called (a decent compiler should give a warning about it, but don't
1277// count on it)!
1278#define WX_CLEAR_LIST(type, list) \
1279 { \
1280 type::iterator it, en; \
1281 for( it = (list).begin(), en = (list).end(); it != en; ++it ) \
1282 delete *it; \
1283 (list).clear(); \
1284 }
1285
1286#endif // _WX_LISTH__
wxWidgets (Impactor)