added wxNode::IndexOf and wxList::IndexOf (patch by Frank McIngvale)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1096 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/list.tex b/docs/latex/wx/list.tex
index 3af91125d335dbeb1cf9a1dc083546869e1d51ca..a3ac3e840e95af830f337aee5f26980668992c00 100644 (file)
--- a/docs/latex/wx/list.tex
+++ b/docs/latex/wx/list.tex
@@ -144,6 +144,13 @@ Returns the node whose stored key matches {\it key}. Use on a keyed list only.
 
 Returns the first node in the list (NULL if the list is empty).
 
 
 Returns the first node in the list (NULL if the list is empty).
 

+\membersection{wxList::IndexOf}
+
+\func{int}{IndexOf}{\param{wxObject*}{ obj }}
+
+Returns the index of {\it obj} within the list or NOT\_FOUND if {\it obj}
+is not found in the list.
+

 \membersection{wxList::Insert}
 
 \func{wxNode *}{Insert}{\param{wxObject *}{object}}
 \membersection{wxList::Insert}
 
 \func{wxNode *}{Insert}{\param{wxObject *}{object}}

diff --git a/docs/latex/wx/node.tex b/docs/latex/wx/node.tex
index 417329092f5f3bb3b82bf6a7ccd61896353ca83a..a65eb41c69a932f3c4ac23848286167c020a8bb1 100644 (file)
--- a/docs/latex/wx/node.tex
+++ b/docs/latex/wx/node.tex
@@ -38,4 +38,10 @@ Retrieves the previous node (NULL if at start of list).
 Sets the data associated with the node (usually the pointer will have been
 set when the node was created).
 
 Sets the data associated with the node (usually the pointer will have been
 set when the node was created).
 

+\membersection{wxNode::IndexOf}
+
+\func{int}{IndexOf}{\void}
+
+Returns the zero-based index of this node within the list. The return value
+will be NOT\_FOUND if the node has not been added to a list yet.

 
 

diff --git a/include/wx/list.h b/include/wx/list.h
index 625387f67ea3057df787d3e717c16159dd839bcb..0274f7fcb335e2f4367dadb1b6950da195b12327 100644 (file)
--- a/include/wx/list.h
+++ b/include/wx/list.h
@@ -6,7 +6,7 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart

-// Licence:    wxWindows license
+// Licence:       wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 /*
 /////////////////////////////////////////////////////////////////////////////
 
 /*


@@ -163,6 +163,9 @@ protected:
     void *GetData() const { return m_data; }
     void SetData(void *data) { m_data = data; }
 
     void *GetData() const { return m_data; }
     void SetData(void *data) { m_data = data; }
 

+    // get 0-based index of this node within the list or NOT_FOUND
+    int IndexOf() const;
+

     virtual void DeleteData() { }
 
 private:
     virtual void DeleteData() { }
 
 private:


@@ -248,7 +251,7 @@ protected:
     bool DeleteNode(wxNodeBase *node);
         // finds object pointer and deletes node (and object if DeleteContents
         // is on), returns FALSE if object not found
     bool DeleteNode(wxNodeBase *node);
         // finds object pointer and deletes node (and object if DeleteContents
         // is on), returns FALSE if object not found

-    bool DeleteObject(void *object);  
+    bool DeleteObject(void *object);

 
     // search (all return NULL if item not found)
         // by data
 
     // search (all return NULL if item not found)
         // by data


@@ -257,6 +260,9 @@ protected:
         // by key
     wxNodeBase *Find(const wxListKey& key) const;
 
         // by key
     wxNodeBase *Find(const wxListKey& key) const;
 

+    // get 0-based index of object or NOT_FOUND
+    int IndexOf( void *object ) const;
+

     // this function allows the sorting of arbitrary lists by giving
     // a function to compare two list elements. The list is sorted in place.
     void Sort(const wxSortCompareFunction compfunc);
     // this function allows the sorting of arbitrary lists by giving
     // a function to compare two list elements. The list is sorted in place.
     void Sort(const wxSortCompareFunction compfunc);


@@ -377,6 +383,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); }                   \
                                                                             \

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

         void Sort(wxSortFuncFor_##name func)                                \
             { wxListBase::Sort((wxSortCompareFunction)func); }              \
                                                                             \
         void Sort(wxSortFuncFor_##name func)                                \
             { wxListBase::Sort((wxSortCompareFunction)func); }              \
                                                                             \


@@ -430,7 +439,7 @@ public:
 // -----------------------------------------------------------------------------
 // wxStringList class for compatibility with the old code
 // -----------------------------------------------------------------------------
 // -----------------------------------------------------------------------------
 // wxStringList class for compatibility with the old code
 // -----------------------------------------------------------------------------

-    
+

 WX_DECLARE_LIST_2(char, wxStringListBase, wxStringListNode);
 
 class WXDLLEXPORT wxStringList : public wxStringListBase
 WX_DECLARE_LIST_2(char, wxStringListBase, wxStringListNode);
 
 class WXDLLEXPORT wxStringList : public wxStringListBase

diff --git a/src/common/list.cpp b/src/common/list.cpp
index a689f0b40eaea85cf0516bd96bed5cf7419692af..457a48aa146647be3f968abd7fcd754c70b70682 100644 (file)
--- a/src/common/list.cpp
+++ b/src/common/list.cpp
@@ -68,7 +68,7 @@ bool wxListKey::operator==(wxListKeyValue value) const
         case wxKEY_INTEGER:
             return m_key.integer == value.integer;
     }
         case wxKEY_INTEGER:
             return m_key.integer == value.integer;
     }

-}                                
+}

 
 // -----------------------------------------------------------------------------
 // wxNodeBase
 
 // -----------------------------------------------------------------------------
 // wxNodeBase


@@ -82,28 +82,28 @@ wxNodeBase::wxNodeBase(wxListBase *list,
     m_data = data;
     m_previous = previous;
     m_next = next;
     m_data = data;
     m_previous = previous;
     m_next = next;

-    
+

     switch ( key.GetKeyType() )
     {
         case wxKEY_NONE:
             break;
     switch ( key.GetKeyType() )
     {
         case wxKEY_NONE:
             break;

-        
+

         case wxKEY_INTEGER:
             m_key.integer = key.GetNumber();
             break;
         case wxKEY_INTEGER:
             m_key.integer = key.GetNumber();
             break;

-        
+

         case wxKEY_STRING:
             // to be free()d later
             m_key.string = strdup(key.GetString());
             break;
         case wxKEY_STRING:
             // to be free()d later
             m_key.string = strdup(key.GetString());
             break;

-        
+

         default:
             wxFAIL_MSG("invalid key type");
     }
         default:
             wxFAIL_MSG("invalid key type");
     }

-    
+

     if ( previous )
         previous->m_next = this;
     if ( previous )
         previous->m_next = this;

-    
+

     if ( next )
         next->m_previous = this;
 }
     if ( next )
         next->m_previous = this;
 }


@@ -119,6 +119,25 @@ wxNodeBase::~wxNodeBase()
     }
 }
 
     }
 }
 

+int wxNodeBase::IndexOf() const
+{
+    wxCHECK_MSG( m_list, NOT_FOUND, "node doesn't belong to a list in IndexOf");
+
+    // It would be more efficient to implement IndexOf() completely inside
+    // wxListBase (only traverse the list once), but this is probably a more
+    // reusable way of doing it. Can always be optimized at a later date (since
+    // IndexOf() resides in wxListBase as well) if efficiency is a problem.
+    int i;
+    wxNodeBase *prev = m_previous;
+
+    for( i = 0; prev; i++ )
+    {
+        prev = prev->m_previous;
+    }
+
+    return i;
+}
+

 // -----------------------------------------------------------------------------
 // wxListBase
 // -----------------------------------------------------------------------------
 // -----------------------------------------------------------------------------
 // wxListBase
 // -----------------------------------------------------------------------------


@@ -304,6 +323,13 @@ wxNodeBase *wxListBase::Find(void *object) const
     return (wxNodeBase *)NULL;
 }
 
     return (wxNodeBase *)NULL;
 }
 

+int wxListBase::IndexOf(void *object) const
+{
+    wxNodeBase *node = Find( object );
+
+    return node ? node->IndexOf() : NOT_FOUND;
+}
+

 void wxListBase::DoDeleteNode(wxNodeBase *node)
 {
     // free node's data
 void wxListBase::DoDeleteNode(wxNodeBase *node)
 {
     // free node's data


@@ -498,7 +524,7 @@ void wxStringList::DoCopy(const wxStringList& other)
     size_t count = other.GetCount();
     for ( size_t n = 0; n < count; n++ )
     {
     size_t count = other.GetCount();
     for ( size_t n = 0; n < count; n++ )
     {

-        Add(other.Item(n)->GetData()); 
+        Add(other.Item(n)->GetData());

     }
 }
 
     }
 }