// 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 <ron@debian.org>
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#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_BASE wxObject;
-#if wxUSE_DYNAMIC_CLASSES
+#ifndef wxUSE_EXTENDED_RTTI
+#define wxUSE_EXTENDED_RTTI 0
+#endif
+
+#if wxUSE_EXTENDED_RTTI
+#include "wx/xti.h"
+#else
// ----------------------------------------------------------------------------
// conditional compilation
// ----------------------------------------------------------------------------
-// this shouldn't be needed any longer as <wx/msw/private.h> does it but it
-// doesn't hurt neither
-#ifdef GetClassName
-#undef GetClassName
-#endif
-#ifdef GetClassInfo
-#undef GetClassInfo
-#endif
-
-class WXDLLEXPORT wxClassInfo;
-class WXDLLEXPORT wxHashTable;
-class WXDLLEXPORT wxObjectRefData;
-
-#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
- #include "wx/ioswrap.h"
-#endif
-
+class WXDLLIMPEXP_BASE wxClassInfo;
+class WXDLLIMPEXP_BASE wxHashTable;
+class WXDLLIMPEXP_BASE wxObjectRefData;
// ----------------------------------------------------------------------------
// wxClassInfo
typedef wxObject *(*wxObjectConstructorFn)(void);
-class WXDLLEXPORT wxClassInfo
+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)
{
-#ifdef __WXDEBUG__
- if (sm_classTable != NULL) {
- wxString msg(_T("too late binding of class info (lazy binding) for "));
- msg += className;
- wxFAIL_MSG(msg);
- }
-#endif
sm_first = this;
+ Register();
}
- wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
+ ~wxClassInfo();
+
+ 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);
( 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:
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;
// many clients)
static wxHashTable *sm_classTable;
-private:
- // InitializeClasses() helper
- static wxClassInfo *GetBaseByName(const wxChar *name);
+protected:
+ // registers the class
+ void Register();
+ void Unregister();
DECLARE_NO_COPY_CLASS(wxClassInfo)
};
-WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
+WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *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
// 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
// -----------------------------------
#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
+#define CLASSINFO(name) (&name::ms_classInfo)
-#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)
-
-#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)
-
-#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__
-
-// for some reason Borland seems to need this include.
-#if wxUSE_STD_IOSTREAM \
- && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) \
- && defined(__BORLANDC__)
- #if wxUSE_IOSTREAMH
- #include <iostream.h>
- #else
- #include <iostream>
- #endif
-#endif // wxUSE_IOSTREAMH
-
// ----------------------------------------------------------------------------
// set up memory debugging macros
// ----------------------------------------------------------------------------
#define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
#endif
-// Only VC++ 6.0 and CodeWarrior compilers get overloaded delete that matches new
-#if ( defined(__VISUALC__) && (__VISUALC__ >= 1200) ) || (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
+// 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
#endif // wxUSE_ARRAY_MEMORY_OPERATORS
-#endif // WXDEBUG && wxUSE_MEMORY_TRACING
+#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
+// ----------------------------------------------------------------------------
+// wxObjectRefData: ref counted data meant to be stored in wxObject
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxObjectRefData
+{
+ friend class WXDLLIMPEXP_BASE 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;
+};
// ----------------------------------------------------------------------------
-// wxObject: the root class of wxWindows object hierarchy
+// wxObjectDataPtr: helper class to avoid memleaks because of missing calls
+// to wxObjectRefData::DecRef
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxObject
+template <class T>
+class wxObjectDataPtr
{
- DECLARE_ABSTRACT_CLASS(wxObject)
+public:
+ typedef T element_type;
+
+ wxEXPLICIT wxObjectDataPtr(T *ptr = NULL) : m_ptr(ptr) {}
+
+ // copy ctor
+ wxObjectDataPtr(const wxObjectDataPtr<T> &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:
- void InitFrom(const wxObject& other);
-
+ T *m_ptr;
+};
+
+// ----------------------------------------------------------------------------
+// wxObject: the root class of wxWidgets object hierarchy
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxObject
+{
+ DECLARE_ABSTRACT_CLASS(wxObject)
+
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;
}
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
// destroy a reference
void UnRef();
+ // 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:
// 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
- // only because of the backwards compatibility reasons
+ // both methods must be implemented if AllocExclusive() is used, not pure
+ // virtual only because of the backwards compatibility reasons
// create a new m_refData
virtual wxObjectRefData *CreateRefData() const;
wxObjectRefData *m_refData;
};
-// ----------------------------------------------------------------------------
-// wxObjectRefData: ref counted data meant to be stored in wxObject
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxObjectRefData
+inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
{
- friend class 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
+ wxDynamicClassInfo *nonconst = wx_const_cast(wxDynamicClassInfo *, m_classInfo);
+ return wx_static_cast(wxClassInfo *, nonconst);
+#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__