synchronize GTK2 minimum version in docs

[wxWidgets.git] / include / wx / list.h

diff --git a/include/wx/list.h b/include/wx/list.h
index aca713b04c0f0e9f3c8bfa04b9f011f4ab7ff388..2144dea9db8c68c848b166f7f376e249c1960616 100644 (file)
--- a/include/wx/list.h
+++ b/include/wx/list.h
@@ -33,7 +33,7 @@
 #include "wx/object.h"
 #include "wx/string.h"
 
 #include "wx/object.h"
 #include "wx/string.h"
 

-#if wxUSE_STL
+#if wxUSE_STD_CONTAINERS

     #include "wx/beforestd.h"
     #include <algorithm>
     #include <iterator>
     #include "wx/beforestd.h"
     #include <algorithm>
     #include <iterator>


@@ -48,7 +48,7 @@
 class WXDLLIMPEXP_FWD_BASE wxObjectListNode;
 typedef wxObjectListNode wxNode;
 
 class WXDLLIMPEXP_FWD_BASE wxObjectListNode;
 typedef wxObjectListNode wxNode;
 

-#if wxUSE_STL
+#if wxUSE_STD_CONTAINERS

 
 #define wxLIST_COMPATIBILITY
 
 
 #define wxLIST_COMPATIBILITY
 


@@ -186,7 +186,7 @@ inline const void *wxListCastElementToVoidPtr(const wxString& str)
             bool operator==(const compatibility_iterator& i) const            \
             {                                                                 \
                 wxASSERT_MSG( m_list && i.m_list,                             \
             bool operator==(const compatibility_iterator& i) const            \
             {                                                                 \
                 wxASSERT_MSG( m_list && i.m_list,                             \

-                              _T("comparing invalid iterators is illegal") ); \
+                              wxT("comparing invalid iterators is illegal") ); \

                 return (m_list == i.m_list) && (m_iter == i.m_iter);          \
             }                                                                 \
             bool operator!=(const compatibility_iterator& i) const            \
                 return (m_list == i.m_list) && (m_iter == i.m_iter);          \
             }                                                                 \
             bool operator!=(const compatibility_iterator& i) const            \


@@ -258,7 +258,7 @@ inline const void *wxListCastElementToVoidPtr(const wxString& str)
             iterator i = const_cast< liT* >(this)->end();                     \
             return compatibility_iterator( this, !empty() ? --i : i );        \
         }                                                                     \
             iterator i = const_cast< liT* >(this)->end();                     \
             return compatibility_iterator( this, !empty() ? --i : i );        \
         }                                                                     \

-        compatibility_iterator Member( elT e ) const                          \
+        bool Member( elT e ) const                                            \

             { return Find( e ); }                                             \
         compatibility_iterator Nth( int n ) const                             \
             { return Item( n ); }                                             \
             { return Find( e ); }                                             \
         compatibility_iterator Nth( int n ) const                             \
             { return Item( n ); }                                             \


@@ -275,7 +275,7 @@ inline const void *wxListCastElementToVoidPtr(const wxString& str)
             push_front( e );                                                  \
             return compatibility_iterator( this, begin() );                   \
         }                                                                     \
             push_front( e );                                                  \
             return compatibility_iterator( this, begin() );                   \
         }                                                                     \

-        compatibility_iterator Insert( compatibility_iterator & i, elT e )    \
+        compatibility_iterator Insert(const compatibility_iterator & i, elT e)\

         {                                                                     \
             return compatibility_iterator( this, insert( i.m_iter, e ) );     \
         }                                                                     \
         {                                                                     \
             return compatibility_iterator( this, insert( i.m_iter, e ) );     \
         }                                                                     \


@@ -346,7 +346,7 @@ inline const void *wxListCastElementToVoidPtr(const wxString& str)
 #define WX_DEFINE_EXPORTED_LIST(name)      WX_DEFINE_LIST(name)
 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
 
 #define WX_DEFINE_EXPORTED_LIST(name)      WX_DEFINE_LIST(name)
 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
 

-#else // if !wxUSE_STL
+#else // if !wxUSE_STD_CONTAINERS

 
 
 // undef it to get rid of old, deprecated functions
 
 
 // undef it to get rid of old, deprecated functions


@@ -420,9 +420,9 @@ class WXDLLIMPEXP_BASE wxNodeBase
 friend class wxListBase;
 public:
     // ctor
 friend class wxListBase;
 public:
     // ctor

-    wxNodeBase(wxListBase *list = (wxListBase *)NULL,
-               wxNodeBase *previous = (wxNodeBase *)NULL,
-               wxNodeBase *next = (wxNodeBase *)NULL,
+    wxNodeBase(wxListBase *list = NULL,
+               wxNodeBase *previous = NULL,
+               wxNodeBase *next = NULL,

                void *data = NULL,
                const wxListKey& key = wxDefaultListKey);
 
                void *data = NULL,
                const wxListKey& key = wxDefaultListKey);
 


@@ -457,7 +457,7 @@ protected:
     virtual void DeleteData() { }
 public:
     // for wxList::iterator
     virtual void DeleteData() { }
 public:
     // for wxList::iterator

-    void** GetDataPtr() const { return &(wx_const_cast(wxNodeBase*, this)->m_data); }
+    void** GetDataPtr() const { return &(const_cast<wxNodeBase*>(this)->m_data); }

 private:
     // optional key stuff
     wxListKeyValue m_key;
 private:
     // optional key stuff
     wxListKeyValue m_key;


@@ -468,7 +468,7 @@ private:
 
     wxListBase  *m_list;        // list we belong to
 
 
     wxListBase  *m_list;        // list we belong to
 

-    DECLARE_NO_COPY_CLASS(wxNodeBase)
+    wxDECLARE_NO_COPY_CLASS(wxNodeBase);

 };
 
 // -----------------------------------------------------------------------------
 };
 
 // -----------------------------------------------------------------------------


@@ -559,7 +559,7 @@ protected:
     {
         wxNodeBase *node = Item(n);
 
     {
         wxNodeBase *node = Item(n);
 

-        return node ? node->GetData() : (wxNodeBase *)NULL;
+        return node ? node->GetData() : NULL;

     }
 
     // operations
     }
 
     // operations


@@ -569,7 +569,8 @@ protected:
         // append to beginning of list
     wxNodeBase *Append(void *object);
         // insert a new item at the beginning of the list
         // append to beginning of list
     wxNodeBase *Append(void *object);
         // insert a new item at the beginning of the list

-    wxNodeBase *Insert(void *object) { return Insert( (wxNodeBase*)NULL, object); }
+    wxNodeBase *Insert(void *object)
+        { return Insert(static_cast<wxNodeBase *>(NULL), object); }

         // insert a new item at the given position
     wxNodeBase *Insert(size_t pos, void *object)
         { return pos == GetCount() ? Append(object)
         // insert a new item at the given position
     wxNodeBase *Insert(size_t pos, void *object)
         { return pos == GetCount() ? Append(object)


@@ -673,10 +674,10 @@ private:
     classexp nodetype : public wxNodeBase                                   \
     {                                                                       \
     public:                                                                 \
     classexp nodetype : public wxNodeBase                                   \
     {                                                                       \
     public:                                                                 \

-        nodetype(wxListBase *list = (wxListBase *)NULL,                     \
-                 nodetype *previous = (nodetype *)NULL,                     \
-                 nodetype *next = (nodetype *)NULL,                         \
-                 T *data = (T *)NULL,                                       \
+        nodetype(wxListBase *list = NULL,                                   \
+                 nodetype *previous = NULL,                                 \
+                 nodetype *next = NULL,                                     \
+                 T *data = NULL,                                            \

                  const wxListKey& key = wxDefaultListKey)                   \
             : wxNodeBase(list, previous, next, data, key) { }               \
                                                                             \
                  const wxListKey& key = wxDefaultListKey)                   \
             : wxNodeBase(list, previous, next, data, key) { }               \
                                                                             \


@@ -733,13 +734,14 @@ private:
         T *operator[](size_t index) const                                   \
         {                                                                   \
             nodetype *node = Item(index);                                   \
         T *operator[](size_t index) const                                   \
         {                                                                   \
             nodetype *node = Item(index);                                   \

-            return node ? (T*)(node->GetData()) : (T*)NULL;                 \
+            return node ? (T*)(node->GetData()) : NULL;                     \

         }                                                                   \
                                                                             \
         nodetype *Append(Tbase *object)                                     \
             { return (nodetype *)wxListBase::Append(object); }              \
         nodetype *Insert(Tbase *object)                                     \
         }                                                                   \
                                                                             \
         nodetype *Append(Tbase *object)                                     \
             { return (nodetype *)wxListBase::Append(object); }              \
         nodetype *Insert(Tbase *object)                                     \

-            { return (nodetype *)Insert((nodetype*)NULL, object); }         \
+            { return (nodetype *)Insert(static_cast<nodetype *>(NULL),      \
+                                        object); }                          \

         nodetype *Insert(size_t pos, Tbase *object)                         \
             { return (nodetype *)wxListBase::Insert(pos, object); }         \
         nodetype *Insert(nodetype *prev, Tbase *object)                     \
         nodetype *Insert(size_t pos, Tbase *object)                         \
             { return (nodetype *)wxListBase::Insert(pos, object); }         \
         nodetype *Insert(nodetype *prev, Tbase *object)                     \


@@ -765,6 +767,9 @@ private:
         virtual nodetype *Find(const wxListKey& key) const                  \
             { return (nodetype *)wxListBase::Find(key); }                   \
                                                                             \
         virtual nodetype *Find(const wxListKey& key) const                  \
             { return (nodetype *)wxListBase::Find(key); }                   \
                                                                             \

+        bool Member(const Tbase *object) const                              \
+            { return Find(object) != NULL; }                                \
+                                                                            \

         int IndexOf(Tbase *object) const                                    \
             { return wxListBase::IndexOf(object); }                         \
                                                                             \
         int IndexOf(Tbase *object) const                                    \
             { return wxListBase::IndexOf(object); }                         \
                                                                             \


@@ -814,9 +819,19 @@ private:
             reference_type operator*() const                                \
                 { return *(pointer_type)m_node->GetDataPtr(); }             \
             ptrop                                                           \
             reference_type operator*() const                                \
                 { return *(pointer_type)m_node->GetDataPtr(); }             \
             ptrop                                                           \

-            itor& operator++() { m_node = m_node->GetNext(); return *this; }\
+            itor& operator++()                                              \
+            {                                                               \
+                wxASSERT_MSG( m_node, wxT("uninitialized iterator") );      \
+                m_node = m_node->GetNext();                                 \
+                return *this;                                               \
+            }                                                               \

             const itor operator++(int)                                      \
             const itor operator++(int)                                      \

-                { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
+            {                                                               \
+                itor tmp = *this;                                           \
+                wxASSERT_MSG( m_node, wxT("uninitialized iterator") );      \
+                m_node = m_node->GetNext();                                 \
+                return tmp;                                                 \
+            }                                                               \

             itor& operator--()                                              \
             {                                                               \
                 m_node = m_node ? m_node->GetPrevious() : m_init;           \
             itor& operator--()                                              \
             {                                                               \
                 m_node = m_node ? m_node->GetPrevious() : m_init;           \


@@ -857,9 +872,19 @@ private:
             reference_type operator*() const                                \
                 { return *(pointer_type)m_node->GetDataPtr(); }             \
             ptrop                                                           \
             reference_type operator*() const                                \
                 { return *(pointer_type)m_node->GetDataPtr(); }             \
             ptrop                                                           \

-            itor& operator++() { m_node = m_node->GetNext(); return *this; }\
+            itor& operator++()                                              \
+            {                                                               \
+                wxASSERT_MSG( m_node, wxT("uninitialized iterator") );      \
+                m_node = m_node->GetNext();                                 \
+                return *this;                                               \
+            }                                                               \

             const itor operator++(int)                                      \
             const itor operator++(int)                                      \

-                { itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
+            {                                                               \
+                itor tmp = *this;                                           \
+                wxASSERT_MSG( m_node, wxT("uninitialized iterator") );      \
+                m_node = m_node->GetNext();                                 \
+                return tmp;                                                 \
+            }                                                               \

             itor& operator--()                                              \
             {                                                               \
                 m_node = m_node ? m_node->GetPrevious() : m_init;           \
             itor& operator--()                                              \
             {                                                               \
                 m_node = m_node ? m_node->GetPrevious() : m_init;           \


@@ -1007,20 +1032,34 @@ private:
         }                                                                   \
         iterator insert(const iterator& it, const_reference v)              \
         {                                                                   \
         }                                                                   \
         iterator insert(const iterator& it, const_reference v)              \
         {                                                                   \

-            Insert(it.m_node, (const_base_reference)v);                     \
-            iterator itprev(it);                                            \
-            return itprev--;                                                \
+            if ( it == end() )                                              \
+            {                                                               \
+                Append((const_base_reference)v);                            \
+                /*                                                          \
+                    note that this is the new end(), the old one was        \
+                    invalidated by the Append() call, and this is why we    \
+                    can't use the same code as in the normal case below     \
+                 */                                                         \
+                iterator itins(end());                                      \
+                return --itins;                                             \
+            }                                                               \
+            else                                                            \
+            {                                                               \
+                Insert(it.m_node, (const_base_reference)v);                 \
+                iterator itins(it);                                         \
+                return --itins;                                             \
+            }                                                               \

         }                                                                   \
         void insert(const iterator& it, size_type n, const_reference v)     \
         {                                                                   \
             for(size_type i = 0; i < n; ++i)                                \
         }                                                                   \
         void insert(const iterator& it, size_type n, const_reference v)     \
         {                                                                   \
             for(size_type i = 0; i < n; ++i)                                \

-                Insert(it.m_node, (const_base_reference)v);                 \
+                insert(it, v);                                              \

         }                                                                   \
         void insert(const iterator& it,                                     \
         }                                                                   \
         void insert(const iterator& it,                                     \

-                    const const_iterator& first, const const_iterator& last)\
+                    const_iterator first, const const_iterator& last)       \

         {                                                                   \
             for(; first != last; ++first)                                   \
         {                                                                   \
             for(; first != last; ++first)                                   \

-                Insert(it.m_node, (const_base_reference)*first);            \
+                insert(it, *first);                                         \

         }                                                                   \
         iterator erase(const iterator& it)                                  \
         {                                                                   \
         }                                                                   \
         iterator erase(const iterator& it)                                  \
         {                                                                   \


@@ -1029,7 +1068,9 @@ private:
         }                                                                   \
         iterator erase(const iterator& first, const iterator& last)         \
         {                                                                   \
         }                                                                   \
         iterator erase(const iterator& first, const iterator& last)         \
         {                                                                   \

-            iterator next = last; ++next;                                   \
+            iterator next = last;                                           \
+            if ( next != end() )                                            \
+                ++next;                                                     \

             DeleteNodes(first.m_node, last.m_node);                         \
             return next;                                                    \
         }                                                                   \
             DeleteNodes(first.m_node, last.m_node);                         \
             return next;                                                    \
         }                                                                   \


@@ -1040,10 +1081,11 @@ private:
             { splice(it, l, l.begin(), l.end() ); }                         \
         void splice(const iterator& it, name& l, const iterator& first)     \
         {                                                                   \
             { splice(it, l, l.begin(), l.end() ); }                         \
         void splice(const iterator& it, name& l, const iterator& first)     \
         {                                                                   \

-            iterator tmp = first; ++tmp;                                    \
-            if(it == first || it == tmp) return;                            \
-            insert(it, *first);                                             \
-            l.erase(first);                                                 \
+            if ( it != first )                                              \
+            {                                                               \
+                insert(it, *first);                                         \
+                l.erase(first);                                             \
+            }                                                               \

         }                                                                   \
         void remove(const_reference v)                                      \
             { DeleteObject((const_base_reference)v); }                      \
         }                                                                   \
         void remove(const_reference v)                                      \
             { DeleteObject((const_base_reference)v); }                      \


@@ -1106,7 +1148,7 @@ private:
 #define WX_DEFINE_EXPORTED_LIST(name)      WX_DEFINE_LIST(name)
 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
 
 #define WX_DEFINE_EXPORTED_LIST(name)      WX_DEFINE_LIST(name)
 #define WX_DEFINE_USER_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
 

-#endif // !wxUSE_STL
+#endif // !wxUSE_STD_CONTAINERS

 
 // ============================================================================
 // now we can define classes 100% compatible with the old ones
 
 // ============================================================================
 // now we can define classes 100% compatible with the old ones


@@ -1120,7 +1162,7 @@ private:
 
 // inline compatibility functions
 
 
 // inline compatibility functions
 

-#if !wxUSE_STL
+#if !wxUSE_STD_CONTAINERS

 
 // ----------------------------------------------------------------------------
 // wxNodeBase deprecated methods
 
 // ----------------------------------------------------------------------------
 // wxNodeBase deprecated methods


@@ -1155,31 +1197,26 @@ WX_DECLARE_LIST_2(wxObject, wxObjectList, wxObjectListNode,
 class WXDLLIMPEXP_BASE wxList : public wxObjectList
 {
 public:
 class WXDLLIMPEXP_BASE wxList : public wxObjectList
 {
 public:

-#if defined(wxWARN_COMPAT_LIST_USE) && !wxUSE_STL
-    wxList() { };
+#if defined(wxWARN_COMPAT_LIST_USE) && !wxUSE_STD_CONTAINERS
+    wxList() { }

     wxDEPRECATED( wxList(int key_type) );
     wxDEPRECATED( wxList(int key_type) );

-#elif !wxUSE_STL
+#elif !wxUSE_STD_CONTAINERS

     wxList(int key_type = wxKEY_NONE);
 #endif
 
     // this destructor is required for Darwin
    ~wxList() { }
 
     wxList(int key_type = wxKEY_NONE);
 #endif
 
     // this destructor is required for Darwin
    ~wxList() { }
 

-#if !wxUSE_STL
+#if !wxUSE_STD_CONTAINERS

     wxList& operator=(const wxList& list)
         { if (&list != this) Assign(list); return *this; }
 
     // compatibility methods
     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
     wxList& operator=(const wxList& list)
         { if (&list != this) Assign(list); return *this; }
 
     // compatibility methods
     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }

-#endif
-
-#if wxUSE_STL
-#else
-    wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
-#endif
+#endif // !wxUSE_STD_CONTAINERS

 };
 
 };
 

-#if !wxUSE_STL
+#if !wxUSE_STD_CONTAINERS

 
 // -----------------------------------------------------------------------------
 // wxStringList class for compatibility with the old code
 
 // -----------------------------------------------------------------------------
 // wxStringList class for compatibility with the old code


@@ -1231,7 +1268,7 @@ private:
     void DoCopy(const wxStringList&); // common part of copy ctor and operator=
 };
 
     void DoCopy(const wxStringList&); // common part of copy ctor and operator=
 };
 

-#else // if wxUSE_STL
+#else // if wxUSE_STD_CONTAINERS

 
 WX_DECLARE_LIST_XO(wxString, wxStringListBase, class WXDLLIMPEXP_BASE);
 
 
 WX_DECLARE_LIST_XO(wxString, wxStringListBase, class WXDLLIMPEXP_BASE);
 


@@ -1254,7 +1291,7 @@ public:
         { push_front(s); return GetFirst(); }
 };
 
         { push_front(s); return GetFirst(); }
 };
 

-#endif // wxUSE_STL
+#endif // wxUSE_STD_CONTAINERS

 
 #endif // wxLIST_COMPATIBILITY
 
 
 #endif // wxLIST_COMPATIBILITY
 


@@ -1272,4 +1309,15 @@ public:
         (list).clear();                                                      \
     }
 
         (list).clear();                                                      \
     }
 

+// append all element of one list to another one
+#define WX_APPEND_LIST(list, other)                                           \
+    {                                                                         \
+        wxList::compatibility_iterator node = other->GetFirst();              \
+        while ( node )                                                        \
+        {                                                                     \
+            (list)->push_back(node->GetData());                               \
+            node = node->GetNext();                                           \
+        }                                                                     \
+    }
+

 #endif // _WX_LISTH__
 #endif // _WX_LISTH__