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 // For compilers that support precompilation, includes "wx.h".
  14 #include "wx/wxprec.h"
  15
  16 #ifdef __BORLANDC__
  17     #pragma hdrstop
  18 #endif
  19
  20 #ifndef WX_PRECOMP
  21     #include "wx/object.h"
  22     #include "wx/hash.h"
  23     #include "wx/memory.h"
  24 #endif
  25
  26 #include <string.h>
  27
  28 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
  29     #if defined(__VISAGECPP__)
  30         #define DEBUG_PRINTF(NAME) { static int raz=0; \
  31             printf( #NAME " %i\n",raz); fflush(stdout); raz++; }
  32     #else
  33         #define DEBUG_PRINTF(NAME)
  34     #endif
  35 #endif // __WXDEBUG__ || wxUSE_DEBUG_CONTEXT
  36
  37 // we must disable optimizations for VC.NET because otherwise its too eager
  38 // linker discards wxClassInfo objects in release build thus breaking many,
  39 // many things
  40 #if defined __VISUALC__ && __VISUALC__ >= 1300
  41     #pragma optimize("", off)
  42 #endif
  43
  44 #if wxUSE_EXTENDED_RTTI
  45 const wxClassInfo* wxObject::ms_classParents[] = { NULL } ;
  46  wxObject* wxVariantToObjectConverterwxObject ( wxxVariant &data )
  47 { return data.wxTEMPLATED_MEMBER_CALL(Get , wxObject*) ; }
  48  wxObject* wxVariantOfPtrToObjectConverterwxObject ( wxxVariant &data )
  49 { return &data.wxTEMPLATED_MEMBER_CALL(Get , wxObject) ; }
  50  wxxVariant wxObjectToVariantConverterwxObject ( wxObject *data )
  51  { return wxxVariant( dynamic_cast<wxObject*> (data)  ) ; }
  52  wxClassInfo wxObject::ms_classInfo(ms_classParents , wxEmptyString , wxT("wxObject"),
  53             (int) sizeof(wxObject),                              \
  54             (wxObjectConstructorFn) 0   ,
  55             (wxPropertyInfo*) NULL,(wxHandlerInfo*) NULL,0 , 0 ,
  56             0 , wxVariantOfPtrToObjectConverterwxObject , wxVariantToObjectConverterwxObject , wxObjectToVariantConverterwxObject);
  57  template<> void wxStringReadValue(const wxString & , wxObject * & ){assert(0) ;}
  58  template<> void wxStringWriteValue(wxString & , wxObject* const & ){assert(0) ;}
  59  template<> void wxStringReadValue(const wxString & , wxObject & ){assert(0) ;}
  60  template<> void wxStringWriteValue(wxString & , wxObject const & ){assert(0) ;}
  61  wxClassTypeInfo s_typeInfo(wxT_OBJECT_PTR , &wxObject::ms_classInfo , NULL , NULL , typeid(wxObject*).name() ) ;
  62  wxClassTypeInfo s_typeInfowxObject(wxT_OBJECT , &wxObject::ms_classInfo , NULL , NULL , typeid(wxObject).name() ) ;
  63 #else
  64 wxClassInfo wxObject::ms_classInfo( wxT("wxObject"), 0, 0,
  65                                         (int) sizeof(wxObject),
  66                                         (wxObjectConstructorFn) 0 );
  67 #endif
  68
  69 // restore optimizations
  70 #if defined __VISUALC__ && __VISUALC__ >= 1300
  71     #pragma optimize("", on)
  72 #endif
  73
  74 wxClassInfo* wxClassInfo::sm_first = NULL;
  75 wxHashTable* wxClassInfo::sm_classTable = NULL;
  76
  77 // when using XTI, this method is already implemented inline inside
  78 // DECLARE_DYNAMIC_CLASS but otherwise we intentionally make this function
  79 // non-inline because this allows us to have a non-inline virtual function in
  80 // all wx classes and this solves linking problems for HP-UX native toolchain
  81 // and possibly others (we could make dtor non-inline as well but it's more
  82 // useful to keep it inline than this function)
  83 #if !wxUSE_EXTENDED_RTTI
  84
  85 wxClassInfo *wxObject::GetClassInfo() const
  86 {
  87     return &wxObject::ms_classInfo;
  88 }
  89
  90 #endif // wxUSE_EXTENDED_RTTI
  91
  92 // this variable exists only so that we can avoid 'always true/false' warnings
  93 const bool wxFalse = false;
  94
  95 // Is this object a kind of (a subclass of) 'info'?
  96 // E.g. is wxWindow a kind of wxObject?
  97 // Go from this class to superclass, taking into account
  98 // two possible base classes.
  99 bool wxObject::IsKindOf(wxClassInfo *info) const
 100 {
 101     wxClassInfo *thisInfo = GetClassInfo();
 102     return (thisInfo) ? thisInfo->IsKindOf(info) : false ;
 103 }
 104
 105 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING && defined( new )
 106     #undef new
 107 #endif
 108
 109
 110 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
 111 void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum )
 112 {
 113     return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true);
 114 }
 115 #endif
 116
 117 #ifdef _WX_WANT_DELETE_VOID
 118 void wxObject::operator delete ( void *buf )
 119 {
 120     wxDebugFree(buf);
 121 }
 122 #endif
 123
 124 #ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
 125 void wxObject::operator delete ( void *buf, const char *_fname, size_t _line )
 126 {
 127     wxDebugFree(buf);
 128 }
 129 #endif
 130
 131 #ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
 132 void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum) )
 133 {
 134      wxDebugFree(buf);
 135 }
 136 #endif
 137
 138 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
 139 void *wxObject::operator new[] ( size_t size, const wxChar* fileName, int lineNum )
 140 {
 141     return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true, true);
 142 }
 143 #endif
 144
 145 #ifdef _WX_WANT_ARRAY_DELETE_VOID
 146 void wxObject::operator delete[] ( void *buf )
 147 {
 148     wxDebugFree(buf, true);
 149 }
 150 #endif
 151
 152 #ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
 153 void wxObject::operator delete[] (void * buf, const wxChar*  WXUNUSED(fileName), int WXUNUSED(lineNum) )
 154 {
 155     wxDebugFree(buf, true);
 156 }
 157 #endif
 158
 159
 160 // ----------------------------------------------------------------------------
 161 // wxClassInfo
 162 // ----------------------------------------------------------------------------
 163
 164 wxClassInfo::~wxClassInfo()
 165 {
 166     // remove this object from the linked list of all class infos: if we don't
 167     // do it, loading/unloading a DLL containing static wxClassInfo objects is
 168     // not going to work
 169     if ( this == sm_first )
 170     {
 171         sm_first = m_next;
 172     }
 173     else
 174     {
 175         wxClassInfo *info = sm_first;
 176         while (info)
 177         {
 178             if ( info->m_next == this )
 179             {
 180                 info->m_next = m_next;
 181                 break;
 182             }
 183
 184             info = info->m_next;
 185         }
 186     }
 187     Unregister();
 188 }
 189
 190 wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
 191 {
 192     if ( sm_classTable )
 193     {
 194         return (wxClassInfo *)wxClassInfo::sm_classTable->Get(className);
 195     }
 196     else
 197     {
 198         for ( wxClassInfo *info = sm_first; info ; info = info->m_next )
 199         {
 200             if ( wxStrcmp(info->GetClassName(), className) == 0 )
 201                 return info;
 202         }
 203
 204         return NULL;
 205     }
 206 }
 207
 208 // This function wasn't written to be reentrant but there is a possiblity of
 209 // reentrance if something it does causes a shared lib to load and register
 210 // classes. On Solaris this happens when the wxHashTable is newed, so the first
 211 // part of the function has been modified to handle it, and a wxASSERT checks
 212 // against reentrance in the remainder of the function.
 213
 214 void wxClassInfo::Register()
 215 {
 216     if ( !sm_classTable )
 217     {
 218         wxHashTable *classTable = new wxHashTable(wxKEY_STRING);
 219
 220         // check for reentrance
 221         if ( sm_classTable )
 222             delete classTable;
 223         else
 224             sm_classTable = classTable;
 225     }
 226
 227 #ifdef __WXDEBUG__
 228     // reentrance guard - see note above
 229     static int entry = 0;
 230     wxASSERT_MSG(++entry == 1, _T("wxClassInfo::Register() reentrance"));
 231 #endif
 232
 233     // Using IMPLEMENT_DYNAMIC_CLASS() macro twice (which may happen if you
 234     // link any object module twice mistakenly, or link twice against wx shared
 235     // library) will break this function because it will enter an infinite loop
 236     // and eventually die with "out of memory" - as this is quite hard to
 237     // detect if you're unaware of this, try to do some checks here.
 238     wxASSERT_MSG( sm_classTable->Get(m_className) == NULL,
 239         wxString::Format
 240         (
 241             _T("Class \"%s\" already in RTTI table - have you used IMPLEMENT_DYNAMIC_CLASS() multiple times or linked some object file twice)?"),
 242             m_className
 243         )
 244     );
 245
 246     sm_classTable->Put(m_className, (wxObject *)this);
 247
 248 #ifdef __WXDEBUG__
 249     --entry;
 250 #endif
 251 }
 252
 253 void wxClassInfo::Unregister()
 254 {
 255     if ( sm_classTable )
 256     {
 257         sm_classTable->Delete(m_className);
 258         if ( sm_classTable->GetCount() == 0 )
 259         {
 260             delete sm_classTable;
 261             sm_classTable = NULL;
 262         }
 263     }
 264 }
 265
 266 wxObject *wxCreateDynamicObject(const wxChar *name)
 267 {
 268 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 269     DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
 270 #endif
 271
 272     if ( wxClassInfo::sm_classTable )
 273     {
 274         wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name);
 275         return info ? info->CreateObject() : NULL;
 276     }
 277     else // no sm_classTable yet
 278     {
 279         for ( wxClassInfo *info = wxClassInfo::sm_first;
 280               info;
 281               info = info->m_next )
 282         {
 283             if (info->m_className && wxStrcmp(info->m_className, name) == 0)
 284                 return info->CreateObject();
 285         }
 286
 287         return NULL;
 288     }
 289 }
 290
 291
 292 // ----------------------------------------------------------------------------
 293 // wxObjectRefData
 294 // ----------------------------------------------------------------------------
 295
 296 void wxObjectRefData::DecRef()
 297 {
 298     if ( --m_count == 0 )
 299         delete this;
 300 }
 301
 302
 303 // ----------------------------------------------------------------------------
 304 // wxObject
 305 // ----------------------------------------------------------------------------
 306
 307 void wxObject::Ref(const wxObject& clone)
 308 {
 309 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 310     DEBUG_PRINTF(wxObject::Ref)
 311 #endif
 312
 313     // nothing to be done
 314     if (m_refData == clone.m_refData)
 315         return;
 316
 317     // delete reference to old data
 318     UnRef();
 319
 320     // reference new data
 321     if ( clone.m_refData )
 322     {
 323         m_refData = clone.m_refData;
 324         m_refData->IncRef();
 325     }
 326 }
 327
 328 void wxObject::UnRef()
 329 {
 330     if ( m_refData )
 331     {
 332         wxASSERT_MSG( m_refData->m_count > 0, _T("invalid ref data count") );
 333
 334         m_refData->DecRef();
 335         m_refData = NULL;
 336     }
 337 }
 338
 339 void wxObject::AllocExclusive()
 340 {
 341     if ( !m_refData )
 342     {
 343         m_refData = CreateRefData();
 344     }
 345     else if ( m_refData->GetRefCount() > 1 )
 346     {
 347         // note that ref is not going to be destroyed in this case
 348         const wxObjectRefData* ref = m_refData;
 349         UnRef();
 350
 351         // ... so we can still access it
 352         m_refData = CloneRefData(ref);
 353     }
 354     //else: ref count is 1, we are exclusive owners of m_refData anyhow
 355
 356     wxASSERT_MSG( m_refData && m_refData->GetRefCount() == 1,
 357                   _T("wxObject::AllocExclusive() failed.") );
 358 }
 359
 360 wxObjectRefData *wxObject::CreateRefData() const
 361 {
 362     // if you use AllocExclusive() you must override this method
 363     wxFAIL_MSG( _T("CreateRefData() must be overridden if called!") );
 364
 365     return NULL;
 366 }
 367
 368 wxObjectRefData *
 369 wxObject::CloneRefData(const wxObjectRefData * WXUNUSED(data)) const
 370 {
 371     // if you use AllocExclusive() you must override this method
 372     wxFAIL_MSG( _T("CloneRefData() must be overridden if called!") );
 373
 374     return NULL;
 375 }