include/wx/object.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 and Markus Holzem
   9 //              (c) 2001 Ron Lee <ron@debian.org>
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_OBJECTH__
  14 #define _WX_OBJECTH__
  15
  16 #ifdef __GNUG__
  17 #pragma interface "object.h"
  18 #endif
  19
  20 // ----------------------------------------------------------------------------
  21 // headers
  22 // ----------------------------------------------------------------------------
  23
  24 #include "wx/defs.h"
  25 #include "wx/memory.h"
  26
  27 class WXDLLEXPORT wxObject;
  28
  29 #if wxUSE_DYNAMIC_CLASSES
  30
  31 // ----------------------------------------------------------------------------
  32 // conditional compilation
  33 // ----------------------------------------------------------------------------
  34
  35 #ifdef GetClassName
  36 #undef GetClassName
  37 #endif
  38 #ifdef GetClassInfo
  39 #undef GetClassInfo
  40 #endif
  41
  42 class WXDLLEXPORT wxClassInfo;
  43 class WXDLLEXPORT wxHashTable;
  44
  45 #if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
  46 #include "wx/ioswrap.h"
  47 #endif
  48
  49
  50 // ----------------------------------------------------------------------------
  51 // wxClassInfo
  52 // ----------------------------------------------------------------------------
  53
  54 typedef wxObject *(*wxObjectConstructorFn)(void);
  55
  56 class WXDLLEXPORT wxClassInfo
  57 {
  58 public:
  59     wxClassInfo( const wxChar *className,
  60                  const wxChar *baseName1,
  61                  const wxChar *baseName2,
  62                  int size,
  63                  wxObjectConstructorFn ctor )
  64         : m_className(className)
  65         , m_baseClassName1(baseName1)
  66         , m_baseClassName2(baseName2)
  67         , m_objectSize(size)
  68         , m_objectConstructor(ctor)
  69         , m_baseInfo1(0)
  70         , m_baseInfo2(0)
  71         , m_next(sm_first)
  72     { sm_first = this; }
  73
  74     wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
  75
  76     const wxChar       *GetClassName() const { return m_className; }
  77     const wxChar       *GetBaseClassName1() const { return m_baseClassName1; }
  78     const wxChar       *GetBaseClassName2() const { return m_baseClassName2; }
  79     const wxClassInfo  *GetBaseClass1() const { return m_baseInfo1; }
  80     const wxClassInfo  *GetBaseClass2() const { return m_baseInfo2; }
  81     int                 GetSize() const { return m_objectSize; }
  82
  83     wxObjectConstructorFn      GetConstructor() const { return m_objectConstructor; }
  84     static const wxClassInfo  *GetFirst() { return sm_first; }
  85     const wxClassInfo         *GetNext() const { return m_next; }
  86     static wxClassInfo        *FindClass(const wxChar *className);
  87
  88         // Climb upwards through inheritance hierarchy.
  89         // Dual inheritance is catered for.
  90
  91     bool IsKindOf(const wxClassInfo *info) const
  92     {
  93         return info != 0 &&
  94                ( info == this ||
  95                  ( m_baseInfo1 && m_baseInfo1->IsKindOf(info) ) ||
  96                  ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) );
  97     }
  98
  99         // Initializes parent pointers and hash table for fast searching.
 100
 101     static void     InitializeClasses();
 102
 103         // Cleans up hash table used for fast searching.
 104
 105     static void     CleanUpClasses();
 106
 107 public:
 108     const wxChar            *m_className;
 109     const wxChar            *m_baseClassName1;
 110     const wxChar            *m_baseClassName2;
 111     int                      m_objectSize;
 112     wxObjectConstructorFn    m_objectConstructor;
 113
 114         // Pointers to base wxClassInfos: set in InitializeClasses
 115
 116     const wxClassInfo       *m_baseInfo1;
 117     const wxClassInfo       *m_baseInfo2;
 118
 119         // class info object live in a linked list:
 120         // pointers to its head and the next element in it
 121
 122     static wxClassInfo      *sm_first;
 123     wxClassInfo             *m_next;
 124
 125     // FIXME: this should be private (currently used directly by way too
 126     //        many clients)
 127     static wxHashTable      *sm_classTable;
 128
 129 private:
 130     // InitializeClasses() helper
 131     static wxClassInfo *GetBaseByName(const wxChar *name);
 132 };
 133
 134 WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
 135
 136 // ----------------------------------------------------------------------------
 137 // Dynamic class macros
 138 // ----------------------------------------------------------------------------
 139
 140 #define DECLARE_DYNAMIC_CLASS(name)           \
 141  public:                                      \
 142   static wxClassInfo sm_class##name;          \
 143   virtual wxClassInfo *GetClassInfo() const   \
 144    { return &name::sm_class##name; }
 145
 146 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 147 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 148
 149 // -----------------------------------
 150 // for concrete classes
 151 // -----------------------------------
 152
 153     // Single inheritance with one base class
 154
 155 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)                 \
 156  wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name()          \
 157   { return new name; }                                          \
 158  wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename),   \
 159             0, (int) sizeof(name),                              \
 160             (wxObjectConstructorFn) wxConstructorFor##name);
 161
 162     // Multiple inheritance with two base classes
 163
 164 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)    \
 165  wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name()          \
 166   { return new name; }                                          \
 167  wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1),  \
 168             wxT(#basename2), (int) sizeof(name),                \
 169             (wxObjectConstructorFn) wxConstructorFor##name);
 170
 171 // -----------------------------------
 172 // for abstract classes
 173 // -----------------------------------
 174
 175     // Single inheritance with one base class
 176
 177 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)                \
 178  wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename),   \
 179             0, (int) sizeof(name), (wxObjectConstructorFn) 0);
 180
 181     // Multiple inheritance with two base classes
 182
 183 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)   \
 184  wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1),  \
 185             wxT(#basename2), (int) sizeof(name),                \
 186             (wxObjectConstructorFn) 0);
 187
 188 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 189 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 190
 191 // -----------------------------------
 192 // for pluggable classes
 193 // -----------------------------------
 194
 195     // NOTE: this should probably be the very first statement
 196     //       in the class declaration so wxPluginSentinel is
 197     //       the first member initialised and the last destroyed.
 198
 199 // _DECLARE_DL_SENTINEL(name) wxPluginSentinel m_pluginsentinel;
 200
 201 #if wxUSE_NESTED_CLASSES
 202
 203 #define _DECLARE_DL_SENTINEL(name, exportdecl)  \
 204 class exportdecl name##PluginSentinel {         \
 205 private:                                        \
 206     static const wxString sm_className;         \
 207 public:                                         \
 208     name##PluginSentinel();                     \
 209     ~name##PluginSentinel();                    \
 210 };                                              \
 211 name##PluginSentinel  m_pluginsentinel;
 212
 213 #define _IMPLEMENT_DL_SENTINEL(name)                                \
 214  const wxString name::name##PluginSentinel::sm_className(#name);    \
 215  name::name##PluginSentinel::name##PluginSentinel() {               \
 216     wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name);   \
 217     if( e != 0 ) { e->RefObj(); }                                      \
 218  }                                                                  \
 219  name::name##PluginSentinel::~name##PluginSentinel() {            \
 220     wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name);   \
 221     if( e != 0 ) { e->UnrefObj(); }                                 \
 222  }
 223 #else
 224
 225 #define _DECLARE_DL_SENTINEL(name)
 226 #define _IMPLEMENT_DL_SENTINEL(name)
 227
 228 #endif  // wxUSE_NESTED_CLASSES
 229
 230 #define DECLARE_PLUGGABLE_CLASS(name) \
 231  DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
 232 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)  \
 233  DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
 234
 235 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
 236  DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
 237 #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo)  \
 238  DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
 239
 240 #define IMPLEMENT_PLUGGABLE_CLASS(name, basename) \
 241  IMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
 242 #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)  \
 243  IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
 244 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
 245  IMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
 246 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)  \
 247  IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
 248
 249 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \
 250  IMPLEMENT_PLUGGABLE_CLASS(name, basename)
 251 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2)  \
 252  IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
 253 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
 254  IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
 255 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)  \
 256  IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
 257
 258
 259 #define CLASSINFO(name) (&name::sm_class##name)
 260
 261 #else // !wxUSE_DYNAMIC_CLASSES
 262
 263     // No dynamic class system: so stub out the macros
 264
 265 #define DECLARE_DYNAMIC_CLASS(name)
 266 #define DECLARE_ABSTRACT_CLASS(name)
 267 #define DECLARE_CLASS(name)
 268 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)
 269 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)
 270 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)
 271 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
 272 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 273 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 274
 275 #define DECLARE_PLUGGABLE_CLASS(name)
 276 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)
 277 #define IMPLEMENT_PLUGGABLE_CLASS(name, basename)
 278 #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
 279 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
 280 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
 281
 282 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo)
 283 #define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo)
 284 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename)
 285 #define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2)
 286 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename)
 287 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
 288
 289 #endif // wxUSE_DYNAMIC_CLASSES
 290
 291
 292 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className)
 293
 294     // Just seems a bit nicer-looking (pretend it's not a macro)
 295
 296 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className)
 297
 298     // to be replaced by dynamic_cast<> in the future
 299
 300 #define wxDynamicCast(obj, className) \
 301  (className *) wxCheckDynamicCast((wxObject*)(obj), &className::sm_class##className)
 302
 303     // The 'this' pointer is always true, so use this version
 304     // to cast the this pointer and avoid compiler warnings.
 305
 306 #define wxDynamicCastThis(className) \
 307  (IsKindOf(&className::sm_class##className) ? (className *)(this) : (className *)0)
 308
 309 #define wxConstCast(obj, className) ((className *)(obj))
 310
 311
 312 #ifdef __WXDEBUG__
 313 inline void wxCheckCast(void *ptr)
 314 {
 315     wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") );
 316 }
 317 #define wxStaticCast(obj, className) \
 318  (wxCheckCast(wxDynamicCast(obj, className)), ((className *)(obj)))
 319
 320 #else  // !__WXDEBUG__
 321 #define wxStaticCast(obj, className) ((className *)(obj))
 322
 323 #endif  // __WXDEBUG__
 324
 325
 326     // Unfortunately Borland seems to need this include.
 327
 328 #if wxUSE_STD_IOSTREAM                                \
 329     && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)  \
 330     && defined(__BORLANDC__)
 331 #if wxUSE_IOSTREAMH
 332 #include <iostream.h>
 333 #else
 334 #include <iostream>
 335 #endif
 336 #endif
 337
 338
 339 // ----------------------------------------------------------------------------
 340 // wxObject
 341 // ----------------------------------------------------------------------------
 342
 343 class WXDLLEXPORT wxObjectRefData;
 344
 345 class WXDLLEXPORT wxObject
 346 {
 347 DECLARE_ABSTRACT_CLASS(wxObject)
 348
 349 public:
 350     wxObject() : m_refData(0) {}
 351     virtual ~wxObject() { UnRef(); }
 352
 353     bool IsKindOf(wxClassInfo *info) const;
 354
 355 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
 356     void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0);
 357
 358 #ifndef __VISAGECPP__
 359     void operator delete (void * buf);
 360 #elif __DEBUG_ALLOC__
 361     void operator delete (void *buf, const char *_fname, size_t _line);
 362 #endif
 363
 364     // VC++ 6.0
 365
 366 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 367     void operator delete(void *buf, wxChar*, int);
 368 #endif
 369
 370     // Causes problems for VC++
 371
 372 #if wxUSE_ARRAY_MEMORY_OPERATORS && !defined(__VISUALC__) && !defined( __MWERKS__)
 373     void *operator new[] (size_t size, wxChar *fileName = 0, int lineNum = 0);
 374     void operator delete[] (void *buf);
 375 #endif
 376
 377 #ifdef __MWERKS__
 378     void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0);
 379     void *operator new[] (size_t size) { return operator new[] ( size, 0, 0 ) ; }
 380     void operator delete[] (void *buf);
 381 #endif
 382
 383 #endif // Debug & memory tracing
 384
 385
 386 #if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
 387     virtual void Dump(wxSTD ostream& str);
 388 #endif
 389
 390     // ref counted data handling methods
 391
 392     // get/set
 393     wxObjectRefData *GetRefData() const { return m_refData; }
 394     void SetRefData(wxObjectRefData *data) { m_refData = data; }
 395
 396     // make a 'clone' of the object
 397     void Ref(const wxObject& clone);
 398
 399     // destroy a reference
 400     void UnRef();
 401
 402 protected:
 403     // ensure that our data is not shared with anybody else: if we have no
 404     // data, it is created using CreateRefData() below, if we have shared data
 405     // it is copied using CloneRefData(), otherwise nothing is done
 406     void AllocExclusive();
 407
 408     // both methods must be implemented if Unshare() is used, not pure virtual
 409     // only because of the backwards compatibility reasons
 410
 411     // create a new m_refData
 412     virtual wxObjectRefData *CreateRefData() const;
 413
 414     // create a new m_refData initialized with the given one
 415     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 416
 417     wxObjectRefData *m_refData;
 418 };
 419
 420
 421 class WXDLLEXPORT wxObjectRefData
 422 {
 423     friend class wxObject;
 424
 425 public:
 426     wxObjectRefData() : m_count(1) {}
 427     virtual ~wxObjectRefData() {}
 428
 429     inline int GetRefCount() const { return m_count; }
 430 private:
 431     int m_count;
 432 };
 433
 434
 435 inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
 436 {
 437     return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : 0;
 438 }
 439
 440 #ifdef __WXDEBUG__
 441 #ifndef WXDEBUG_NEW
 442 #define WXDEBUG_NEW new(__TFILE__,__LINE__)
 443 #endif
 444 #else
 445 #define WXDEBUG_NEW new
 446 #endif
 447
 448     // Redefine new to be the debugging version. This doesn't
 449     // work with all compilers, in which case you need to
 450     // use WXDEBUG_NEW explicitly if you wish to use the debugging version.
 451
 452 #if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
 453 #define new new(__TFILE__,__LINE__)
 454 #endif
 455
 456 #endif  // _WX_OBJECTH__
 457
 458 // vi:sts=4:sw=4:et