X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a095505c96a4ffbbfa559d9239bc8a6f75698da1..470402b9966ec0c9b0011193cb82bd6baa4a98c5:/include/wx/object.h diff --git a/include/wx/object.h b/include/wx/object.h index b215797a0e..c268f677b4 100644 --- a/include/wx/object.h +++ b/include/wx/object.h @@ -13,44 +13,26 @@ #ifndef _WX_OBJECTH__ #define _WX_OBJECTH__ -#if defined(__GNUG__) && !defined(__APPLE__) -#pragma interface "object.h" -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- -#include "wx/defs.h" #include "wx/memory.h" class WXDLLIMPEXP_BASE wxObject; -#if wxUSE_DYNAMIC_CLASSES - -#ifndef wxUSE_XTI -#define wxUSE_XTI 0 +#ifndef wxUSE_EXTENDED_RTTI +#define wxUSE_EXTENDED_RTTI 0 #endif -#if wxUSE_XTI - +#if wxUSE_EXTENDED_RTTI #include "wx/xti.h" - #else // ---------------------------------------------------------------------------- // conditional compilation // ---------------------------------------------------------------------------- -// this shouldn't be needed any longer as does it but it -// doesn't hurt neither -#ifdef GetClassName -#undef GetClassName -#endif -#ifdef GetClassInfo -#undef GetClassInfo -#endif - class WXDLLIMPEXP_BASE wxClassInfo; class WXDLLIMPEXP_BASE wxHashTable; class WXDLLIMPEXP_BASE wxObjectRefData; @@ -65,27 +47,31 @@ class WXDLLIMPEXP_BASE wxClassInfo { public: wxClassInfo( const wxChar *className, - const wxChar *baseName1, - const wxChar *baseName2, + 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; } @@ -106,19 +92,15 @@ 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(); - +#if WXWIN_COMPATIBILITY_2_4 + // Initializes parent pointers and hash table for fast searching. + wxDEPRECATED( static void InitializeClasses() ); + // Cleans up hash table used for fast searching. + wxDEPRECATED( static void CleanUpClasses() ); +#endif public: const wxChar *m_className; - const wxChar *m_baseClassName1; - const wxChar *m_baseClassName2; int m_objectSize; wxObjectConstructorFn m_objectConstructor; @@ -142,52 +124,77 @@ private: static wxClassInfo *GetBaseByName(const wxChar *name); DECLARE_NO_COPY_CLASS(wxClassInfo) + +protected: + // registers the class + void Register(); + void Unregister(); }; WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name); +#if WXWIN_COMPATIBILITY_2_4 +inline void wxClassInfo::InitializeClasses() {} +inline void wxClassInfo::CleanUpClasses() {} +#endif + // ---------------------------------------------------------------------------- // 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) \ +#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) \ +#define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \ + DECLARE_NO_COPY_CLASS(name) \ DECLARE_DYNAMIC_CLASS(name) -#define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name) +#define DECLARE_DYNAMIC_CLASS(name) \ + DECLARE_ABSTRACT_CLASS(name) \ + static wxObject* wxCreateObject(); + #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* 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* 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 @@ -195,21 +202,18 @@ WXDLLIMPEXP_BASE 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_XTI +#endif // !wxUSE_EXTENDED_RTTI // ----------------------------------- @@ -279,69 +283,41 @@ name##PluginSentinel m_pluginsentinel; #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 +#define CLASSINFO(name) (&name::ms_classInfo) - // 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) - -#define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) -#define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) -#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) -#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) -#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) -#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) - -#endif // wxUSE_DYNAMIC_CLASSES - -#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className) +#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo) // Just seems a bit nicer-looking (pretend it's not a macro) -#define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className) +#define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo) -// to be replaced by dynamic_cast<> in the future +// 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)) + ((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) - -#ifdef HAVE_CONST_CAST -#define wxConstCast(obj, className) const_cast(obj) -#else -#define wxConstCast(obj, className) ((className *)(obj)) -#endif - + (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__ @@ -401,39 +377,50 @@ inline void wxCheckCast(void *ptr) #endif // wxUSE_ARRAY_MEMORY_OPERATORS -#endif // WXDEBUG && wxUSE_MEMORY_TRACING +#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING -#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) -// needed by wxObject::Dump -#include "wx/iosfwrap.h" -#endif +// ---------------------------------------------------------------------------- +// wxObjectRefData: ref counted data meant to be stored in wxObject +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_BASE wxObjectRefData +{ + friend class WXDLLIMPEXP_BASE wxObject; + +public: + wxObjectRefData() : m_count(1) { } + virtual ~wxObjectRefData() { } + + int GetRefCount() const { return m_count; } + +private: + int m_count; +}; // ---------------------------------------------------------------------------- -// wxObject: the root class of wxWindows object hierarchy +// wxObject: the root class of wxWidgets object hierarchy // ---------------------------------------------------------------------------- class WXDLLIMPEXP_BASE wxObject { DECLARE_ABSTRACT_CLASS(wxObject) -private: - void InitFrom(const wxObject& other); - public: wxObject() { m_refData = NULL; } virtual ~wxObject() { UnRef(); } - + wxObject(const wxObject& other) - { - InitFrom(other); - } - + { + m_refData = other.m_refData; + if (m_refData) + m_refData->m_count++; + } + wxObject& operator=(const wxObject& other) { if ( this != &other ) { - UnRef(); - InitFrom(other); + Ref(other); } return *this; } @@ -471,11 +458,6 @@ public: void operator delete[] (void* buf, const wxChar*, int ); #endif - -#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) - virtual void Dump(wxSTD ostream& str); -#endif - // ref counted data handling methods // get/set @@ -488,13 +470,16 @@ public: // destroy a reference void UnRef(); + // Make sure this object has only one reference + void UnShare() { AllocExclusive(); } + protected: // 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 Unshare() is used, not pure virtual + // both methods must be implemented if AllocExclusive() is used, not pure virtual // only because of the backwards compatibility reasons // create a new m_refData @@ -506,49 +491,73 @@ protected: wxObjectRefData *m_refData; }; -// ---------------------------------------------------------------------------- -// wxObjectRefData: ref counted data meant to be stored in wxObject -// ---------------------------------------------------------------------------- - -class WXDLLIMPEXP_BASE wxObjectRefData +inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo) { - friend class WXDLLIMPEXP_BASE wxObject; + return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL; +} +#if wxUSE_EXTENDED_RTTI +class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject +{ + friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ; public: - wxObjectRefData() : m_count(1) { } - virtual ~wxObjectRefData() { } + // instantiates this object with an instance of its superclass + wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ; + virtual ~wxDynamicObject(); - int GetRefCount() const { return m_count; } + void SetProperty (const wxChar *propertyName, const wxxVariant &value); + wxxVariant GetProperty (const wxChar *propertyName) const ; -private: - int m_count; -}; + // get the runtime identity of this object + wxClassInfo *GetClassInfo() const + { +#ifdef _MSC_VER + return (wxClassInfo*) m_classInfo; +#else + return wx_const_cast(wxClassInfo *, m_classInfo); +#endif + } + wxObject* GetSuperClassInstance() const + { + return m_superClassInstance ; + } +private : + // removes an existing runtime-property + void RemoveProperty( const wxChar *propertyName ) ; -inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo) -{ - return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL; -} + // 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 // ---------------------------------------------------------------------------- // more debugging macros // ---------------------------------------------------------------------------- -#ifdef __WXDEBUG__ - #ifndef WXDEBUG_NEW - #define WXDEBUG_NEW new(__TFILE__,__LINE__) - #endif -#else // !__WXDEBUG__ - #define WXDEBUG_NEW new -#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. -#if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS - #define new new(__TFILE__,__LINE__) -#endif - -#endif // _WX_OBJECTH__ +#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__