]>
Commit | Line | Data |
---|---|---|
c801d85f | 1 | ///////////////////////////////////////////////////////////////////////////// |
b2edef6f | 2 | // Name: wx/object.h |
c801d85f KB |
3 | // Purpose: wxObject class, plus run-time type information macros |
4 | // Author: Julian Smart | |
0b9ab0bd | 5 | // Modified by: Ron Lee |
c801d85f KB |
6 | // Created: 01/02/97 |
7 | // RCS-ID: $Id$ | |
371a5b4e | 8 | // Copyright: (c) 1997 Julian Smart |
0b9ab0bd | 9 | // (c) 2001 Ron Lee <ron@debian.org> |
65571936 | 10 | // Licence: wxWindows licence |
c801d85f KB |
11 | ///////////////////////////////////////////////////////////////////////////// |
12 | ||
34138703 JS |
13 | #ifndef _WX_OBJECTH__ |
14 | #define _WX_OBJECTH__ | |
c801d85f | 15 | |
0b9ab0bd RL |
16 | // ---------------------------------------------------------------------------- |
17 | // headers | |
18 | // ---------------------------------------------------------------------------- | |
19 | ||
e55ad60e | 20 | #include "wx/memory.h" |
c801d85f | 21 | |
b5dbe15d VS |
22 | class WXDLLIMPEXP_FWD_BASE wxObject; |
23 | class WXDLLIMPEXP_FWD_BASE wxString; | |
c801d85f | 24 | |
4393b50c | 25 | #ifndef wxUSE_EXTENDED_RTTI |
6d553b5f | 26 | #define wxUSE_EXTENDED_RTTI 0 |
a095505c SC |
27 | #endif |
28 | ||
644cb537 MB |
29 | #define DECLARE_CLASS_INFO_ITERATORS() \ |
30 | class WXDLLIMPEXP_BASE const_iterator \ | |
31 | { \ | |
32 | typedef wxHashTable_Node Node; \ | |
33 | public: \ | |
34 | typedef const wxClassInfo* value_type; \ | |
35 | typedef const value_type& const_reference; \ | |
36 | typedef const_iterator itor; \ | |
37 | typedef value_type* ptr_type; \ | |
38 | \ | |
39 | Node* m_node; \ | |
40 | wxHashTable* m_table; \ | |
41 | public: \ | |
42 | typedef const_reference reference_type; \ | |
43 | typedef ptr_type pointer_type; \ | |
44 | \ | |
45 | const_iterator(Node* node, wxHashTable* table) \ | |
46 | : m_node(node), m_table(table) { } \ | |
47 | const_iterator() : m_node(NULL), m_table(NULL) { } \ | |
48 | value_type operator*() const; \ | |
49 | itor& operator++(); \ | |
50 | const itor operator++(int); \ | |
51 | bool operator!=(const itor& it) const \ | |
52 | { return it.m_node != m_node; } \ | |
53 | bool operator==(const itor& it) const \ | |
54 | { return it.m_node == m_node; } \ | |
55 | }; \ | |
56 | \ | |
57 | static const_iterator begin_classinfo(); \ | |
58 | static const_iterator end_classinfo(); | |
59 | ||
6d553b5f | 60 | #if wxUSE_EXTENDED_RTTI |
a095505c | 61 | #include "wx/xti.h" |
a095505c SC |
62 | #else |
63 | ||
0b9ab0bd RL |
64 | // ---------------------------------------------------------------------------- |
65 | // conditional compilation | |
66 | // ---------------------------------------------------------------------------- | |
67 | ||
b5dbe15d VS |
68 | class WXDLLIMPEXP_FWD_BASE wxClassInfo; |
69 | class WXDLLIMPEXP_FWD_BASE wxHashTable; | |
70 | class WXDLLIMPEXP_FWD_BASE wxObject; | |
71 | class WXDLLIMPEXP_FWD_BASE wxPluginLibrary; | |
72 | class WXDLLIMPEXP_FWD_BASE wxObjectRefData; | |
73 | class WXDLLIMPEXP_FWD_BASE wxHashTable_Node; | |
c801d85f | 74 | |
0b9ab0bd RL |
75 | // ---------------------------------------------------------------------------- |
76 | // wxClassInfo | |
77 | // ---------------------------------------------------------------------------- | |
78 | ||
79 | typedef wxObject *(*wxObjectConstructorFn)(void); | |
c801d85f | 80 | |
bddd7a8d | 81 | class WXDLLIMPEXP_BASE wxClassInfo |
c801d85f | 82 | { |
b5dbe15d | 83 | friend class WXDLLIMPEXP_FWD_BASE wxObject; |
c1e10a22 | 84 | friend WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name); |
aac65598 | 85 | public: |
38befbee | 86 | wxClassInfo( const wxChar *className, |
d1d738f1 VS |
87 | const wxClassInfo *baseInfo1, |
88 | const wxClassInfo *baseInfo2, | |
38befbee RL |
89 | int size, |
90 | wxObjectConstructorFn ctor ) | |
0b9ab0bd | 91 | : m_className(className) |
0b9ab0bd RL |
92 | , m_objectSize(size) |
93 | , m_objectConstructor(ctor) | |
d1d738f1 VS |
94 | , m_baseInfo1(baseInfo1) |
95 | , m_baseInfo2(baseInfo2) | |
0b9ab0bd | 96 | , m_next(sm_first) |
7e548f6b | 97 | { |
d1d738f1 VS |
98 | sm_first = this; |
99 | Register(); | |
100 | } | |
0b9ab0bd | 101 | |
aa4b7ef9 | 102 | ~wxClassInfo(); |
1d2eddff | 103 | |
4e124582 VZ |
104 | wxObject *CreateObject() const |
105 | { return m_objectConstructor ? (*m_objectConstructor)() : 0; } | |
0c06c983 | 106 | bool IsDynamic() const { return (NULL != m_objectConstructor); } |
0b9ab0bd RL |
107 | |
108 | const wxChar *GetClassName() const { return m_className; } | |
469349b5 MB |
109 | const wxChar *GetBaseClassName1() const |
110 | { return m_baseInfo1 ? m_baseInfo1->GetClassName() : NULL; } | |
111 | const wxChar *GetBaseClassName2() const | |
112 | { return m_baseInfo2 ? m_baseInfo2->GetClassName() : NULL; } | |
0b9ab0bd RL |
113 | const wxClassInfo *GetBaseClass1() const { return m_baseInfo1; } |
114 | const wxClassInfo *GetBaseClass2() const { return m_baseInfo2; } | |
115 | int GetSize() const { return m_objectSize; } | |
116 | ||
4e124582 VZ |
117 | wxObjectConstructorFn GetConstructor() const |
118 | { return m_objectConstructor; } | |
0b9ab0bd RL |
119 | static const wxClassInfo *GetFirst() { return sm_first; } |
120 | const wxClassInfo *GetNext() const { return m_next; } | |
c1e10a22 | 121 | static wxClassInfo *FindClass(const wxString& className); |
807d8487 | 122 | |
0b9ab0bd RL |
123 | // Climb upwards through inheritance hierarchy. |
124 | // Dual inheritance is catered for. | |
125 | ||
126 | bool IsKindOf(const wxClassInfo *info) const | |
127 | { | |
128 | return info != 0 && | |
129 | ( info == this || | |
130 | ( m_baseInfo1 && m_baseInfo1->IsKindOf(info) ) || | |
131 | ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) ); | |
132 | } | |
3f4a0c5b | 133 | |
644cb537 MB |
134 | DECLARE_CLASS_INFO_ITERATORS() |
135 | private: | |
0b9ab0bd | 136 | const wxChar *m_className; |
0b9ab0bd RL |
137 | int m_objectSize; |
138 | wxObjectConstructorFn m_objectConstructor; | |
139 | ||
1125dc3f | 140 | // Pointers to base wxClassInfos |
0b9ab0bd RL |
141 | |
142 | const wxClassInfo *m_baseInfo1; | |
143 | const wxClassInfo *m_baseInfo2; | |
144 | ||
145 | // class info object live in a linked list: | |
146 | // pointers to its head and the next element in it | |
147 | ||
148 | static wxClassInfo *sm_first; | |
149 | wxClassInfo *m_next; | |
150 | ||
151 | static wxHashTable *sm_classTable; | |
1f428942 | 152 | |
7e548f6b | 153 | protected: |
d1d738f1 VS |
154 | // registers the class |
155 | void Register(); | |
156 | void Unregister(); | |
1125dc3f | 157 | |
c0c133e1 | 158 | wxDECLARE_NO_COPY_CLASS(wxClassInfo); |
c801d85f KB |
159 | }; |
160 | ||
c1e10a22 | 161 | WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name); |
c801d85f | 162 | |
0b9ab0bd RL |
163 | // ---------------------------------------------------------------------------- |
164 | // Dynamic class macros | |
165 | // ---------------------------------------------------------------------------- | |
166 | ||
14ca93a0 VZ |
167 | #define DECLARE_ABSTRACT_CLASS(name) \ |
168 | public: \ | |
169 | static wxClassInfo ms_classInfo; \ | |
170 | virtual wxClassInfo *GetClassInfo() const; | |
171 | ||
172 | #define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \ | |
173 | DECLARE_NO_ASSIGN_CLASS(name) \ | |
fc7a2a60 VZ |
174 | DECLARE_DYNAMIC_CLASS(name) |
175 | ||
14ca93a0 VZ |
176 | #define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \ |
177 | DECLARE_NO_COPY_CLASS(name) \ | |
fc7a2a60 VZ |
178 | DECLARE_DYNAMIC_CLASS(name) |
179 | ||
14ca93a0 VZ |
180 | #define DECLARE_DYNAMIC_CLASS(name) \ |
181 | DECLARE_ABSTRACT_CLASS(name) \ | |
182 | static wxObject* wxCreateObject(); | |
183 | ||
c801d85f KB |
184 | #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name) |
185 | ||
14ca93a0 VZ |
186 | |
187 | // common part of the macros below | |
188 | #define wxIMPLEMENT_CLASS_COMMON(name, basename, baseclsinfo2, func) \ | |
189 | wxClassInfo name::ms_classInfo(wxT(#name), \ | |
190 | &basename::ms_classInfo, \ | |
191 | baseclsinfo2, \ | |
192 | (int) sizeof(name), \ | |
32bb5309 | 193 | func); \ |
14ca93a0 VZ |
194 | \ |
195 | wxClassInfo *name::GetClassInfo() const \ | |
196 | { return &name::ms_classInfo; } | |
197 | ||
198 | #define wxIMPLEMENT_CLASS_COMMON1(name, basename, func) \ | |
199 | wxIMPLEMENT_CLASS_COMMON(name, basename, NULL, func) | |
200 | ||
201 | #define wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, func) \ | |
2b199a38 | 202 | wxIMPLEMENT_CLASS_COMMON(name, basename1, &basename2::ms_classInfo, func) |
14ca93a0 | 203 | |
0b9ab0bd RL |
204 | // ----------------------------------- |
205 | // for concrete classes | |
206 | // ----------------------------------- | |
207 | ||
208 | // Single inheritance with one base class | |
14ca93a0 VZ |
209 | #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \ |
210 | wxIMPLEMENT_CLASS_COMMON1(name, basename, name::wxCreateObject) \ | |
211 | wxObject* name::wxCreateObject() \ | |
212 | { return new name; } | |
c801d85f | 213 | |
0b9ab0bd | 214 | // Multiple inheritance with two base classes |
14ca93a0 VZ |
215 | #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \ |
216 | wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, \ | |
217 | name::wxCreateObject) \ | |
218 | wxObject* name::wxCreateObject() \ | |
219 | { return new name; } | |
c801d85f | 220 | |
0b9ab0bd RL |
221 | // ----------------------------------- |
222 | // for abstract classes | |
223 | // ----------------------------------- | |
c801d85f | 224 | |
0b9ab0bd RL |
225 | // Single inheritance with one base class |
226 | ||
14ca93a0 VZ |
227 | #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \ |
228 | wxIMPLEMENT_CLASS_COMMON1(name, basename, NULL) | |
0b9ab0bd RL |
229 | |
230 | // Multiple inheritance with two base classes | |
231 | ||
14ca93a0 VZ |
232 | #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \ |
233 | wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, NULL) | |
c801d85f KB |
234 | |
235 | #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS | |
236 | #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2 | |
237 | ||
6d553b5f | 238 | #endif // !wxUSE_EXTENDED_RTTI |
a095505c SC |
239 | |
240 | ||
0b9ab0bd RL |
241 | // ----------------------------------- |
242 | // for pluggable classes | |
243 | // ----------------------------------- | |
244 | ||
245 | // NOTE: this should probably be the very first statement | |
246 | // in the class declaration so wxPluginSentinel is | |
247 | // the first member initialised and the last destroyed. | |
248 | ||
249 | // _DECLARE_DL_SENTINEL(name) wxPluginSentinel m_pluginsentinel; | |
250 | ||
251 | #if wxUSE_NESTED_CLASSES | |
252 | ||
60b73526 RL |
253 | #define _DECLARE_DL_SENTINEL(name, exportdecl) \ |
254 | class exportdecl name##PluginSentinel { \ | |
255 | private: \ | |
256 | static const wxString sm_className; \ | |
257 | public: \ | |
258 | name##PluginSentinel(); \ | |
2e0b1b11 | 259 | ~name##PluginSentinel(); \ |
60b73526 | 260 | }; \ |
0b9ab0bd | 261 | name##PluginSentinel m_pluginsentinel; |
0b9ab0bd RL |
262 | |
263 | #define _IMPLEMENT_DL_SENTINEL(name) \ | |
264 | const wxString name::name##PluginSentinel::sm_className(#name); \ | |
265 | name::name##PluginSentinel::name##PluginSentinel() { \ | |
4f89dbc4 | 266 | wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \ |
7c1e2b44 | 267 | if( e != 0 ) { e->RefObj(); } \ |
0b9ab0bd | 268 | } \ |
abad5367 | 269 | name::name##PluginSentinel::~name##PluginSentinel() { \ |
4f89dbc4 | 270 | wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \ |
7c1e2b44 | 271 | if( e != 0 ) { e->UnrefObj(); } \ |
0b9ab0bd RL |
272 | } |
273 | #else | |
274 | ||
275 | #define _DECLARE_DL_SENTINEL(name) | |
276 | #define _IMPLEMENT_DL_SENTINEL(name) | |
277 | ||
278 | #endif // wxUSE_NESTED_CLASSES | |
279 | ||
280 | #define DECLARE_PLUGGABLE_CLASS(name) \ | |
53a2db12 | 281 | DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE) |
0b9ab0bd | 282 | #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name) \ |
53a2db12 | 283 | DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE) |
60b73526 RL |
284 | |
285 | #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \ | |
286 | DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo) | |
287 | #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo) \ | |
288 | DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo) | |
0b9ab0bd RL |
289 | |
290 | #define IMPLEMENT_PLUGGABLE_CLASS(name, basename) \ | |
291 | IMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name) | |
292 | #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) \ | |
293 | IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name) | |
0b9ab0bd RL |
294 | #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \ |
295 | IMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name) | |
296 | #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \ | |
297 | IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name) | |
298 | ||
60b73526 RL |
299 | #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \ |
300 | IMPLEMENT_PLUGGABLE_CLASS(name, basename) | |
301 | #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2) \ | |
302 | IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2) | |
303 | #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \ | |
304 | IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) | |
305 | #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) \ | |
306 | IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2) | |
307 | ||
c0db9626 | 308 | #define CLASSINFO(name) (&name::ms_classInfo) |
c801d85f | 309 | |
c0db9626 | 310 | #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo) |
3013b6f4 | 311 | |
b2edef6f | 312 | // Just seems a bit nicer-looking (pretend it's not a macro) |
c0db9626 | 313 | #define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo) |
c801d85f | 314 | |
73fbb031 VZ |
315 | // this cast does some more checks at compile time as it uses static_cast |
316 | // internally | |
317 | // | |
318 | // note that it still has different semantics from dynamic_cast<> and so can't | |
319 | // be replaced by it as long as there are any compilers not supporting it | |
34636400 | 320 | #define wxDynamicCast(obj, className) \ |
5232d996 | 321 | ((className *) wxCheckDynamicCast( \ |
5c33522f VZ |
322 | const_cast<wxObject *>(static_cast<const wxObject *>(\ |
323 | const_cast<className *>(static_cast<const className *>(obj)))), \ | |
5232d996 | 324 | &className::ms_classInfo)) |
0b9ab0bd | 325 | |
b2edef6f VZ |
326 | // The 'this' pointer is always true, so use this version |
327 | // to cast the this pointer and avoid compiler warnings. | |
f7637829 | 328 | #define wxDynamicCastThis(className) \ |
73fbb031 | 329 | (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0) |
33ac7e6f | 330 | |
f6bcfd97 | 331 | #ifdef __WXDEBUG__ |
e32d4836 | 332 | inline void* wxCheckCast(void *ptr) |
0b9ab0bd RL |
333 | { |
334 | wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") ); | |
e32d4836 | 335 | return ptr; |
0b9ab0bd RL |
336 | } |
337 | #define wxStaticCast(obj, className) \ | |
e32d4836 | 338 | ((className *)wxCheckCast(wxDynamicCast(obj, className))) |
f6bcfd97 | 339 | |
0b9ab0bd | 340 | #else // !__WXDEBUG__ |
ef0aea5a | 341 | #define wxStaticCast(obj, className) \ |
5c33522f | 342 | const_cast<className *>(static_cast<const className *>(obj)) |
f6bcfd97 | 343 | |
0b9ab0bd | 344 | #endif // __WXDEBUG__ |
f6bcfd97 | 345 | |
b2edef6f VZ |
346 | // ---------------------------------------------------------------------------- |
347 | // set up memory debugging macros | |
348 | // ---------------------------------------------------------------------------- | |
349 | ||
350 | /* | |
351 | Which new/delete operator variants do we want? | |
352 | ||
353 | _WX_WANT_NEW_SIZET_WXCHAR_INT = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0) | |
354 | _WX_WANT_DELETE_VOID = void operator delete (void * buf) | |
355 | _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET = void operator delete (void *buf, const char *_fname, size_t _line) | |
356 | _WX_WANT_DELETE_VOID_WXCHAR_INT = void operator delete(void *buf, wxChar*, int) | |
357 | _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0) | |
358 | _WX_WANT_ARRAY_DELETE_VOID = void operator delete[] (void *buf) | |
359 | _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT = void operator delete[] (void* buf, wxChar*, int ) | |
360 | */ | |
361 | ||
362 | #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING | |
363 | ||
364 | // All compilers get this one | |
365 | #define _WX_WANT_NEW_SIZET_WXCHAR_INT | |
366 | ||
367 | // Everyone except Visage gets the next one | |
368 | #ifndef __VISAGECPP__ | |
369 | #define _WX_WANT_DELETE_VOID | |
c801d85f | 370 | #endif |
b2edef6f VZ |
371 | |
372 | // Only visage gets this one under the correct circumstances | |
373 | #if defined(__VISAGECPP__) && __DEBUG_ALLOC__ | |
374 | #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET | |
375 | #endif | |
376 | ||
4e124582 VZ |
377 | // Only VC++ 6 and CodeWarrior get overloaded delete that matches new |
378 | #if (defined(__VISUALC__) && (__VISUALC__ >= 1200)) || \ | |
379 | (defined(__MWERKS__) && (__MWERKS__ >= 0x2400)) | |
b2edef6f | 380 | #define _WX_WANT_DELETE_VOID_WXCHAR_INT |
fd85b064 | 381 | #endif |
c801d85f | 382 | |
b2edef6f VZ |
383 | // Now see who (if anyone) gets the array memory operators |
384 | #if wxUSE_ARRAY_MEMORY_OPERATORS | |
385 | ||
386 | // Everyone except Visual C++ (cause problems for VC++ - crashes) | |
387 | #if !defined(__VISUALC__) | |
388 | #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT | |
389 | #endif | |
390 | ||
391 | // Everyone except Visual C++ (cause problems for VC++ - crashes) | |
392 | #if !defined(__VISUALC__) | |
393 | #define _WX_WANT_ARRAY_DELETE_VOID | |
394 | #endif | |
395 | ||
396 | // Only CodeWarrior 6 or higher | |
397 | #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400) | |
398 | #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT | |
399 | #endif | |
400 | ||
401 | #endif // wxUSE_ARRAY_MEMORY_OPERATORS | |
402 | ||
e755eb67 | 403 | #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING |
b2edef6f | 404 | |
f8855e47 VZ |
405 | // ---------------------------------------------------------------------------- |
406 | // wxObjectRefData: ref counted data meant to be stored in wxObject | |
407 | // ---------------------------------------------------------------------------- | |
408 | ||
409 | class WXDLLIMPEXP_BASE wxObjectRefData | |
410 | { | |
b5dbe15d | 411 | friend class WXDLLIMPEXP_FWD_BASE wxObject; |
f8855e47 VZ |
412 | |
413 | public: | |
414 | wxObjectRefData() : m_count(1) { } | |
f8855e47 VZ |
415 | |
416 | int GetRefCount() const { return m_count; } | |
417 | ||
4a11340a RR |
418 | void IncRef() { m_count++; } |
419 | void DecRef(); | |
420 | ||
421 | protected: | |
422 | // this object should never be destroyed directly but only as a | |
423 | // result of a DecRef() call: | |
424 | virtual ~wxObjectRefData() { } | |
425 | ||
f8855e47 | 426 | private: |
4a11340a | 427 | // our refcount: |
f8855e47 VZ |
428 | int m_count; |
429 | }; | |
430 | ||
4a11340a RR |
431 | // ---------------------------------------------------------------------------- |
432 | // wxObjectDataPtr: helper class to avoid memleaks because of missing calls | |
433 | // to wxObjectRefData::DecRef | |
434 | // ---------------------------------------------------------------------------- | |
435 | ||
436 | template <class T> | |
437 | class wxObjectDataPtr | |
438 | { | |
439 | public: | |
440 | typedef T element_type; | |
441 | ||
442 | wxEXPLICIT wxObjectDataPtr(T *ptr = NULL) : m_ptr(ptr) {} | |
443 | ||
444 | // copy ctor | |
53a2db12 | 445 | wxObjectDataPtr(const wxObjectDataPtr<T> &tocopy) |
4a11340a | 446 | : m_ptr(tocopy.m_ptr) |
53a2db12 | 447 | { |
4a11340a | 448 | if (m_ptr) |
53a2db12 | 449 | m_ptr->IncRef(); |
4a11340a RR |
450 | } |
451 | ||
53a2db12 FM |
452 | ~wxObjectDataPtr() |
453 | { | |
454 | if (m_ptr) | |
455 | m_ptr->DecRef(); | |
4a11340a RR |
456 | } |
457 | ||
458 | T *get() const { return m_ptr; } | |
53a2db12 | 459 | |
a60b0ddc RR |
460 | // test for pointer validity: defining conversion to unspecified_bool_type |
461 | // and not more obvious bool to avoid implicit conversions to integer types | |
462 | typedef T *(wxObjectDataPtr<T>::*unspecified_bool_type)() const; | |
463 | operator unspecified_bool_type() const | |
464 | { | |
465 | return m_ptr ? &wxObjectDataPtr<T>::get : NULL; | |
466 | } | |
467 | ||
468 | T& operator*() const | |
53a2db12 FM |
469 | { |
470 | wxASSERT(m_ptr != NULL); | |
a60b0ddc RR |
471 | return *(m_ptr); |
472 | } | |
53a2db12 | 473 | |
e39d30c0 | 474 | T *operator->() const |
53a2db12 FM |
475 | { |
476 | wxASSERT(m_ptr != NULL); | |
477 | return get(); | |
e39d30c0 | 478 | } |
4a11340a RR |
479 | |
480 | void reset(T *ptr) | |
481 | { | |
482 | if (m_ptr) | |
483 | m_ptr->DecRef(); | |
484 | m_ptr = ptr; | |
485 | } | |
486 | ||
487 | wxObjectDataPtr& operator=(const wxObjectDataPtr &tocopy) | |
53a2db12 FM |
488 | { |
489 | if (m_ptr) | |
490 | m_ptr->DecRef(); | |
491 | m_ptr = tocopy.m_ptr; | |
4a11340a | 492 | if (m_ptr) |
53a2db12 | 493 | m_ptr->IncRef(); |
4a11340a RR |
494 | return *this; |
495 | } | |
496 | ||
497 | wxObjectDataPtr& operator=(T *ptr) | |
53a2db12 FM |
498 | { |
499 | if (m_ptr) | |
500 | m_ptr->DecRef(); | |
501 | m_ptr = ptr; | |
4a11340a RR |
502 | return *this; |
503 | } | |
504 | ||
505 | private: | |
506 | T *m_ptr; | |
507 | }; | |
508 | ||
0b9ab0bd | 509 | // ---------------------------------------------------------------------------- |
77ffb593 | 510 | // wxObject: the root class of wxWidgets object hierarchy |
0b9ab0bd RL |
511 | // ---------------------------------------------------------------------------- |
512 | ||
bddd7a8d | 513 | class WXDLLIMPEXP_BASE wxObject |
c801d85f | 514 | { |
684242c6 | 515 | DECLARE_ABSTRACT_CLASS(wxObject) |
c801d85f | 516 | |
0b9ab0bd | 517 | public: |
b2edef6f | 518 | wxObject() { m_refData = NULL; } |
0b9ab0bd | 519 | virtual ~wxObject() { UnRef(); } |
4393b50c | 520 | |
a6391d30 | 521 | wxObject(const wxObject& other) |
66e9a9f0 | 522 | { |
f8855e47 VZ |
523 | m_refData = other.m_refData; |
524 | if (m_refData) | |
525 | m_refData->m_count++; | |
66e9a9f0 | 526 | } |
4393b50c | 527 | |
a6391d30 GD |
528 | wxObject& operator=(const wxObject& other) |
529 | { | |
530 | if ( this != &other ) | |
531 | { | |
f8855e47 | 532 | Ref(other); |
a6391d30 GD |
533 | } |
534 | return *this; | |
535 | } | |
536 | ||
303c6f20 | 537 | bool IsKindOf(const wxClassInfo *info) const; |
c801d85f | 538 | |
0b9ab0bd | 539 | |
b2edef6f VZ |
540 | // Turn on the correct set of new and delete operators |
541 | ||
542 | #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT | |
cf760e4c | 543 | void *operator new ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 ); |
0b9ab0bd | 544 | #endif |
27198be4 | 545 | |
b2edef6f VZ |
546 | #ifdef _WX_WANT_DELETE_VOID |
547 | void operator delete ( void * buf ); | |
548 | #endif | |
0b9ab0bd | 549 | |
b2edef6f VZ |
550 | #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET |
551 | void operator delete ( void *buf, const char *_fname, size_t _line ); | |
0b9ab0bd | 552 | #endif |
76626af2 | 553 | |
b2edef6f | 554 | #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT |
cf760e4c | 555 | void operator delete ( void *buf, const wxChar*, int ); |
b2edef6f | 556 | #endif |
8cfc5426 | 557 | |
b2edef6f | 558 | #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT |
cf760e4c | 559 | void *operator new[] ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 ); |
0b9ab0bd RL |
560 | #endif |
561 | ||
b2edef6f VZ |
562 | #ifdef _WX_WANT_ARRAY_DELETE_VOID |
563 | void operator delete[] ( void *buf ); | |
0b9ab0bd | 564 | #endif |
27198be4 | 565 | |
b2edef6f | 566 | #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT |
cf760e4c | 567 | void operator delete[] (void* buf, const wxChar*, int ); |
b2edef6f | 568 | #endif |
c801d85f | 569 | |
807d8487 VZ |
570 | // ref counted data handling methods |
571 | ||
572 | // get/set | |
573 | wxObjectRefData *GetRefData() const { return m_refData; } | |
574 | void SetRefData(wxObjectRefData *data) { m_refData = data; } | |
575 | ||
576 | // make a 'clone' of the object | |
0b9ab0bd | 577 | void Ref(const wxObject& clone); |
c801d85f | 578 | |
807d8487 | 579 | // destroy a reference |
0b9ab0bd | 580 | void UnRef(); |
c801d85f | 581 | |
93c5f755 PC |
582 | // Make sure this object has only one reference |
583 | void UnShare() { AllocExclusive(); } | |
584 | ||
a3ab1c18 VZ |
585 | // check if this object references the same data as the other one |
586 | bool IsSameAs(const wxObject& o) const { return m_refData == o.m_refData; } | |
55ccdb93 | 587 | |
c801d85f | 588 | protected: |
807d8487 VZ |
589 | // ensure that our data is not shared with anybody else: if we have no |
590 | // data, it is created using CreateRefData() below, if we have shared data | |
591 | // it is copied using CloneRefData(), otherwise nothing is done | |
592 | void AllocExclusive(); | |
593 | ||
4e124582 VZ |
594 | // both methods must be implemented if AllocExclusive() is used, not pure |
595 | // virtual only because of the backwards compatibility reasons | |
807d8487 VZ |
596 | |
597 | // create a new m_refData | |
598 | virtual wxObjectRefData *CreateRefData() const; | |
599 | ||
600 | // create a new m_refData initialized with the given one | |
b8027888 | 601 | virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const; |
807d8487 | 602 | |
0b9ab0bd | 603 | wxObjectRefData *m_refData; |
c801d85f KB |
604 | }; |
605 | ||
ea1e6c4b RL |
606 | inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo) |
607 | { | |
b2edef6f | 608 | return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL; |
ea1e6c4b RL |
609 | } |
610 | ||
2d51f067 SC |
611 | #if wxUSE_EXTENDED_RTTI |
612 | class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject | |
613 | { | |
b5dbe15d | 614 | friend class WXDLLIMPEXP_FWD_BASE wxDynamicClassInfo ; |
2d51f067 SC |
615 | public: |
616 | // instantiates this object with an instance of its superclass | |
617 | wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ; | |
d3c7fc99 | 618 | virtual ~wxDynamicObject(); |
2d51f067 | 619 | |
8f2b1cfd SC |
620 | void SetProperty (const wxChar *propertyName, const wxxVariant &value); |
621 | wxxVariant GetProperty (const wxChar *propertyName) const ; | |
2d51f067 SC |
622 | |
623 | // get the runtime identity of this object | |
624 | wxClassInfo *GetClassInfo() const | |
625 | { | |
f525dc35 JS |
626 | #ifdef _MSC_VER |
627 | return (wxClassInfo*) m_classInfo; | |
628 | #else | |
5c33522f VZ |
629 | wxDynamicClassInfo *nonconst = const_cast<wxDynamicClassInfo *>(m_classInfo); |
630 | return static_cast<wxClassInfo *>(nonconst); | |
f525dc35 | 631 | #endif |
2d51f067 SC |
632 | } |
633 | ||
634 | wxObject* GetSuperClassInstance() const | |
635 | { | |
636 | return m_superClassInstance ; | |
637 | } | |
638 | private : | |
8f2b1cfd SC |
639 | // removes an existing runtime-property |
640 | void RemoveProperty( const wxChar *propertyName ) ; | |
641 | ||
642 | // renames an existing runtime-property | |
643 | void RenameProperty( const wxChar *oldPropertyName , const wxChar *newPropertyName ) ; | |
644 | ||
2d51f067 SC |
645 | wxObject *m_superClassInstance ; |
646 | const wxDynamicClassInfo *m_classInfo; | |
647 | struct wxDynamicObjectInternal; | |
648 | wxDynamicObjectInternal *m_data; | |
649 | }; | |
650 | #endif | |
651 | ||
b2edef6f VZ |
652 | // ---------------------------------------------------------------------------- |
653 | // more debugging macros | |
654 | // ---------------------------------------------------------------------------- | |
655 | ||
b2edef6f VZ |
656 | // Redefine new to be the debugging version. This doesn't work with all |
657 | // compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish | |
658 | // to use the debugging version. | |
7fe7d506 | 659 | |
70bf6180 VZ |
660 | #ifdef __WXDEBUG__ |
661 | #define WXDEBUG_NEW new(__TFILE__,__LINE__) | |
662 | ||
663 | #if wxUSE_DEBUG_NEW_ALWAYS | |
664 | #if wxUSE_GLOBAL_MEMORY_OPERATORS | |
665 | #define new WXDEBUG_NEW | |
666 | #elif defined(__VISUALC__) | |
667 | // Including this file redefines new and allows leak reports to | |
668 | // contain line numbers | |
669 | #include "wx/msw/msvcrt.h" | |
670 | #endif | |
671 | #endif // wxUSE_DEBUG_NEW_ALWAYS | |
672 | #else // !__WXDEBUG__ | |
673 | #define WXDEBUG_NEW new | |
674 | #endif // __WXDEBUG__/!__WXDEBUG__ | |
c801d85f | 675 | |
c0089c96 | 676 | #endif // _WX_OBJECTH__ |