changed removed wxToUpper to standard toupper

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

diff --git a/include/wx/list.h b/include/wx/list.h
index dc52fc248cb53c7b98901a204082cf1298b792f5..b5789828662db1b3244ad35185aa4cd2e8b574fa 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

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


@@ -127,6 +127,8 @@ private:
 // wxNodeBase class is a (base for) node in a double linked list
 // -----------------------------------------------------------------------------
 
 // wxNodeBase class is a (base for) node in a double linked list
 // -----------------------------------------------------------------------------
 

+WXDLLEXPORT_DATA(extern wxListKey) wxDefaultListKey;
+

 class WXDLLEXPORT wxNodeBase
 {
 friend class wxListBase;
 class WXDLLEXPORT wxNodeBase
 {
 friend class wxListBase;


@@ -136,12 +138,17 @@ public:
                wxNodeBase *previous = (wxNodeBase *)NULL,
                wxNodeBase *next = (wxNodeBase *)NULL,
                void *data = NULL,
                wxNodeBase *previous = (wxNodeBase *)NULL,
                wxNodeBase *next = (wxNodeBase *)NULL,
                void *data = NULL,

-               const wxListKey& key = wxListKey());
+               const wxListKey& key = wxDefaultListKey);

 
     virtual ~wxNodeBase();
 
     // @@ no check is done that the list is really keyed on strings
     const char *GetKeyString() const { return m_key.string; }
 
     virtual ~wxNodeBase();
 
     // @@ no check is done that the list is really keyed on strings
     const char *GetKeyString() const { return m_key.string; }

+    long GetKeyInteger() const { return m_key.integer; }
+
+    // Necessary for some existing code
+    void SetKeyString(char* s) { m_key.string = s; }
+    void SetKeyInteger(long i) { m_key.integer = i; }

 
 #ifdef wxLIST_COMPATIBILITY
     // compatibility methods
 
 #ifdef wxLIST_COMPATIBILITY
     // compatibility methods


@@ -158,6 +165,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 wxNOT_FOUND
+    int IndexOf() const;
+

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


@@ -187,19 +197,39 @@ public:
     size_t GetCount() const { return m_count; }
 
     // operations
     size_t GetCount() const { return m_count; }
 
     // operations

+    

         // delete all nodes
         // delete all nodes

-    virtual void Clear();
+    void Clear();
+    

         // instruct it to destroy user data when deleting nodes
     void DeleteContents(bool destroy) { m_destroy = destroy; }
 
         // instruct it to destroy user data when deleting nodes
     void DeleteContents(bool destroy) { m_destroy = destroy; }
 

+       // query if to delete
+    bool GetDeleteContents() const
+        { return m_destroy; }
+    
+      // get the keytype
+    wxKeyType GetKeyType() const
+        { return m_keyType; }
+
+      // set the keytype (required by the serial code)
+    void SetKeyType(wxKeyType keyType)
+        { wxASSERT( m_count==0 ); m_keyType = keyType; }
+

 protected:
 protected:

+

     // all methods here are "overloaded" in derived classes to provide compile
     // time type checking
 
     // create a node for the list of this type
     virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,
                                    void *data,
     // all methods here are "overloaded" in derived classes to provide compile
     // time type checking
 
     // create a node for the list of this type
     virtual wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,
                                    void *data,

-                                   const wxListKey& key = wxListKey()) = 0;
+                                   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


@@ -207,6 +237,7 @@ protected:
         // from a sequence of objects
     wxListBase(void *object, ... /* terminate with NULL */);
 
         // from a sequence of objects
     wxListBase(void *object, ... /* terminate with NULL */);
 

+protected:

         // copy ctor and assignment operator
     wxListBase(const wxListBase& list)
         { DoCopy(list); }
         // copy ctor and assignment operator
     wxListBase(const wxListBase& list)
         { DoCopy(list); }


@@ -222,13 +253,13 @@ protected:
 
         // get the list item's data
     void *operator[](size_t index) const
 
         // get the list item's data
     void *operator[](size_t index) const

-        { wxNodeBase *node = Item(index); return node ? node->GetData() : NULL; }
+        { wxNodeBase *node = Item(index); return node ? node->GetData() : (wxNodeBase*)NULL; }

 
     // operations
         // append to end of list
     wxNodeBase *Append(void *object);
         // insert a new item at the beginning of the list
 
     // operations
         // append to end of list
     wxNodeBase *Append(void *object);
         // insert a new item at the beginning of the list

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

         // insert before given node or at front of list if prev == NULL
     wxNodeBase *Insert(wxNodeBase *prev, void *object);
 
         // insert before given node or at front of list if prev == NULL
     wxNodeBase *Insert(wxNodeBase *prev, void *object);
 


@@ -243,7 +274,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


@@ -252,6 +283,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 wxNOT_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);


@@ -260,11 +294,11 @@ protected:
     void *FirstThat(wxListIterateFunction func);
     void ForEach(wxListIterateFunction func);
     void *LastThat(wxListIterateFunction func);
     void *FirstThat(wxListIterateFunction func);
     void ForEach(wxListIterateFunction func);
     void *LastThat(wxListIterateFunction func);

-
+    

 private:
     // helpers
         // common part of all ctors
 private:
     // helpers
         // common part of all ctors

-    void Init(wxKeyType keyType);
+    void Init(wxKeyType keyType = wxKEY_NONE);

         // common part of copy ctor and assignment operator
     void DoCopy(const wxListBase& list);
         // common part of all Append()s
         // common part of copy ctor and assignment operator
     void DoCopy(const wxListBase& list);
         // common part of all Append()s


@@ -288,15 +322,15 @@ private:
 
 // declare a list type named 'name' and containing elements of type 'T *'
 // (as a by product of macro expansion you also get wx##name##Node
 
 // declare a list type named 'name' and containing elements of type 'T *'
 // (as a by product of macro expansion you also get wx##name##Node

-// wxNode-dervied type)
+// wxNode-derived type)

 //
 // implementation details:
 //
 // implementation details:

-//  1. we define _WX_LIST_ITEM_TYPE_##name typedef to save in it the item type
+//  1. We define _WX_LIST_ITEM_TYPE_##name typedef to save in it the item type

 //     for the list of given type - this allows us to pass only the list name
 //     to WX_DEFINE_LIST() even if it needs both the name and the type
 //
 //     for the list of given type - this allows us to pass only the list name
 //     to WX_DEFINE_LIST() even if it needs both the name and the type
 //

-//  2. We redefine all not type-safe wxList functions withtype-safe versions
-//     which don't take any place (everything is inline), but bring compile
+//  2. We redefine all non-type-safe wxList functions with type-safe versions
+//     which don't take any space (everything is inline), but bring compile

 //     time error checking.
 
 #define WX_DECLARE_LIST_2(T, name, nodetype)                                \
 //     time error checking.
 
 #define WX_DECLARE_LIST_2(T, name, nodetype)                                \


@@ -309,7 +343,7 @@ private:
                  nodetype *previous = (nodetype *)NULL,                     \
                  nodetype *next = (nodetype *)NULL,                         \
                  T *data = (T *)NULL,                                       \
                  nodetype *previous = (nodetype *)NULL,                     \
                  nodetype *next = (nodetype *)NULL,                         \
                  T *data = (T *)NULL,                                       \

-                 const wxListKey& key = wxListKey())                        \
+                 const wxListKey& key = wxDefaultListKey)                        \

             : wxNodeBase(list, previous, next, data, key) { }               \
                                                                             \
         nodetype *GetNext() const                                           \
             : wxNodeBase(list, previous, next, data, key) { }               \
                                                                             \
         nodetype *GetNext() const                                           \


@@ -328,6 +362,8 @@ private:
     class WXDLLEXPORT name : public wxListBase                                          \
     {                                                                       \
     public:                                                                 \
     class WXDLLEXPORT name : public wxListBase                                          \
     {                                                                       \
     public:                                                                 \

+        typedef nodetype Node;                                              \
+                                                                            \

         name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType)          \
             { }                                                             \
         name(size_t count, T *elements[])                                   \
         name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType)          \
             { }                                                             \
         name(size_t count, T *elements[])                                   \


@@ -350,7 +386,7 @@ private:
         nodetype *Append(T *object)                                         \
             { return (nodetype *)wxListBase::Append(object); }              \
         nodetype *Insert(T *object)                                         \
         nodetype *Append(T *object)                                         \
             { return (nodetype *)wxListBase::Append(object); }              \
         nodetype *Insert(T *object)                                         \

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

         nodetype *Insert(nodetype *prev, T *object)                         \
             { return (nodetype *)wxListBase::Insert(prev, object); }        \
                                                                             \
         nodetype *Insert(nodetype *prev, T *object)                         \
             { return (nodetype *)wxListBase::Insert(prev, object); }        \
                                                                             \


@@ -372,13 +408,16 @@ 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); }              \
                                                                             \
     protected:                                                              \
         wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,          \
                                void *data,                                  \
         void Sort(wxSortFuncFor_##name func)                                \
             { wxListBase::Sort((wxSortCompareFunction)func); }              \
                                                                             \
     protected:                                                              \
         wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next,          \
                                void *data,                                  \

-                               const wxListKey& key = wxListKey())          \
+                               const wxListKey& key = wxDefaultListKey)          \

             {                                                               \
                 return new nodetype(this,                                   \
                                     (nodetype *)prev, (nodetype *)next,     \
             {                                                               \
                 return new nodetype(this,                                   \
                                     (nodetype *)prev, (nodetype *)next,     \


@@ -425,7 +464,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


@@ -436,13 +475,18 @@ public:
     wxStringList() { DeleteContents(TRUE); }
     wxStringList(const char *first ...);
 
     wxStringList() { DeleteContents(TRUE); }
     wxStringList(const char *first ...);
 

+        // copying the string list: the strings are copied, too (extremely
+        // inefficient!)
+    wxStringList(const wxStringList& other) { DoCopy(other); }
+    wxStringList& operator=(const wxStringList& other)
+        { Clear(); DoCopy(other); return *this; }
+

     // operations
         // makes a copy of the string
     wxNode *Add(const char *s)
         { return (wxNode *)wxStringListBase::Append(copystring(s)); }
 
     // operations
         // makes a copy of the string
     wxNode *Add(const char *s)
         { return (wxNode *)wxStringListBase::Append(copystring(s)); }
 

-    void Delete(const char *s)
-        { wxStringListBase::DeleteObject((char *)s); }
+    bool Delete(const char *s);

 
     char **ListToArray(bool new_copies = FALSE) const;
     bool Member(const char *s) const;
 
     char **ListToArray(bool new_copies = FALSE) const;
     bool Member(const char *s) const;


@@ -455,6 +499,9 @@ public:
     wxNode *First() const { return (wxNode *)GetFirst(); }
     wxNode *Last() const { return (wxNode *)GetLast(); }
     wxNode *Nth(size_t index) const { return (wxNode *)Item(index); }
     wxNode *First() const { return (wxNode *)GetFirst(); }
     wxNode *Last() const { return (wxNode *)GetLast(); }
     wxNode *Nth(size_t index) const { return (wxNode *)Item(index); }

+
+private:
+    void DoCopy(const wxStringList&); // common part of copy ctor and operator=

 };
 
 #endif // wxLIST_COMPATIBILITY
 };
 
 #endif // wxLIST_COMPATIBILITY