1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxObject class, plus run-time type information macros
4 // Author: Julian Smart
5 // Modified by: Ron Lee
8 // Copyright: (c) 1997 Julian Smart
9 // (c) 2001 Ron Lee <ron@debian.org>
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #include "wx/memory.h"
23 class WXDLLIMPEXP_BASE wxObject
;
25 #ifndef wxUSE_EXTENDED_RTTI
26 #define wxUSE_EXTENDED_RTTI 0
29 #if wxUSE_EXTENDED_RTTI
33 // ----------------------------------------------------------------------------
34 // conditional compilation
35 // ----------------------------------------------------------------------------
37 class WXDLLIMPEXP_BASE wxClassInfo
;
38 class WXDLLIMPEXP_BASE wxHashTable
;
39 class WXDLLIMPEXP_BASE wxObjectRefData
;
41 // ----------------------------------------------------------------------------
43 // ----------------------------------------------------------------------------
45 typedef wxObject
*(*wxObjectConstructorFn
)(void);
47 class WXDLLIMPEXP_BASE wxClassInfo
50 wxClassInfo( const wxChar
*className
,
51 const wxClassInfo
*baseInfo1
,
52 const wxClassInfo
*baseInfo2
,
54 wxObjectConstructorFn ctor
)
55 : m_className(className
)
57 , m_objectConstructor(ctor
)
58 , m_baseInfo1(baseInfo1
)
59 , m_baseInfo2(baseInfo2
)
68 wxObject
*CreateObject() { return m_objectConstructor
? (*m_objectConstructor
)() : 0; }
70 const wxChar
*GetClassName() const { return m_className
; }
71 const wxChar
*GetBaseClassName1() const
72 { return m_baseInfo1
? m_baseInfo1
->GetClassName() : NULL
; }
73 const wxChar
*GetBaseClassName2() const
74 { return m_baseInfo2
? m_baseInfo2
->GetClassName() : NULL
; }
75 const wxClassInfo
*GetBaseClass1() const { return m_baseInfo1
; }
76 const wxClassInfo
*GetBaseClass2() const { return m_baseInfo2
; }
77 int GetSize() const { return m_objectSize
; }
79 wxObjectConstructorFn
GetConstructor() const { return m_objectConstructor
; }
80 static const wxClassInfo
*GetFirst() { return sm_first
; }
81 const wxClassInfo
*GetNext() const { return m_next
; }
82 static wxClassInfo
*FindClass(const wxChar
*className
);
84 // Climb upwards through inheritance hierarchy.
85 // Dual inheritance is catered for.
87 bool IsKindOf(const wxClassInfo
*info
) const
91 ( m_baseInfo1
&& m_baseInfo1
->IsKindOf(info
) ) ||
92 ( m_baseInfo2
&& m_baseInfo2
->IsKindOf(info
) ) );
95 #if WXWIN_COMPATIBILITY_2_4
96 // Initializes parent pointers and hash table for fast searching.
97 wxDEPRECATED( static void InitializeClasses() );
98 // Cleans up hash table used for fast searching.
99 wxDEPRECATED( static void CleanUpClasses() );
101 static void CleanUp();
104 const wxChar
*m_className
;
106 wxObjectConstructorFn m_objectConstructor
;
108 // Pointers to base wxClassInfos: set in InitializeClasses
110 const wxClassInfo
*m_baseInfo1
;
111 const wxClassInfo
*m_baseInfo2
;
113 // class info object live in a linked list:
114 // pointers to its head and the next element in it
116 static wxClassInfo
*sm_first
;
119 // FIXME: this should be private (currently used directly by way too
121 static wxHashTable
*sm_classTable
;
124 // InitializeClasses() helper
125 static wxClassInfo
*GetBaseByName(const wxChar
*name
);
127 DECLARE_NO_COPY_CLASS(wxClassInfo
)
130 // registers the class
135 WXDLLIMPEXP_BASE wxObject
*wxCreateDynamicObject(const wxChar
*name
);
137 #if WXWIN_COMPATIBILITY_2_4
138 inline void wxClassInfo::InitializeClasses() {}
139 inline void wxClassInfo::CleanUpClasses() {}
142 // ----------------------------------------------------------------------------
143 // Dynamic class macros
144 // ----------------------------------------------------------------------------
146 #define DECLARE_ABSTRACT_CLASS(name) \
148 static wxClassInfo ms_classInfo; \
149 virtual wxClassInfo *GetClassInfo() const;
151 #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \
152 DECLARE_NO_ASSIGN_CLASS(name) \
153 DECLARE_DYNAMIC_CLASS(name)
155 #define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \
156 DECLARE_NO_COPY_CLASS(name) \
157 DECLARE_DYNAMIC_CLASS(name)
159 #define DECLARE_DYNAMIC_CLASS(name) \
160 DECLARE_ABSTRACT_CLASS(name) \
161 static wxObject* wxCreateObject();
163 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
166 // common part of the macros below
167 #define wxIMPLEMENT_CLASS_COMMON(name, basename, baseclsinfo2, func) \
168 wxClassInfo name::ms_classInfo(wxT(#name), \
169 &basename::ms_classInfo, \
171 (int) sizeof(name), \
172 (wxObjectConstructorFn) func); \
174 wxClassInfo *name::GetClassInfo() const \
175 { return &name::ms_classInfo; }
177 #define wxIMPLEMENT_CLASS_COMMON1(name, basename, func) \
178 wxIMPLEMENT_CLASS_COMMON(name, basename, NULL, func)
180 #define wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, func) \
181 wxIMPLEMENT_CLASS_COMMON(name, basename1, &basename2::ms_classInfo, func)
183 // -----------------------------------
184 // for concrete classes
185 // -----------------------------------
187 // Single inheritance with one base class
188 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
189 wxIMPLEMENT_CLASS_COMMON1(name, basename, name::wxCreateObject) \
190 wxObject* name::wxCreateObject() \
193 // Multiple inheritance with two base classes
194 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
195 wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, \
196 name::wxCreateObject) \
197 wxObject* name::wxCreateObject() \
200 // -----------------------------------
201 // for abstract classes
202 // -----------------------------------
204 // Single inheritance with one base class
206 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
207 wxIMPLEMENT_CLASS_COMMON1(name, basename, NULL)
209 // Multiple inheritance with two base classes
211 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
212 wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, NULL)
214 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
215 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
217 #endif // !wxUSE_EXTENDED_RTTI
220 // -----------------------------------
221 // for pluggable classes
222 // -----------------------------------
224 // NOTE: this should probably be the very first statement
225 // in the class declaration so wxPluginSentinel is
226 // the first member initialised and the last destroyed.
228 // _DECLARE_DL_SENTINEL(name) wxPluginSentinel m_pluginsentinel;
230 #if wxUSE_NESTED_CLASSES
232 #define _DECLARE_DL_SENTINEL(name, exportdecl) \
233 class exportdecl name##PluginSentinel { \
235 static const wxString sm_className; \
237 name##PluginSentinel(); \
238 ~name##PluginSentinel(); \
240 name##PluginSentinel m_pluginsentinel;
242 #define _IMPLEMENT_DL_SENTINEL(name) \
243 const wxString name::name##PluginSentinel::sm_className(#name); \
244 name::name##PluginSentinel::name##PluginSentinel() { \
245 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
246 if( e != 0 ) { e->RefObj(); } \
248 name::name##PluginSentinel::~name##PluginSentinel() { \
249 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
250 if( e != 0 ) { e->UnrefObj(); } \
254 #define _DECLARE_DL_SENTINEL(name)
255 #define _IMPLEMENT_DL_SENTINEL(name)
257 #endif // wxUSE_NESTED_CLASSES
259 #define DECLARE_PLUGGABLE_CLASS(name) \
260 DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
261 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \
262 DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
264 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
265 DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
266 #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) \
267 DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
269 #define IMPLEMENT_PLUGGABLE_CLASS(name, basename) \
270 IMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
271 #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) \
272 IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
273 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
274 IMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
275 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
276 IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
278 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \
279 IMPLEMENT_PLUGGABLE_CLASS(name, basename)
280 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) \
281 IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
282 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
283 IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
284 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
285 IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
287 #define CLASSINFO(name) (&name::ms_classInfo)
289 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo)
291 // Just seems a bit nicer-looking (pretend it's not a macro)
292 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo)
294 // this cast does some more checks at compile time as it uses static_cast
297 // note that it still has different semantics from dynamic_cast<> and so can't
298 // be replaced by it as long as there are any compilers not supporting it
299 #define wxDynamicCast(obj, className) \
300 ((className *) wxCheckDynamicCast( \
301 wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \
302 wx_const_cast(className *, wx_static_cast(const className *, obj)))), \
303 &className::ms_classInfo))
305 // The 'this' pointer is always true, so use this version
306 // to cast the this pointer and avoid compiler warnings.
307 #define wxDynamicCastThis(className) \
308 (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
311 inline void* wxCheckCast(void *ptr
)
313 wxASSERT_MSG( ptr
, _T("wxStaticCast() used incorrectly") );
316 #define wxStaticCast(obj, className) \
317 ((className *)wxCheckCast(wxDynamicCast(obj, className)))
319 #else // !__WXDEBUG__
320 #define wxStaticCast(obj, className) \
321 wx_const_cast(className *, wx_static_cast(const className *, obj))
323 #endif // __WXDEBUG__
325 // ----------------------------------------------------------------------------
326 // set up memory debugging macros
327 // ----------------------------------------------------------------------------
330 Which new/delete operator variants do we want?
332 _WX_WANT_NEW_SIZET_WXCHAR_INT = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0)
333 _WX_WANT_DELETE_VOID = void operator delete (void * buf)
334 _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET = void operator delete (void *buf, const char *_fname, size_t _line)
335 _WX_WANT_DELETE_VOID_WXCHAR_INT = void operator delete(void *buf, wxChar*, int)
336 _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0)
337 _WX_WANT_ARRAY_DELETE_VOID = void operator delete[] (void *buf)
338 _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT = void operator delete[] (void* buf, wxChar*, int )
341 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
343 // All compilers get this one
344 #define _WX_WANT_NEW_SIZET_WXCHAR_INT
346 // Everyone except Visage gets the next one
347 #ifndef __VISAGECPP__
348 #define _WX_WANT_DELETE_VOID
351 // Only visage gets this one under the correct circumstances
352 #if defined(__VISAGECPP__) && __DEBUG_ALLOC__
353 #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
356 // Only VC++ 6.0 and CodeWarrior compilers get overloaded delete that matches new
357 #if ( defined(__VISUALC__) && (__VISUALC__ >= 1200) ) || (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
358 #define _WX_WANT_DELETE_VOID_WXCHAR_INT
361 // Now see who (if anyone) gets the array memory operators
362 #if wxUSE_ARRAY_MEMORY_OPERATORS
364 // Everyone except Visual C++ (cause problems for VC++ - crashes)
365 #if !defined(__VISUALC__)
366 #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
369 // Everyone except Visual C++ (cause problems for VC++ - crashes)
370 #if !defined(__VISUALC__)
371 #define _WX_WANT_ARRAY_DELETE_VOID
374 // Only CodeWarrior 6 or higher
375 #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
376 #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
379 #endif // wxUSE_ARRAY_MEMORY_OPERATORS
381 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
383 // ----------------------------------------------------------------------------
384 // wxObject: the root class of wxWidgets object hierarchy
385 // ----------------------------------------------------------------------------
387 class WXDLLIMPEXP_BASE wxObject
389 DECLARE_ABSTRACT_CLASS(wxObject
)
392 void InitFrom(const wxObject
& other
);
395 wxObject() { m_refData
= NULL
; }
396 virtual ~wxObject() { UnRef(); }
398 wxObject(const wxObject
& other
)
403 wxObject
& operator=(const wxObject
& other
)
405 if ( this != &other
)
413 bool IsKindOf(wxClassInfo
*info
) const;
416 // Turn on the correct set of new and delete operators
418 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
419 void *operator new ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
422 #ifdef _WX_WANT_DELETE_VOID
423 void operator delete ( void * buf
);
426 #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
427 void operator delete ( void *buf
, const char *_fname
, size_t _line
);
430 #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
431 void operator delete ( void *buf
, const wxChar
*, int );
434 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
435 void *operator new[] ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
438 #ifdef _WX_WANT_ARRAY_DELETE_VOID
439 void operator delete[] ( void *buf
);
442 #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
443 void operator delete[] (void* buf
, const wxChar
*, int );
446 // ref counted data handling methods
449 wxObjectRefData
*GetRefData() const { return m_refData
; }
450 void SetRefData(wxObjectRefData
*data
) { m_refData
= data
; }
452 // make a 'clone' of the object
453 void Ref(const wxObject
& clone
);
455 // destroy a reference
459 // Reserved for future use
460 virtual void ReservedObjectFunc1() {}
461 virtual void ReservedObjectFunc2() {}
462 virtual void ReservedObjectFunc3() {}
463 virtual void ReservedObjectFunc4() {}
464 virtual void ReservedObjectFunc5() {}
465 virtual void ReservedObjectFunc6() {}
466 virtual void ReservedObjectFunc7() {}
467 virtual void ReservedObjectFunc8() {}
468 virtual void ReservedObjectFunc9() {}
471 // ensure that our data is not shared with anybody else: if we have no
472 // data, it is created using CreateRefData() below, if we have shared data
473 // it is copied using CloneRefData(), otherwise nothing is done
474 void AllocExclusive();
476 // both methods must be implemented if Unshare() is used, not pure virtual
477 // only because of the backwards compatibility reasons
479 // create a new m_refData
480 virtual wxObjectRefData
*CreateRefData() const;
482 // create a new m_refData initialized with the given one
483 virtual wxObjectRefData
*CloneRefData(const wxObjectRefData
*data
) const;
485 wxObjectRefData
*m_refData
;
488 // ----------------------------------------------------------------------------
489 // wxObjectRefData: ref counted data meant to be stored in wxObject
490 // ----------------------------------------------------------------------------
492 class WXDLLIMPEXP_BASE wxObjectRefData
494 friend class WXDLLIMPEXP_BASE wxObject
;
497 wxObjectRefData() : m_count(1) { }
498 virtual ~wxObjectRefData() { }
500 int GetRefCount() const { return m_count
; }
507 inline wxObject
*wxCheckDynamicCast(wxObject
*obj
, wxClassInfo
*classInfo
)
509 return obj
&& obj
->GetClassInfo()->IsKindOf(classInfo
) ? obj
: NULL
;
512 #if wxUSE_EXTENDED_RTTI
513 class WXDLLIMPEXP_BASE wxDynamicObject
: public wxObject
515 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo
;
517 // instantiates this object with an instance of its superclass
518 wxDynamicObject(wxObject
* superClassInstance
, const wxDynamicClassInfo
*info
) ;
521 void SetProperty (const wxChar
*propertyName
, const wxxVariant
&value
);
522 wxxVariant
GetProperty (const wxChar
*propertyName
) const ;
524 // get the runtime identity of this object
525 wxClassInfo
*GetClassInfo() const
528 return (wxClassInfo
*) m_classInfo
;
530 return wx_const_cast(wxClassInfo
*, m_classInfo
);
534 wxObject
* GetSuperClassInstance() const
536 return m_superClassInstance
;
539 // removes an existing runtime-property
540 void RemoveProperty( const wxChar
*propertyName
) ;
542 // renames an existing runtime-property
543 void RenameProperty( const wxChar
*oldPropertyName
, const wxChar
*newPropertyName
) ;
545 wxObject
*m_superClassInstance
;
546 const wxDynamicClassInfo
*m_classInfo
;
547 struct wxDynamicObjectInternal
;
548 wxDynamicObjectInternal
*m_data
;
552 // ----------------------------------------------------------------------------
553 // more debugging macros
554 // ----------------------------------------------------------------------------
558 #define WXDEBUG_NEW new(__TFILE__,__LINE__)
560 #else // !__WXDEBUG__
561 #define WXDEBUG_NEW new
564 // Redefine new to be the debugging version. This doesn't work with all
565 // compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish
566 // to use the debugging version.
568 #if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
569 #define new new(__TFILE__,__LINE__)
570 #elif (defined(__WXDEBUG__) && defined(__VISUALC__) && !wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS)
571 // Including this file redefines new and allows leak reports to contain line numbers
572 #include "wx/msw/msvcrt.h"
575 #endif // _WX_OBJECTH__