made wxHeaderColumnBase dtor virtual to avoid gcc warnings

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

diff --git a/include/wx/list.h b/include/wx/list.h
index 2539ab1c1086019939e5c67b0cb06d67e5326432..5f9b4d1fa0e25404f6cefb1c57c42325a62f39e0 100644 (file)
--- a/include/wx/list.h
+++ b/include/wx/list.h
@@ -22,8 +22,8 @@
   like the old class.
 */
 
   like the old class.
 */
 

-#ifndef _WX_LISTH__
-#define _WX_LISTH__
+#ifndef _WX_LIST_H_
+#define _WX_LIST_H_

 
 // -----------------------------------------------------------------------------
 // headers
 
 // -----------------------------------------------------------------------------
 // headers


@@ -45,37 +45,9 @@
 // types
 // ----------------------------------------------------------------------------
 
 // types
 // ----------------------------------------------------------------------------
 

-// type of compare function for list sort operation (as in 'qsort'): it should
-// return a negative value, 0 or positive value if the first element is less
-// than, equal or greater than the second
-
-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 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
 #if wxUSE_STL
 
 #define wxLIST_COMPATIBILITY


@@ -93,10 +65,10 @@ enum wxKeyType
 #define WX_DECLARE_LIST_WITH_DECL(elT, liT, decl) \
     WX_DECLARE_LIST_XO(elT*, liT, decl)
 
 #define WX_DECLARE_LIST_WITH_DECL(elT, liT, decl) \
     WX_DECLARE_LIST_XO(elT*, liT, decl)
 

-#if !defined( __VISUALC__ )
+#if !defined(__VISUALC__) || __VISUALC__ >= 1300 // == !VC6

 
 template<class T>
 
 template<class T>

-class WXDLLIMPEXP_BASE wxList_SortFunction
+class wxList_SortFunction

 {
 public:
     wxList_SortFunction(wxSortCompareFunction f) : m_f(f) { }
 {
 public:
     wxList_SortFunction(wxSortCompareFunction f) : m_f(f) { }


@@ -107,12 +79,12 @@ private:
 };
 
 #define WX_LIST_SORTFUNCTION( elT, f ) wxList_SortFunction<elT>(f)
 };
 
 #define WX_LIST_SORTFUNCTION( elT, f ) wxList_SortFunction<elT>(f)

-#define VC6_WORKAROUND(elT, liT, decl)
+#define WX_LIST_VC6_WORKAROUND(elT, liT, decl)

 
 

-#else // if defined( __VISUALC__ )
+#else // if defined( __VISUALC__ ) && __VISUALC__ < 1300 // == VC6

 
 #define WX_LIST_SORTFUNCTION( elT, f ) std::greater<elT>( f )
 
 #define WX_LIST_SORTFUNCTION( elT, f ) std::greater<elT>( f )

-#define VC6_WORKAROUND(elT, liT, decl)                                        \
+#define WX_LIST_VC6_WORKAROUND(elT, liT, decl)                                \

     decl liT;                                                                 \
                                                                               \
     /* Workaround for broken VC6 STL incorrectly requires a std::greater<> */ \
     decl liT;                                                                 \
                                                                               \
     /* Workaround for broken VC6 STL incorrectly requires a std::greater<> */ \


@@ -128,19 +100,26 @@ private:
             bool operator()(const elT X, const elT Y) const                   \
                 {                                                             \
                     return m_CompFunc ?                                       \
             bool operator()(const elT X, const elT Y) const                   \
                 {                                                             \
                     return m_CompFunc ?                                       \

-                        ( m_CompFunc( X, Y ) < 0 ) :                          \
+                        ( m_CompFunc( wxListCastElementToVoidPtr(X),          \
+                                      wxListCastElementToVoidPtr(Y) ) < 0 ) : \

                         ( X > Y );                                            \
                 }                                                             \
     };
 
                         ( X > Y );                                            \
                 }                                                             \
     };
 

-#endif // defined( __VISUALC__ )
+// helper for std::greater<elT> above:
+template<typename T>
+inline const void *wxListCastElementToVoidPtr(const T* ptr) { return ptr; }
+inline const void *wxListCastElementToVoidPtr(const wxString& str)
+    { return (const char*)str; }
+
+#endif // VC6/!VC6

 
 /*
 
 /*

-    Note: the outer helper class _WX_LIST_HELPER_##liT below is a workaround
+    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:
 
     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
+         struct WXDLLIMPEXP_CORE Foo

          {
             static void Bar();
             struct SomeInnerClass
          {
             static void Bar();
             struct SomeInnerClass


@@ -155,35 +134,47 @@ private:
 
     The program does not link under mingw_gcc 3.2.3 producing undefined
     reference to Foo::Bar() function
 
     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)                                    \
  */
 
 // the real wxList-class declaration
 #define WX_DECLARE_LIST_XO(elT, liT, decl)                                    \

-    class WXDLLEXPORT _WX_LIST_HELPER_##liT                                   \
+    decl _WX_LIST_HELPER_##liT                                                \

     {                                                                         \
         typedef elT _WX_LIST_ITEM_TYPE_##liT;                                 \
     public:                                                                   \
         static void DeleteFunction( _WX_LIST_ITEM_TYPE_##liT X );             \
     };                                                                        \
                                                                               \
     {                                                                         \
         typedef elT _WX_LIST_ITEM_TYPE_##liT;                                 \
     public:                                                                   \
         static void DeleteFunction( _WX_LIST_ITEM_TYPE_##liT X );             \
     };                                                                        \
                                                                               \

-    VC6_WORKAROUND(elT, liT, decl)                                            \
+    WX_LIST_VC6_WORKAROUND(elT, liT, decl)                                    \

     decl liT : public std::list<elT>                                          \
     {                                                                         \
     private:                                                                  \
     decl liT : public std::list<elT>                                          \
     {                                                                         \
     private:                                                                  \

+        typedef std::list<elT> BaseListType;                                  \
+        static BaseListType EmptyList;                                        \
+                                                                              \

         bool m_destroy;                                                       \
         bool m_destroy;                                                       \

+                                                                              \

     public:                                                                   \
         decl compatibility_iterator                                           \
         {                                                                     \
         private:                                                              \
     public:                                                                   \
         decl compatibility_iterator                                           \
         {                                                                     \
         private:                                                              \

-          /* Workaround for broken VC6 nested class name resolution */        \
-          typedef std::list<elT>::iterator iterator;                          \
-          friend class liT;                                                   \
-        private:                                                              \
+            /* Workaround for broken VC6 nested class name resolution */      \
+            typedef std::list<elT>::iterator iterator;                        \
+            friend class liT;                                                 \
+                                                                              \

             iterator m_iter;                                                  \
             liT * m_list;                                                     \
             iterator m_iter;                                                  \
             liT * m_list;                                                     \

+                                                                              \

         public:                                                               \
             compatibility_iterator()                                          \
         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 )               \
             compatibility_iterator( liT* li, iterator i )                     \
                 : m_iter( i ), m_list( li ) {}                                \
             compatibility_iterator( const liT* li, iterator i )               \


@@ -252,6 +243,11 @@ private:
             std::advance( i, idx );                                           \
             return compatibility_iterator( this, i );                         \
         }                                                                     \
             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,                              \
         compatibility_iterator GetFirst() const                               \
         {                                                                     \
             return compatibility_iterator( this,                              \


@@ -323,6 +319,9 @@ private:
         void Sort( wxSortCompareFunction compfunc )                           \
             { sort( WX_LIST_SORTFUNCTION( elT, compfunc ) ); }                \
         ~liT() { Clear(); }                                                   \
         void Sort( wxSortCompareFunction 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)                              \
     }
 
 #define WX_DECLARE_LIST(elementtype, listname)                              \


@@ -331,7 +330,7 @@ private:
     WX_DECLARE_LIST(elementtype, listname)
 
 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname)                     \
     WX_DECLARE_LIST(elementtype, listname)
 
 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname)                     \

-    WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class WXDLLEXPORT)
+    WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class WXDLLIMPEXP_CORE)

 #define WX_DECLARE_EXPORTED_LIST_PTR(elementtype, listname)                 \
     WX_DECLARE_EXPORTED_LIST(elementtype, listname)
 
 #define WX_DECLARE_EXPORTED_LIST_PTR(elementtype, listname)                 \
     WX_DECLARE_EXPORTED_LIST(elementtype, listname)
 


@@ -349,11 +348,6 @@ private:
 
 #else // if !wxUSE_STL
 
 
 #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

 
 // undef it to get rid of old, deprecated functions
 #define wxLIST_COMPATIBILITY
 
 // undef it to get rid of old, deprecated functions
 #define wxLIST_COMPATIBILITY


@@ -365,7 +359,7 @@ extern WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s);
 union wxListKeyValue
 {
     long integer;
 union wxListKeyValue
 {
     long integer;

-    wxChar *string;
+    wxString *string;

 };
 
 // a struct which may contain both types of keys
 };
 
 // a struct which may contain both types of keys


@@ -382,15 +376,17 @@ public:
         { }
     wxListKey(long i) : m_keyType(wxKEY_INTEGER)
         { m_key.integer = i; }
         { }
     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)
     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; }
 
     // 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; }
 
     long GetNumber() const
         { wxASSERT( m_keyType == wxKEY_INTEGER ); return m_key.integer; }
 


@@ -403,7 +399,7 @@ public:
     ~wxListKey()
     {
         if ( m_keyType == wxKEY_STRING )
     ~wxListKey()
     {
         if ( m_keyType == wxKEY_STRING )

-            free(m_key.string);
+            delete m_key.string;

     }
 
 private:
     }
 
 private:


@@ -417,7 +413,7 @@ private:
 
 extern WXDLLIMPEXP_DATA_BASE(wxListKey) wxDefaultListKey;
 
 
 extern WXDLLIMPEXP_DATA_BASE(wxListKey) wxDefaultListKey;
 

-class WXDLLIMPEXP_BASE wxListBase;
+class WXDLLIMPEXP_FWD_BASE wxListBase;

 
 class WXDLLIMPEXP_BASE wxNodeBase
 {
 
 class WXDLLIMPEXP_BASE wxNodeBase
 {


@@ -433,11 +429,11 @@ public:
     virtual ~wxNodeBase();
 
     // FIXME no check is done that the list is really keyed on strings
     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
     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
     void SetKeyInteger(long i) { m_key.integer = i; }
 
 #ifdef wxLIST_COMPATIBILITY


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

-    void** GetDataPtr() const { return &(((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;


@@ -479,11 +475,11 @@ private:
 // a double-linked list class
 // -----------------------------------------------------------------------------
 
 // 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()
 
 public:
 friend class wxHashTableBase;   // should be able to call untyped Find()
 
 public:


@@ -540,10 +536,6 @@ protected:
                                    void *data,
                                    const wxListKey& key = wxDefaultListKey) = 0;
 
                                    void *data,
                                    const wxListKey& key = wxDefaultListKey) = 0;
 

-// Can't access these from derived classes otherwise (bug in Salford C++?)
-#ifdef __SALFORDC__
-public:
-#endif

 
     // ctors
         // from an array
 
     // ctors
         // from an array


@@ -587,7 +579,7 @@ protected:
 
         // keyed append
     wxNodeBase *Append(long key, void *object);
 
         // 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)
 
         // 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)


@@ -728,7 +720,7 @@ private:
             : wxListBase(count, (void **)elements) { }                      \
                                                                             \
         name& operator=(const name& list)                                   \
             : wxListBase(count, (void **)elements) { }                      \
                                                                             \
         name& operator=(const name& list)                                   \

-            { Assign(list); return *this; }                                 \
+            { if (&list != this) Assign(list); return *this; }              \

                                                                             \
         nodetype *GetFirst() const                                          \
             { return (nodetype *)wxListBase::GetFirst(); }                  \
                                                                             \
         nodetype *GetFirst() const                                          \
             { return (nodetype *)wxListBase::GetFirst(); }                  \


@@ -1013,17 +1005,22 @@ private:
             for(size_type i = 0; i < n; ++i)                                \
                 Append((const_base_reference)v);                            \
         }                                                                   \
             for(size_type i = 0; i < n; ++i)                                \
                 Append((const_base_reference)v);                            \
         }                                                                   \

-        iterator insert(const iterator& it, const_reference v = value_type())\
+        iterator insert(const iterator& it, const_reference v)              \

         {                                                                   \
         {                                                                   \

-            Insert(it.m_node, (const_base_reference)v);                     \
-            return iterator(it.m_node->GetPrevious(), GetLast());           \
+            if ( it == end() )                                              \
+                Append((const_base_reference)v);                            \
+            else                                                            \
+                Insert(it.m_node, (const_base_reference)v);                 \
+            iterator itprev(it);                                            \
+            return itprev--;                                                \

         }                                                                   \
         }                                                                   \

-        void insert(const iterator& it, size_type n, const_reference v = value_type())\
+        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);                 \
         }                                                                   \
         {                                                                   \
             for(size_type i = 0; i < n; ++i)                                \
                 Insert(it.m_node, (const_base_reference)v);                 \
         }                                                                   \

-        void insert(const iterator& it, const_iterator first, const 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);            \
         {                                                                   \
             for(; first != last; ++first)                                   \
                 Insert(it.m_node, (const_base_reference)*first);            \


@@ -1092,11 +1089,11 @@ private:
     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, decl)
 
 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname)                     \
     WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node, decl)
 
 #define WX_DECLARE_EXPORTED_LIST(elementtype, listname)                     \

-    WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class WXDLLEXPORT)
+    WX_DECLARE_LIST_WITH_DECL(elementtype, listname, class WXDLLIMPEXP_CORE)

 
 #define WX_DECLARE_EXPORTED_LIST_PTR(elementtype, listname)                     \
     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 
 #define WX_DECLARE_EXPORTED_LIST_PTR(elementtype, listname)                     \
     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \

-    WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class WXDLLEXPORT)
+    WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class WXDLLIMPEXP_CORE)

 
 #define WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo)       \
     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \
 
 #define WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo)       \
     typedef elementtype _WX_LIST_ITEM_TYPE_##listname;                      \


@@ -1173,7 +1170,7 @@ public:
 
 #if !wxUSE_STL
     wxList& operator=(const wxList& list)
 
 #if !wxUSE_STL
     wxList& operator=(const wxList& list)

-        { (void) wxListBase::operator=(list); return *this; }
+        { if (&list != this) Assign(list); return *this; }

 
     // compatibility methods
     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
 
     // compatibility methods
     void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }


@@ -1183,11 +1180,6 @@ public:
 #else
     wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
 #endif
 #else
     wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
 #endif

-
-private:
-#if !wxUSE_STL
-    DECLARE_DYNAMIC_CLASS(wxList)
-#endif

 };
 
 #if !wxUSE_STL
 };
 
 #if !wxUSE_STL


@@ -1204,17 +1196,24 @@ public:
         // default
 #ifdef wxWARN_COMPAT_LIST_USE
     wxStringList();
         // default
 #ifdef wxWARN_COMPAT_LIST_USE
     wxStringList();

-    wxDEPRECATED( wxStringList(const wxChar *first ...) );
+    wxDEPRECATED( wxStringList(const wxChar *first ...) ); // FIXME-UTF8

 #else
     wxStringList();
 #else
     wxStringList();

-    wxStringList(const wxChar *first ...);
+    wxStringList(const wxChar *first ...); // FIXME-UTF8

 #endif
 
         // copying the string list: the strings are copied, too (extremely
         // inefficient!)
     wxStringList(const wxStringList& other) : wxStringListBase() { DeleteContents(true); DoCopy(other); }
     wxStringList& operator=(const wxStringList& other)
 #endif
 
         // copying the string list: the strings are copied, too (extremely
         // inefficient!)
     wxStringList(const wxStringList& other) : wxStringListBase() { DeleteContents(true); DoCopy(other); }
     wxStringList& operator=(const wxStringList& other)

-        { Clear(); DoCopy(other); return *this; }
+    {
+        if (&other != this)
+        {
+            Clear();
+            DoCopy(other);
+        }
+        return *this;
+    }

 
     // operations
         // makes a copy of the string
 
     // operations
         // makes a copy of the string


@@ -1233,8 +1232,6 @@ public:
 
 private:
     void DoCopy(const wxStringList&); // common part of copy ctor and operator=
 
 private:
     void DoCopy(const wxStringList&); // common part of copy ctor and operator=

-
-    DECLARE_DYNAMIC_CLASS(wxStringList)

 };
 
 #else // if wxUSE_STL
 };
 
 #else // if wxUSE_STL