X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/30bda36c48562097617bda268917253ead20b09b..3f434666bf9476e7fc6c27de94075211db5f1417:/include/wx/list.h diff --git a/include/wx/list.h b/include/wx/list.h index 136aeaf0f3..a76ad27d29 100644 --- a/include/wx/list.h +++ b/include/wx/list.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: list.h +// Name: wx/list.h // Purpose: wxList, wxStringList classes // Author: Julian Smart // Modified by: VZ at 16/11/98: WX_DECLARE_LIST() and typesafe lists added @@ -25,11 +25,6 @@ #ifndef _WX_LISTH__ #define _WX_LISTH__ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && \ - !(defined(__MINGW32__) && __GNUC__ == 3 && __GNUC_MINOR__ == 2) -#pragma interface "list.h" -#endif - // ----------------------------------------------------------------------------- // headers // ----------------------------------------------------------------------------- @@ -59,28 +54,12 @@ extern "C" typedef int (* LINKAGEMODE wxSortCompareFunction)(const void *elem1, const void *elem2); } -class WXDLLIMPEXP_BASE wxObjectListNode; +class WXDLLIMPEXP_FWD_BASE wxObjectListNode; typedef wxObjectListNode wxNode; // typedef int (* LINKAGEMODE wxListIterateFunction)(void *current); -// ---------------------------------------------------------------------------- -// constants -// ---------------------------------------------------------------------------- - -#if !defined(wxENUM_KEY_TYPE_DEFINED) -#define wxENUM_KEY_TYPE_DEFINED - -enum wxKeyType -{ - wxKEY_NONE, - wxKEY_INTEGER, - wxKEY_STRING -}; - -#endif - #if wxUSE_STL #define wxLIST_COMPATIBILITY @@ -98,6 +77,8 @@ enum wxKeyType #define WX_DECLARE_LIST_WITH_DECL(elT, liT, decl) \ WX_DECLARE_LIST_XO(elT*, liT, decl) +#if !defined(__VISUALC__) || __VISUALC__ >= 1300 // == !VC6 + template class WXDLLIMPEXP_BASE wxList_SortFunction { @@ -109,27 +90,103 @@ private: wxSortCompareFunction m_f; }; +#define WX_LIST_SORTFUNCTION( elT, f ) wxList_SortFunction(f) +#define WX_LIST_VC6_WORKAROUND(elT, liT, decl) + +#else // if defined( __VISUALC__ ) && __VISUALC__ < 1300 // == VC6 + +#define WX_LIST_SORTFUNCTION( elT, f ) std::greater( f ) +#define WX_LIST_VC6_WORKAROUND(elT, liT, decl) \ + decl liT; \ + \ + /* Workaround for broken VC6 STL incorrectly requires a std::greater<> */ \ + /* to be passed into std::list::sort() */ \ + template <> \ + struct std::greater \ + { \ + private: \ + wxSortCompareFunction m_CompFunc; \ + public: \ + greater( wxSortCompareFunction compfunc = NULL ) \ + : m_CompFunc( compfunc ) {} \ + bool operator()(const elT X, const elT Y) const \ + { \ + return m_CompFunc ? \ + ( m_CompFunc( wxListCastElementToVoidPtr(X), \ + wxListCastElementToVoidPtr(Y) ) < 0 ) : \ + ( X > Y ); \ + } \ + }; + +// helper for std::greater above: +template +inline const void *wxListCastElementToVoidPtr(const T* ptr) { return ptr; } +inline const void *wxListCastElementToVoidPtr(const wxString& str) + { return (const char*)str; } + +#endif // VC6/!VC6 + +/* + Note 1: the outer helper class _WX_LIST_HELPER_##liT below is a workaround + for mingw 3.2.3 compiler bug that prevents a static function of liT class + from being exported into dll. A minimal code snippet reproducing the bug: + + struct WXDLLEXPORT Foo + { + static void Bar(); + struct SomeInnerClass + { + friend class Foo; // comment this out to make it link + }; + ~Foo() + { + Bar(); + } + }; + + The program does not link under mingw_gcc 3.2.3 producing undefined + reference to Foo::Bar() function + + + Note 2: the EmptyList is needed to allow having a NULL pointer-like + invalid iterator. We used to use just an uninitialized iterator object + instead but this fails with some debug/checked versions of STL, notably the + glibc version activated with _GLIBCXX_DEBUG, so we need to have a separate + invalid iterator. + */ + +// the real wxList-class declaration #define WX_DECLARE_LIST_XO(elT, liT, decl) \ + decl _WX_LIST_HELPER_##liT \ + { \ + typedef elT _WX_LIST_ITEM_TYPE_##liT; \ + public: \ + static void DeleteFunction( _WX_LIST_ITEM_TYPE_##liT X ); \ + }; \ + \ + WX_LIST_VC6_WORKAROUND(elT, liT, decl) \ decl liT : public std::list \ { \ private: \ + typedef std::list BaseListType; \ + static BaseListType EmptyList; \ + \ bool m_destroy; \ - private: \ - typedef elT _WX_LIST_ITEM_TYPE_##liT; \ - static void DeleteFunction( const _WX_LIST_ITEM_TYPE_##liT X ); \ + \ public: \ - class compatibility_iterator \ + decl compatibility_iterator \ { \ private: \ - /* Workaround for broken VC6 nested class name resolution */ \ - typedef std::list::iterator iterator; \ - friend class liT; \ - private: \ + /* Workaround for broken VC6 nested class name resolution */ \ + typedef std::list::iterator iterator; \ + friend class liT; \ + \ iterator m_iter; \ liT * m_list; \ + \ public: \ compatibility_iterator() \ - : m_iter(), m_list( NULL ) {} \ + : m_iter(EmptyList.end()), m_list( NULL ) {} \ compatibility_iterator( liT* li, iterator i ) \ : m_iter( i ), m_list( li ) {} \ compatibility_iterator( const liT* li, iterator i ) \ @@ -138,9 +195,13 @@ private: compatibility_iterator* operator->() { return this; } \ const compatibility_iterator* operator->() const { return this; } \ \ - bool operator==(const compatibility_iterator& i) \ - { return (m_list == i.m_list) && (m_iter == i.m_iter); } \ - bool operator!=(const compatibility_iterator& i) \ + bool operator==(const compatibility_iterator& i) const \ + { \ + wxASSERT_MSG( m_list && i.m_list, \ + _T("comparing invalid iterators is illegal") ); \ + return (m_list == i.m_list) && (m_iter == i.m_iter); \ + } \ + bool operator!=(const compatibility_iterator& i) const \ { return !( operator==( i ) ); } \ operator bool() const \ { return m_list ? m_iter != m_list->end() : false; } \ @@ -159,16 +220,16 @@ private: } \ compatibility_iterator GetPrevious() const \ { \ + if ( m_iter == m_list->begin() ) \ + return compatibility_iterator(); \ + \ iterator i = m_iter; \ return compatibility_iterator( m_list, --i ); \ } \ int IndexOf() const \ { \ - return m_list ? \ - m_iter != m_list->end() ? \ - std::distance( m_list->begin(), m_iter ) : \ - wxNOT_FOUND : \ - wxNOT_FOUND; \ + return *this ? std::distance( m_list->begin(), m_iter ) \ + : wxNOT_FOUND; \ } \ }; \ public: \ @@ -194,6 +255,11 @@ private: std::advance( i, idx ); \ return compatibility_iterator( this, i ); \ } \ + elT operator[](size_t idx) const \ + { \ + return Item(idx).GetData(); \ + } \ + \ compatibility_iterator GetFirst() const \ { \ return compatibility_iterator( this, \ @@ -238,7 +304,7 @@ private: void Erase( const compatibility_iterator& i ) \ { \ if ( m_destroy ) \ - DeleteFunction( i->GetData() ); \ + _WX_LIST_HELPER_##liT::DeleteFunction( i->GetData() ); \ erase( i.m_iter ); \ } \ bool DeleteNode( const compatibility_iterator& i ) \ @@ -257,13 +323,17 @@ private: void Clear() \ { \ if ( m_destroy ) \ - std::for_each( begin(), end(), DeleteFunction ); \ + std::for_each( begin(), end(), \ + _WX_LIST_HELPER_##liT::DeleteFunction ); \ clear(); \ } \ /* Workaround for broken VC6 std::list::sort() see above */ \ void Sort( wxSortCompareFunction compfunc ) \ - { sort( wxList_SortFunction( compfunc ) ); } \ + { sort( WX_LIST_SORTFUNCTION( elT, compfunc ) ); } \ ~liT() { Clear(); } \ + \ + /* It needs access to our EmptyList */ \ + friend class compatibility_iterator; \ } #define WX_DECLARE_LIST(elementtype, listname) \ @@ -282,7 +352,7 @@ private: WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo) // this macro must be inserted in your program after -// #include +// #include "wx/listimpl.cpp" #define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!" #define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name) @@ -290,14 +360,6 @@ private: #else // if !wxUSE_STL -// due to circular header dependencies this function has to be declared here -// (normally it's found in utils.h which includes itself list.h...) -#if WXWIN_COMPATIBILITY_2_4 -extern WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s); -#endif - -class WXDLLEXPORT wxObjectListNode; -typedef wxObjectListNode wxNode; // undef it to get rid of old, deprecated functions #define wxLIST_COMPATIBILITY @@ -309,7 +371,7 @@ typedef wxObjectListNode wxNode; union wxListKeyValue { long integer; - wxChar *string; + wxString *string; }; // a struct which may contain both types of keys @@ -326,15 +388,17 @@ public: { } wxListKey(long i) : m_keyType(wxKEY_INTEGER) { m_key.integer = i; } - wxListKey(const wxChar *s) : m_keyType(wxKEY_STRING) - { m_key.string = wxStrdup(s); } wxListKey(const wxString& s) : m_keyType(wxKEY_STRING) - { m_key.string = wxStrdup(s.c_str()); } + { m_key.string = new wxString(s); } + wxListKey(const char *s) : m_keyType(wxKEY_STRING) + { m_key.string = new wxString(s); } + wxListKey(const wchar_t *s) : m_keyType(wxKEY_STRING) + { m_key.string = new wxString(s); } // accessors wxKeyType GetKeyType() const { return m_keyType; } - const wxChar *GetString() const - { wxASSERT( m_keyType == wxKEY_STRING ); return m_key.string; } + const wxString GetString() const + { wxASSERT( m_keyType == wxKEY_STRING ); return *m_key.string; } long GetNumber() const { wxASSERT( m_keyType == wxKEY_INTEGER ); return m_key.integer; } @@ -347,7 +411,7 @@ public: ~wxListKey() { if ( m_keyType == wxKEY_STRING ) - free(m_key.string); + delete m_key.string; } private: @@ -361,7 +425,7 @@ private: extern WXDLLIMPEXP_DATA_BASE(wxListKey) wxDefaultListKey; -class WXDLLIMPEXP_BASE wxListBase; +class WXDLLIMPEXP_FWD_BASE wxListBase; class WXDLLIMPEXP_BASE wxNodeBase { @@ -377,11 +441,11 @@ public: virtual ~wxNodeBase(); // FIXME no check is done that the list is really keyed on strings - const wxChar *GetKeyString() const { return m_key.string; } + wxString GetKeyString() const { return *m_key.string; } long GetKeyInteger() const { return m_key.integer; } // Necessary for some existing code - void SetKeyString(wxChar* s) { m_key.string = s; } + void SetKeyString(const wxString& s) { m_key.string = new wxString(s); } void SetKeyInteger(long i) { m_key.integer = i; } #ifdef wxLIST_COMPATIBILITY @@ -423,15 +487,13 @@ private: // a double-linked list class // ----------------------------------------------------------------------------- -class WXDLLIMPEXP_BASE wxList; +class WXDLLIMPEXP_FWD_BASE wxList; -class WXDLLIMPEXP_BASE wxListBase : public wxObject +class WXDLLIMPEXP_BASE wxListBase { -friend class WXDLLIMPEXP_BASE wxNodeBase; // should be able to call DetachNode() +friend class wxNodeBase; // should be able to call DetachNode() friend class wxHashTableBase; // should be able to call untyped Find() -private: - // common part of all ctors - void Init(wxKeyType keyType = wxKEY_NONE); // Must be declared before it's used (for VC++ 1.5) + public: // default ctor & dtor wxListBase(wxKeyType keyType = wxKEY_NONE) @@ -533,7 +595,7 @@ protected: // keyed append wxNodeBase *Append(long key, void *object); - wxNodeBase *Append(const wxChar *key, void *object); + wxNodeBase *Append(const wxString& key, void *object); // removes node from the list but doesn't delete it (returns pointer // to the node or NULL if it wasn't found in the list) @@ -568,6 +630,10 @@ protected: void Reverse(); void DeleteNodes(wxNodeBase* first, wxNodeBase* last); private: + + // common part of all ctors + void Init(wxKeyType keyType = wxKEY_NONE); + // helpers // common part of copy ctor and assignment operator void DoCopy(const wxListBase& list); @@ -640,6 +706,7 @@ private: void SetData(T *data) \ { wxNodeBase::SetData(data); } \ \ + protected: \ virtual void DeleteData(); \ \ DECLARE_NO_COPY_CLASS(nodetype) \ @@ -649,7 +716,17 @@ private: { \ public: \ typedef nodetype Node; \ - typedef Node* compatibility_iterator; \ + classexp compatibility_iterator \ + { \ + public: \ + compatibility_iterator(Node *ptr = NULL) : m_ptr(ptr) { } \ + \ + Node *operator->() const { return m_ptr; } \ + operator Node *() const { return m_ptr; } \ + \ + private: \ + Node *m_ptr; \ + }; \ \ name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType) \ { } \ @@ -695,7 +772,7 @@ private: { return wxListBase::DeleteNode(node); } \ bool DeleteObject(Tbase *object) \ { return wxListBase::DeleteObject(object); } \ - void Erase(compatibility_iterator it) \ + void Erase(nodetype *it) \ { DeleteNode(it); } \ \ nodetype *Find(const Tbase *object) const \ @@ -732,7 +809,7 @@ private: typedef base_value_type& base_reference; \ typedef const base_value_type& const_base_reference; \ \ - class iterator \ + classexp iterator \ { \ typedef name list; \ public: \ @@ -754,14 +831,14 @@ private: { return *(pointer_type)m_node->GetDataPtr(); } \ ptrop \ itor& operator++() { m_node = m_node->GetNext(); return *this; }\ - itor operator++(int) \ + const itor operator++(int) \ { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\ itor& operator--() \ { \ m_node = m_node ? m_node->GetPrevious() : m_init; \ return *this; \ } \ - itor operator--(int) \ + const itor operator--(int) \ { \ itor tmp = *this; \ m_node = m_node ? m_node->GetPrevious() : m_init; \ @@ -772,7 +849,7 @@ private: bool operator==(const itor& it) const \ { return it.m_node == m_node; } \ }; \ - class const_iterator \ + classexp const_iterator \ { \ typedef name list; \ public: \ @@ -797,14 +874,14 @@ private: { return *(pointer_type)m_node->GetDataPtr(); } \ ptrop \ itor& operator++() { m_node = m_node->GetNext(); return *this; }\ - itor operator++(int) \ + const itor operator++(int) \ { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\ itor& operator--() \ { \ m_node = m_node ? m_node->GetPrevious() : m_init; \ return *this; \ } \ - itor operator--(int) \ + const itor operator--(int) \ { \ itor tmp = *this; \ m_node = m_node ? m_node->GetPrevious() : m_init; \ @@ -815,7 +892,7 @@ private: bool operator==(const itor& it) const \ { return it.m_node == m_node; } \ }; \ - class reverse_iterator \ + classexp reverse_iterator \ { \ typedef name list; \ public: \ @@ -839,11 +916,11 @@ private: ptrop \ itor& operator++() \ { m_node = m_node->GetPrevious(); return *this; } \ - itor operator++(int) \ + const itor operator++(int) \ { itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\ itor& operator--() \ { m_node = m_node ? m_node->GetNext() : m_init; return *this; } \ - itor operator--(int) \ + const itor operator--(int) \ { \ itor tmp = *this; \ m_node = m_node ? m_node->GetNext() : m_init; \ @@ -854,7 +931,7 @@ private: bool operator==(const itor& it) const \ { return it.m_node == m_node; } \ }; \ - class const_reverse_iterator \ + classexp const_reverse_iterator \ { \ typedef name list; \ public: \ @@ -880,11 +957,11 @@ private: ptrop \ itor& operator++() \ { m_node = m_node->GetPrevious(); return *this; } \ - itor operator++(int) \ + const itor operator++(int) \ { itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\ itor& operator--() \ { m_node = m_node ? m_node->GetNext() : m_init; return *this;}\ - itor operator--(int) \ + const itor operator--(int) \ { \ itor tmp = *this; \ m_node = m_node ? m_node->GetNext() : m_init; \ @@ -898,7 +975,7 @@ private: \ wxEXPLICIT name(size_type n, const_reference v = value_type()) \ { assign(n, v); } \ - name(const_iterator first, const_iterator last) \ + name(const const_iterator& first, const const_iterator& last) \ { assign(first, last); } \ iterator begin() { return iterator(GetFirst(), GetLast()); } \ const_iterator begin() const \ @@ -924,15 +1001,15 @@ private: bool empty() const { return IsEmpty(); } \ reference front() { return *begin(); } \ const_reference front() const { return *begin(); } \ - reference back() { return *--end(); } \ - const_reference back() const { return *--end(); } \ + reference back() { iterator tmp = end(); return *--tmp; } \ + const_reference back() const { const_iterator tmp = end(); return *--tmp; }\ void push_front(const_reference v = value_type()) \ { Insert(GetFirst(), (const_base_reference)v); } \ void pop_front() { DeleteNode(GetFirst()); } \ void push_back(const_reference v = value_type()) \ { Append((const_base_reference)v); } \ void pop_back() { DeleteNode(GetLast()); } \ - void assign(const_iterator first, const_iterator last) \ + void assign(const_iterator first, const const_iterator& last) \ { \ clear(); \ for(; first != last; ++first) \ @@ -944,38 +1021,39 @@ private: for(size_type i = 0; i < n; ++i) \ Append((const_base_reference)v); \ } \ - iterator insert(iterator it, const_reference v = value_type()) \ + iterator insert(const iterator& it, const_reference v = value_type())\ { \ Insert(it.m_node, (const_base_reference)v); \ - return iterator(it.m_node->GetPrevious(), GetLast()); \ + iterator itprev(it); \ + return itprev--; \ } \ - void insert(iterator it, size_type n, const_reference v = value_type())\ + void insert(const iterator& it, size_type n, const_reference v = value_type())\ { \ for(size_type i = 0; i < n; ++i) \ Insert(it.m_node, (const_base_reference)v); \ } \ - void insert(iterator it, const_iterator first, const_iterator last) \ + void insert(const iterator& it, const_iterator first, const const_iterator& last)\ { \ for(; first != last; ++first) \ Insert(it.m_node, (const_base_reference)*first); \ } \ - iterator erase(iterator it) \ + iterator erase(const iterator& it) \ { \ iterator next = iterator(it.m_node->GetNext(), GetLast()); \ DeleteNode(it.m_node); return next; \ } \ - iterator erase(iterator first, iterator last) \ + iterator erase(const iterator& first, const iterator& last) \ { \ iterator next = last; ++next; \ DeleteNodes(first.m_node, last.m_node); \ return next; \ } \ void clear() { Clear(); } \ - void splice(iterator it, name& l, iterator first, iterator last) \ + void splice(const iterator& it, name& l, const iterator& first, const iterator& last)\ { insert(it, first, last); l.erase(first, last); } \ - void splice(iterator it, name& l) \ + void splice(const iterator& it, name& l) \ { splice(it, l, l.begin(), l.end() ); } \ - void splice(iterator it, name& l, iterator first) \ + void splice(const iterator& it, name& l, const iterator& first) \ { \ iterator tmp = first; ++tmp; \ if(it == first || it == tmp) return; \ @@ -1037,7 +1115,7 @@ private: WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class usergoo) // this macro must be inserted in your program after -// #include +// #include "wx/listimpl.cpp" #define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!" #define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name) @@ -1104,7 +1182,7 @@ public: #if !wxUSE_STL wxList& operator=(const wxList& list) - { (void) wxListBase::operator=(list); return *this; } + { Assign(list); return *this; } // compatibility methods void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); } @@ -1114,11 +1192,6 @@ public: #else wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); } #endif - -private: -#if !wxUSE_STL - DECLARE_DYNAMIC_CLASS(wxList) -#endif }; #if !wxUSE_STL @@ -1135,10 +1208,10 @@ public: // default #ifdef wxWARN_COMPAT_LIST_USE wxStringList(); - wxDEPRECATED( wxStringList(const wxChar *first ...) ); + wxDEPRECATED( wxStringList(const wxChar *first ...) ); // FIXME-UTF8 #else wxStringList(); - wxStringList(const wxChar *first ...); + wxStringList(const wxChar *first ...); // FIXME-UTF8 #endif // copying the string list: the strings are copied, too (extremely @@ -1164,8 +1237,6 @@ public: private: void DoCopy(const wxStringList&); // common part of copy ctor and operator= - - DECLARE_DYNAMIC_CLASS(wxStringList) }; #else // if wxUSE_STL @@ -1209,5 +1280,4 @@ public: (list).clear(); \ } -#endif - // _WX_LISTH__ +#endif // _WX_LISTH__