src/common/object.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/object.cpp
   3 // Purpose:     wxObject implementation
   4 // Author:      Julian Smart
   5 // Modified by: Ron Lee
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Julian Smart
   9 //              (c) 2001 Ron Lee <ron@debian.org>
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifdef __GNUG__
  14 #pragma implementation "object.h"
  15 #endif
  16
  17 // For compilers that support precompilation, includes "wx.h".
  18 #include "wx/wxprec.h"
  19
  20 #ifdef __BORLANDC__
  21 #pragma hdrstop
  22 #endif
  23
  24 #ifndef WX_PRECOMP
  25     #include "wx/hash.h"
  26     #include "wx/object.h"
  27 #endif
  28
  29 #include <string.h>
  30
  31 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
  32 #include "wx/memory.h"
  33 #endif
  34
  35 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
  36     // for wxObject::Dump
  37     #include "wx/ioswrap.h"
  38
  39     #if defined(__VISAGECPP__)
  40         #define DEBUG_PRINTF(NAME) { static int raz=0; \
  41             printf( #NAME " %i\n",raz); fflush(stdout); raz++; }
  42     #else
  43         #define DEBUG_PRINTF(NAME)
  44     #endif
  45 #endif // __WXDEBUG__ || wxUSE_DEBUG_CONTEXT
  46
  47 // we must disable optimizations for VC.NET because otherwise its too eager
  48 // linker discards wxClassInfo objects in release build thus breaking many,
  49 // many things
  50 #if defined __VISUALC__ && __VISUALC__ >= 1300
  51     #pragma optimize("", off)
  52 #endif
  53
  54 #if wxUSE_EXTENDED_RTTI
  55 const wxClassInfo* wxObject::sm_classParentswxObject[] = { NULL } ;
  56  wxObject* wxVariantToObjectConverterwxObject ( wxxVariant &data )
  57 { return data.Get<wxObject*>() ; }
  58  wxObject* wxVariantOfPtrToObjectConverterwxObject ( wxxVariant &data )
  59 { return &data.Get<wxObject>() ; }
  60  wxxVariant wxObjectToVariantConverterwxObject ( wxObject *data )
  61  { return wxxVariant( dynamic_cast<wxObject*> (data)  ) ; }
  62  wxClassInfo wxObject::sm_classwxObject(sm_classParentswxObject , wxT("") , wxT("wxObject"),
  63             (int) sizeof(wxObject),                              \
  64             (wxObjectConstructorFn) 0   ,
  65                         (wxPropertyInfo*) NULL,(wxHandlerInfo*) NULL,0 , 0 ,
  66                         0 , wxVariantOfPtrToObjectConverterwxObject , wxVariantToObjectConverterwxObject , wxObjectToVariantConverterwxObject);
  67  template<> void wxStringReadValue(const wxString & , wxObject * & ){assert(0) ;}
  68  template<> void wxStringWriteValue(wxString & , wxObject* const & ){assert(0) ;}
  69  template<> void wxStringReadValue(const wxString & , wxObject & ){assert(0) ;}
  70  template<> void wxStringWriteValue(wxString & , wxObject const & ){assert(0) ;}
  71  template<> const wxTypeInfo* wxGetTypeInfo( wxObject ** )
  72  { static wxClassTypeInfo s_typeInfo(wxT_OBJECT_PTR , &wxObject::sm_classwxObject) ; return &s_typeInfo ; }
  73  template<> const wxTypeInfo* wxGetTypeInfo( wxObject * )
  74  { static wxClassTypeInfo s_typeInfo(wxT_OBJECT , &wxObject::sm_classwxObject) ; return &s_typeInfo ; }
  75 #else
  76 wxClassInfo wxObject::sm_classwxObject( wxT("wxObject"), 0, 0,
  77                                         (int) sizeof(wxObject),
  78                                         (wxObjectConstructorFn) 0 );
  79 #endif
  80
  81 // restore optimizations
  82 #if defined __VISUALC__ && __VISUALC__ >= 1300
  83     #pragma optimize("", on)
  84 #endif
  85
  86 wxClassInfo* wxClassInfo::sm_first = NULL;
  87 wxHashTable* wxClassInfo::sm_classTable = NULL;
  88
  89 // These are here so we can avoid 'always true/false' warnings
  90 // by referring to these instead of TRUE/FALSE
  91 const bool wxTrue = TRUE;
  92 const bool wxFalse = FALSE;
  93
  94 // Is this object a kind of (a subclass of) 'info'?
  95 // E.g. is wxWindow a kind of wxObject?
  96 // Go from this class to superclass, taking into account
  97 // two possible base classes.
  98 bool wxObject::IsKindOf(wxClassInfo *info) const
  99 {
 100     wxClassInfo *thisInfo = GetClassInfo();
 101     return (thisInfo) ? thisInfo->IsKindOf(info) : FALSE ;
 102 }
 103
 104 #if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
 105 void wxObject::Dump(wxSTD ostream& str)
 106 {
 107     if (GetClassInfo() && GetClassInfo()->GetClassName())
 108         str << GetClassInfo()->GetClassName();
 109     else
 110         str << _T("unknown object class");
 111 }
 112 #endif
 113
 114
 115 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING && defined( new )
 116         #undef new
 117 #endif
 118
 119
 120 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
 121 void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum )
 122 {
 123     return wxDebugAlloc(size, (wxChar*) fileName, lineNum, TRUE);
 124 }
 125 #endif
 126
 127 #ifdef _WX_WANT_DELETE_VOID
 128 void wxObject::operator delete ( void *buf )
 129 {
 130     wxDebugFree(buf);
 131 }
 132 #endif
 133
 134 #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
 135 void wxObject::operator delete ( void *buf, const char *_fname, size_t _line )
 136 {
 137     wxDebugFree(buf);
 138 }
 139 #endif
 140
 141 #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
 142 void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum) )
 143 {
 144      wxDebugFree(buf);
 145 }
 146 #endif
 147
 148 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
 149 void *wxObject::operator new[] ( size_t size, const wxChar* fileName, int lineNum )
 150 {
 151     return wxDebugAlloc(size, (wxChar*) fileName, lineNum, TRUE, TRUE);
 152 }
 153 #endif
 154
 155 #ifdef _WX_WANT_ARRAY_DELETE_VOID
 156 void wxObject::operator delete[] ( void *buf )
 157 {
 158     wxDebugFree(buf, TRUE);
 159 }
 160 #endif
 161
 162 #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
 163 void wxObject::operator delete[] (void * buf, const wxChar*  WXUNUSED(fileName), int WXUNUSED(lineNum) )
 164 {
 165     wxDebugFree(buf, TRUE);
 166 }
 167 #endif
 168
 169
 170 // ----------------------------------------------------------------------------
 171 // wxClassInfo
 172 // ----------------------------------------------------------------------------
 173
 174 wxClassInfo::~wxClassInfo()
 175 {
 176     // remove this object from the linked list of all class infos: if we don't
 177     // do it, loading/unloading a DLL containing static wxClassInfo objects is
 178     // not going to work
 179     if ( this == sm_first )
 180     {
 181         sm_first = m_next;
 182     }
 183     else
 184     {
 185         wxClassInfo *info = sm_first;
 186         while (info)
 187         {
 188             if ( info->m_next == this )
 189             {
 190                 info->m_next = m_next;
 191                 break;
 192             }
 193
 194             info = info->m_next;
 195         }
 196     }
 197 #if wxUSE_EXTENDED_RTTI
 198         Unregister( m_className ) ;
 199 #endif
 200 }
 201
 202 wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
 203 {
 204     if ( sm_classTable )
 205     {
 206         return (wxClassInfo *)wxClassInfo::sm_classTable->Get(className);
 207     }
 208     else
 209     {
 210         for ( wxClassInfo *info = sm_first; info ; info = info->m_next )
 211         {
 212             if ( wxStrcmp(info->GetClassName(), className) == 0 )
 213                 return info;
 214         }
 215
 216         return NULL;
 217     }
 218 }
 219
 220 // a tiny InitializeClasses() helper
 221 /* static */
 222 inline wxClassInfo *wxClassInfo::GetBaseByName(const wxChar *name)
 223 {
 224     if ( !name )
 225         return NULL;
 226
 227     wxClassInfo *classInfo = (wxClassInfo *)sm_classTable->Get(name);
 228
 229 #ifdef __WXDEBUG__
 230     // this must be fixed, other things will work wrongly later if you get this
 231     if ( !classInfo )
 232     {
 233         wxFAIL_MSG( wxString::Format
 234                     (
 235                         _T("base class '%s' is unknown to wxWindows RTTI"),
 236                         name
 237                     ) );
 238     }
 239 #endif // __WXDEBUG__
 240
 241     return classInfo;
 242 }
 243
 244 // Set pointers to base class(es) to speed up IsKindOf
 245 void wxClassInfo::InitializeClasses()
 246 {
 247     // using IMPLEMENT_DYNAMIC_CLASS() macro twice (which may happen if you
 248     // link any object module twice mistakenly) will break this function
 249     // because it will enter an infinite loop and eventually die with "out of
 250     // memory" - as this is quite hard to detect if you're unaware of this,
 251     // try to do some checks here
 252
 253 #ifdef __WXDEBUG__
 254     static const size_t nMaxClasses = 10000;    // more than we'll ever have
 255     size_t nClass = 0;
 256 #endif
 257
 258     sm_classTable = new wxHashTable(wxKEY_STRING);
 259
 260         // Index all class infos by their class name
 261
 262     wxClassInfo *info;
 263     for(info = sm_first; info; info = info->m_next)
 264     {
 265         if (info->m_className)
 266         {
 267             wxASSERT_MSG( ++nClass < nMaxClasses,
 268                           _T("an infinite loop detected - have you used IMPLEMENT_DYNAMIC_CLASS() twice (may be by linking some object module(s) twice)?") );
 269             sm_classTable->Put(info->m_className, (wxObject *)info);
 270         }
 271     }
 272
 273 #if wxUSE_EXTENDED_RTTI == 0
 274         // Set base pointers for each wxClassInfo
 275
 276     for(info = sm_first; info; info = info->m_next)
 277     {
 278         info->m_baseInfo1 = GetBaseByName(info->GetBaseClassName1());
 279         info->m_baseInfo2 = GetBaseByName(info->GetBaseClassName2());
 280     }
 281 #endif
 282 }
 283
 284 void wxClassInfo::CleanUpClasses()
 285 {
 286     delete wxClassInfo::sm_classTable;
 287     wxClassInfo::sm_classTable = NULL;
 288 }
 289
 290 wxObject *wxCreateDynamicObject(const wxChar *name)
 291 {
 292 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 293     DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
 294 #endif
 295
 296     if ( wxClassInfo::sm_classTable )
 297     {
 298         wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name);
 299         return info ? info->CreateObject() : NULL;
 300     }
 301     else // no sm_classTable yet
 302     {
 303         for ( wxClassInfo *info = wxClassInfo::sm_first;
 304               info;
 305               info = info->m_next )
 306         {
 307             if (info->m_className && wxStrcmp(info->m_className, name) == 0)
 308                 return info->CreateObject();
 309         }
 310
 311         return NULL;
 312     }
 313 }
 314
 315
 316 // ----------------------------------------------------------------------------
 317 // wxObject
 318 // ----------------------------------------------------------------------------
 319
 320 // Initialize ref data from another object (needed for copy constructor and
 321 // assignment operator)
 322 void wxObject::InitFrom(const wxObject& other)
 323 {
 324     m_refData = other.m_refData;
 325     if ( m_refData )
 326         m_refData->m_count++;
 327 }
 328
 329 void wxObject::Ref(const wxObject& clone)
 330 {
 331 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 332     DEBUG_PRINTF(wxObject::Ref)
 333 #endif
 334
 335     // nothing to be done
 336     if (m_refData == clone.m_refData)
 337         return;
 338
 339     // delete reference to old data
 340     UnRef();
 341
 342     // reference new data
 343     if ( clone.m_refData )
 344     {
 345         m_refData = clone.m_refData;
 346         ++(m_refData->m_count);
 347     }
 348 }
 349
 350 void wxObject::UnRef()
 351 {
 352     if ( m_refData )
 353     {
 354         wxASSERT_MSG( m_refData->m_count > 0, _T("invalid ref data count") );
 355
 356         if ( !--m_refData->m_count )
 357             delete m_refData;
 358         m_refData = NULL;
 359     }
 360 }
 361
 362 void wxObject::AllocExclusive()
 363 {
 364     if ( !m_refData )
 365     {
 366         m_refData = CreateRefData();
 367     }
 368     else if ( m_refData->GetRefCount() > 1 )
 369     {
 370         // note that ref is not going to be destroyed in this case
 371         const wxObjectRefData* ref = m_refData;
 372         UnRef();
 373
 374         // ... so we can still access it
 375         m_refData = CloneRefData(ref);
 376     }
 377     //else: ref count is 1, we are exclusive owners of m_refData anyhow
 378
 379     wxASSERT_MSG( m_refData && m_refData->GetRefCount() == 1,
 380                   _T("wxObject::AllocExclusive() failed.") );
 381 }
 382
 383 wxObjectRefData *wxObject::CreateRefData() const
 384 {
 385     // if you use AllocExclusive() you must override this method
 386     wxFAIL_MSG( _T("CreateRefData() must be overridden if called!") );
 387
 388     return NULL;
 389 }
 390
 391 wxObjectRefData *
 392 wxObject::CloneRefData(const wxObjectRefData * WXUNUSED(data)) const
 393 {
 394     // if you use AllocExclusive() you must override this method
 395     wxFAIL_MSG( _T("CloneRefData() must be overridden if called!") );
 396
 397     return NULL;
 398 }
 399
 400 // ----------------------------------------------------------------------------
 401 // misc
 402 // ----------------------------------------------------------------------------
 403
 404 #if defined(__DARWIN__) && defined(WXMAKINGDLL)
 405
 406 extern "C" {
 407     void __initialize_Cplusplus(void);
 408     void wxWindowsDylibInit(void);
 409 };
 410
 411 // Dynamic shared library (dylib) initialization routine
 412 //   required to initialize static C++ objects bacause of lazy dynamic linking
 413 //   http://developer.apple.com/techpubs/macosx/Essentials/
 414 //          SystemOverview/Frameworks/Dynamic_Shared_Libraries.html
 415
 416 void wxWindowsDylibInit()
 417 {
 418     // The function __initialize_Cplusplus() must be called from the shared
 419     // library initialization routine to cause the static C++ objects in
 420     // the library to be initialized (reference number 2441683).
 421
 422     // This only seems to be necessary if the library initialization routine
 423     // needs to use the static C++ objects
 424     __initialize_Cplusplus();
 425 }
 426
 427 #endif
 428
 429 // vi:sts=4:sw=4:et