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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  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         Unregister();
 198 }
 199
 200 wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
 201 {
 202     if ( sm_classTable )
 203     {
 204         return (wxClassInfo *)wxClassInfo::sm_classTable->Get(className);
 205     }
 206     else
 207     {
 208         for ( wxClassInfo *info = sm_first; info ; info = info->m_next )
 209         {
 210             if ( wxStrcmp(info->GetClassName(), className) == 0 )
 211                 return info;
 212         }
 213
 214         return NULL;
 215     }
 216 }
 217
 218 void wxClassInfo::CleanUp()
 219 {
 220     if ( sm_classTable )
 221     {
 222         delete sm_classTable;
 223         sm_classTable = NULL;
 224     }
 225 }
 226
 227 void wxClassInfo::Register()
 228 {
 229     if ( !sm_classTable )
 230     {
 231         sm_classTable = new wxHashTable(wxKEY_STRING);
 232     }
 233
 234     // using IMPLEMENT_DYNAMIC_CLASS() macro twice (which may happen if you
 235     // link any object module twice mistakenly) will break this function
 236     // because it will enter an infinite loop and eventually die with "out of
 237     // memory" - as this is quite hard to detect if you're unaware of this,
 238     // try to do some checks here
 239     wxASSERT_MSG( sm_classTable->Get(m_className) == NULL,
 240                   _T("class already in RTTI table - have you used IMPLEMENT_DYNAMIC_CLASS() twice (may be by linking some object module(s) twice)?") );
 241
 242     sm_classTable->Put(m_className, (wxObject *)this);
 243 }
 244
 245 void wxClassInfo::Unregister()
 246 {
 247     if ( sm_classTable )
 248     {
 249         sm_classTable->Delete(m_className);
 250         if ( sm_classTable->GetCount() == 0 )
 251         {
 252             delete sm_classTable;
 253             sm_classTable = NULL;
 254         }
 255     }
 256 }
 257
 258 wxObject *wxCreateDynamicObject(const wxChar *name)
 259 {
 260 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 261     DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
 262 #endif
 263
 264     if ( wxClassInfo::sm_classTable )
 265     {
 266         wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name);
 267         return info ? info->CreateObject() : NULL;
 268     }
 269     else // no sm_classTable yet
 270     {
 271         for ( wxClassInfo *info = wxClassInfo::sm_first;
 272               info;
 273               info = info->m_next )
 274         {
 275             if (info->m_className && wxStrcmp(info->m_className, name) == 0)
 276                 return info->CreateObject();
 277         }
 278
 279         return NULL;
 280     }
 281 }
 282
 283
 284 // ----------------------------------------------------------------------------
 285 // wxObject
 286 // ----------------------------------------------------------------------------
 287
 288 // Initialize ref data from another object (needed for copy constructor and
 289 // assignment operator)
 290 void wxObject::InitFrom(const wxObject& other)
 291 {
 292     m_refData = other.m_refData;
 293     if ( m_refData )
 294         m_refData->m_count++;
 295 }
 296
 297 void wxObject::Ref(const wxObject& clone)
 298 {
 299 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 300     DEBUG_PRINTF(wxObject::Ref)
 301 #endif
 302
 303     // nothing to be done
 304     if (m_refData == clone.m_refData)
 305         return;
 306
 307     // delete reference to old data
 308     UnRef();
 309
 310     // reference new data
 311     if ( clone.m_refData )
 312     {
 313         m_refData = clone.m_refData;
 314         ++(m_refData->m_count);
 315     }
 316 }
 317
 318 void wxObject::UnRef()
 319 {
 320     if ( m_refData )
 321     {
 322         wxASSERT_MSG( m_refData->m_count > 0, _T("invalid ref data count") );
 323
 324         if ( !--m_refData->m_count )
 325             delete m_refData;
 326         m_refData = NULL;
 327     }
 328 }
 329
 330 void wxObject::AllocExclusive()
 331 {
 332     if ( !m_refData )
 333     {
 334         m_refData = CreateRefData();
 335     }
 336     else if ( m_refData->GetRefCount() > 1 )
 337     {
 338         // note that ref is not going to be destroyed in this case
 339         const wxObjectRefData* ref = m_refData;
 340         UnRef();
 341
 342         // ... so we can still access it
 343         m_refData = CloneRefData(ref);
 344     }
 345     //else: ref count is 1, we are exclusive owners of m_refData anyhow
 346
 347     wxASSERT_MSG( m_refData && m_refData->GetRefCount() == 1,
 348                   _T("wxObject::AllocExclusive() failed.") );
 349 }
 350
 351 wxObjectRefData *wxObject::CreateRefData() const
 352 {
 353     // if you use AllocExclusive() you must override this method
 354     wxFAIL_MSG( _T("CreateRefData() must be overridden if called!") );
 355
 356     return NULL;
 357 }
 358
 359 wxObjectRefData *
 360 wxObject::CloneRefData(const wxObjectRefData * WXUNUSED(data)) const
 361 {
 362     // if you use AllocExclusive() you must override this method
 363     wxFAIL_MSG( _T("CloneRefData() must be overridden if called!") );
 364
 365     return NULL;
 366 }