/////////////////////////////////////////////////////////////////////////////
-// 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 <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;
-
-#if wxUSE_DYNAMIC_CLASSES
-
-// ----------------------------------------------------------------------------
-// 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
-
-
-// ----------------------------------------------------------------------------
-// wxClassInfo
-// ----------------------------------------------------------------------------
-
-typedef wxObject *(*wxObjectConstructorFn)(void);
-
-class WXDLLEXPORT wxClassInfo
-{
-public:
- wxClassInfo( const wxChar *className,
- const wxChar *baseName1,
- const wxChar *baseName2,
- 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_next(sm_first)
- { sm_first = this; }
-
- wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
-
- const wxChar *GetClassName() const { return m_className; }
- const wxChar *GetBaseClassName1() const { return m_baseClassName1; }
- const wxChar *GetBaseClassName2() const { return m_baseClassName2; }
- 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; }
- static const wxClassInfo *GetFirst() { return sm_first; }
- const wxClassInfo *GetNext() const { return m_next; }
- static wxClassInfo *FindClass(const wxChar *className);
-
- // Climb upwards through inheritance hierarchy.
- // Dual inheritance is catered for.
-
- bool IsKindOf(const wxClassInfo *info) const
- {
- return info != 0 &&
- ( info == this ||
- ( m_baseInfo1 && m_baseInfo1->IsKindOf(info) ) ||
- ( 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
-
- const wxClassInfo *m_baseInfo1;
- const wxClassInfo *m_baseInfo2;
-
- // class info object live in a linked list:
- // pointers to its head and the next element in it
-
- static wxClassInfo *sm_first;
- wxClassInfo *m_next;
-
- static wxHashTable *sm_classTable;
-};
-
-WXDLLEXPORT 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) DECLARE_DYNAMIC_CLASS(name)
-#define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
-
-// -----------------------------------
-// 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);
-
- // 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);
-
-// -----------------------------------
-// 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);
-
- // 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_CLASS IMPLEMENT_ABSTRACT_CLASS
-#define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
+#define wxDECLARE_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()
+
+// based on the value of wxUSE_EXTENDED_RTTI symbol,
+// only one of the RTTI system will be compiled:
+// - the "old" one (defined by rtti.h) or
+// - the "new" one (defined by xti.h)
+#include "wx/xti.h"
+#include "wx/rtti.h"
+
+#define wxIMPLEMENT_CLASS(name, basename) \
+ wxIMPLEMENT_ABSTRACT_CLASS(name, basename)
+
+#define wxIMPLEMENT_CLASS2(name, basename1, basename2) \
+ wxIMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
// -----------------------------------
// for pluggable classes
name##PluginSentinel(); \
~name##PluginSentinel(); \
}; \
-name##PluginSentinel m_pluginsentinel;
+name##PluginSentinel m_pluginsentinel
#define _IMPLEMENT_DL_SENTINEL(name) \
const wxString name::name##PluginSentinel::sm_className(#name); \
wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
if( e != 0 ) { e->RefObj(); } \
} \
- name::name##PluginSentinel::~##name##PluginSentinel() { \
+ name::name##PluginSentinel::~name##PluginSentinel() { \
wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
if( e != 0 ) { e->UnrefObj(); } \
}
#endif // wxUSE_NESTED_CLASSES
-#define DECLARE_PLUGGABLE_CLASS(name) \
- DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
-#define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \
- DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
+#define wxDECLARE_PLUGGABLE_CLASS(name) \
+ wxDECLARE_DYNAMIC_CLASS(name); _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)
+#define wxDECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \
+ wxDECLARE_ABSTRACT_CLASS(name); _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)
+
+#define wxDECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
+ wxDECLARE_DYNAMIC_CLASS(name); _DECLARE_DL_SENTINEL(name, usergoo)
+#define wxDECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) \
+ wxDECLARE_ABSTRACT_CLASS(name); _DECLARE_DL_SENTINEL(name, usergoo)
+
+#define wxIMPLEMENT_PLUGGABLE_CLASS(name, basename) \
+ wxIMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
+#define wxIMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) \
+ wxIMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
+#define wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
+ wxIMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
+#define wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
+ wxIMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
+
+#define wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \
+ wxIMPLEMENT_PLUGGABLE_CLASS(name, basename)
+#define wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) \
+ wxIMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
+#define wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
+ wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
+#define wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
+ wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
+
+#define wxCLASSINFO(name) (&name::ms_classInfo)
+
+#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::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( \
+ const_cast<wxObject *>(static_cast<const wxObject *>(\
+ const_cast<className *>(static_cast<const className *>(obj)))), \
+ &className::ms_classInfo))
-#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)
+// The 'this' pointer is always true, so use this version
+// to cast the this pointer and avoid compiler warnings.
+#define wxDynamicCastThis(className) \
+ (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
-#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)
+// FIXME-VC6: dummy argument needed because VC6 doesn't support explicitly
+// choosing the template function to call
+template <class T>
+inline T *wxCheckCast(const void *ptr, T * = NULL)
+{
+ wxASSERT_MSG( wxDynamicCast(ptr, T), "wxStaticCast() used incorrectly" );
+ return const_cast<T *>(static_cast<const T *>(ptr));
+}
-#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 wxStaticCast(obj, className) wxCheckCast((obj), (className *)NULL)
+// ----------------------------------------------------------------------------
+// set up memory debugging macros
+// ----------------------------------------------------------------------------
+
+/*
+ Which new/delete operator variants do we want?
-#define CLASSINFO(name) (&name::sm_class##name)
+ _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 )
+*/
-#else // !wxUSE_DYNAMIC_CLASSES
+#if wxUSE_MEMORY_TRACING
- // No dynamic class system: so stub out the macros
+// All compilers get this one
+#define _WX_WANT_NEW_SIZET_WXCHAR_INT
-#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
+// Everyone except Visage gets the next one
+#ifndef __VISAGECPP__
+ #define _WX_WANT_DELETE_VOID
+#endif
-#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)
+// Only visage gets this one under the correct circumstances
+#if defined(__VISAGECPP__) && __DEBUG_ALLOC__
+ #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
+#endif
-#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)
+// 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_DYNAMIC_CLASSES
+// 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
-#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className)
+ // Everyone except Visual C++ (cause problems for VC++ - crashes)
+ #if !defined(__VISUALC__)
+ #define _WX_WANT_ARRAY_DELETE_VOID
+ #endif
- // Just seems a bit nicer-looking (pretend it's not a macro)
+ // Only CodeWarrior 6 or higher
+ #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
+ #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
+ #endif
-#define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className)
+#endif // wxUSE_ARRAY_MEMORY_OPERATORS
- // to be replaced by dynamic_cast<> in the future
+#endif // wxUSE_MEMORY_TRACING
-#define wxDynamicCast(obj, className) \
- (className *) wxCheckDynamicCast((wxObject*)(obj), &className::sm_class##className)
+// ----------------------------------------------------------------------------
+// Compatibility macro aliases DECLARE group
+// ----------------------------------------------------------------------------
+// deprecated variants _not_ requiring a semicolon after them and without wx prefix.
+// (note that also some wx-prefixed macro do _not_ require a semicolon because
+// it's not always possible to force the compire to require it)
+
+#define DECLARE_CLASS_INFO_ITERATORS() wxDECLARE_CLASS_INFO_ITERATORS();
+#define DECLARE_ABSTRACT_CLASS(n) wxDECLARE_ABSTRACT_CLASS(n);
+#define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(n) wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(n);
+#define DECLARE_DYNAMIC_CLASS_NO_COPY(n) wxDECLARE_DYNAMIC_CLASS_NO_COPY(n);
+#define DECLARE_DYNAMIC_CLASS(n) wxDECLARE_DYNAMIC_CLASS(n);
+#define DECLARE_CLASS(n) wxDECLARE_CLASS(n);
+
+#define DECLARE_PLUGGABLE_CLASS(n) wxDECLARE_PLUGGABLE_CLASS(n);
+#define DECLARE_ABSTRACT_PLUGGABLE_CLASS(n) wxDECLARE_ABSTRACT_PLUGGABLE_CLASS(n);
+#define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(n,u) wxDECLARE_USER_EXPORTED_PLUGGABLE_CLASS(n,u);
+#define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,u) wxDECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,u);
- // The 'this' pointer is always true, so use this version
- // to cast the this pointer and avoid compiler warnings.
+// ----------------------------------------------------------------------------
+// wxRefCounter: ref counted data "manager"
+// ----------------------------------------------------------------------------
-#define wxDynamicCastThis(className) \
- (IsKindOf(&className::sm_class##className) ? (className *)(this) : (className *)0)
+class WXDLLIMPEXP_BASE wxRefCounter
+{
+public:
+ wxRefCounter() { 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 ~wxRefCounter() { }
-#define wxConstCast(obj, className) ((className *)(obj))
+private:
+ // our refcount:
+ int m_count;
+ // It doesn't make sense to copy the reference counted objects, a new ref
+ // counter should be created for a new object instead and compilation
+ // errors in the code using wxRefCounter due to the lack of copy ctor often
+ // indicate a problem, e.g. a forgotten copy ctor implementation somewhere.
+ wxDECLARE_NO_COPY_CLASS(wxRefCounter);
+};
-#ifdef __WXDEBUG__
-inline void wxCheckCast(void *ptr)
+// ----------------------------------------------------------------------------
+// wxObjectRefData: ref counted data meant to be stored in wxObject
+// ----------------------------------------------------------------------------
+
+typedef wxRefCounter wxObjectRefData;
+
+// ----------------------------------------------------------------------------
+// wxObjectDataPtr: helper class to avoid memleaks because of missing calls
+// to wxObjectRefData::DecRef
+// ----------------------------------------------------------------------------
+
+template <class T>
+class wxObjectDataPtr
{
- wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") );
-}
-#define wxStaticCast(obj, className) \
- (wxCheckCast(wxDynamicCast(obj, className)), ((className *)(obj)))
+public:
+ typedef T element_type;
-#else // !__WXDEBUG__
-#define wxStaticCast(obj, className) ((className *)(obj))
+ wxEXPLICIT wxObjectDataPtr(T *ptr = NULL) : m_ptr(ptr) {}
-#endif // __WXDEBUG__
+ // 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();
+ }
- // Unfortunately Borland seems to need this include.
+ T *get() const { return m_ptr; }
-#if wxUSE_STD_IOSTREAM \
- && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) \
- && defined(__BORLANDC__)
-#if wxUSE_IOSTREAMH
-#include <iostream.h>
-#else
-#include <iostream>
-#endif
-#endif
+ // test for pointer validity: defining conversion to unspecified_bool_type
+ // and not more obvious bool to avoid implicit conversions to integer types
+ typedef T *(wxObjectDataPtr<T>::*unspecified_bool_type)() const;
+ operator unspecified_bool_type() const
+ {
+ return m_ptr ? &wxObjectDataPtr<T>::get : NULL;
+ }
+
+ T& operator*() const
+ {
+ wxASSERT(m_ptr != NULL);
+ return *(m_ptr);
+ }
+
+ T *operator->() const
+ {
+ wxASSERT(m_ptr != NULL);
+ 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;
+ return *this;
+ }
+
+private:
+ T *m_ptr;
+};
// ----------------------------------------------------------------------------
-// wxObject
+// wxObject: the root class of wxWidgets object hierarchy
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxObjectRefData;
-
-class WXDLLEXPORT wxObject
+class WXDLLIMPEXP_BASE wxObject
{
-DECLARE_ABSTRACT_CLASS(wxObject)
+ wxDECLARE_ABSTRACT_CLASS(wxObject);
public:
- wxObject() : m_refData(0) {}
+ wxObject() { m_refData = NULL; }
virtual ~wxObject() { UnRef(); }
- bool IsKindOf(wxClassInfo *info) const;
+ wxObject(const wxObject& other)
+ {
+ m_refData = other.m_refData;
+ if (m_refData)
+ m_refData->IncRef();
+ }
-#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
- void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0);
+ wxObject& operator=(const wxObject& other)
+ {
+ if ( this != &other )
+ {
+ Ref(other);
+ }
+ return *this;
+ }
-#ifndef __VISAGECPP__
- void operator delete (void * buf);
-#elif __DEBUG_ALLOC__
- void operator delete (void *buf, const char *_fname, size_t _line);
-#endif
+ bool IsKindOf(const wxClassInfo *info) const;
- // VC++ 6.0
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
- void operator delete(void *buf, wxChar*, int);
+ // 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
- // Causes problems for VC++
+#ifdef _WX_WANT_DELETE_VOID
+ void operator delete ( void * buf );
+#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_DELETE_VOID_CONSTCHAR_SIZET
+ void operator delete ( void *buf, const char *_fname, size_t _line );
#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_DELETE_VOID_WXCHAR_INT
+ void operator delete ( void *buf, const wxChar*, int );
#endif
-#endif // Debug & memory tracing
+#ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
+ void *operator new[] ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
+#endif
+#ifdef _WX_WANT_ARRAY_DELETE_VOID
+ void operator delete[] ( void *buf );
+#endif
-#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
- virtual void Dump(wxSTD ostream& str);
+#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
+ void operator delete[] (void* buf, const wxChar*, int );
#endif
- // make a 'clone' of the object
-
+ // ref counted data handling methods
+
+ // get/set
+ wxObjectRefData *GetRefData() const { return m_refData; }
+ void SetRefData(wxObjectRefData *data) { m_refData = data; }
+
+ // 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
-#else
-#define WXDEBUG_NEW new
-#endif
+#include "wx/xti2.h"
- // 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.
+// ----------------------------------------------------------------------------
+// more debugging macros
+// ----------------------------------------------------------------------------
-#if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
-#define new new(__TFILE__,__LINE__)
-#endif
+#if wxUSE_DEBUG_NEW_ALWAYS
+ #define WXDEBUG_NEW new(__TFILE__,__LINE__)
+
+ #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
-#endif // _WX_OBJECTH__
+// ----------------------------------------------------------------------------
+// Compatibility macro aliases IMPLEMENT group
+// ----------------------------------------------------------------------------
-// vi:sts=4:sw=4:et
+// deprecated variants _not_ requiring a semicolon after them and without wx prefix.
+// (note that also some wx-prefixed macro do _not_ require a semicolon because
+// it's not always possible to force the compire to require it)
+
+#define IMPLEMENT_DYNAMIC_CLASS(n,b) wxIMPLEMENT_DYNAMIC_CLASS(n,b)
+#define IMPLEMENT_DYNAMIC_CLASS2(n,b1,b2) wxIMPLEMENT_DYNAMIC_CLASS2(n,b1,b2)
+#define IMPLEMENT_ABSTRACT_CLASS(n,b) wxIMPLEMENT_ABSTRACT_CLASS(n,b)
+#define IMPLEMENT_ABSTRACT_CLASS2(n,b1,b2) wxIMPLEMENT_ABSTRACT_CLASS2(n,b1,b2)
+#define IMPLEMENT_CLASS(n,b) wxIMPLEMENT_CLASS(n,b)
+#define IMPLEMENT_CLASS2(n,b1,b2) wxIMPLEMENT_CLASS2(n,b1,b2)
+
+#define IMPLEMENT_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_PLUGGABLE_CLASS(n,b)
+#define IMPLEMENT_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_PLUGGABLE_CLASS2(n,b,b2)
+#define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(n,b)
+#define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2)
+#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(n,b)
+#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(n,b,b2)
+#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,b)
+#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2)
+
+#define CLASSINFO(n) wxCLASSINFO(n)
+
+#endif // _WX_OBJECTH__