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 // ----------------------------------------------------------------------------
20 #include "wx/memory.h"
22 class WXDLLIMPEXP_BASE wxObject
;
24 #ifndef wxUSE_EXTENDED_RTTI
25 #define wxUSE_EXTENDED_RTTI 0
28 #define DECLARE_CLASS_INFO_ITERATORS() \
29 class WXDLLIMPEXP_BASE const_iterator \
31 typedef wxHashTable_Node Node; \
33 typedef const wxClassInfo* value_type; \
34 typedef const value_type& const_reference; \
35 typedef const_iterator itor; \
36 typedef value_type* ptr_type; \
39 wxHashTable* m_table; \
41 typedef const_reference reference_type; \
42 typedef ptr_type pointer_type; \
44 const_iterator(Node* node, wxHashTable* table) \
45 : m_node(node), m_table(table) { } \
46 const_iterator() : m_node(NULL), m_table(NULL) { } \
47 value_type operator*() const; \
49 const itor operator++(int); \
50 bool operator!=(const itor& it) const \
51 { return it.m_node != m_node; } \
52 bool operator==(const itor& it) const \
53 { return it.m_node == m_node; } \
56 static const_iterator begin_classinfo(); \
57 static const_iterator end_classinfo();
59 #if wxUSE_EXTENDED_RTTI
63 // ----------------------------------------------------------------------------
64 // conditional compilation
65 // ----------------------------------------------------------------------------
67 class WXDLLIMPEXP_BASE wxClassInfo
;
68 class WXDLLIMPEXP_BASE wxHashTable
;
69 class WXDLLIMPEXP_BASE wxObject
;
70 class WXDLLIMPEXP_BASE wxPluginLibrary
;
71 class WXDLLIMPEXP_BASE wxObjectRefData
;
72 class WXDLLIMPEXP_BASE wxHashTable_Node
;
74 // ----------------------------------------------------------------------------
76 // ----------------------------------------------------------------------------
78 typedef wxObject
*(*wxObjectConstructorFn
)(void);
80 class WXDLLIMPEXP_BASE wxClassInfo
82 friend class WXDLLIMPEXP_BASE wxObject
;
83 friend wxObject
*wxCreateDynamicObject(const wxChar
*name
);
85 wxClassInfo( const wxChar
*className
,
86 const wxClassInfo
*baseInfo1
,
87 const wxClassInfo
*baseInfo2
,
89 wxObjectConstructorFn ctor
)
90 : m_className(className
)
92 , m_objectConstructor(ctor
)
93 , m_baseInfo1(baseInfo1
)
94 , m_baseInfo2(baseInfo2
)
103 wxObject
*CreateObject() const
104 { return m_objectConstructor
? (*m_objectConstructor
)() : 0; }
105 bool IsDynamic() const { return (NULL
!= m_objectConstructor
); }
107 const wxChar
*GetClassName() const { return m_className
; }
108 const wxChar
*GetBaseClassName1() const
109 { return m_baseInfo1
? m_baseInfo1
->GetClassName() : NULL
; }
110 const wxChar
*GetBaseClassName2() const
111 { return m_baseInfo2
? m_baseInfo2
->GetClassName() : NULL
; }
112 const wxClassInfo
*GetBaseClass1() const { return m_baseInfo1
; }
113 const wxClassInfo
*GetBaseClass2() const { return m_baseInfo2
; }
114 int GetSize() const { return m_objectSize
; }
116 wxObjectConstructorFn
GetConstructor() const
117 { return m_objectConstructor
; }
118 static const wxClassInfo
*GetFirst() { return sm_first
; }
119 const wxClassInfo
*GetNext() const { return m_next
; }
120 static wxClassInfo
*FindClass(const wxChar
*className
);
122 // Climb upwards through inheritance hierarchy.
123 // Dual inheritance is catered for.
125 bool IsKindOf(const wxClassInfo
*info
) const
129 ( m_baseInfo1
&& m_baseInfo1
->IsKindOf(info
) ) ||
130 ( m_baseInfo2
&& m_baseInfo2
->IsKindOf(info
) ) );
133 DECLARE_CLASS_INFO_ITERATORS()
135 const wxChar
*m_className
;
137 wxObjectConstructorFn m_objectConstructor
;
139 // Pointers to base wxClassInfos
141 const wxClassInfo
*m_baseInfo1
;
142 const wxClassInfo
*m_baseInfo2
;
144 // class info object live in a linked list:
145 // pointers to its head and the next element in it
147 static wxClassInfo
*sm_first
;
150 static wxHashTable
*sm_classTable
;
153 // registers the class
157 DECLARE_NO_COPY_CLASS(wxClassInfo
)
160 WXDLLIMPEXP_BASE wxObject
*wxCreateDynamicObject(const wxChar
*name
);
162 // ----------------------------------------------------------------------------
163 // Dynamic class macros
164 // ----------------------------------------------------------------------------
166 #define DECLARE_ABSTRACT_CLASS(name) \
168 static wxClassInfo ms_classInfo; \
169 virtual wxClassInfo *GetClassInfo() const;
171 #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \
172 DECLARE_NO_ASSIGN_CLASS(name) \
173 DECLARE_DYNAMIC_CLASS(name)
175 #define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \
176 DECLARE_NO_COPY_CLASS(name) \
177 DECLARE_DYNAMIC_CLASS(name)
179 #define DECLARE_DYNAMIC_CLASS(name) \
180 DECLARE_ABSTRACT_CLASS(name) \
181 static wxObject* wxCreateObject();
183 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
186 // common part of the macros below
187 #define wxIMPLEMENT_CLASS_COMMON(name, basename, baseclsinfo2, func) \
188 wxClassInfo name::ms_classInfo(wxT(#name), \
189 &basename::ms_classInfo, \
191 (int) sizeof(name), \
192 (wxObjectConstructorFn) func); \
194 wxClassInfo *name::GetClassInfo() const \
195 { return &name::ms_classInfo; }
197 #define wxIMPLEMENT_CLASS_COMMON1(name, basename, func) \
198 wxIMPLEMENT_CLASS_COMMON(name, basename, NULL, func)
200 #define wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, func) \
201 wxIMPLEMENT_CLASS_COMMON(name, basename1, &basename2::ms_classInfo, func)
203 // -----------------------------------
204 // for concrete classes
205 // -----------------------------------
207 // Single inheritance with one base class
208 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
209 wxIMPLEMENT_CLASS_COMMON1(name, basename, name::wxCreateObject) \
210 wxObject* name::wxCreateObject() \
213 // Multiple inheritance with two base classes
214 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
215 wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, \
216 name::wxCreateObject) \
217 wxObject* name::wxCreateObject() \
220 // -----------------------------------
221 // for abstract classes
222 // -----------------------------------
224 // Single inheritance with one base class
226 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
227 wxIMPLEMENT_CLASS_COMMON1(name, basename, NULL)
229 // Multiple inheritance with two base classes
231 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
232 wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, NULL)
234 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
235 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
237 #endif // !wxUSE_EXTENDED_RTTI
240 // -----------------------------------
241 // for pluggable classes
242 // -----------------------------------
244 // NOTE: this should probably be the very first statement
245 // in the class declaration so wxPluginSentinel is
246 // the first member initialised and the last destroyed.
248 // _DECLARE_DL_SENTINEL(name) wxPluginSentinel m_pluginsentinel;
250 #if wxUSE_NESTED_CLASSES
252 #define _DECLARE_DL_SENTINEL(name, exportdecl) \
253 class exportdecl name##PluginSentinel { \
255 static const wxString sm_className; \
257 name##PluginSentinel(); \
258 ~name##PluginSentinel(); \
260 name##PluginSentinel m_pluginsentinel;
262 #define _IMPLEMENT_DL_SENTINEL(name) \
263 const wxString name::name##PluginSentinel::sm_className(#name); \
264 name::name##PluginSentinel::name##PluginSentinel() { \
265 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
266 if( e != 0 ) { e->RefObj(); } \
268 name::name##PluginSentinel::~name##PluginSentinel() { \
269 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
270 if( e != 0 ) { e->UnrefObj(); } \
274 #define _DECLARE_DL_SENTINEL(name)
275 #define _IMPLEMENT_DL_SENTINEL(name)
277 #endif // wxUSE_NESTED_CLASSES
279 #define DECLARE_PLUGGABLE_CLASS(name) \
280 DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
281 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \
282 DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
284 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
285 DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
286 #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) \
287 DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
289 #define IMPLEMENT_PLUGGABLE_CLASS(name, basename) \
290 IMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
291 #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) \
292 IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
293 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
294 IMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
295 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
296 IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
298 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \
299 IMPLEMENT_PLUGGABLE_CLASS(name, basename)
300 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) \
301 IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
302 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
303 IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
304 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
305 IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
307 #define CLASSINFO(name) (&name::ms_classInfo)
309 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo)
311 // Just seems a bit nicer-looking (pretend it's not a macro)
312 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo)
314 // this cast does some more checks at compile time as it uses static_cast
317 // note that it still has different semantics from dynamic_cast<> and so can't
318 // be replaced by it as long as there are any compilers not supporting it
319 #define wxDynamicCast(obj, className) \
320 ((className *) wxCheckDynamicCast( \
321 wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \
322 wx_const_cast(className *, wx_static_cast(const className *, obj)))), \
323 &className::ms_classInfo))
325 // The 'this' pointer is always true, so use this version
326 // to cast the this pointer and avoid compiler warnings.
327 #define wxDynamicCastThis(className) \
328 (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
331 inline void* wxCheckCast(void *ptr
)
333 wxASSERT_MSG( ptr
, _T("wxStaticCast() used incorrectly") );
336 #define wxStaticCast(obj, className) \
337 ((className *)wxCheckCast(wxDynamicCast(obj, className)))
339 #else // !__WXDEBUG__
340 #define wxStaticCast(obj, className) \
341 wx_const_cast(className *, wx_static_cast(const className *, obj))
343 #endif // __WXDEBUG__
345 // ----------------------------------------------------------------------------
346 // set up memory debugging macros
347 // ----------------------------------------------------------------------------
350 Which new/delete operator variants do we want?
352 _WX_WANT_NEW_SIZET_WXCHAR_INT = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0)
353 _WX_WANT_DELETE_VOID = void operator delete (void * buf)
354 _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET = void operator delete (void *buf, const char *_fname, size_t _line)
355 _WX_WANT_DELETE_VOID_WXCHAR_INT = void operator delete(void *buf, wxChar*, int)
356 _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0)
357 _WX_WANT_ARRAY_DELETE_VOID = void operator delete[] (void *buf)
358 _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT = void operator delete[] (void* buf, wxChar*, int )
361 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
363 // All compilers get this one
364 #define _WX_WANT_NEW_SIZET_WXCHAR_INT
366 // Everyone except Visage gets the next one
367 #ifndef __VISAGECPP__
368 #define _WX_WANT_DELETE_VOID
371 // Only visage gets this one under the correct circumstances
372 #if defined(__VISAGECPP__) && __DEBUG_ALLOC__
373 #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
376 // Only VC++ 6 and CodeWarrior get overloaded delete that matches new
377 #if (defined(__VISUALC__) && (__VISUALC__ >= 1200)) || \
378 (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
379 #define _WX_WANT_DELETE_VOID_WXCHAR_INT
382 // Now see who (if anyone) gets the array memory operators
383 #if wxUSE_ARRAY_MEMORY_OPERATORS
385 // Everyone except Visual C++ (cause problems for VC++ - crashes)
386 #if !defined(__VISUALC__)
387 #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
390 // Everyone except Visual C++ (cause problems for VC++ - crashes)
391 #if !defined(__VISUALC__)
392 #define _WX_WANT_ARRAY_DELETE_VOID
395 // Only CodeWarrior 6 or higher
396 #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
397 #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
400 #endif // wxUSE_ARRAY_MEMORY_OPERATORS
402 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
404 // ----------------------------------------------------------------------------
405 // wxObjectRefData: ref counted data meant to be stored in wxObject
406 // ----------------------------------------------------------------------------
408 class WXDLLIMPEXP_BASE wxObjectRefData
410 friend class WXDLLIMPEXP_BASE wxObject
;
413 wxObjectRefData() : m_count(1) { }
415 int GetRefCount() const { return m_count
; }
417 void IncRef() { m_count
++; }
421 // this object should never be destroyed directly but only as a
422 // result of a DecRef() call:
423 virtual ~wxObjectRefData() { }
430 // ----------------------------------------------------------------------------
431 // wxObjectDataPtr: helper class to avoid memleaks because of missing calls
432 // to wxObjectRefData::DecRef
433 // ----------------------------------------------------------------------------
436 class wxObjectDataPtr
439 typedef T element_type
;
441 wxEXPLICIT
wxObjectDataPtr(T
*ptr
= NULL
) : m_ptr(ptr
) {}
444 wxObjectDataPtr(const wxObjectDataPtr
<T
> &tocopy
)
445 : m_ptr(tocopy
.m_ptr
)
457 T
*get() const { return m_ptr
; }
458 T
*operator->() const { return get(); }
467 wxObjectDataPtr
& operator=(const wxObjectDataPtr
&tocopy
)
471 m_ptr
= tocopy
.m_ptr
;
477 wxObjectDataPtr
& operator=(T
*ptr
)
491 // ----------------------------------------------------------------------------
492 // wxObject: the root class of wxWidgets object hierarchy
493 // ----------------------------------------------------------------------------
495 class WXDLLIMPEXP_BASE wxObject
497 DECLARE_ABSTRACT_CLASS(wxObject
)
500 wxObject() { m_refData
= NULL
; }
501 virtual ~wxObject() { UnRef(); }
503 wxObject(const wxObject
& other
)
505 m_refData
= other
.m_refData
;
507 m_refData
->m_count
++;
510 wxObject
& operator=(const wxObject
& other
)
512 if ( this != &other
)
519 bool IsKindOf(wxClassInfo
*info
) const;
522 // Turn on the correct set of new and delete operators
524 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
525 void *operator new ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
528 #ifdef _WX_WANT_DELETE_VOID
529 void operator delete ( void * buf
);
532 #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
533 void operator delete ( void *buf
, const char *_fname
, size_t _line
);
536 #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
537 void operator delete ( void *buf
, const wxChar
*, int );
540 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
541 void *operator new[] ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
544 #ifdef _WX_WANT_ARRAY_DELETE_VOID
545 void operator delete[] ( void *buf
);
548 #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
549 void operator delete[] (void* buf
, const wxChar
*, int );
552 // ref counted data handling methods
555 wxObjectRefData
*GetRefData() const { return m_refData
; }
556 void SetRefData(wxObjectRefData
*data
) { m_refData
= data
; }
558 // make a 'clone' of the object
559 void Ref(const wxObject
& clone
);
561 // destroy a reference
564 // Make sure this object has only one reference
565 void UnShare() { AllocExclusive(); }
567 // check if this object references the same data as the other one
568 bool IsSameAs(const wxObject
& o
) const { return m_refData
== o
.m_refData
; }
571 // ensure that our data is not shared with anybody else: if we have no
572 // data, it is created using CreateRefData() below, if we have shared data
573 // it is copied using CloneRefData(), otherwise nothing is done
574 void AllocExclusive();
576 // both methods must be implemented if AllocExclusive() is used, not pure
577 // virtual only because of the backwards compatibility reasons
579 // create a new m_refData
580 virtual wxObjectRefData
*CreateRefData() const;
582 // create a new m_refData initialized with the given one
583 virtual wxObjectRefData
*CloneRefData(const wxObjectRefData
*data
) const;
585 wxObjectRefData
*m_refData
;
588 inline wxObject
*wxCheckDynamicCast(wxObject
*obj
, wxClassInfo
*classInfo
)
590 return obj
&& obj
->GetClassInfo()->IsKindOf(classInfo
) ? obj
: NULL
;
593 #if wxUSE_EXTENDED_RTTI
594 class WXDLLIMPEXP_BASE wxDynamicObject
: public wxObject
596 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo
;
598 // instantiates this object with an instance of its superclass
599 wxDynamicObject(wxObject
* superClassInstance
, const wxDynamicClassInfo
*info
) ;
600 virtual ~wxDynamicObject();
602 void SetProperty (const wxChar
*propertyName
, const wxxVariant
&value
);
603 wxxVariant
GetProperty (const wxChar
*propertyName
) const ;
605 // get the runtime identity of this object
606 wxClassInfo
*GetClassInfo() const
609 return (wxClassInfo
*) m_classInfo
;
611 wxDynamicClassInfo
*nonconst
= wx_const_cast(wxDynamicClassInfo
*, m_classInfo
);
612 return wx_static_cast(wxClassInfo
*, nonconst
);
616 wxObject
* GetSuperClassInstance() const
618 return m_superClassInstance
;
621 // removes an existing runtime-property
622 void RemoveProperty( const wxChar
*propertyName
) ;
624 // renames an existing runtime-property
625 void RenameProperty( const wxChar
*oldPropertyName
, const wxChar
*newPropertyName
) ;
627 wxObject
*m_superClassInstance
;
628 const wxDynamicClassInfo
*m_classInfo
;
629 struct wxDynamicObjectInternal
;
630 wxDynamicObjectInternal
*m_data
;
634 // ----------------------------------------------------------------------------
635 // more debugging macros
636 // ----------------------------------------------------------------------------
638 // Redefine new to be the debugging version. This doesn't work with all
639 // compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish
640 // to use the debugging version.
643 #define WXDEBUG_NEW new(__TFILE__,__LINE__)
645 #if wxUSE_DEBUG_NEW_ALWAYS
646 #if wxUSE_GLOBAL_MEMORY_OPERATORS
647 #define new WXDEBUG_NEW
648 #elif defined(__VISUALC__)
649 // Including this file redefines new and allows leak reports to
650 // contain line numbers
651 #include "wx/msw/msvcrt.h"
653 #endif // wxUSE_DEBUG_NEW_ALWAYS
654 #else // !__WXDEBUG__
655 #define WXDEBUG_NEW new
656 #endif // __WXDEBUG__/!__WXDEBUG__
658 #endif // _WX_OBJECTH__