Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improvements to wxWeakRef and related classes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51187 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-01-13 01:12:13 +00:00
parent 0fb0ecc452
commit cc6ceca789
12 changed files with 983 additions and 309 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
include/wx/defs.h
View File

@@ -444,6 +444,21 @@ typedef short int WXTYPE;
#endif
#endif /* HAVE_WOSTREAM */
// ----------------------------------------------------------------------------
// other C++ features
// ----------------------------------------------------------------------------
#ifndef HAVE_PARTIAL_SPECIALIZATION
// be optimistic by default
#define HAVE_PARTIAL_SPECIALIZATION
#endif
#ifdef __VISUALC__
#if __VISUALC__ < 1310
#undef HAVE_PARTIAL_SPECIALIZATION
#endif
#endif // __VISUALC__
/* ---------------------------------------------------------------------------- */
/* portable calling conventions macros */
/* ---------------------------------------------------------------------------- */

87
include/wx/event.h
View File

@@ -39,6 +39,7 @@ class WXDLLIMPEXP_FWD_BASE wxList;
#endif // wxUSE_GUI
class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
class wxEventConnectionRef;
// ----------------------------------------------------------------------------
// Event types
@@ -2258,44 +2259,11 @@ protected:
DECLARE_NO_COPY_CLASS(wxEventHashTable)
};
// ----------------------------------------------------------------------------
// wxEventConnectionRef: A class that represents all connections between two event
// handlers and enables automatic disconnect when an event handler sink goes
// out of scope. Each connection/disconnect increases/decreases ref count, and
// when zero the node goes out of scope.
// ----------------------------------------------------------------------------
struct wxEventConnectionRef : public wxTrackerNode {
wxEventConnectionRef() : m_src(0), m_sink(0), m_refCount(0) { }
wxEventConnectionRef( wxEvtHandler *src, wxEvtHandler *sink );
virtual ~wxEventConnectionRef();
// The sink is being destroyed
virtual void OnObjectDestroy( );
virtual wxTrackerNodeType GetType( ){ return EventConnectionRef; }
void IncRef( ) { m_refCount++; }
void DecRef( );
protected:
wxEvtHandler *m_src, *m_sink;
int m_refCount;
friend class wxEvtHandler;
private:
// It makes no sense to copy objects of this class
wxEventConnectionRef& operator = (const wxEventConnectionRef& WXUNUSED(other)) { wxFAIL; return *this; }
};
// ----------------------------------------------------------------------------
// wxEvtHandler: the base class for all objects handling wxWidgets events
// ----------------------------------------------------------------------------
class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject, public wxTrackableBase
class WXDLLIMPEXP_BASE wxEvtHandler : public wxObject, public wxTrackable
{
public:
wxEvtHandler();
@@ -2463,12 +2431,61 @@ protected:
virtual void *DoGetClientData() const;
// Search tracker objects for event connection with this sink
wxEventConnectionRef *FindRefInTrackerList( wxEvtHandler *eventSink );
wxEventConnectionRef *FindRefInTrackerList(wxEvtHandler *eventSink);
private:
DECLARE_DYNAMIC_CLASS_NO_COPY(wxEvtHandler)
};
// ----------------------------------------------------------------------------
// wxEventConnectionRef represents all connections between two event handlers
// and enables automatic disconnect when an event handler sink goes out of
// scope. Each connection/disconnect increases/decreases ref count, and
// when it reaches zero the node goes out of scope.
// ----------------------------------------------------------------------------
class wxEventConnectionRef : public wxTrackerNode
{
public:
wxEventConnectionRef() : m_src(NULL), m_sink(NULL), m_refCount(0) { }
wxEventConnectionRef(wxEvtHandler *src, wxEvtHandler *sink)
: m_src(src), m_sink(sink), m_refCount(1)
{
m_sink->AddNode(this);
}
// The sink is being destroyed
virtual void OnObjectDestroy( )
{
if ( m_src )
m_src->OnSinkDestroyed( m_sink );
delete this;
}
virtual wxEventConnectionRef *ToEventConnection() { return this; }
void IncRef() { m_refCount++; }
void DecRef()
{
if ( !--m_refCount )
{
// The sink holds the only external pointer to this object
if ( m_sink )
m_sink->RemoveNode(this);
delete this;
}
}
private:
wxEvtHandler *m_src,
*m_sink;
int m_refCount;
friend class wxEvtHandler;
DECLARE_NO_ASSIGN_CLASS(wxEventConnectionRef)
};
// Post a message to the given eventhandler which will be processed during the
// next event loop iteration
inline void wxPostEvent(wxEvtHandler *dest, const wxEvent& event)

140
include/wx/tracker.h
View File

@@ -2,7 +2,7 @@
// Name: wx/tracker.h
// Purpose: Support class for object lifetime tracking (wxWeakRef<T>)
// Author: Arne Steinarson
// Created: 2007-12-28
// Created: 28 Dec 07
// RCS-ID: $Id$
// Copyright: (c) 2007 Arne Steinarson
// Licence: wxWindows licence
@@ -11,133 +11,73 @@
#ifndef _WX_TRACKER_H_
#define _WX_TRACKER_H_
#include "wx/defs.h"
// This structure represents an object tracker and is stored in a linked list
class wxEventConnectionRef;
// This class represents an object tracker and is stored in a linked list
// in the tracked object. It is only used in one of its derived forms.
struct wxTrackerNode {
wxTrackerNode( ) : m_nxt(0) { }
class WXDLLIMPEXP_BASE wxTrackerNode
{
public:
wxTrackerNode() : m_nxt(NULL) { }
virtual ~wxTrackerNode() { }
virtual void OnObjectDestroy( ) = 0;
// This is to tell the difference between different tracker node types.
// It's a replacement of dynamic_cast<> for this class since dynamic_cast
// may be disabled (and we don't have wxDynamicCast since wxTrackerNode
// is not derived wxObject).
enum wxTrackerNodeType { WeakRef, EventConnectionRef };
virtual wxTrackerNodeType GetType() = 0;
protected:
virtual void OnObjectDestroy() = 0;
virtual wxEventConnectionRef *ToEventConnection() { return NULL; }
private:
wxTrackerNode *m_nxt;
friend class wxTrackableBase; // For list access
friend class wxTrackable; // For list access
friend class wxEvtHandler; // For list access
};
// Add-on base class for a trackable object.
struct wxTrackableBase {
wxTrackableBase() : m_first(0) { }
~wxTrackableBase()
{
class wxTrackable
{
public:
wxTrackable() : m_first(NULL) { }
~wxTrackable()
{
// Notify all registered refs
wxTrackerNode *first;
while( m_first )
while ( m_first )
{
first = m_first;
first->OnObjectDestroy( );
RemoveNode(first);
wxTrackerNode * const first = m_first;
m_first = first->m_nxt;
first->OnObjectDestroy();
}
}
void AddNode( wxTrackerNode *prn )
void AddNode(wxTrackerNode *prn)
{
prn->m_nxt = m_first;
m_first = prn;
}
void RemoveNode( wxTrackerNode *prn )
void RemoveNode(wxTrackerNode *prn)
{
for( wxTrackerNode **pprn=&m_first; *pprn; pprn=&(*pprn)->m_nxt )
for ( wxTrackerNode **pprn = &m_first; *pprn; pprn = &(*pprn)->m_nxt )
{
if( *pprn==prn )
if ( *pprn == prn )
{
*pprn = prn->m_nxt;
return;
}
}
// Not found, an error.
wxASSERT( false );
wxFAIL_MSG( "removing invalid tracker node" );
}
wxTrackerNode* GetFirst( ){ return m_first; }
// If trying to copy this object, then do not copy its ref list.
wxTrackableBase& operator = (const wxTrackableBase& WXUNUSED(other)) { return *this; }
protected:
wxTrackerNode *GetFirst() const { return m_first; }
protected:
wxTrackerNode *m_first;
DECLARE_NO_COPY_CLASS(wxTrackable)
};
// The difference to wxTrackableBase is that this class adds
// a VTable to enable dynamic_cast query for wxTrackable.
struct wxTrackable : public wxTrackableBase
{
virtual ~wxTrackable(){ }
};
// Helper to decide if an object has a base class or not
// (strictly speaking, this test succeeds if a type is convertible
// to another type in some way.)
template<class T, class B>
struct wxHasBase{
static char Match( B* pb );
static int Match( ... );
enum { value = (sizeof(Match((T*)NULL))==sizeof(char)) };
};
// VC++ before 7.1 does not have partial template specialization
#ifdef __VISUALC__
#if __VISUALC__ < 1310
#define HAVE_NO_PARTIAL_SPECIALIZATION
#endif
#endif
#if defined(HAVE_DYNAMIC_CAST) && !defined(HAVE_NO_PARTIAL_SPECIALIZATION)
// A structure to cast to wxTrackableBase, using either static_cast<> or dynamic_cast<>.
template<class T,bool is_static>
struct wxTrackableCaster;
template <class T>
struct wxTrackableCaster<T,true> {
static wxTrackableBase* Cast(T* pt){ return static_cast<wxTrackableBase*>(pt); }
};
template <class T>
struct wxTrackableCaster<T,false> {
static wxTrackableBase* Cast(T* pt){ return dynamic_cast<wxTrackableBase*>(pt); }
};
#else
#if defined(HAVE_DYNAMIC_CAST)
// If we have dynamic_cast, default to that. For gcc, dynamic_cast<> does the job
// of both the dynamic and the static case. It could be that all compilers do it
// that way, rendering the specialization code above rednundant.
template <class T,bool is_static>
struct wxTrackableCaster {
static wxTrackableBase* Cast(T* pt){ return dynamic_cast<wxTrackableBase*>(pt); }
};
#else
// No dynamic_cast<> is available.
// We use static_cast<>, that gives support for wxEvtHandler and wxWindow references.
// We don't get weak refs to other wxObject derived types.
template <class T,bool is_static>
struct wxTrackableCaster {
static wxTrackableBase* Cast(T* pt){ return static_cast<wxTrackableBase*>(pt); }
};
#endif
#endif
#endif // _WX_TRACKER_H_

338
include/wx/weakref.h
View File

@@ -2,7 +2,7 @@
// Name: wx/weakref.h
// Purpose: wxWeakRef - Generic weak references for wxWidgets
// Author: Arne Steinarson
// Created: 2007-12-27
// Created: 27 Dec 07
// RCS-ID: $Id$
// Copyright: (c) 2007 Arne Steinarson
// Licence: wxWindows licence
@@ -11,19 +11,243 @@
#ifndef _WX_WEAKREF_H_
#define _WX_WEAKREF_H_
#include <wx/tracker.h>
#include "wx/tracker.h"
// A weak reference to an object of type T, where T has type wxTrackable
// as one of its base classes (in a static or dynamic sense).
template<class T>
class wxWeakRef : public wxTrackerNode
#include "wx/meta/convertible.h"
#include "wx/meta/int2type.h"
template <class T>
struct wxIsStaticTrackable
{
enum { value = wxConvertibleTo<T, wxTrackable>::value };
};
// Weak ref implementation when T has wxTrackable as a known base class
template <class T>
class wxWeakRefStatic : public wxTrackerNode
{
public:
typedef T element_type;
wxWeakRef(T *pobj = NULL) : m_pobj(NULL) { Assign(pobj); }
wxWeakRefStatic() : m_pobj(NULL) { }
virtual ~wxWeakRef() { Assign(NULL); }
void Release()
{
// Release old object if any
if ( m_pobj )
{
// Remove ourselves from object tracker list
wxTrackable *pt = static_cast<wxTrackable*>(m_pobj);
pt->RemoveNode(this);
m_pobj = NULL;
}
}
protected:
void Assign(T* pobj)
{
if ( m_pobj == pobj )
return;
Release();
// Now set new trackable object
if ( pobj )
{
// Add ourselves to object tracker list
wxTrackable *pt = static_cast<wxTrackable*>(pobj);
pt->AddNode(this);
m_pobj = pobj;
}
}
void AssignCopy( const wxWeakRefStatic& wr )
{
Assign( wr.m_pobj );
}
virtual void OnObjectDestroy()
{
// Tracked object itself removes us from list of trackers
wxASSERT( m_pobj!=NULL );
m_pobj = NULL;
}
T *m_pobj;
};
#ifdef HAVE_PARTIAL_SPECIALIZATION
template<class T,bool use_static>
struct wxWeakRefImpl;
// Intermediate class, to select the static case above.
template <class T>
struct wxWeakRefImpl<T, true> : public wxWeakRefStatic<T>
{
enum { value = 1 };
};
// Weak ref implementation when T does not have wxTrackable as known base class
template<class T>
struct wxWeakRefImpl<T, false> : public wxTrackerNode
{
void Release()
{
// Release old object if any
if ( m_pobj )
{
// Remove ourselves from object tracker list
m_ptbase->RemoveNode(this);
m_pobj = NULL;
m_ptbase = NULL;
}
}
protected:
wxWeakRefImpl() : m_pobj(NULL), m_ptbase(NULL) { }
// Assign receives most derived class here and can use that
template <class TDerived>
void Assign( TDerived* pobj )
{
AssignHelper( pobj, wxInt2Type<wxIsStaticTrackable<TDerived>::value>() );
}
template <class TDerived>
void AssignHelper(TDerived* pobj, wxInt2Type<true>)
{
wxTrackable *ptbase = static_cast<wxTrackable*>(pobj);
DoAssign( pobj, ptbase );
}
#ifdef HAVE_DYNAMIC_CAST
void AssignHelper(T* pobj, wxInt2Type<false>)
{
// A last way to get a trackable pointer
wxTrackable *ptbase = dynamic_cast<wxTrackable*>(pobj);
if ( ptbase )
{
DoAssign( pobj, ptbase );
}
else
{
wxFAIL_MSG( "Tracked class should inherit from wxTrackable" );
Release();
}
}
#endif // HAVE_DYNAMIC_CAST
void AssignCopy(const wxWeakRefImpl& wr)
{
DoAssign( wr.m_pobj, wr.m_ptbase );
}
void DoAssign( T* pobj, wxTrackable *ptbase ) {
if( m_pobj==pobj ) return;
Release();
// Now set new trackable object
if( pobj )
{
// Add ourselves to object tracker list
wxASSERT( ptbase );
ptbase->AddNode( this );
m_pobj = pobj;
m_ptbase = ptbase;
}
}
virtual void OnObjectDestroy()
{
// Tracked object itself removes us from list of trackers
wxASSERT( m_pobj!=NULL );
m_pobj = NULL;
m_ptbase = NULL;
}
T *m_pobj;
wxTrackable *m_ptbase;
};
#endif // HAVE_PARTIAL_SPECIALIZATION
// A weak reference to an object of type T, where T has type wxTrackable
// (usually statically but if not dynamic_cast<> is tried).
template <class T>
class wxWeakRef : public
#ifdef HAVE_PARTIAL_SPECIALIZATION
wxWeakRefImpl<T, wxIsStaticTrackable<T>::value>
#else
wxWeakRefStatic<T>
#endif
{
public:
// Default ctor
wxWeakRef() { }
// When we have the full type here, static_cast<> will always work
// (or give a straight compiler error).
template <class TDerived>
wxWeakRef(TDerived* pobj)
{
Assign(pobj);
}
template <class TDerived>
wxWeakRef<T>& operator=(TDerived* pobj)
{
Assign(pobj);
return *this;
}
wxWeakRef<T>& operator=(const wxWeakRef<T>& wr)
{
AssignCopy(wr);
return *this;
}
virtual ~wxWeakRef() { Release(); }
// Smart pointer functions
T& operator*() const { return *m_pobj; }
T* operator->() const { return m_pobj; }
T* get() const { return m_pobj; }
// test for pointer validity: defining conversion to unspecified_bool_type
// and not more obvious bool to avoid implicit conversions to integer types
typedef T *(wxWeakRef<T>::*unspecified_bool_type)() const;
operator unspecified_bool_type() const
{
return this->m_pobj ? &wxWeakRef<T>::get : NULL;
}
};
// Weak ref implementation assign objects are queried for wxTrackable
// using dynamic_cast<>
template<class T>
class wxWeakRefDynamic : public wxTrackerNode
{
public:
wxWeakRefDynamic() : m_pobj(NULL) { }
wxWeakRefDynamic(T* pobj) : m_pobj(pobj)
{
Assign(pobj);
}
virtual ~wxWeakRefDynamic() { Release(); }
// Smart pointer functions
T& operator * (){ wxASSERT(this->m_pobj); return *m_pobj; }
T* operator -> (){ wxASSERT(this->m_pobj); return m_pobj; }
T* operator = (T* pobj) { Assign(pobj); return m_pobj; }
T* get(){ return this->m_pobj; }
// operator T* (){ return this->m_pobj; }
// test for pointer validity: defining conversion to unspecified_bool_type
// and not more obvious bool to avoid implicit conversions to integer types
@@ -33,92 +257,68 @@ public:
return m_pobj ? &wxWeakRef<T>::get : NULL;
}
T * get() const
{
return m_pobj;
}
T* operator->()
{
wxASSERT(m_pobj != NULL);
return m_pobj;
}
T& operator*() const
{
wxASSERT(m_pobj != NULL);
return *m_pobj;
}
T* operator=(T *pobj)
{
Assign(pobj);
return m_pobj;
}
// Assign from another weak ref, point to same object
T* operator = (const wxWeakRef<T> &wr)
{
Assign(wr);
return m_pobj;
}
virtual void OnObjectDestroy()
T* operator = (const wxWeakRef<T> &wr) { Assign( wr.get() ); return this->m_pobj; }
void Release()
{
// Tracked object itself removes us from list of trackers
wxASSERT( m_pobj );
m_pobj = NULL;
}
protected:
friend class wxTrackableBase;
friend class wxEvtHandler;
virtual wxTrackerNodeType GetType() { return WeakRef; }
void Assign(T* pobj)
{
if ( m_pobj == pobj )
return;
// First release old object if any
if ( m_pobj )
// Release old object if any
if( m_pobj )
{
// Remove ourselves from object tracker list
// This does static_cast if available, otherwise it tries dynamic cast
wxTrackableBase *pt = wxTrackableCaster<T,wxHasBase<T,wxTrackableBase>::value >::Cast(m_pobj);
wxTrackable *pt = dynamic_cast<wxTrackable*>(m_pobj);
wxASSERT(pt);
pt->RemoveNode(this);
m_pobj = NULL;
}
}
protected:
void Assign(T *pobj)
{
if ( m_pobj == pobj )
return;
Release();
// Now set new trackable object
if ( pobj )
{
wxTrackableBase *pt = wxTrackableCaster<T,wxHasBase<T,wxTrackableBase>::value >::Cast(pobj);
if( pt )
// Add ourselves to object tracker list
wxTrackable *pt = dynamic_cast<wxTrackable*>(pobj);
if ( pt )
{
pt->AddNode( this );
pt->AddNode(this);
m_pobj = pobj;
}
else
{
// If the tracked we want to track does not support wxTackableBase, then
// log a message and keep the NULL object pointer.
wxLogWarning( _T("wxWeakRef::Assign - Type does not provide wxTrackableBase - resetting tracked object") );
// If the object we want to track does not support wxTackable, then
// log a message and keep the NULL object pointer.
wxFAIL_MSG( "Tracked class should inherit from wxTrackable" );
}
}
}
void AssignCopy(const wxWeakRefDynamic& wr)
{
Assign(wr.m_pobj);
}
virtual void OnObjectDestroy()
{
wxASSERT_MSG( m_pobj, "tracked object should have removed us itself" );
m_pobj = NULL;
}
T *m_pobj;
};
// Provide some basic types of weak references
class WXDLLIMPEXP_FWD_BASE wxObject;
class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
class WXDLLIMPEXP_FWD_CORE wxWindow;
class WXDLLIMPEXP_FWD_BASE wxWindow;
typedef wxWeakRef<wxObject> wxObjectRef;
typedef wxWeakRef<wxEvtHandler> wxEvtHandlerRef;
typedef wxWeakRef<wxWindow> wxWindowRef;