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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
17 #pragma interface "object.h"
20 // ----------------------------------------------------------------------------
22 // ----------------------------------------------------------------------------
25 #include "wx/memory.h"
27 class WXDLLIMPEXP_BASE wxObject
;
29 #if wxUSE_DYNAMIC_CLASSES
31 #ifndef wxUSE_EXTENDED_RTTI
32 #define wxUSE_EXTENDED_RTTI 0
35 #if wxUSE_EXTENDED_RTTI
39 // ----------------------------------------------------------------------------
40 // conditional compilation
41 // ----------------------------------------------------------------------------
43 // this shouldn't be needed any longer as <wx/msw/private.h> does it but it
44 // doesn't hurt neither
52 class WXDLLIMPEXP_BASE wxClassInfo
;
53 class WXDLLIMPEXP_BASE wxHashTable
;
54 class WXDLLIMPEXP_BASE wxObjectRefData
;
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 typedef wxObject
*(*wxObjectConstructorFn
)(void);
62 class WXDLLIMPEXP_BASE wxClassInfo
65 wxClassInfo( const wxChar
*className
,
66 const wxClassInfo
*baseInfo1
,
67 const wxClassInfo
*baseInfo2
,
69 wxObjectConstructorFn ctor
)
70 : m_className(className
)
72 , m_objectConstructor(ctor
)
73 , m_baseInfo1(baseInfo1
)
74 , m_baseInfo2(baseInfo2
)
83 wxObject
*CreateObject() { return m_objectConstructor
? (*m_objectConstructor
)() : 0; }
85 const wxChar
*GetClassName() const { return m_className
; }
86 const wxChar
*GetBaseClassName1() const
87 { return m_baseInfo1
? m_baseInfo1
->GetClassName() : NULL
; }
88 const wxChar
*GetBaseClassName2() const
89 { return m_baseInfo2
? m_baseInfo2
->GetClassName() : NULL
; }
90 const wxClassInfo
*GetBaseClass1() const { return m_baseInfo1
; }
91 const wxClassInfo
*GetBaseClass2() const { return m_baseInfo2
; }
92 int GetSize() const { return m_objectSize
; }
94 wxObjectConstructorFn
GetConstructor() const { return m_objectConstructor
; }
95 static const wxClassInfo
*GetFirst() { return sm_first
; }
96 const wxClassInfo
*GetNext() const { return m_next
; }
97 static wxClassInfo
*FindClass(const wxChar
*className
);
99 // Climb upwards through inheritance hierarchy.
100 // Dual inheritance is catered for.
102 bool IsKindOf(const wxClassInfo
*info
) const
106 ( m_baseInfo1
&& m_baseInfo1
->IsKindOf(info
) ) ||
107 ( m_baseInfo2
&& m_baseInfo2
->IsKindOf(info
) ) );
110 #if WXWIN_COMPATIBILITY_2_4
111 // Initializes parent pointers and hash table for fast searching.
112 wxDEPRECATED( static void InitializeClasses() );
113 // Cleans up hash table used for fast searching.
114 wxDEPRECATED( static void CleanUpClasses() );
116 static void CleanUp();
119 const wxChar
*m_className
;
121 wxObjectConstructorFn m_objectConstructor
;
123 // Pointers to base wxClassInfos: set in InitializeClasses
125 const wxClassInfo
*m_baseInfo1
;
126 const wxClassInfo
*m_baseInfo2
;
128 // class info object live in a linked list:
129 // pointers to its head and the next element in it
131 static wxClassInfo
*sm_first
;
134 // FIXME: this should be private (currently used directly by way too
136 static wxHashTable
*sm_classTable
;
139 // InitializeClasses() helper
140 static wxClassInfo
*GetBaseByName(const wxChar
*name
);
142 DECLARE_NO_COPY_CLASS(wxClassInfo
)
145 // registers the class
150 WXDLLIMPEXP_BASE wxObject
*wxCreateDynamicObject(const wxChar
*name
);
152 #if WXWIN_COMPATIBILITY_2_4
153 inline void wxClassInfo::InitializeClasses() {}
154 inline void wxClassInfo::CleanUpClasses() {}
157 // ----------------------------------------------------------------------------
158 // Dynamic class macros
159 // ----------------------------------------------------------------------------
161 #define DECLARE_DYNAMIC_CLASS(name) \
163 static wxClassInfo ms_classInfo; \
164 static wxObject* wxCreateObject(); \
165 virtual wxClassInfo *GetClassInfo() const \
166 { return &name::ms_classInfo; }
168 #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \
169 DECLARE_NO_ASSIGN_CLASS(name) \
170 DECLARE_DYNAMIC_CLASS(name)
172 #define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \
173 DECLARE_NO_COPY_CLASS(name) \
174 DECLARE_DYNAMIC_CLASS(name)
176 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
177 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
179 // -----------------------------------
180 // for concrete classes
181 // -----------------------------------
183 // Single inheritance with one base class
185 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
186 wxObject* name::wxCreateObject() \
187 { return new name; } \
188 wxClassInfo name::ms_classInfo(wxT(#name), \
189 &basename::ms_classInfo, NULL, \
190 (int) sizeof(name), \
191 (wxObjectConstructorFn) name::wxCreateObject);
193 // Multiple inheritance with two base classes
195 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
196 wxObject* name::wxCreateObject() \
197 { return new name; } \
198 wxClassInfo name::ms_classInfo(wxT(#name), \
199 &basename1::ms_classInfo, \
200 &basename2::ms_classInfo, \
201 wxT(#basename2), (int) sizeof(name), \
202 (wxObjectConstructorFn) name::wxCreateObject);
204 // -----------------------------------
205 // for abstract classes
206 // -----------------------------------
208 // Single inheritance with one base class
210 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
211 wxClassInfo name::ms_classInfo(wxT(#name), \
212 &basename::ms_classInfo, NULL, \
213 (int) sizeof(name), (wxObjectConstructorFn) 0);
215 // Multiple inheritance with two base classes
217 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
218 wxClassInfo name::ms_classInfo(wxT(#name), \
219 &basename1::ms_classInfo, \
220 &basename2::ms_classInfo, \
221 (int) sizeof(name), \
222 (wxObjectConstructorFn) 0);
224 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
225 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
227 #endif // !wxUSE_EXTENDED_RTTI
230 // -----------------------------------
231 // for pluggable classes
232 // -----------------------------------
234 // NOTE: this should probably be the very first statement
235 // in the class declaration so wxPluginSentinel is
236 // the first member initialised and the last destroyed.
238 // _DECLARE_DL_SENTINEL(name) wxPluginSentinel m_pluginsentinel;
240 #if wxUSE_NESTED_CLASSES
242 #define _DECLARE_DL_SENTINEL(name, exportdecl) \
243 class exportdecl name##PluginSentinel { \
245 static const wxString sm_className; \
247 name##PluginSentinel(); \
248 ~name##PluginSentinel(); \
250 name##PluginSentinel m_pluginsentinel;
252 #define _IMPLEMENT_DL_SENTINEL(name) \
253 const wxString name::name##PluginSentinel::sm_className(#name); \
254 name::name##PluginSentinel::name##PluginSentinel() { \
255 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
256 if( e != 0 ) { e->RefObj(); } \
258 name::name##PluginSentinel::~name##PluginSentinel() { \
259 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
260 if( e != 0 ) { e->UnrefObj(); } \
264 #define _DECLARE_DL_SENTINEL(name)
265 #define _IMPLEMENT_DL_SENTINEL(name)
267 #endif // wxUSE_NESTED_CLASSES
269 #define DECLARE_PLUGGABLE_CLASS(name) \
270 DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
271 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \
272 DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
274 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
275 DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
276 #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) \
277 DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
279 #define IMPLEMENT_PLUGGABLE_CLASS(name, basename) \
280 IMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
281 #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) \
282 IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
283 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
284 IMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
285 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
286 IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
288 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \
289 IMPLEMENT_PLUGGABLE_CLASS(name, basename)
290 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) \
291 IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
292 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
293 IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
294 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
295 IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
297 #define CLASSINFO(name) (&name::ms_classInfo)
299 #else // !wxUSE_DYNAMIC_CLASSES
301 // No dynamic class system: so stub out the macros
303 #define DECLARE_DYNAMIC_CLASS(name)
304 #define DECLARE_ABSTRACT_CLASS(name)
305 #define DECLARE_CLASS(name)
306 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)
307 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)
308 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)
309 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
310 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
311 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
313 #define DECLARE_PLUGGABLE_CLASS(name)
314 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)
315 #define IMPLEMENT_PLUGGABLE_CLASS(name, basename)
316 #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
317 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
318 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
320 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo)
321 #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo)
322 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename)
323 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2)
324 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename)
325 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
327 #endif // wxUSE_DYNAMIC_CLASSES
329 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo)
331 // Just seems a bit nicer-looking (pretend it's not a macro)
332 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo)
334 // to be replaced by dynamic_cast<> in the future
335 #define wxDynamicCast(obj, className) \
336 ((className *) wxCheckDynamicCast( \
337 wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \
338 wx_const_cast(className *, wx_static_cast(const className *, obj)))), \
339 &className::ms_classInfo))
341 // The 'this' pointer is always true, so use this version
342 // to cast the this pointer and avoid compiler warnings.
343 #define wxDynamicCastThis(className) \
344 (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
347 inline void* wxCheckCast(void *ptr
)
349 wxASSERT_MSG( ptr
, _T("wxStaticCast() used incorrectly") );
352 #define wxStaticCast(obj, className) \
353 ((className *)wxCheckCast(wxDynamicCast(obj, className)))
355 #else // !__WXDEBUG__
356 #define wxStaticCast(obj, className) ((className *)(obj))
358 #endif // __WXDEBUG__
360 // ----------------------------------------------------------------------------
361 // set up memory debugging macros
362 // ----------------------------------------------------------------------------
365 Which new/delete operator variants do we want?
367 _WX_WANT_NEW_SIZET_WXCHAR_INT = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0)
368 _WX_WANT_DELETE_VOID = void operator delete (void * buf)
369 _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET = void operator delete (void *buf, const char *_fname, size_t _line)
370 _WX_WANT_DELETE_VOID_WXCHAR_INT = void operator delete(void *buf, wxChar*, int)
371 _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0)
372 _WX_WANT_ARRAY_DELETE_VOID = void operator delete[] (void *buf)
373 _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT = void operator delete[] (void* buf, wxChar*, int )
376 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
378 // All compilers get this one
379 #define _WX_WANT_NEW_SIZET_WXCHAR_INT
381 // Everyone except Visage gets the next one
382 #ifndef __VISAGECPP__
383 #define _WX_WANT_DELETE_VOID
386 // Only visage gets this one under the correct circumstances
387 #if defined(__VISAGECPP__) && __DEBUG_ALLOC__
388 #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
391 // Only VC++ 6.0 and CodeWarrior compilers get overloaded delete that matches new
392 #if ( defined(__VISUALC__) && (__VISUALC__ >= 1200) ) || (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
393 #define _WX_WANT_DELETE_VOID_WXCHAR_INT
396 // Now see who (if anyone) gets the array memory operators
397 #if wxUSE_ARRAY_MEMORY_OPERATORS
399 // Everyone except Visual C++ (cause problems for VC++ - crashes)
400 #if !defined(__VISUALC__)
401 #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
404 // Everyone except Visual C++ (cause problems for VC++ - crashes)
405 #if !defined(__VISUALC__)
406 #define _WX_WANT_ARRAY_DELETE_VOID
409 // Only CodeWarrior 6 or higher
410 #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
411 #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
414 #endif // wxUSE_ARRAY_MEMORY_OPERATORS
416 #endif // WXDEBUG && wxUSE_MEMORY_TRACING
418 // ----------------------------------------------------------------------------
419 // wxObject: the root class of wxWidgets object hierarchy
420 // ----------------------------------------------------------------------------
422 class WXDLLIMPEXP_BASE wxObject
424 DECLARE_ABSTRACT_CLASS(wxObject
)
427 void InitFrom(const wxObject
& other
);
430 wxObject() { m_refData
= NULL
; }
431 virtual ~wxObject() { UnRef(); }
433 wxObject(const wxObject
& other
)
438 wxObject
& operator=(const wxObject
& other
)
440 if ( this != &other
)
448 bool IsKindOf(wxClassInfo
*info
) const;
451 // Turn on the correct set of new and delete operators
453 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
454 void *operator new ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
457 #ifdef _WX_WANT_DELETE_VOID
458 void operator delete ( void * buf
);
461 #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
462 void operator delete ( void *buf
, const char *_fname
, size_t _line
);
465 #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
466 void operator delete ( void *buf
, const wxChar
*, int );
469 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
470 void *operator new[] ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
473 #ifdef _WX_WANT_ARRAY_DELETE_VOID
474 void operator delete[] ( void *buf
);
477 #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
478 void operator delete[] (void* buf
, const wxChar
*, int );
481 // ref counted data handling methods
484 wxObjectRefData
*GetRefData() const { return m_refData
; }
485 void SetRefData(wxObjectRefData
*data
) { m_refData
= data
; }
487 // make a 'clone' of the object
488 void Ref(const wxObject
& clone
);
490 // destroy a reference
494 // ensure that our data is not shared with anybody else: if we have no
495 // data, it is created using CreateRefData() below, if we have shared data
496 // it is copied using CloneRefData(), otherwise nothing is done
497 void AllocExclusive();
499 // both methods must be implemented if Unshare() is used, not pure virtual
500 // only because of the backwards compatibility reasons
502 // create a new m_refData
503 virtual wxObjectRefData
*CreateRefData() const;
505 // create a new m_refData initialized with the given one
506 virtual wxObjectRefData
*CloneRefData(const wxObjectRefData
*data
) const;
508 wxObjectRefData
*m_refData
;
511 // ----------------------------------------------------------------------------
512 // wxObjectRefData: ref counted data meant to be stored in wxObject
513 // ----------------------------------------------------------------------------
515 class WXDLLIMPEXP_BASE wxObjectRefData
517 friend class WXDLLIMPEXP_BASE wxObject
;
520 wxObjectRefData() : m_count(1) { }
521 virtual ~wxObjectRefData() { }
523 int GetRefCount() const { return m_count
; }
530 inline wxObject
*wxCheckDynamicCast(wxObject
*obj
, wxClassInfo
*classInfo
)
532 return obj
&& obj
->GetClassInfo()->IsKindOf(classInfo
) ? obj
: NULL
;
535 #if wxUSE_EXTENDED_RTTI
536 class WXDLLIMPEXP_BASE wxDynamicObject
: public wxObject
538 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo
;
540 // instantiates this object with an instance of its superclass
541 wxDynamicObject(wxObject
* superClassInstance
, const wxDynamicClassInfo
*info
) ;
544 void SetProperty (const wxChar
*propertyName
, const wxxVariant
&value
);
545 wxxVariant
GetProperty (const wxChar
*propertyName
) const ;
547 // get the runtime identity of this object
548 wxClassInfo
*GetClassInfo() const
551 return (wxClassInfo
*) m_classInfo
;
553 return wx_const_cast(wxClassInfo
*, m_classInfo
);
557 wxObject
* GetSuperClassInstance() const
559 return m_superClassInstance
;
562 // removes an existing runtime-property
563 void RemoveProperty( const wxChar
*propertyName
) ;
565 // renames an existing runtime-property
566 void RenameProperty( const wxChar
*oldPropertyName
, const wxChar
*newPropertyName
) ;
568 wxObject
*m_superClassInstance
;
569 const wxDynamicClassInfo
*m_classInfo
;
570 struct wxDynamicObjectInternal
;
571 wxDynamicObjectInternal
*m_data
;
575 // ----------------------------------------------------------------------------
576 // more debugging macros
577 // ----------------------------------------------------------------------------
581 #define WXDEBUG_NEW new(__TFILE__,__LINE__)
583 #else // !__WXDEBUG__
584 #define WXDEBUG_NEW new
587 // Redefine new to be the debugging version. This doesn't work with all
588 // compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish
589 // to use the debugging version.
591 #if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
592 #define new new(__TFILE__,__LINE__)
595 #endif // _WX_OBJECTH__