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 #define wxDECLARE_CLASS_INFO_ITERATORS() \
23 class WXDLLIMPEXP_BASE const_iterator \
25 typedef wxHashTable_Node Node; \
27 typedef const wxClassInfo* value_type; \
28 typedef const value_type& const_reference; \
29 typedef const_iterator itor; \
30 typedef value_type* ptr_type; \
33 wxHashTable* m_table; \
35 typedef const_reference reference_type; \
36 typedef ptr_type pointer_type; \
38 const_iterator(Node* node, wxHashTable* table) \
39 : m_node(node), m_table(table) { } \
40 const_iterator() : m_node(NULL), m_table(NULL) { } \
41 value_type operator*() const; \
43 const itor operator++(int); \
44 bool operator!=(const itor& it) const \
45 { return it.m_node != m_node; } \
46 bool operator==(const itor& it) const \
47 { return it.m_node == m_node; } \
50 static const_iterator begin_classinfo(); \
51 static const_iterator end_classinfo()
53 // based on the value of wxUSE_EXTENDED_RTTI symbol,
54 // only one of the RTTI system will be compiled:
55 // - the "old" one (defined by rtti.h) or
56 // - the "new" one (defined by xti.h)
60 #define wxIMPLEMENT_CLASS(name, basename) \
61 wxIMPLEMENT_ABSTRACT_CLASS(name, basename)
63 #define wxIMPLEMENT_CLASS2(name, basename1, basename2) \
64 wxIMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
66 // -----------------------------------
67 // for pluggable classes
68 // -----------------------------------
70 // NOTE: this should probably be the very first statement
71 // in the class declaration so wxPluginSentinel is
72 // the first member initialised and the last destroyed.
74 // _DECLARE_DL_SENTINEL(name) wxPluginSentinel m_pluginsentinel;
76 #if wxUSE_NESTED_CLASSES
78 #define _DECLARE_DL_SENTINEL(name, exportdecl) \
79 class exportdecl name##PluginSentinel { \
81 static const wxString sm_className; \
83 name##PluginSentinel(); \
84 ~name##PluginSentinel(); \
86 name##PluginSentinel m_pluginsentinel
88 #define _IMPLEMENT_DL_SENTINEL(name) \
89 const wxString name::name##PluginSentinel::sm_className(#name); \
90 name::name##PluginSentinel::name##PluginSentinel() { \
91 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
92 if( e != 0 ) { e->RefObj(); } \
94 name::name##PluginSentinel::~name##PluginSentinel() { \
95 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
96 if( e != 0 ) { e->UnrefObj(); } \
100 #define _DECLARE_DL_SENTINEL(name)
101 #define _IMPLEMENT_DL_SENTINEL(name)
103 #endif // wxUSE_NESTED_CLASSES
105 #define wxDECLARE_PLUGGABLE_CLASS(name) \
106 wxDECLARE_DYNAMIC_CLASS(name); _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)
107 #define wxDECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \
108 wxDECLARE_ABSTRACT_CLASS(name); _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)
110 #define wxDECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
111 wxDECLARE_DYNAMIC_CLASS(name); _DECLARE_DL_SENTINEL(name, usergoo)
112 #define wxDECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) \
113 wxDECLARE_ABSTRACT_CLASS(name); _DECLARE_DL_SENTINEL(name, usergoo)
115 #define wxIMPLEMENT_PLUGGABLE_CLASS(name, basename) \
116 wxIMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
117 #define wxIMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) \
118 wxIMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
119 #define wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
120 wxIMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
121 #define wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
122 wxIMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
124 #define wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \
125 wxIMPLEMENT_PLUGGABLE_CLASS(name, basename)
126 #define wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) \
127 wxIMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
128 #define wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
129 wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
130 #define wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \
131 wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
133 #define wxCLASSINFO(name) (&name::ms_classInfo)
135 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo)
137 // Just seems a bit nicer-looking (pretend it's not a macro)
138 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo)
140 // this cast does some more checks at compile time as it uses static_cast
143 // note that it still has different semantics from dynamic_cast<> and so can't
144 // be replaced by it as long as there are any compilers not supporting it
145 #define wxDynamicCast(obj, className) \
146 ((className *) wxCheckDynamicCast( \
147 const_cast<wxObject *>(static_cast<const wxObject *>(\
148 const_cast<className *>(static_cast<const className *>(obj)))), \
149 &className::ms_classInfo))
151 // The 'this' pointer is always true, so use this version
152 // to cast the this pointer and avoid compiler warnings.
153 #define wxDynamicCastThis(className) \
154 (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
156 // FIXME-VC6: dummy argument needed because VC6 doesn't support explicitly
157 // choosing the template function to call
159 inline T
*wxCheckCast(const void *ptr
, T
* = NULL
)
161 wxASSERT_MSG( wxDynamicCast(ptr
, T
), "wxStaticCast() used incorrectly" );
162 return const_cast<T
*>(static_cast<const T
*>(ptr
));
165 #define wxStaticCast(obj, className) wxCheckCast((obj), (className *)NULL)
167 // ----------------------------------------------------------------------------
168 // set up memory debugging macros
169 // ----------------------------------------------------------------------------
172 Which new/delete operator variants do we want?
174 _WX_WANT_NEW_SIZET_WXCHAR_INT = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0)
175 _WX_WANT_DELETE_VOID = void operator delete (void * buf)
176 _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET = void operator delete (void *buf, const char *_fname, size_t _line)
177 _WX_WANT_DELETE_VOID_WXCHAR_INT = void operator delete(void *buf, wxChar*, int)
178 _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0)
179 _WX_WANT_ARRAY_DELETE_VOID = void operator delete[] (void *buf)
180 _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT = void operator delete[] (void* buf, wxChar*, int )
183 #if wxUSE_MEMORY_TRACING
185 // All compilers get this one
186 #define _WX_WANT_NEW_SIZET_WXCHAR_INT
188 // Everyone except Visage gets the next one
189 #ifndef __VISAGECPP__
190 #define _WX_WANT_DELETE_VOID
193 // Only visage gets this one under the correct circumstances
194 #if defined(__VISAGECPP__) && __DEBUG_ALLOC__
195 #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
198 // Only VC++ 6 and CodeWarrior get overloaded delete that matches new
199 #if (defined(__VISUALC__) && (__VISUALC__ >= 1200)) || \
200 (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
201 #define _WX_WANT_DELETE_VOID_WXCHAR_INT
204 // Now see who (if anyone) gets the array memory operators
205 #if wxUSE_ARRAY_MEMORY_OPERATORS
207 // Everyone except Visual C++ (cause problems for VC++ - crashes)
208 #if !defined(__VISUALC__)
209 #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
212 // Everyone except Visual C++ (cause problems for VC++ - crashes)
213 #if !defined(__VISUALC__)
214 #define _WX_WANT_ARRAY_DELETE_VOID
217 // Only CodeWarrior 6 or higher
218 #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
219 #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
222 #endif // wxUSE_ARRAY_MEMORY_OPERATORS
224 #endif // wxUSE_MEMORY_TRACING
226 // ----------------------------------------------------------------------------
227 // Compatibility macro aliases DECLARE group
228 // ----------------------------------------------------------------------------
229 // deprecated variants _not_ requiring a semicolon after them and without wx prefix.
230 // (note that also some wx-prefixed macro do _not_ require a semicolon because
231 // it's not always possible to force the compire to require it)
233 #define DECLARE_CLASS_INFO_ITERATORS() wxDECLARE_CLASS_INFO_ITERATORS();
234 #define DECLARE_ABSTRACT_CLASS(n) wxDECLARE_ABSTRACT_CLASS(n);
235 #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(n) wxDECLARE_DYNAMIC_CLASS_NO_ASSIGN(n);
236 #define DECLARE_DYNAMIC_CLASS_NO_COPY(n) wxDECLARE_DYNAMIC_CLASS_NO_COPY(n);
237 #define DECLARE_DYNAMIC_CLASS(n) wxDECLARE_DYNAMIC_CLASS(n);
238 #define DECLARE_CLASS(n) wxDECLARE_CLASS(n);
240 #define DECLARE_PLUGGABLE_CLASS(n) wxDECLARE_PLUGGABLE_CLASS(n);
241 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(n) wxDECLARE_ABSTRACT_PLUGGABLE_CLASS(n);
242 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(n,u) wxDECLARE_USER_EXPORTED_PLUGGABLE_CLASS(n,u);
243 #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,u) wxDECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,u);
245 // ----------------------------------------------------------------------------
246 // wxRefCounter: ref counted data "manager"
247 // ----------------------------------------------------------------------------
249 class WXDLLIMPEXP_BASE wxRefCounter
252 wxRefCounter() { m_count
= 1; }
254 int GetRefCount() const { return m_count
; }
256 void IncRef() { m_count
++; }
260 // this object should never be destroyed directly but only as a
261 // result of a DecRef() call:
262 virtual ~wxRefCounter() { }
268 // It doesn't make sense to copy the reference counted objects, a new ref
269 // counter should be created for a new object instead and compilation
270 // errors in the code using wxRefCounter due to the lack of copy ctor often
271 // indicate a problem, e.g. a forgotten copy ctor implementation somewhere.
272 wxDECLARE_NO_COPY_CLASS(wxRefCounter
);
275 // ----------------------------------------------------------------------------
276 // wxObjectRefData: ref counted data meant to be stored in wxObject
277 // ----------------------------------------------------------------------------
279 typedef wxRefCounter wxObjectRefData
;
281 // ----------------------------------------------------------------------------
282 // wxObjectDataPtr: helper class to avoid memleaks because of missing calls
283 // to wxObjectRefData::DecRef
284 // ----------------------------------------------------------------------------
287 class wxObjectDataPtr
290 typedef T element_type
;
292 wxEXPLICIT
wxObjectDataPtr(T
*ptr
= NULL
) : m_ptr(ptr
) {}
295 wxObjectDataPtr(const wxObjectDataPtr
<T
> &tocopy
)
296 : m_ptr(tocopy
.m_ptr
)
308 T
*get() const { return m_ptr
; }
310 // test for pointer validity: defining conversion to unspecified_bool_type
311 // and not more obvious bool to avoid implicit conversions to integer types
312 typedef T
*(wxObjectDataPtr
<T
>::*unspecified_bool_type
)() const;
313 operator unspecified_bool_type() const
315 return m_ptr
? &wxObjectDataPtr
<T
>::get
: NULL
;
320 wxASSERT(m_ptr
!= NULL
);
324 T
*operator->() const
326 wxASSERT(m_ptr
!= NULL
);
337 wxObjectDataPtr
& operator=(const wxObjectDataPtr
&tocopy
)
341 m_ptr
= tocopy
.m_ptr
;
347 wxObjectDataPtr
& operator=(T
*ptr
)
359 // ----------------------------------------------------------------------------
360 // wxObject: the root class of wxWidgets object hierarchy
361 // ----------------------------------------------------------------------------
363 class WXDLLIMPEXP_BASE wxObject
365 wxDECLARE_ABSTRACT_CLASS(wxObject
);
368 wxObject() { m_refData
= NULL
; }
369 virtual ~wxObject() { UnRef(); }
371 wxObject(const wxObject
& other
)
373 m_refData
= other
.m_refData
;
378 wxObject
& operator=(const wxObject
& other
)
380 if ( this != &other
)
387 bool IsKindOf(const wxClassInfo
*info
) const;
390 // Turn on the correct set of new and delete operators
392 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
393 void *operator new ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
396 #ifdef _WX_WANT_DELETE_VOID
397 void operator delete ( void * buf
);
400 #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
401 void operator delete ( void *buf
, const char *_fname
, size_t _line
);
404 #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
405 void operator delete ( void *buf
, const wxChar
*, int );
408 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
409 void *operator new[] ( size_t size
, const wxChar
*fileName
= NULL
, int lineNum
= 0 );
412 #ifdef _WX_WANT_ARRAY_DELETE_VOID
413 void operator delete[] ( void *buf
);
416 #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
417 void operator delete[] (void* buf
, const wxChar
*, int );
420 // ref counted data handling methods
423 wxObjectRefData
*GetRefData() const { return m_refData
; }
424 void SetRefData(wxObjectRefData
*data
) { m_refData
= data
; }
426 // make a 'clone' of the object
427 void Ref(const wxObject
& clone
);
429 // destroy a reference
432 // Make sure this object has only one reference
433 void UnShare() { AllocExclusive(); }
435 // check if this object references the same data as the other one
436 bool IsSameAs(const wxObject
& o
) const { return m_refData
== o
.m_refData
; }
439 // ensure that our data is not shared with anybody else: if we have no
440 // data, it is created using CreateRefData() below, if we have shared data
441 // it is copied using CloneRefData(), otherwise nothing is done
442 void AllocExclusive();
444 // both methods must be implemented if AllocExclusive() is used, not pure
445 // virtual only because of the backwards compatibility reasons
447 // create a new m_refData
448 virtual wxObjectRefData
*CreateRefData() const;
450 // create a new m_refData initialized with the given one
451 virtual wxObjectRefData
*CloneRefData(const wxObjectRefData
*data
) const;
453 wxObjectRefData
*m_refData
;
456 inline wxObject
*wxCheckDynamicCast(wxObject
*obj
, wxClassInfo
*classInfo
)
458 return obj
&& obj
->GetClassInfo()->IsKindOf(classInfo
) ? obj
: NULL
;
463 // ----------------------------------------------------------------------------
464 // more debugging macros
465 // ----------------------------------------------------------------------------
467 #if wxUSE_DEBUG_NEW_ALWAYS
468 #define WXDEBUG_NEW new(__TFILE__,__LINE__)
470 #if wxUSE_GLOBAL_MEMORY_OPERATORS
471 #define new WXDEBUG_NEW
472 #elif defined(__VISUALC__)
473 // Including this file redefines new and allows leak reports to
474 // contain line numbers
475 #include "wx/msw/msvcrt.h"
477 #endif // wxUSE_DEBUG_NEW_ALWAYS
479 // ----------------------------------------------------------------------------
480 // Compatibility macro aliases IMPLEMENT group
481 // ----------------------------------------------------------------------------
483 // deprecated variants _not_ requiring a semicolon after them and without wx prefix.
484 // (note that also some wx-prefixed macro do _not_ require a semicolon because
485 // it's not always possible to force the compire to require it)
487 #define IMPLEMENT_DYNAMIC_CLASS(n,b) wxIMPLEMENT_DYNAMIC_CLASS(n,b)
488 #define IMPLEMENT_DYNAMIC_CLASS2(n,b1,b2) wxIMPLEMENT_DYNAMIC_CLASS2(n,b1,b2)
489 #define IMPLEMENT_ABSTRACT_CLASS(n,b) wxIMPLEMENT_ABSTRACT_CLASS(n,b)
490 #define IMPLEMENT_ABSTRACT_CLASS2(n,b1,b2) wxIMPLEMENT_ABSTRACT_CLASS2(n,b1,b2)
491 #define IMPLEMENT_CLASS(n,b) wxIMPLEMENT_CLASS(n,b)
492 #define IMPLEMENT_CLASS2(n,b1,b2) wxIMPLEMENT_CLASS2(n,b1,b2)
494 #define IMPLEMENT_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_PLUGGABLE_CLASS(n,b)
495 #define IMPLEMENT_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_PLUGGABLE_CLASS2(n,b,b2)
496 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(n,b)
497 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2)
498 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(n,b)
499 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(n,b,b2)
500 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,b) wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(n,b)
501 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2) wxIMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(n,b,b2)
503 #define CLASSINFO(n) wxCLASSINFO(n)
505 #endif // _WX_OBJECTH__