X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0b9ab0bd824b6b9c93849928d67de1ec71e7c167..49d8a7819b3a04c5a51a4e73c3d5b41d8082972c:/include/wx/object.h diff --git a/include/wx/object.h b/include/wx/object.h index 3384b88562..e24fc89e1c 100644 --- a/include/wx/object.h +++ b/include/wx/object.h @@ -1,11 +1,11 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: object.h +// Name: wx/object.h // Purpose: wxObject class, plus run-time type information macros // Author: Julian Smart // Modified by: Ron Lee // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) 1997 Julian Smart and Markus Holzem +// Copyright: (c) 1997 Julian Smart // (c) 2001 Ron Lee // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -13,39 +13,64 @@ #ifndef _WX_OBJECTH__ #define _WX_OBJECTH__ -#ifdef __GNUG__ -#pragma interface "object.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#include "wx/defs.h" #include "wx/memory.h" -class WXDLLEXPORT wxObject; +class WXDLLIMPEXP_FWD_BASE wxObject; +class WXDLLIMPEXP_FWD_BASE wxString; -#if wxUSE_DYNAMIC_CLASSES +#ifndef wxUSE_EXTENDED_RTTI +#define wxUSE_EXTENDED_RTTI 0 +#endif + +#define DECLARE_CLASS_INFO_ITERATORS() \ + class WXDLLIMPEXP_BASE const_iterator \ + { \ + typedef wxHashTable_Node Node; \ + public: \ + typedef const wxClassInfo* value_type; \ + typedef const value_type& const_reference; \ + typedef const_iterator itor; \ + typedef value_type* ptr_type; \ + \ + Node* m_node; \ + wxHashTable* m_table; \ + public: \ + typedef const_reference reference_type; \ + typedef ptr_type pointer_type; \ + \ + const_iterator(Node* node, wxHashTable* table) \ + : m_node(node), m_table(table) { } \ + const_iterator() : m_node(NULL), m_table(NULL) { } \ + value_type operator*() const; \ + itor& operator++(); \ + const itor operator++(int); \ + bool operator!=(const itor& it) const \ + { return it.m_node != m_node; } \ + bool operator==(const itor& it) const \ + { return it.m_node == m_node; } \ + }; \ + \ + static const_iterator begin_classinfo(); \ + static const_iterator end_classinfo(); + +#if wxUSE_EXTENDED_RTTI +#include "wx/xti.h" +#else // ---------------------------------------------------------------------------- // conditional compilation // ---------------------------------------------------------------------------- -#ifdef GetClassName -#undef GetClassName -#endif -#ifdef GetClassInfo -#undef GetClassInfo -#endif - -class WXDLLEXPORT wxClassInfo; -class WXDLLEXPORT wxHashTable; - -#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) -#include "wx/ioswrap.h" -#endif - +class WXDLLIMPEXP_FWD_BASE wxClassInfo; +class WXDLLIMPEXP_FWD_BASE wxHashTable; +class WXDLLIMPEXP_FWD_BASE wxObject; +class WXDLLIMPEXP_FWD_BASE wxPluginLibrary; +class WXDLLIMPEXP_FWD_BASE wxObjectRefData; +class WXDLLIMPEXP_FWD_BASE wxHashTable_Node; // ---------------------------------------------------------------------------- // wxClassInfo @@ -53,38 +78,48 @@ class WXDLLEXPORT wxHashTable; typedef wxObject *(*wxObjectConstructorFn)(void); -class WXDLLEXPORT wxClassInfo +class WXDLLIMPEXP_BASE wxClassInfo { + friend class WXDLLIMPEXP_FWD_BASE wxObject; + friend WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name); public: - wxClassInfo::wxClassInfo(const wxChar *className, - const wxChar *baseName1, - const wxChar *baseName2, - int size, - wxObjectConstructorFn ctor) + wxClassInfo( const wxChar *className, + const wxClassInfo *baseInfo1, + const wxClassInfo *baseInfo2, + int size, + wxObjectConstructorFn ctor ) : m_className(className) - , m_baseClassName1(baseName1) - , m_baseClassName2(baseName2) , m_objectSize(size) , m_objectConstructor(ctor) - , m_baseInfo1(0) - , m_baseInfo2(0) + , m_baseInfo1(baseInfo1) + , m_baseInfo2(baseInfo2) , m_next(sm_first) - { sm_first = this; } + { + sm_first = this; + Register(); + } + + ~wxClassInfo(); - wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; } + wxObject *CreateObject() const + { return m_objectConstructor ? (*m_objectConstructor)() : 0; } + bool IsDynamic() const { return (NULL != m_objectConstructor); } const wxChar *GetClassName() const { return m_className; } - const wxChar *GetBaseClassName1() const { return m_baseClassName1; } - const wxChar *GetBaseClassName2() const { return m_baseClassName2; } + const wxChar *GetBaseClassName1() const + { return m_baseInfo1 ? m_baseInfo1->GetClassName() : NULL; } + const wxChar *GetBaseClassName2() const + { return m_baseInfo2 ? m_baseInfo2->GetClassName() : NULL; } const wxClassInfo *GetBaseClass1() const { return m_baseInfo1; } const wxClassInfo *GetBaseClass2() const { return m_baseInfo2; } int GetSize() const { return m_objectSize; } - wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; } + wxObjectConstructorFn GetConstructor() const + { return m_objectConstructor; } static const wxClassInfo *GetFirst() { return sm_first; } const wxClassInfo *GetNext() const { return m_next; } - static wxClassInfo *FindClass(const wxChar *className); - + static wxClassInfo *FindClass(const wxString& className); + // Climb upwards through inheritance hierarchy. // Dual inheritance is catered for. @@ -96,22 +131,13 @@ public: ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) ); } - // Initializes parent pointers and hash table for fast searching. - - static void InitializeClasses(); - - // Cleans up hash table used for fast searching. - - static void CleanUpClasses(); - -public: + DECLARE_CLASS_INFO_ITERATORS() +private: const wxChar *m_className; - const wxChar *m_baseClassName1; - const wxChar *m_baseClassName2; int m_objectSize; wxObjectConstructorFn m_objectConstructor; - // Pointers to base wxClassInfos: set in InitializeClasses + // Pointers to base wxClassInfos const wxClassInfo *m_baseInfo1; const wxClassInfo *m_baseInfo2; @@ -123,45 +149,74 @@ public: wxClassInfo *m_next; static wxHashTable *sm_classTable; -}; -WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name); +protected: + // registers the class + void Register(); + void Unregister(); + DECLARE_NO_COPY_CLASS(wxClassInfo) +}; + +WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name); // ---------------------------------------------------------------------------- // Dynamic class macros // ---------------------------------------------------------------------------- -#define DECLARE_DYNAMIC_CLASS(name) \ - public: \ - static wxClassInfo sm_class##name; \ - virtual wxClassInfo *GetClassInfo() const \ - { return &name::sm_class##name; } +#define DECLARE_ABSTRACT_CLASS(name) \ + public: \ + static wxClassInfo ms_classInfo; \ + virtual wxClassInfo *GetClassInfo() const; + +#define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \ + DECLARE_NO_ASSIGN_CLASS(name) \ + DECLARE_DYNAMIC_CLASS(name) + +#define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \ + DECLARE_NO_COPY_CLASS(name) \ + DECLARE_DYNAMIC_CLASS(name) + +#define DECLARE_DYNAMIC_CLASS(name) \ + DECLARE_ABSTRACT_CLASS(name) \ + static wxObject* wxCreateObject(); -#define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name) #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name) + +// common part of the macros below +#define wxIMPLEMENT_CLASS_COMMON(name, basename, baseclsinfo2, func) \ + wxClassInfo name::ms_classInfo(wxT(#name), \ + &basename::ms_classInfo, \ + baseclsinfo2, \ + (int) sizeof(name), \ + (wxObjectConstructorFn) func); \ + \ + wxClassInfo *name::GetClassInfo() const \ + { return &name::ms_classInfo; } + +#define wxIMPLEMENT_CLASS_COMMON1(name, basename, func) \ + wxIMPLEMENT_CLASS_COMMON(name, basename, NULL, func) + +#define wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, func) \ + wxIMPLEMENT_CLASS_COMMON(name, basename1, &basename2::ms_classInfo, func) + // ----------------------------------- // for concrete classes // ----------------------------------- // Single inheritance with one base class - -#define IMPLEMENT_DYNAMIC_CLASS(name, basename) \ - wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name() \ - { return new name; } \ - wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename), \ - 0, (int) sizeof(name), \ - (wxObjectConstructorFn) wxConstructorFor##name); +#define IMPLEMENT_DYNAMIC_CLASS(name, basename) \ + wxIMPLEMENT_CLASS_COMMON1(name, basename, name::wxCreateObject) \ + wxObject* name::wxCreateObject() \ + { return new name; } // Multiple inheritance with two base classes - -#define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \ - wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name() \ - { return new name; } \ - wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1), \ - wxT(#basename2), (int) sizeof(name), \ - (wxObjectConstructorFn) wxConstructorFor##name); +#define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \ + wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, \ + name::wxCreateObject) \ + wxObject* name::wxCreateObject() \ + { return new name; } // ----------------------------------- // for abstract classes @@ -169,20 +224,20 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name); // Single inheritance with one base class -#define IMPLEMENT_ABSTRACT_CLASS(name, basename) \ - wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename), \ - 0, (int) sizeof(name), (wxObjectConstructorFn) 0); +#define IMPLEMENT_ABSTRACT_CLASS(name, basename) \ + wxIMPLEMENT_CLASS_COMMON1(name, basename, NULL) // Multiple inheritance with two base classes -#define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \ - wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1), \ - wxT(#basename2), (int) sizeof(name), \ - (wxObjectConstructorFn) 0); +#define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \ + wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, NULL) #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2 +#endif // !wxUSE_EXTENDED_RTTI + + // ----------------------------------- // for pluggable classes // ----------------------------------- @@ -195,32 +250,25 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name); #if wxUSE_NESTED_CLASSES -#if 0 -#define _DECLARE_DL_SENTINEL(name) \ - wxPluginSentinel m_pluginsentinel; - -#else - -#define _DECLARE_DL_SENTINEL(name) \ -class name##PluginSentinel { \ -private: \ - static const wxString sm_className; \ -public: \ - name##PluginSentinel(); \ - ~##name##PluginSentinel(); \ -}; \ +#define _DECLARE_DL_SENTINEL(name, exportdecl) \ +class exportdecl name##PluginSentinel { \ +private: \ + static const wxString sm_className; \ +public: \ + name##PluginSentinel(); \ + ~name##PluginSentinel(); \ +}; \ name##PluginSentinel m_pluginsentinel; -#endif #define _IMPLEMENT_DL_SENTINEL(name) \ const wxString name::name##PluginSentinel::sm_className(#name); \ name::name##PluginSentinel::name##PluginSentinel() { \ - wxDLManifestEntry *e = (wxDLManifestEntry*) wxDLManifestEntry::ms_classes.Get(#name); \ - if( e != 0 ) { e->Ref(); } \ + wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \ + if( e != 0 ) { e->RefObj(); } \ } \ - name::name##PluginSentinel::~##name##PluginSentinel() { \ - wxDLManifestEntry *e = (wxDLManifestEntry*) wxDLManifestEntry::ms_classes.Get(#name); \ - if( e != 0 ) { wxCHECK_RET( !e->Unref(), _T("premature library unlinking") ); } \ + name::name##PluginSentinel::~name##PluginSentinel() { \ + wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \ + if( e != 0 ) { e->UnrefObj(); } \ } #else @@ -230,197 +278,382 @@ name##PluginSentinel m_pluginsentinel; #endif // wxUSE_NESTED_CLASSES #define DECLARE_PLUGGABLE_CLASS(name) \ - DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name) - + DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT) #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \ - DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name) + DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT) + +#define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \ + DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo) +#define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) \ + DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo) #define IMPLEMENT_PLUGGABLE_CLASS(name, basename) \ IMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name) #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) \ IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name) - #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \ IMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name) #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \ IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name) +#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \ + IMPLEMENT_PLUGGABLE_CLASS(name, basename) +#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) \ + IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) +#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \ + IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) +#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \ + IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) -#define CLASSINFO(name) (&name::sm_class##name) - -#else // !wxUSE_DYNAMIC_CLASSES - - // No dynamic class system: so stub out the macros - -#define DECLARE_DYNAMIC_CLASS(name) -#define DECLARE_ABSTRACT_CLASS(name) -#define DECLARE_CLASS(name) -#define IMPLEMENT_DYNAMIC_CLASS(name, basename) -#define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) -#define IMPLEMENT_ABSTRACT_CLASS(name, basename) -#define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) -#define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS -#define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2 - -#define DECLARE_PLUGGABLE_CLASS(name) -#define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name) -#define IMPLEMENT_PLUGGABLE_CLASS(name, basename) -#define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) -#define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) -#define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) - -#endif // wxUSE_DYNAMIC_CLASSES - - -#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className) - - // Just seems a bit nicer-looking (pretend it's not a macro) +#define CLASSINFO(name) (&name::ms_classInfo) -#define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className) +#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo) - // to be replaced by dynamic_cast<> in the future +// Just seems a bit nicer-looking (pretend it's not a macro) +#define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo) +// this cast does some more checks at compile time as it uses static_cast +// internally +// +// note that it still has different semantics from dynamic_cast<> and so can't +// be replaced by it as long as there are any compilers not supporting it #define wxDynamicCast(obj, className) \ - (className *) wxCheckDynamicCast((wxObject*)(obj), &className::sm_class##className) - - // The 'this' pointer is always true, so use this version - // to cast the this pointer and avoid compiler warnings. + ((className *) wxCheckDynamicCast( \ + wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \ + wx_const_cast(className *, wx_static_cast(const className *, obj)))), \ + &className::ms_classInfo)) +// The 'this' pointer is always true, so use this version +// to cast the this pointer and avoid compiler warnings. #define wxDynamicCastThis(className) \ - (IsKindOf(&className::sm_class##className) ? (className *)(this) : (className *)0) - -#define wxConstCast(obj, className) ((className *)(obj)) - + (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0) #ifdef __WXDEBUG__ -inline void wxCheckCast(void *ptr) +inline void* wxCheckCast(void *ptr) { wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") ); + return ptr; } #define wxStaticCast(obj, className) \ - (wxCheckCast(wxDynamicCast(obj, className)), ((className *)(obj))) + ((className *)wxCheckCast(wxDynamicCast(obj, className))) #else // !__WXDEBUG__ -#define wxStaticCast(obj, className) ((className *)(obj)) +#define wxStaticCast(obj, className) \ + wx_const_cast(className *, wx_static_cast(const className *, obj)) #endif // __WXDEBUG__ +// ---------------------------------------------------------------------------- +// set up memory debugging macros +// ---------------------------------------------------------------------------- - // Unfortunately Borland seems to need this include. +/* + Which new/delete operator variants do we want? -#if wxUSE_STD_IOSTREAM \ - && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) \ - && defined(__BORLANDC__) -#if wxUSE_IOSTREAMH -#include -#else -#include + _WX_WANT_NEW_SIZET_WXCHAR_INT = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0) + _WX_WANT_DELETE_VOID = void operator delete (void * buf) + _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET = void operator delete (void *buf, const char *_fname, size_t _line) + _WX_WANT_DELETE_VOID_WXCHAR_INT = void operator delete(void *buf, wxChar*, int) + _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0) + _WX_WANT_ARRAY_DELETE_VOID = void operator delete[] (void *buf) + _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT = void operator delete[] (void* buf, wxChar*, int ) +*/ + +#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING + +// All compilers get this one +#define _WX_WANT_NEW_SIZET_WXCHAR_INT + +// Everyone except Visage gets the next one +#ifndef __VISAGECPP__ + #define _WX_WANT_DELETE_VOID +#endif + +// Only visage gets this one under the correct circumstances +#if defined(__VISAGECPP__) && __DEBUG_ALLOC__ + #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET #endif + +// Only VC++ 6 and CodeWarrior get overloaded delete that matches new +#if (defined(__VISUALC__) && (__VISUALC__ >= 1200)) || \ + (defined(__MWERKS__) && (__MWERKS__ >= 0x2400)) + #define _WX_WANT_DELETE_VOID_WXCHAR_INT #endif +// Now see who (if anyone) gets the array memory operators +#if wxUSE_ARRAY_MEMORY_OPERATORS + + // Everyone except Visual C++ (cause problems for VC++ - crashes) + #if !defined(__VISUALC__) + #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT + #endif + + // Everyone except Visual C++ (cause problems for VC++ - crashes) + #if !defined(__VISUALC__) + #define _WX_WANT_ARRAY_DELETE_VOID + #endif + + // Only CodeWarrior 6 or higher + #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400) + #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT + #endif + +#endif // wxUSE_ARRAY_MEMORY_OPERATORS + +#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING // ---------------------------------------------------------------------------- -// wxObject +// wxObjectRefData: ref counted data meant to be stored in wxObject // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxObjectRefData; +class WXDLLIMPEXP_BASE wxObjectRefData +{ + friend class WXDLLIMPEXP_FWD_BASE wxObject; -class WXDLLEXPORT wxObject +public: + wxObjectRefData() : m_count(1) { } + + int GetRefCount() const { return m_count; } + + void IncRef() { m_count++; } + void DecRef(); + +protected: + // this object should never be destroyed directly but only as a + // result of a DecRef() call: + virtual ~wxObjectRefData() { } + +private: + // our refcount: + int m_count; +}; + +// ---------------------------------------------------------------------------- +// wxObjectDataPtr: helper class to avoid memleaks because of missing calls +// to wxObjectRefData::DecRef +// ---------------------------------------------------------------------------- + +template +class wxObjectDataPtr +{ +public: + typedef T element_type; + + wxEXPLICIT wxObjectDataPtr(T *ptr = NULL) : m_ptr(ptr) {} + + // copy ctor + wxObjectDataPtr(const wxObjectDataPtr &tocopy) + : m_ptr(tocopy.m_ptr) + { + if (m_ptr) + m_ptr->IncRef(); + } + + ~wxObjectDataPtr() + { + if (m_ptr) + m_ptr->DecRef(); + } + + T *get() const { return m_ptr; } + T *operator->() const { return get(); } + + void reset(T *ptr) + { + if (m_ptr) + m_ptr->DecRef(); + m_ptr = ptr; + } + + wxObjectDataPtr& operator=(const wxObjectDataPtr &tocopy) + { + if (m_ptr) + m_ptr->DecRef(); + m_ptr = tocopy.m_ptr; + if (m_ptr) + m_ptr->IncRef(); + return *this; + } + + wxObjectDataPtr& operator=(T *ptr) + { + if (m_ptr) + m_ptr->DecRef(); + m_ptr = ptr; + if (m_ptr) + m_ptr->IncRef(); + return *this; + } + +private: + T *m_ptr; +}; + +// ---------------------------------------------------------------------------- +// wxObject: the root class of wxWidgets object hierarchy +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_BASE wxObject { -DECLARE_ABSTRACT_CLASS(wxObject) + DECLARE_ABSTRACT_CLASS(wxObject) public: - wxObject() : m_refData(0) {} + wxObject() { m_refData = NULL; } virtual ~wxObject() { UnRef(); } + wxObject(const wxObject& other) + { + m_refData = other.m_refData; + if (m_refData) + m_refData->m_count++; + } + + wxObject& operator=(const wxObject& other) + { + if ( this != &other ) + { + Ref(other); + } + return *this; + } + bool IsKindOf(wxClassInfo *info) const; -#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING - void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0); -#ifndef __VISAGECPP__ - void operator delete (void * buf); -#elif __DEBUG_ALLOC__ - void operator delete (void *buf, const char *_fname, size_t _line); + // Turn on the correct set of new and delete operators + +#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT + void *operator new ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 ); #endif - // VC++ 6.0 +#ifdef _WX_WANT_DELETE_VOID + void operator delete ( void * buf ); +#endif -#if defined(__VISUALC__) && (__VISUALC__ >= 1200) - void operator delete(void *buf, wxChar*, int); +#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET + void operator delete ( void *buf, const char *_fname, size_t _line ); #endif - // Causes problems for VC++ +#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT + void operator delete ( void *buf, const wxChar*, int ); +#endif -#if wxUSE_ARRAY_MEMORY_OPERATORS && !defined(__VISUALC__) && !defined( __MWERKS__) - void *operator new[] (size_t size, wxChar *fileName = 0, int lineNum = 0); - void operator delete[] (void *buf); +#ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT + void *operator new[] ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 ); #endif -#ifdef __MWERKS__ - void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0); - void *operator new[] (size_t size) { return operator new[] ( size, 0, 0 ) ; } - void operator delete[] (void *buf); +#ifdef _WX_WANT_ARRAY_DELETE_VOID + void operator delete[] ( void *buf ); #endif -#endif // Debug & memory tracing +#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT + void operator delete[] (void* buf, const wxChar*, int ); +#endif + // ref counted data handling methods -#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) - virtual void Dump(wxSTD ostream& str); -#endif + // get/set + wxObjectRefData *GetRefData() const { return m_refData; } + void SetRefData(wxObjectRefData *data) { m_refData = data; } - // make a 'clone' of the object - + // make a 'clone' of the object void Ref(const wxObject& clone); - // destroy a reference - + // destroy a reference void UnRef(); - inline wxObjectRefData *GetRefData() const { return m_refData; } - inline void SetRefData(wxObjectRefData *data) { m_refData = data; } + // Make sure this object has only one reference + void UnShare() { AllocExclusive(); } + + // check if this object references the same data as the other one + bool IsSameAs(const wxObject& o) const { return m_refData == o.m_refData; } protected: - wxObjectRefData *m_refData; -}; + // ensure that our data is not shared with anybody else: if we have no + // data, it is created using CreateRefData() below, if we have shared data + // it is copied using CloneRefData(), otherwise nothing is done + void AllocExclusive(); + // both methods must be implemented if AllocExclusive() is used, not pure + // virtual only because of the backwards compatibility reasons -class WXDLLEXPORT wxObjectRefData -{ - friend class wxObject; + // create a new m_refData + virtual wxObjectRefData *CreateRefData() const; -public: - wxObjectRefData() : m_count(1) {} - virtual ~wxObjectRefData() {} + // create a new m_refData initialized with the given one + virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const; - inline int GetRefCount() const { return m_count; } -private: - int m_count; + wxObjectRefData *m_refData; }; - inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo) { - return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : 0; + return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL; } -#ifdef __WXDEBUG__ -#ifndef WXDEBUG_NEW -#define WXDEBUG_NEW new(__TFILE__,__LINE__) -#endif +#if wxUSE_EXTENDED_RTTI +class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject +{ + friend class WXDLLIMPEXP_FWD_BASE wxDynamicClassInfo ; +public: + // instantiates this object with an instance of its superclass + wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ; + virtual ~wxDynamicObject(); + + void SetProperty (const wxChar *propertyName, const wxxVariant &value); + wxxVariant GetProperty (const wxChar *propertyName) const ; + + // get the runtime identity of this object + wxClassInfo *GetClassInfo() const + { +#ifdef _MSC_VER + return (wxClassInfo*) m_classInfo; #else -#define WXDEBUG_NEW new + wxDynamicClassInfo *nonconst = wx_const_cast(wxDynamicClassInfo *, m_classInfo); + return wx_static_cast(wxClassInfo *, nonconst); #endif + } - // Redefine new to be the debugging version. This doesn't - // work with all compilers, in which case you need to - // use WXDEBUG_NEW explicitly if you wish to use the debugging version. + wxObject* GetSuperClassInstance() const + { + return m_superClassInstance ; + } +private : + // removes an existing runtime-property + void RemoveProperty( const wxChar *propertyName ) ; -#if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS -#define new new(__TFILE__,__LINE__) + // renames an existing runtime-property + void RenameProperty( const wxChar *oldPropertyName , const wxChar *newPropertyName ) ; + + wxObject *m_superClassInstance ; + const wxDynamicClassInfo *m_classInfo; + struct wxDynamicObjectInternal; + wxDynamicObjectInternal *m_data; +}; #endif -#endif // _WX_OBJECTH__ +// ---------------------------------------------------------------------------- +// more debugging macros +// ---------------------------------------------------------------------------- -// vi:sts=4:sw=4:et +// Redefine new to be the debugging version. This doesn't work with all +// compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish +// to use the debugging version. + +#ifdef __WXDEBUG__ + #define WXDEBUG_NEW new(__TFILE__,__LINE__) + + #if wxUSE_DEBUG_NEW_ALWAYS + #if wxUSE_GLOBAL_MEMORY_OPERATORS + #define new WXDEBUG_NEW + #elif defined(__VISUALC__) + // Including this file redefines new and allows leak reports to + // contain line numbers + #include "wx/msw/msvcrt.h" + #endif + #endif // wxUSE_DEBUG_NEW_ALWAYS +#else // !__WXDEBUG__ + #define WXDEBUG_NEW new +#endif // __WXDEBUG__/!__WXDEBUG__ + +#endif // _WX_OBJECTH__