include/wx/object.h

   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 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/memory.h"
  21
  22 class WXDLLIMPEXP_FWD_BASE wxObject;
  23 class WXDLLIMPEXP_FWD_BASE wxString;
  24
  25 #ifndef wxUSE_EXTENDED_RTTI
  26 #define wxUSE_EXTENDED_RTTI 0
  27 #endif
  28
  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
  60 #if wxUSE_EXTENDED_RTTI
  61 #include "wx/xti.h"
  62 #else
  63
  64 // ----------------------------------------------------------------------------
  65 // conditional compilation
  66 // ----------------------------------------------------------------------------
  67
  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;
  74
  75 // ----------------------------------------------------------------------------
  76 // wxClassInfo
  77 // ----------------------------------------------------------------------------
  78
  79 typedef wxObject *(*wxObjectConstructorFn)(void);
  80
  81 class WXDLLIMPEXP_BASE wxClassInfo
  82 {
  83     friend class WXDLLIMPEXP_FWD_BASE wxObject;
  84     friend WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name);
  85 public:
  86     wxClassInfo( const wxChar *className,
  87                  const wxClassInfo *baseInfo1,
  88                  const wxClassInfo *baseInfo2,
  89                  int size,
  90                  wxObjectConstructorFn ctor )
  91         : m_className(className)
  92         , m_objectSize(size)
  93         , m_objectConstructor(ctor)
  94         , m_baseInfo1(baseInfo1)
  95         , m_baseInfo2(baseInfo2)
  96         , m_next(sm_first)
  97         {
  98             sm_first = this;
  99             Register();
 100         }
 101
 102     ~wxClassInfo();
 103
 104     wxObject *CreateObject() const
 105         { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
 106     bool IsDynamic() const { return (NULL != m_objectConstructor); }
 107
 108     const wxChar       *GetClassName() const { return m_className; }
 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; }
 113     const wxClassInfo  *GetBaseClass1() const { return m_baseInfo1; }
 114     const wxClassInfo  *GetBaseClass2() const { return m_baseInfo2; }
 115     int                 GetSize() const { return m_objectSize; }
 116
 117     wxObjectConstructorFn      GetConstructor() const
 118         { return m_objectConstructor; }
 119     static const wxClassInfo  *GetFirst() { return sm_first; }
 120     const wxClassInfo         *GetNext() const { return m_next; }
 121     static wxClassInfo        *FindClass(const wxString& className);
 122
 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     }
 133
 134     DECLARE_CLASS_INFO_ITERATORS()
 135 private:
 136     const wxChar            *m_className;
 137     int                      m_objectSize;
 138     wxObjectConstructorFn    m_objectConstructor;
 139
 140         // Pointers to base wxClassInfos
 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;
 152
 153 protected:
 154     // registers the class
 155     void Register();
 156     void Unregister();
 157
 158     DECLARE_NO_COPY_CLASS(wxClassInfo)
 159 };
 160
 161 WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name);
 162
 163 // ----------------------------------------------------------------------------
 164 // Dynamic class macros
 165 // ----------------------------------------------------------------------------
 166
 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)                                             \
 174     DECLARE_DYNAMIC_CLASS(name)
 175
 176 #define DECLARE_DYNAMIC_CLASS_NO_COPY(name)                                   \
 177     DECLARE_NO_COPY_CLASS(name)                                               \
 178     DECLARE_DYNAMIC_CLASS(name)
 179
 180 #define DECLARE_DYNAMIC_CLASS(name)                                           \
 181     DECLARE_ABSTRACT_CLASS(name)                                              \
 182     static wxObject* wxCreateObject();
 183
 184 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 185
 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),                                               \
 193             (wxObjectConstructorFn) func);                                    \
 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)           \
 202     wxIMPLEMENT_CLASS_COMMON(name, basename1, &basename2::ms_classInfo, func)
 203
 204 // -----------------------------------
 205 // for concrete classes
 206 // -----------------------------------
 207
 208     // Single inheritance with one base class
 209 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)                               \
 210     wxIMPLEMENT_CLASS_COMMON1(name, basename, name::wxCreateObject)           \
 211     wxObject* name::wxCreateObject()                                          \
 212         { return new name; }
 213
 214     // Multiple inheritance with two base classes
 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; }
 220
 221 // -----------------------------------
 222 // for abstract classes
 223 // -----------------------------------
 224
 225     // Single inheritance with one base class
 226
 227 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)                              \
 228     wxIMPLEMENT_CLASS_COMMON1(name, basename, NULL)
 229
 230     // Multiple inheritance with two base classes
 231
 232 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)                 \
 233     wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, NULL)
 234
 235 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 236 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 237
 238 #endif // !wxUSE_EXTENDED_RTTI
 239
 240
 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
 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();                     \
 259     ~name##PluginSentinel();                    \
 260 };                                              \
 261 name##PluginSentinel  m_pluginsentinel;
 262
 263 #define _IMPLEMENT_DL_SENTINEL(name)                                \
 264  const wxString name::name##PluginSentinel::sm_className(#name);    \
 265  name::name##PluginSentinel::name##PluginSentinel() {               \
 266     wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name);   \
 267     if( e != 0 ) { e->RefObj(); }                                      \
 268  }                                                                  \
 269  name::name##PluginSentinel::~name##PluginSentinel() {            \
 270     wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name);   \
 271     if( e != 0 ) { e->UnrefObj(); }                                 \
 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) \
 281  DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
 282 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)  \
 283  DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
 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)
 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)
 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
 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
 308 #define CLASSINFO(name) (&name::ms_classInfo)
 309
 310 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo)
 311
 312 // Just seems a bit nicer-looking (pretend it's not a macro)
 313 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo)
 314
 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
 320 #define wxDynamicCast(obj, className) \
 321     ((className *) wxCheckDynamicCast( \
 322         wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \
 323           wx_const_cast(className *, wx_static_cast(const className *, obj)))), \
 324         &className::ms_classInfo))
 325
 326 // The 'this' pointer is always true, so use this version
 327 // to cast the this pointer and avoid compiler warnings.
 328 #define wxDynamicCastThis(className) \
 329      (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
 330
 331 #ifdef __WXDEBUG__
 332 inline void* wxCheckCast(void *ptr)
 333 {
 334     wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") );
 335     return ptr;
 336 }
 337 #define wxStaticCast(obj, className) \
 338  ((className *)wxCheckCast(wxDynamicCast(obj, className)))
 339
 340 #else  // !__WXDEBUG__
 341 #define wxStaticCast(obj, className) \
 342     wx_const_cast(className *, wx_static_cast(const className *, obj))
 343
 344 #endif  // __WXDEBUG__
 345
 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
 370 #endif
 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
 377 // Only VC++ 6 and CodeWarrior get overloaded delete that matches new
 378 #if (defined(__VISUALC__) && (__VISUALC__ >= 1200)) || \
 379         (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
 380     #define _WX_WANT_DELETE_VOID_WXCHAR_INT
 381 #endif
 382
 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
 403 #endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
 404
 405 // ----------------------------------------------------------------------------
 406 // wxObjectRefData: ref counted data meant to be stored in wxObject
 407 // ----------------------------------------------------------------------------
 408
 409 class WXDLLIMPEXP_BASE wxObjectRefData
 410 {
 411     friend class WXDLLIMPEXP_FWD_BASE wxObject;
 412
 413 public:
 414     wxObjectRefData() : m_count(1) { }
 415
 416     int GetRefCount() const { return m_count; }
 417
 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
 426 private:
 427     // our refcount:
 428     int m_count;
 429 };
 430
 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
 445     wxObjectDataPtr(const wxObjectDataPtr<T> &tocopy)
 446         : m_ptr(tocopy.m_ptr)
 447     {
 448         if (m_ptr)
 449             m_ptr->IncRef();
 450     }
 451
 452     ~wxObjectDataPtr()
 453     {
 454         if (m_ptr)
 455             m_ptr->DecRef();
 456     }
 457
 458     T *get() const { return m_ptr; }
 459
 460     T *operator->() const
 461     {
 462         wxASSERT(m_ptr != NULL);
 463         return get();
 464     }
 465
 466     void reset(T *ptr)
 467     {
 468         if (m_ptr)
 469             m_ptr->DecRef();
 470         m_ptr = ptr;
 471     }
 472
 473     wxObjectDataPtr& operator=(const wxObjectDataPtr &tocopy)
 474     {
 475         if (m_ptr)
 476             m_ptr->DecRef();
 477         m_ptr = tocopy.m_ptr;
 478         if (m_ptr)
 479             m_ptr->IncRef();
 480         return *this;
 481     }
 482
 483     wxObjectDataPtr& operator=(T *ptr)
 484     {
 485         if (m_ptr)
 486             m_ptr->DecRef();
 487         m_ptr = ptr;
 488         return *this;
 489     }
 490
 491 private:
 492     T *m_ptr;
 493 };
 494
 495 // ----------------------------------------------------------------------------
 496 // wxObject: the root class of wxWidgets object hierarchy
 497 // ----------------------------------------------------------------------------
 498
 499 class WXDLLIMPEXP_BASE wxObject
 500 {
 501     DECLARE_ABSTRACT_CLASS(wxObject)
 502
 503 public:
 504     wxObject() { m_refData = NULL; }
 505     virtual ~wxObject() { UnRef(); }
 506
 507     wxObject(const wxObject& other)
 508     {
 509          m_refData = other.m_refData;
 510          if (m_refData)
 511              m_refData->m_count++;
 512     }
 513
 514     wxObject& operator=(const wxObject& other)
 515     {
 516         if ( this != &other )
 517         {
 518             Ref(other);
 519         }
 520         return *this;
 521     }
 522
 523     bool IsKindOf(wxClassInfo *info) const;
 524
 525
 526     // Turn on the correct set of new and delete operators
 527
 528 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
 529     void *operator new ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
 530 #endif
 531
 532 #ifdef _WX_WANT_DELETE_VOID
 533     void operator delete ( void * buf );
 534 #endif
 535
 536 #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
 537     void operator delete ( void *buf, const char *_fname, size_t _line );
 538 #endif
 539
 540 #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
 541     void operator delete ( void *buf, const wxChar*, int );
 542 #endif
 543
 544 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
 545     void *operator new[] ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
 546 #endif
 547
 548 #ifdef _WX_WANT_ARRAY_DELETE_VOID
 549     void operator delete[] ( void *buf );
 550 #endif
 551
 552 #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
 553     void operator delete[] (void* buf, const wxChar*, int );
 554 #endif
 555
 556     // ref counted data handling methods
 557
 558     // get/set
 559     wxObjectRefData *GetRefData() const { return m_refData; }
 560     void SetRefData(wxObjectRefData *data) { m_refData = data; }
 561
 562     // make a 'clone' of the object
 563     void Ref(const wxObject& clone);
 564
 565     // destroy a reference
 566     void UnRef();
 567
 568     // Make sure this object has only one reference
 569     void UnShare() { AllocExclusive(); }
 570
 571     // check if this object references the same data as the other one
 572     bool IsSameAs(const wxObject& o) const { return m_refData == o.m_refData; }
 573
 574 protected:
 575     // ensure that our data is not shared with anybody else: if we have no
 576     // data, it is created using CreateRefData() below, if we have shared data
 577     // it is copied using CloneRefData(), otherwise nothing is done
 578     void AllocExclusive();
 579
 580     // both methods must be implemented if AllocExclusive() is used, not pure
 581     // virtual only because of the backwards compatibility reasons
 582
 583     // create a new m_refData
 584     virtual wxObjectRefData *CreateRefData() const;
 585
 586     // create a new m_refData initialized with the given one
 587     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 588
 589     wxObjectRefData *m_refData;
 590 };
 591
 592 inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
 593 {
 594     return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL;
 595 }
 596
 597 #if wxUSE_EXTENDED_RTTI
 598 class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
 599 {
 600     friend class WXDLLIMPEXP_FWD_BASE wxDynamicClassInfo ;
 601 public:
 602     // instantiates this object with an instance of its superclass
 603     wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ;
 604     virtual ~wxDynamicObject();
 605
 606     void SetProperty (const wxChar *propertyName, const wxxVariant &value);
 607     wxxVariant GetProperty (const wxChar *propertyName) const ;
 608
 609     // get the runtime identity of this object
 610     wxClassInfo *GetClassInfo() const
 611     {
 612 #ifdef _MSC_VER
 613         return (wxClassInfo*) m_classInfo;
 614 #else
 615         wxDynamicClassInfo *nonconst = wx_const_cast(wxDynamicClassInfo *, m_classInfo);
 616         return wx_static_cast(wxClassInfo *, nonconst);
 617 #endif
 618     }
 619
 620     wxObject* GetSuperClassInstance() const
 621     {
 622         return m_superClassInstance ;
 623     }
 624 private :
 625     // removes an existing runtime-property
 626     void RemoveProperty( const wxChar *propertyName ) ;
 627
 628     // renames an existing runtime-property
 629     void RenameProperty( const wxChar *oldPropertyName , const wxChar *newPropertyName ) ;
 630
 631     wxObject *m_superClassInstance ;
 632     const wxDynamicClassInfo *m_classInfo;
 633     struct wxDynamicObjectInternal;
 634     wxDynamicObjectInternal *m_data;
 635 };
 636 #endif
 637
 638 // ----------------------------------------------------------------------------
 639 // more debugging macros
 640 // ----------------------------------------------------------------------------
 641
 642 // Redefine new to be the debugging version. This doesn't work with all
 643 // compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish
 644 // to use the debugging version.
 645
 646 #ifdef __WXDEBUG__
 647     #define WXDEBUG_NEW new(__TFILE__,__LINE__)
 648
 649     #if wxUSE_DEBUG_NEW_ALWAYS
 650         #if wxUSE_GLOBAL_MEMORY_OPERATORS
 651             #define new WXDEBUG_NEW
 652         #elif defined(__VISUALC__)
 653             // Including this file redefines new and allows leak reports to
 654             // contain line numbers
 655             #include "wx/msw/msvcrt.h"
 656         #endif
 657     #endif // wxUSE_DEBUG_NEW_ALWAYS
 658 #else // !__WXDEBUG__
 659     #define WXDEBUG_NEW new
 660 #endif // __WXDEBUG__/!__WXDEBUG__
 661
 662 #endif // _WX_OBJECTH__