// Name: list.h
// Purpose: wxList, wxStringList classes
// Author: Julian Smart
-// Modified by:
+// Modified by: VZ at 16/11/98: WX_DECLARE_LIST() and typesafe lists added
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Julian Smart
-// Licence: wxWindows license
+// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-#ifndef __LISTH__
-#define __LISTH__
+/*
+ All this is quite ugly but serves two purposes:
+ 1. Be almost 100% compatible with old, untyped, wxList class
+ 2. Ensure compile-time type checking for the linked lists
+
+ The idea is to have one base class (wxListBase) working with "void *" data,
+ but to hide these untyped functions - i.e. make them protected, so they
+ can only be used from derived classes which have inline member functions
+ working with right types. This achieves the 2nd goal. As for the first one,
+ we provide a special derivation of wxListBase called wxList which looks just
+ like the old class.
+*/
+
+#ifndef _WX_LISTH__
+#define _WX_LISTH__
#ifdef __GNUG__
-#pragma interface
+#pragma interface "list.h"
#endif
+// -----------------------------------------------------------------------------
+// headers
+// -----------------------------------------------------------------------------
+
#include "wx/defs.h"
+#include "wx/debug.h"
#include "wx/object.h"
+#include "wx/string.h"
+
+// due to circular header dependencies this function has to be declared here
+// (normally it's found in utils.h which includes itself list.h...)
+extern WXDLLEXPORT wxChar* copystring(const wxChar *s);
+
+class WXDLLEXPORT wxObjectListNode;
+typedef wxObjectListNode wxNode;
-class WXDLLEXPORT wxList;
+// undef it to get rid of old, deprecated functions
+#define wxLIST_COMPATIBILITY
-#define wxKEY_NONE 0
-#define wxKEY_INTEGER 1
-#define wxKEY_STRING 2
-class WXDLLEXPORT wxNode: public wxObject
+// -----------------------------------------------------------------------------
+// constants
+// -----------------------------------------------------------------------------
+enum wxKeyType
{
- DECLARE_DYNAMIC_CLASS(wxNode)
- private:
-
- wxObject *data;
- wxNode *next;
- wxNode *previous;
-
- public:
- wxList *list;
-
- // Optional key stuff
- union
- {
- long integer;
- char *string;
- } key;
-
- wxNode(wxList *the_list = NULL, wxNode *last_one = NULL, wxNode *next_one = NULL, wxObject *object = NULL);
- wxNode(wxList *the_list, wxNode *last_one, wxNode *next_one,
- wxObject *object, long the_key);
- wxNode(wxList *the_list, wxNode *last_one, wxNode *next_one,
- wxObject *object, const char *the_key);
- ~wxNode(void);
-
- inline wxNode *Next(void) const { return next; }
- inline wxNode *Previous(void) const { return previous; }
- inline wxObject *Data(void) const { return (wxObject *)data; }
- inline void SetData(wxObject *the_data) { data = the_data; }
+ wxKEY_NONE,
+ wxKEY_INTEGER,
+ wxKEY_STRING
};
-// type of compare function for list sort operation (as in 'qsort')
+// -----------------------------------------------------------------------------
+// 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
typedef int (*wxSortCompareFunction)(const void *elem1, const void *elem2);
-typedef int (*wxListIterateFunction)(wxObject *o);
-class WXDLLEXPORT wxList: public wxObject
+//
+typedef int (*wxListIterateFunction)(void *current);
+
+// -----------------------------------------------------------------------------
+// key stuff: a list may be optionally keyed on integer or string key
+// -----------------------------------------------------------------------------
+
+union wxListKeyValue
+{
+ long integer;
+ wxChar *string;
+};
+
+// a struct which may contain both types of keys
+//
+// implementation note: on one hand, this class allows to have only one function
+// for any keyed operation instead of 2 almost equivalent. OTOH, it's needed to
+// resolve ambiguity which we would otherwise have with wxStringList::Find() and
+// wxList::Find(const char *).
+class WXDLLEXPORT wxListKey
+{
+public:
+ // implicit ctors
+ wxListKey()
+ { m_keyType = wxKEY_NONE; }
+ 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()); }
+
+ // accessors
+ wxKeyType GetKeyType() const { return m_keyType; }
+ const wxChar *GetString() const
+ { wxASSERT( m_keyType == wxKEY_STRING ); return m_key.string; }
+ long GetNumber() const
+ { wxASSERT( m_keyType == wxKEY_INTEGER ); return m_key.integer; }
+
+ // comparison
+ // Note: implementation moved to list.cpp to prevent BC++ inline
+ // expansion warning.
+ bool operator==(wxListKeyValue value) const ;
+
+ // dtor
+ ~wxListKey()
+ {
+ if ( m_keyType == wxKEY_STRING )
+ free(m_key.string);
+ }
+
+private:
+ wxKeyType m_keyType;
+ wxListKeyValue m_key;
+};
+
+// -----------------------------------------------------------------------------
+// wxNodeBase class is a (base for) node in a double linked list
+// -----------------------------------------------------------------------------
+
+WXDLLEXPORT_DATA(extern wxListKey) wxDefaultListKey;
+
+class WXDLLEXPORT wxNodeBase
+{
+friend class wxListBase;
+public:
+ // ctor
+ wxNodeBase(wxListBase *list = (wxListBase *)NULL,
+ wxNodeBase *previous = (wxNodeBase *)NULL,
+ wxNodeBase *next = (wxNodeBase *)NULL,
+ void *data = NULL,
+ const wxListKey& key = wxDefaultListKey);
+
+ virtual ~wxNodeBase();
+
+ // FIXME no check is done that the list is really keyed on strings
+ const wxChar *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 SetKeyInteger(long i) { m_key.integer = i; }
+
+#ifdef wxLIST_COMPATIBILITY
+ // compatibility methods
+ wxNode *Next() const { return (wxNode *)GetNext(); }
+ wxNode *Previous() const { return (wxNode *)GetPrevious(); }
+ wxObject *Data() const { return (wxObject *)GetData(); }
+#endif // wxLIST_COMPATIBILITY
+
+protected:
+ // all these are going to be "overloaded" in the derived classes
+ wxNodeBase *GetNext() const { return m_next; }
+ wxNodeBase *GetPrevious() const { return m_previous; }
+
+ 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:
+ // optional key stuff
+ wxListKeyValue m_key;
+
+ void *m_data; // user data
+ wxNodeBase *m_next, // next and previous nodes in the list
+ *m_previous;
+
+ wxListBase *m_list; // list we belong to
+};
+
+// -----------------------------------------------------------------------------
+// a double-linked list class
+// -----------------------------------------------------------------------------
+class WXDLLEXPORT wxListBase : public wxObject
{
- DECLARE_DYNAMIC_CLASS(wxList)
-
- public:
- int n;
- int destroy_data;
- wxNode *first_node;
- wxNode *last_node;
- unsigned int key_type;
-
- wxList(void);
- wxList(const unsigned int the_key_type);
- wxList(const int N, wxObject *Objects[]);
- wxList(wxObject *object, ...);
-
-#ifdef USE_STORABLE_CLASSES
- wxList( istream &stream, char *data );
- virtual void StoreObject( ostream &stream );
+friend class wxNodeBase; // should be able to call DetachNode()
+public:
+ // default ctor & dtor
+ wxListBase(wxKeyType keyType = wxKEY_NONE) { Init(keyType); }
+ virtual ~wxListBase();
+
+ // accessors
+ // count of items in the list
+ size_t GetCount() const { return m_count; }
+
+ // operations
+
+ // delete all nodes
+ void Clear();
+
+ // 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; }
+
+#ifdef wxLIST_COMPATIBILITY
+ int Number() const { return GetCount(); }
+ wxNode *First() const { return (wxNode *)GetFirst(); }
+ wxNode *Last() const { return (wxNode *)GetLast(); }
+ wxNode *Nth(size_t index) const { return (wxNode *)Item(index); }
+#endif // wxLIST_COMPATIBILITY
+
+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,
+ const wxListKey& key = wxDefaultListKey) = 0;
+
+// Can't access these from derived classes otherwise (bug in Salford C++?)
+#ifdef __SALFORDC__
+public:
#endif
-
- ~wxList(void);
- inline int Number(void) const { return n; }
+ // ctors
+ // from an array
+ wxListBase(size_t count, void *elements[]);
+ // from a sequence of objects
+ wxListBase(void *object, ... /* terminate with NULL */);
+
+protected:
+ // copy ctor and assignment operator
+ wxListBase(const wxListBase& list)
+ { DoCopy(list); }
+ wxListBase& operator=(const wxListBase& list)
+ { Clear(); DoCopy(list); return *this; }
+
+ // get list head/tail
+ wxNodeBase *GetFirst() const { return m_nodeFirst; }
+ wxNodeBase *GetLast() const { return m_nodeLast; }
- // Append to end of list
- wxNode *Append(wxObject *object);
+ // by (0-based) index
+ wxNodeBase *Item(size_t index) const;
- // Insert at front of list
- wxNode *Insert(wxObject *object);
+ // get the list item's data
+ void *operator[](size_t index) const
+ { wxNodeBase *node = Item(index); return node ? node->GetData() : (wxNodeBase*)NULL; }
- // Insert before given node
- wxNode *Insert(wxNode *position, wxObject *object);
+ // 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( (wxNodeBase*)NULL, object); }
+ // insert before given node or at front of list if prev == NULL
+ wxNodeBase *Insert(wxNodeBase *prev, void *object);
- // Keyed append
- wxNode *Append(const long key, wxObject *object);
- wxNode *Append(const char *key, wxObject *object);
+ // keyed append
+ wxNodeBase *Append(long key, void *object);
+ wxNodeBase *Append(const wxChar *key, void *object);
- bool DeleteNode(wxNode *node);
- bool DeleteObject(wxObject *object); // Finds object pointer and
- // deletes node (and object if
- // DeleteContents is on)
- void Clear(void); // Delete all nodes
+ // 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)
+ wxNodeBase *DetachNode(wxNodeBase *node);
+ // delete element from list, returns FALSE if node 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);
- inline wxNode *First(void) const { return first_node; }
- inline wxNode *Last(void) const { return last_node; }
- wxNode *Nth(const int i) const; // nth node counting from 0
+ // search (all return NULL if item not found)
+ // by data
+ wxNodeBase *Find(void *object) const;
- // Keyed search
- wxNode *Find(const long key) const;
- wxNode *Find(const char *key) const;
+ // by key
+ wxNodeBase *Find(const wxListKey& key) const;
- wxNode *Member(wxObject *object) const;
+ // get 0-based index of object or wxNOT_FOUND
+ int IndexOf( void *object ) const;
- inline void DeleteContents(const int destroy) { destroy_data = destroy; }
- // Instruct it to destroy user data
- // when deleting nodes
- // this function allows the sorting of arbitrary lists by giving
- // a function to compare two list elements.
- 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);
- wxObject *FirstThat(wxListIterateFunction func);
- void ForEach(wxListIterateFunction func);
- wxObject *LastThat(wxListIterateFunction func);
+ // functions for iterating over the list
+ void *FirstThat(wxListIterateFunction func);
+ void ForEach(wxListIterateFunction func);
+ void *LastThat(wxListIterateFunction func);
+
+private:
+ // helpers
+ // common part of all ctors
+ 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
+ wxNodeBase *AppendCommon(wxNodeBase *node);
+ // free node's data and node itself
+ void DoDeleteNode(wxNodeBase *node);
+
+ size_t m_count; // number of elements in the list
+ bool m_destroy; // destroy user data when deleting list items?
+ wxNodeBase *m_nodeFirst, // pointers to the head and tail of the list
+ *m_nodeLast;
+
+ wxKeyType m_keyType; // type of our keys (may be wxKEY_NONE)
};
-// String list class. N.B. this always copies strings
-// with Add and deletes them itself.
-class WXDLLEXPORT wxStringList: public wxList
+// -----------------------------------------------------------------------------
+// macros for definition of "template" list type
+// -----------------------------------------------------------------------------
+
+// and now some heavy magic...
+
+// 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-derived type)
+//
+// implementation details:
+// 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
+//
+// 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.
+//
+// 3. The macro which is usually used (WX_DECLARE_LIST) is defined in terms of
+// a more generic WX_DECLARE_LIST_2 macro which, in turn, uses the most
+// generic WX_DECLARE_LIST_3 one. The last macro adds a sometimes
+// interesting capability to store polymorphic objects in the list and is
+// particularly useful with, for example, "wxWindow *" list where the
+// wxWindowBase pointers are put into the list, but wxWindow pointers are
+// retrieved from it.
+
+#define WX_DECLARE_LIST_3(T, Tbase, name, nodetype) \
+ typedef int (*wxSortFuncFor_##name)(const T *, const T *); \
+ \
+ class WXDLLEXPORT nodetype : public wxNodeBase \
+ { \
+ public: \
+ nodetype(wxListBase *list = (wxListBase *)NULL, \
+ nodetype *previous = (nodetype *)NULL, \
+ nodetype *next = (nodetype *)NULL, \
+ T *data = (T *)NULL, \
+ const wxListKey& key = wxDefaultListKey) \
+ : wxNodeBase(list, previous, next, data, key) { } \
+ \
+ nodetype *GetNext() const \
+ { return (nodetype *)wxNodeBase::GetNext(); } \
+ nodetype *GetPrevious() const \
+ { return (nodetype *)wxNodeBase::GetPrevious(); } \
+ \
+ T *GetData() const \
+ { return (T *)wxNodeBase::GetData(); } \
+ void SetData(T *data) \
+ { wxNodeBase::SetData(data); } \
+ \
+ virtual void DeleteData(); \
+ }; \
+ \
+ class WXDLLEXPORT name : public wxListBase \
+ { \
+ public: \
+ typedef nodetype Node; \
+ \
+ name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType) \
+ { } \
+ name(size_t count, T *elements[]) \
+ : wxListBase(count, (void **)elements) { } \
+ \
+ nodetype *GetFirst() const \
+ { return (nodetype *)wxListBase::GetFirst(); } \
+ nodetype *GetLast() const \
+ { return (nodetype *)wxListBase::GetLast(); } \
+ \
+ nodetype *Item(size_t index) const \
+ { return (nodetype *)wxListBase::Item(index); } \
+ \
+ T *operator[](size_t index) const \
+ { \
+ nodetype *node = Item(index); \
+ return node ? (T*)(node->GetData()) : (T*)NULL; \
+ } \
+ \
+ nodetype *Append(Tbase *object) \
+ { return (nodetype *)wxListBase::Append(object); } \
+ nodetype *Insert(Tbase *object) \
+ { return (nodetype *)Insert((nodetype*)NULL, object); } \
+ nodetype *Insert(nodetype *prev, Tbase *object) \
+ { return (nodetype *)wxListBase::Insert(prev, object); } \
+ \
+ nodetype *Append(long key, void *object) \
+ { return (nodetype *)wxListBase::Append(key, object); } \
+ nodetype *Append(const wxChar *key, void *object) \
+ { return (nodetype *)wxListBase::Append(key, object); } \
+ \
+ nodetype *DetachNode(nodetype *node) \
+ { return (nodetype *)wxListBase::DetachNode(node); } \
+ bool DeleteNode(nodetype *node) \
+ { return wxListBase::DeleteNode(node); } \
+ bool DeleteObject(Tbase *object) \
+ { return wxListBase::DeleteObject(object); } \
+ \
+ nodetype *Find(Tbase *object) const \
+ { return (nodetype *)wxListBase::Find(object); } \
+ \
+ virtual nodetype *Find(const wxListKey& key) const \
+ { return (nodetype *)wxListBase::Find(key); } \
+ \
+ int IndexOf(Tbase *object) const \
+ { return wxListBase::IndexOf(object); } \
+ \
+ void Sort(wxSortFuncFor_##name func) \
+ { wxListBase::Sort((wxSortCompareFunction)func); } \
+ \
+ protected: \
+ wxNodeBase *CreateNode(wxNodeBase *prev, wxNodeBase *next, \
+ void *data, \
+ const wxListKey& key = wxDefaultListKey) \
+ { \
+ return new nodetype(this, \
+ (nodetype *)prev, (nodetype *)next, \
+ (T *)data, key); \
+ } \
+ }
+
+#define WX_DECLARE_LIST_2(elementtype, listname, nodename) \
+ WX_DECLARE_LIST_3(elementtype, elementtype, listname, nodename)
+
+#define WX_DECLARE_LIST(elementtype, listname) \
+ typedef elementtype _WX_LIST_ITEM_TYPE_##listname; \
+ WX_DECLARE_LIST_2(elementtype, listname, wx##listname##Node)
+
+// this macro must be inserted in your program after
+// #include <wx/listimpl.cpp>
+#define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
+
+// =============================================================================
+// now we can define classes 100% compatible with the old ones
+// =============================================================================
+
+// ----------------------------------------------------------------------------
+// commonly used list classes
+// ----------------------------------------------------------------------------
+
+#ifdef wxLIST_COMPATIBILITY
+
+// -----------------------------------------------------------------------------
+// wxList compatibility class: in fact, it's a list of wxObjects
+// -----------------------------------------------------------------------------
+
+WX_DECLARE_LIST_2(wxObject, wxObjectList, wxObjectListNode);
+
+class WXDLLEXPORT wxList : public wxObjectList
{
- DECLARE_DYNAMIC_CLASS(wxStringList)
-
- public:
- wxStringList(void);
- wxStringList(const char *first ...);
- ~wxStringList(void);
-
- virtual wxNode *Add(const char *s);
- virtual void Delete(const char *s);
- virtual char **ListToArray(const bool new_copies = FALSE) const;
- virtual void Sort(void);
- virtual bool Member(const char *s) const;
+public:
+ wxList(int key_type = wxKEY_NONE) : wxObjectList((wxKeyType)key_type) { }
+
+ // compatibility methods
+ void Sort(wxSortCompareFunction compfunc) { wxListBase::Sort(compfunc); }
+
+ wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
};
+// -----------------------------------------------------------------------------
+// wxStringList class for compatibility with the old code
+// -----------------------------------------------------------------------------
+
+WX_DECLARE_LIST_2(wxChar, wxStringListBase, wxStringListNode);
+
+class WXDLLEXPORT wxStringList : public wxStringListBase
+{
+public:
+ // ctors and such
+ // default
+ wxStringList() { DeleteContents(TRUE); }
+ wxStringList(const wxChar *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 wxChar *s)
+ { return (wxNode *)wxStringListBase::Append(copystring(s)); }
+
+ bool Delete(const wxChar *s);
+
+ wxChar **ListToArray(bool new_copies = FALSE) const;
+ bool Member(const wxChar *s) const;
+
+ // alphabetic sort
+ void Sort();
+
+private:
+ void DoCopy(const wxStringList&); // common part of copy ctor and operator=
+};
+
+#endif // wxLIST_COMPATIBILITY
+
#endif
- // __LISTH__
+ // _WX_LISTH__
projects / wxWidgets.git / blobdiff