/////////////////////////////////////////////////////////////////////////////
-// Name: list.h
+// Name: wx/list.h
// Purpose: wxList, wxStringList classes
// Author: Julian Smart
// Modified by: VZ at 16/11/98: WX_DECLARE_LIST() and typesafe lists added
like the old class.
*/
-#ifndef _WX_LISTH__
-#define _WX_LISTH__
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && \
- !(defined(__MINGW32__) && __GNUC__ == 3 && __GNUC_MINOR__ == 2)
-#pragma interface "list.h"
-#endif
+#ifndef _WX_LIST_H_
+#define _WX_LIST_H_
// -----------------------------------------------------------------------------
// headers
// 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 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
#define WX_DECLARE_LIST_WITH_DECL(elT, liT, decl) \
WX_DECLARE_LIST_XO(elT*, liT, decl)
-#define WX_DECLARE_LIST_XO(elT, liT, decl) \
+#if !defined(__VISUALC__) || __VISUALC__ >= 1300 // == !VC6
+
+template<class T>
+class wxList_SortFunction
+{
+public:
+ wxList_SortFunction(wxSortCompareFunction f) : m_f(f) { }
+ bool operator()(const T& i1, const T& i2)
+ { return m_f((T*)&i1, (T*)&i2) < 0; }
+private:
+ wxSortCompareFunction m_f;
+};
+
+#define WX_LIST_SORTFUNCTION( elT, f ) wxList_SortFunction<elT>(f)
+#define WX_LIST_VC6_WORKAROUND(elT, liT, decl)
+
+#else // if defined( __VISUALC__ ) && __VISUALC__ < 1300 // == VC6
+
+#define WX_LIST_SORTFUNCTION( elT, f ) std::greater<elT>( f )
+#define WX_LIST_VC6_WORKAROUND(elT, liT, decl) \
decl liT; \
\
/* Workaround for broken VC6 STL incorrectly requires a std::greater<> */ \
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 ); \
} \
+ };
+
+// 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 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:
+
+ struct WXDLLIMPEXP_CORE Foo
+ {
+ static void Bar();
+ struct SomeInnerClass
+ {
+ friend class Foo; // comment this out to make it link
+ };
+ ~Foo()
+ {
+ Bar();
+ }
+ };
+
+ 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) \
+ decl _WX_LIST_HELPER_##liT \
+ { \
+ typedef elT _WX_LIST_ITEM_TYPE_##liT; \
+ public: \
+ static void DeleteFunction( _WX_LIST_ITEM_TYPE_##liT X ); \
}; \
\
+ WX_LIST_VC6_WORKAROUND(elT, liT, decl) \
decl liT : public std::list<elT> \
{ \
private: \
+ typedef std::list<elT> BaseListType; \
+ static BaseListType EmptyList; \
+ \
bool m_destroy; \
- private: \
- typedef elT _WX_LIST_ITEM_TYPE_##liT; \
- static void DeleteFunction( const _WX_LIST_ITEM_TYPE_##liT X ); \
+ \
public: \
- class compatibility_iterator \
+ 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; \
+ \
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* operator->() { return this; } \
const compatibility_iterator* operator->() const { return this; } \
\
- bool operator==(const compatibility_iterator& i) \
- { return (m_list == i.m_list) && (m_iter == i.m_iter); } \
- bool operator!=(const compatibility_iterator& i) \
+ bool operator==(const compatibility_iterator& i) const \
+ { \
+ wxASSERT_MSG( m_list && i.m_list, \
+ _T("comparing invalid iterators is illegal") ); \
+ return (m_list == i.m_list) && (m_iter == i.m_iter); \
+ } \
+ bool operator!=(const compatibility_iterator& i) const \
{ return !( operator==( i ) ); } \
operator bool() const \
{ return m_list ? m_iter != m_list->end() : false; } \
} \
compatibility_iterator GetPrevious() const \
{ \
+ if ( m_iter == m_list->begin() ) \
+ return compatibility_iterator(); \
+ \
iterator i = m_iter; \
return compatibility_iterator( m_list, --i ); \
} \
int IndexOf() const \
{ \
- return m_list ? \
- m_iter != m_list->end() ? \
- std::distance( m_list->begin(), m_iter ) : \
- wxNOT_FOUND : \
- wxNOT_FOUND; \
+ return *this ? std::distance( m_list->begin(), m_iter ) \
+ : wxNOT_FOUND; \
} \
}; \
public: \
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, \
void Erase( const compatibility_iterator& i ) \
{ \
if ( m_destroy ) \
- DeleteFunction( i->GetData() ); \
+ _WX_LIST_HELPER_##liT::DeleteFunction( i->GetData() ); \
erase( i.m_iter ); \
} \
bool DeleteNode( const compatibility_iterator& i ) \
void Clear() \
{ \
if ( m_destroy ) \
- std::for_each( begin(), end(), DeleteFunction ); \
+ std::for_each( begin(), end(), \
+ _WX_LIST_HELPER_##liT::DeleteFunction ); \
clear(); \
} \
- \
/* Workaround for broken VC6 std::list::sort() see above */ \
void Sort( wxSortCompareFunction compfunc ) \
- { sort( std::greater<elT>( 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) \
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)
WX_DECLARE_USER_EXPORTED_LIST(elementtype, listname, usergoo)
// this macro must be inserted in your program after
-// #include <wx/listimpl.cpp>
+// #include "wx/listimpl.cpp"
#define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
#define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
#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
-
-class WXDLLEXPORT wxObjectListNode;
-typedef wxObjectListNode wxNode;
// undef it to get rid of old, deprecated functions
#define wxLIST_COMPATIBILITY
union wxListKeyValue
{
long integer;
- wxChar *string;
+ wxString *string;
};
// a struct which may contain both types of keys
{ }
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()); }
+ { 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; }
- 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; }
~wxListKey()
{
if ( m_keyType == wxKEY_STRING )
- free(m_key.string);
+ delete m_key.string;
}
private:
extern WXDLLIMPEXP_DATA_BASE(wxListKey) wxDefaultListKey;
-class WXDLLIMPEXP_BASE wxListBase;
+class WXDLLIMPEXP_FWD_BASE wxListBase;
class WXDLLIMPEXP_BASE wxNodeBase
{
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
- 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
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;
// 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()
-private:
- // common part of all ctors
- void Init(wxKeyType keyType = wxKEY_NONE); // Must be declared before it's used (for VC++ 1.5)
+
public:
// default ctor & dtor
wxListBase(wxKeyType keyType = wxKEY_NONE)
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
// 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)
void Reverse();
void DeleteNodes(wxNodeBase* first, wxNodeBase* last);
private:
+
+ // common part of all ctors
+ void Init(wxKeyType keyType = wxKEY_NONE);
+
// helpers
// common part of copy ctor and assignment operator
void DoCopy(const wxListBase& list);
void SetData(T *data) \
{ wxNodeBase::SetData(data); } \
\
+ protected: \
virtual void DeleteData(); \
\
DECLARE_NO_COPY_CLASS(nodetype) \
{ \
public: \
typedef nodetype Node; \
- typedef Node* compatibility_iterator; \
+ classexp compatibility_iterator \
+ { \
+ public: \
+ compatibility_iterator(Node *ptr = NULL) : m_ptr(ptr) { } \
+ \
+ Node *operator->() const { return m_ptr; } \
+ operator Node *() const { return m_ptr; } \
+ \
+ private: \
+ Node *m_ptr; \
+ }; \
\
name(wxKeyType keyType = wxKEY_NONE) : wxListBase(keyType) \
{ } \
: 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(); } \
{ return wxListBase::DeleteNode(node); } \
bool DeleteObject(Tbase *object) \
{ return wxListBase::DeleteObject(object); } \
- void Erase(compatibility_iterator it) \
+ void Erase(nodetype *it) \
{ DeleteNode(it); } \
\
nodetype *Find(const Tbase *object) const \
typedef base_value_type& base_reference; \
typedef const base_value_type& const_base_reference; \
\
- class iterator \
+ classexp iterator \
{ \
typedef name list; \
public: \
{ return *(pointer_type)m_node->GetDataPtr(); } \
ptrop \
itor& operator++() { m_node = m_node->GetNext(); return *this; }\
- itor operator++(int) \
+ const itor operator++(int) \
{ itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
itor& operator--() \
{ \
m_node = m_node ? m_node->GetPrevious() : m_init; \
return *this; \
} \
- itor operator--(int) \
+ const itor operator--(int) \
{ \
itor tmp = *this; \
m_node = m_node ? m_node->GetPrevious() : m_init; \
bool operator==(const itor& it) const \
{ return it.m_node == m_node; } \
}; \
- class const_iterator \
+ classexp const_iterator \
{ \
typedef name list; \
public: \
{ return *(pointer_type)m_node->GetDataPtr(); } \
ptrop \
itor& operator++() { m_node = m_node->GetNext(); return *this; }\
- itor operator++(int) \
+ const itor operator++(int) \
{ itor tmp = *this; m_node = m_node->GetNext(); return tmp; }\
itor& operator--() \
{ \
m_node = m_node ? m_node->GetPrevious() : m_init; \
return *this; \
} \
- itor operator--(int) \
+ const itor operator--(int) \
{ \
itor tmp = *this; \
m_node = m_node ? m_node->GetPrevious() : m_init; \
bool operator==(const itor& it) const \
{ return it.m_node == m_node; } \
}; \
- class reverse_iterator \
+ classexp reverse_iterator \
{ \
typedef name list; \
public: \
ptrop \
itor& operator++() \
{ m_node = m_node->GetPrevious(); return *this; } \
- itor operator++(int) \
+ const itor operator++(int) \
{ itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\
itor& operator--() \
{ m_node = m_node ? m_node->GetNext() : m_init; return *this; } \
- itor operator--(int) \
+ const itor operator--(int) \
{ \
itor tmp = *this; \
m_node = m_node ? m_node->GetNext() : m_init; \
bool operator==(const itor& it) const \
{ return it.m_node == m_node; } \
}; \
- class const_reverse_iterator \
+ classexp const_reverse_iterator \
{ \
typedef name list; \
public: \
ptrop \
itor& operator++() \
{ m_node = m_node->GetPrevious(); return *this; } \
- itor operator++(int) \
+ const itor operator++(int) \
{ itor tmp = *this; m_node = m_node->GetPrevious(); return tmp; }\
itor& operator--() \
{ m_node = m_node ? m_node->GetNext() : m_init; return *this;}\
- itor operator--(int) \
+ const itor operator--(int) \
{ \
itor tmp = *this; \
m_node = m_node ? m_node->GetNext() : m_init; \
\
wxEXPLICIT name(size_type n, const_reference v = value_type()) \
{ assign(n, v); } \
- name(const_iterator first, const_iterator last) \
+ name(const const_iterator& first, const const_iterator& last) \
{ assign(first, last); } \
iterator begin() { return iterator(GetFirst(), GetLast()); } \
const_iterator begin() const \
bool empty() const { return IsEmpty(); } \
reference front() { return *begin(); } \
const_reference front() const { return *begin(); } \
- reference back() { return *--end(); } \
- const_reference back() const { return *--end(); } \
+ reference back() { iterator tmp = end(); return *--tmp; } \
+ const_reference back() const { const_iterator tmp = end(); return *--tmp; }\
void push_front(const_reference v = value_type()) \
{ Insert(GetFirst(), (const_base_reference)v); } \
void pop_front() { DeleteNode(GetFirst()); } \
void push_back(const_reference v = value_type()) \
{ Append((const_base_reference)v); } \
void pop_back() { DeleteNode(GetLast()); } \
- void assign(const_iterator first, const_iterator last) \
+ void assign(const_iterator first, const const_iterator& last) \
{ \
clear(); \
for(; first != last; ++first) \
for(size_type i = 0; i < n; ++i) \
Append((const_base_reference)v); \
} \
- iterator insert(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(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); \
} \
- void insert(iterator it, const_iterator first, 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); \
} \
- iterator erase(iterator it) \
+ iterator erase(const iterator& it) \
{ \
iterator next = iterator(it.m_node->GetNext(), GetLast()); \
DeleteNode(it.m_node); return next; \
} \
- iterator erase(iterator first, iterator last) \
+ iterator erase(const iterator& first, const iterator& last) \
{ \
iterator next = last; ++next; \
DeleteNodes(first.m_node, last.m_node); \
return next; \
} \
void clear() { Clear(); } \
- void splice(iterator it, name& l, iterator first, iterator last) \
+ void splice(const iterator& it, name& l, const iterator& first, const iterator& last)\
{ insert(it, first, last); l.erase(first, last); } \
- void splice(iterator it, name& l) \
+ void splice(const iterator& it, name& l) \
{ splice(it, l, l.begin(), l.end() ); } \
- void splice(iterator it, name& l, iterator first) \
+ void splice(const iterator& it, name& l, const iterator& first) \
{ \
iterator tmp = first; ++tmp; \
if(it == first || it == tmp) return; \
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; \
- 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; \
WX_DECLARE_LIST_PTR_2(elementtype, listname, wx##listname##Node, class usergoo)
// this macro must be inserted in your program after
-// #include <wx/listimpl.cpp>
+// #include "wx/listimpl.cpp"
#define WX_DEFINE_LIST(name) "don't forget to include listimpl.cpp!"
#define WX_DEFINE_EXPORTED_LIST(name) WX_DEFINE_LIST(name)
#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); }
#else
wxNode *Member(wxObject *object) const { return (wxNode *)Find(object); }
#endif
-
-private:
-#if !wxUSE_STL
- DECLARE_DYNAMIC_CLASS(wxList)
-#endif
};
#if !wxUSE_STL
// default
#ifdef wxWARN_COMPAT_LIST_USE
wxStringList();
- wxDEPRECATED( wxStringList(const wxChar *first ...) );
+ wxDEPRECATED( wxStringList(const wxChar *first ...) ); // FIXME-UTF8
#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)
- { Clear(); DoCopy(other); return *this; }
+ {
+ if (&other != this)
+ {
+ Clear();
+ DoCopy(other);
+ }
+ return *this;
+ }
// operations
// makes a copy of the string
private:
void DoCopy(const wxStringList&); // common part of copy ctor and operator=
-
- DECLARE_DYNAMIC_CLASS(wxStringList)
};
#else // if wxUSE_STL
(list).clear(); \
}
-#endif
- // _WX_LISTH__
+#endif // _WX_LISTH__
projects / wxWidgets.git / blobdiff