]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/object.h
added AccessMode parameter to wxRegKey
[wxWidgets.git] / include / wx / object.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/object.h
3// Purpose: wxObject class, plus run-time type information macros
4// Author: Julian Smart
5// Modified by: Ron Lee
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c) 1997 Julian Smart
9// (c) 2001 Ron Lee <ron@debian.org>
10// Licence: wxWindows licence
11/////////////////////////////////////////////////////////////////////////////
12
13#ifndef _WX_OBJECTH__
14#define _WX_OBJECTH__
15
16#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
17#pragma interface "object.h"
18#endif
19
20// ----------------------------------------------------------------------------
21// headers
22// ----------------------------------------------------------------------------
23
24#include "wx/defs.h"
25#include "wx/memory.h"
26
27class WXDLLIMPEXP_BASE wxObject;
28
29#if wxUSE_DYNAMIC_CLASSES
30
31#ifndef wxUSE_EXTENDED_RTTI
32#define wxUSE_EXTENDED_RTTI 0
33#endif
34
35#if wxUSE_EXTENDED_RTTI
36#include "wx/xti.h"
37#else
38
39// ----------------------------------------------------------------------------
40// conditional compilation
41// ----------------------------------------------------------------------------
42
43// this shouldn't be needed any longer as <wx/msw/private.h> does it but it
44// doesn't hurt neither
45#ifdef GetClassName
46#undef GetClassName
47#endif
48#ifdef GetClassInfo
49#undef GetClassInfo
50#endif
51
52class WXDLLIMPEXP_BASE wxClassInfo;
53class WXDLLIMPEXP_BASE wxHashTable;
54class WXDLLIMPEXP_BASE wxObjectRefData;
55
56// ----------------------------------------------------------------------------
57// wxClassInfo
58// ----------------------------------------------------------------------------
59
60typedef wxObject *(*wxObjectConstructorFn)(void);
61
62class WXDLLIMPEXP_BASE wxClassInfo
63{
64public:
65 wxClassInfo( const wxChar *className,
66 const wxClassInfo *baseInfo1,
67 const wxClassInfo *baseInfo2,
68 int size,
69 wxObjectConstructorFn ctor )
70 : m_className(className)
71 , m_objectSize(size)
72 , m_objectConstructor(ctor)
73 , m_baseInfo1(baseInfo1)
74 , m_baseInfo2(baseInfo2)
75 , m_next(sm_first)
76 {
77 sm_first = this;
78 Register();
79 }
80
81 ~wxClassInfo();
82
83 wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
84
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; }
93
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);
98
99 // Climb upwards through inheritance hierarchy.
100 // Dual inheritance is catered for.
101
102 bool IsKindOf(const wxClassInfo *info) const
103 {
104 return info != 0 &&
105 ( info == this ||
106 ( m_baseInfo1 && m_baseInfo1->IsKindOf(info) ) ||
107 ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) );
108 }
109
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() );
115#endif
116 static void CleanUp();
117
118public:
119 const wxChar *m_className;
120 int m_objectSize;
121 wxObjectConstructorFn m_objectConstructor;
122
123 // Pointers to base wxClassInfos: set in InitializeClasses
124
125 const wxClassInfo *m_baseInfo1;
126 const wxClassInfo *m_baseInfo2;
127
128 // class info object live in a linked list:
129 // pointers to its head and the next element in it
130
131 static wxClassInfo *sm_first;
132 wxClassInfo *m_next;
133
134 // FIXME: this should be private (currently used directly by way too
135 // many clients)
136 static wxHashTable *sm_classTable;
137
138private:
139 // InitializeClasses() helper
140 static wxClassInfo *GetBaseByName(const wxChar *name);
141
142 DECLARE_NO_COPY_CLASS(wxClassInfo)
143
144protected:
145 // registers the class
146 void Register();
147 void Unregister();
148};
149
150WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name);
151
152#if WXWIN_COMPATIBILITY_2_4
153inline void wxClassInfo::InitializeClasses() {}
154inline void wxClassInfo::CleanUpClasses() {}
155#endif
156
157// ----------------------------------------------------------------------------
158// Dynamic class macros
159// ----------------------------------------------------------------------------
160
161#define DECLARE_DYNAMIC_CLASS(name) \
162 public: \
163 static wxClassInfo ms_classInfo; \
164 static wxObject* wxCreateObject(); \
165 virtual wxClassInfo *GetClassInfo() const \
166 { return &name::ms_classInfo; }
167
168#define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name) \
169 DECLARE_NO_ASSIGN_CLASS(name) \
170 DECLARE_DYNAMIC_CLASS(name)
171
172#define DECLARE_DYNAMIC_CLASS_NO_COPY(name) \
173 DECLARE_NO_COPY_CLASS(name) \
174 DECLARE_DYNAMIC_CLASS(name)
175
176#define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
177#define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
178
179// -----------------------------------
180// for concrete classes
181// -----------------------------------
182
183 // Single inheritance with one base class
184
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);
192
193 // Multiple inheritance with two base classes
194
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);
203
204// -----------------------------------
205// for abstract classes
206// -----------------------------------
207
208 // Single inheritance with one base class
209
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);
214
215 // Multiple inheritance with two base classes
216
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);
223
224#define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
225#define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
226
227#endif // !wxUSE_EXTENDED_RTTI
228
229
230// -----------------------------------
231// for pluggable classes
232// -----------------------------------
233
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.
237
238// _DECLARE_DL_SENTINEL(name) wxPluginSentinel m_pluginsentinel;
239
240#if wxUSE_NESTED_CLASSES
241
242#define _DECLARE_DL_SENTINEL(name, exportdecl) \
243class exportdecl name##PluginSentinel { \
244private: \
245 static const wxString sm_className; \
246public: \
247 name##PluginSentinel(); \
248 ~name##PluginSentinel(); \
249}; \
250name##PluginSentinel m_pluginsentinel;
251
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(); } \
257 } \
258 name::name##PluginSentinel::~name##PluginSentinel() { \
259 wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name); \
260 if( e != 0 ) { e->UnrefObj(); } \
261 }
262#else
263
264#define _DECLARE_DL_SENTINEL(name)
265#define _IMPLEMENT_DL_SENTINEL(name)
266
267#endif // wxUSE_NESTED_CLASSES
268
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)
273
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)
278
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)
287
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)
296
297#define CLASSINFO(name) (&name::ms_classInfo)
298
299#else // !wxUSE_DYNAMIC_CLASSES
300
301 // No dynamic class system: so stub out the macros
302
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
312
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)
319
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)
326
327#endif // wxUSE_DYNAMIC_CLASSES
328
329#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo)
330
331// Just seems a bit nicer-looking (pretend it's not a macro)
332#define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo)
333
334// to be replaced by dynamic_cast<> in the future
335#define wxDynamicCast(obj, className) \
336 ((className *) wxCheckDynamicCast((wxObject*)(obj), &className::ms_classInfo))
337
338// The 'this' pointer is always true, so use this version
339// to cast the this pointer and avoid compiler warnings.
340#define wxDynamicCastThis(className) \
341 (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
342
343#ifdef __WXDEBUG__
344inline void* wxCheckCast(void *ptr)
345{
346 wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") );
347 return ptr;
348}
349#define wxStaticCast(obj, className) \
350 ((className *)wxCheckCast(wxDynamicCast(obj, className)))
351
352#else // !__WXDEBUG__
353#define wxStaticCast(obj, className) ((className *)(obj))
354
355#endif // __WXDEBUG__
356
357// ----------------------------------------------------------------------------
358// set up memory debugging macros
359// ----------------------------------------------------------------------------
360
361/*
362 Which new/delete operator variants do we want?
363
364 _WX_WANT_NEW_SIZET_WXCHAR_INT = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0)
365 _WX_WANT_DELETE_VOID = void operator delete (void * buf)
366 _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET = void operator delete (void *buf, const char *_fname, size_t _line)
367 _WX_WANT_DELETE_VOID_WXCHAR_INT = void operator delete(void *buf, wxChar*, int)
368 _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0)
369 _WX_WANT_ARRAY_DELETE_VOID = void operator delete[] (void *buf)
370 _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT = void operator delete[] (void* buf, wxChar*, int )
371*/
372
373#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
374
375// All compilers get this one
376#define _WX_WANT_NEW_SIZET_WXCHAR_INT
377
378// Everyone except Visage gets the next one
379#ifndef __VISAGECPP__
380 #define _WX_WANT_DELETE_VOID
381#endif
382
383// Only visage gets this one under the correct circumstances
384#if defined(__VISAGECPP__) && __DEBUG_ALLOC__
385 #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
386#endif
387
388// Only VC++ 6.0 and CodeWarrior compilers get overloaded delete that matches new
389#if ( defined(__VISUALC__) && (__VISUALC__ >= 1200) ) || (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
390 #define _WX_WANT_DELETE_VOID_WXCHAR_INT
391#endif
392
393// Now see who (if anyone) gets the array memory operators
394#if wxUSE_ARRAY_MEMORY_OPERATORS
395
396 // Everyone except Visual C++ (cause problems for VC++ - crashes)
397 #if !defined(__VISUALC__)
398 #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
399 #endif
400
401 // Everyone except Visual C++ (cause problems for VC++ - crashes)
402 #if !defined(__VISUALC__)
403 #define _WX_WANT_ARRAY_DELETE_VOID
404 #endif
405
406 // Only CodeWarrior 6 or higher
407 #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
408 #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
409 #endif
410
411#endif // wxUSE_ARRAY_MEMORY_OPERATORS
412
413#endif // WXDEBUG && wxUSE_MEMORY_TRACING
414
415// ----------------------------------------------------------------------------
416// wxObject: the root class of wxWindows object hierarchy
417// ----------------------------------------------------------------------------
418
419class WXDLLIMPEXP_BASE wxObject
420{
421 DECLARE_ABSTRACT_CLASS(wxObject)
422
423private:
424 void InitFrom(const wxObject& other);
425
426public:
427 wxObject() { m_refData = NULL; }
428 virtual ~wxObject() { UnRef(); }
429
430 wxObject(const wxObject& other)
431 {
432 InitFrom(other);
433 }
434
435 wxObject& operator=(const wxObject& other)
436 {
437 if ( this != &other )
438 {
439 UnRef();
440 InitFrom(other);
441 }
442 return *this;
443 }
444
445 bool IsKindOf(wxClassInfo *info) const;
446
447
448 // Turn on the correct set of new and delete operators
449
450#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
451 void *operator new ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
452#endif
453
454#ifdef _WX_WANT_DELETE_VOID
455 void operator delete ( void * buf );
456#endif
457
458#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
459 void operator delete ( void *buf, const char *_fname, size_t _line );
460#endif
461
462#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
463 void operator delete ( void *buf, const wxChar*, int );
464#endif
465
466#ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
467 void *operator new[] ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
468#endif
469
470#ifdef _WX_WANT_ARRAY_DELETE_VOID
471 void operator delete[] ( void *buf );
472#endif
473
474#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
475 void operator delete[] (void* buf, const wxChar*, int );
476#endif
477
478 // ref counted data handling methods
479
480 // get/set
481 wxObjectRefData *GetRefData() const { return m_refData; }
482 void SetRefData(wxObjectRefData *data) { m_refData = data; }
483
484 // make a 'clone' of the object
485 void Ref(const wxObject& clone);
486
487 // destroy a reference
488 void UnRef();
489
490protected:
491 // ensure that our data is not shared with anybody else: if we have no
492 // data, it is created using CreateRefData() below, if we have shared data
493 // it is copied using CloneRefData(), otherwise nothing is done
494 void AllocExclusive();
495
496 // both methods must be implemented if Unshare() is used, not pure virtual
497 // only because of the backwards compatibility reasons
498
499 // create a new m_refData
500 virtual wxObjectRefData *CreateRefData() const;
501
502 // create a new m_refData initialized with the given one
503 virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
504
505 wxObjectRefData *m_refData;
506};
507
508// ----------------------------------------------------------------------------
509// wxObjectRefData: ref counted data meant to be stored in wxObject
510// ----------------------------------------------------------------------------
511
512class WXDLLIMPEXP_BASE wxObjectRefData
513{
514 friend class WXDLLIMPEXP_BASE wxObject;
515
516public:
517 wxObjectRefData() : m_count(1) { }
518 virtual ~wxObjectRefData() { }
519
520 int GetRefCount() const { return m_count; }
521
522private:
523 int m_count;
524};
525
526
527inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
528{
529 return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL;
530}
531
532#if wxUSE_EXTENDED_RTTI
533class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
534{
535 friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
536public:
537 // instantiates this object with an instance of its superclass
538 wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ;
539 ~wxDynamicObject();
540
541 void SetProperty (const wxChar *propertyName, const wxxVariant &value);
542 wxxVariant GetProperty (const wxChar *propertyName) const ;
543
544 // get the runtime identity of this object
545 wxClassInfo *GetClassInfo() const
546 {
547 return const_cast<wxClassInfo*>((const wxClassInfo*)m_classInfo);
548 }
549
550 wxObject* GetSuperClassInstance() const
551 {
552 return m_superClassInstance ;
553 }
554private :
555 // removes an existing runtime-property
556 void RemoveProperty( const wxChar *propertyName ) ;
557
558 // renames an existing runtime-property
559 void RenameProperty( const wxChar *oldPropertyName , const wxChar *newPropertyName ) ;
560
561 wxObject *m_superClassInstance ;
562 const wxDynamicClassInfo *m_classInfo;
563 struct wxDynamicObjectInternal;
564 wxDynamicObjectInternal *m_data;
565};
566#endif
567
568// ----------------------------------------------------------------------------
569// more debugging macros
570// ----------------------------------------------------------------------------
571
572#ifdef __WXDEBUG__
573 #ifndef WXDEBUG_NEW
574 #define WXDEBUG_NEW new(__TFILE__,__LINE__)
575 #endif
576#else // !__WXDEBUG__
577 #define WXDEBUG_NEW new
578#endif
579
580// Redefine new to be the debugging version. This doesn't work with all
581// compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish
582// to use the debugging version.
583
584#if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
585 #define new new(__TFILE__,__LINE__)
586#endif
587
588#endif // _WX_OBJECTH__
589