X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/80e8062f676ca214765983ecefbaef9bc1c2446f..ccc3a25d878ae0797c2f689f5ef6a8b727786f83:/src/common/object.cpp diff --git a/src/common/object.cpp b/src/common/object.cpp index 86b84c8a43..c21fdf02f4 100644 --- a/src/common/object.cpp +++ b/src/common/object.cpp @@ -1,139 +1,194 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: object.cpp +// Name: src/common/object.cpp // Purpose: wxObject implementation // Author: Julian Smart // Modified by: Ron Lee // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) 1998 Julian Smart and Markus Holzem +// Copyright: (c) 1998 Julian Smart // (c) 2001 Ron Lee -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "object.h" -#endif - - // For compilers that support precompilation, includes "wx.h". - +// For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif #ifndef WX_PRECOMP -#include "wx/hash.h" + #include "wx/object.h" + #include "wx/hash.h" + #include "wx/memory.h" + #include "wx/crt.h" #endif #include -#include -#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT -#include "wx/memory.h" +#if wxUSE_DEBUG_CONTEXT + #if defined(__VISAGECPP__) + #define DEBUG_PRINTF(NAME) { static int raz=0; \ + printf( #NAME " %i\n",raz); fflush(stdout); raz++; } + #else + #define DEBUG_PRINTF(NAME) + #endif +#endif // wxUSE_DEBUG_CONTEXT + +// we must disable optimizations for VC.NET because otherwise its too eager +// linker discards wxClassInfo objects in release build thus breaking many, +// many things +#if defined __VISUALC__ && __VISUALC__ >= 1300 + #pragma optimize("", off) #endif -#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT - // for wxObject::Dump -#include "wx/ioswrap.h" - -#if defined(__VISAGECPP__) -#define DEBUG_PRINTF(NAME) { static int raz=0; \ - printf( #NAME " %i\n",raz); fflush(stdout); raz++; } +#if wxUSE_EXTENDED_RTTI +const wxClassInfo* wxObject::ms_classParents[] = { NULL } ; + wxObject* wxVariantToObjectConverterwxObject ( wxxVariant &data ) +{ return data.wxTEMPLATED_MEMBER_CALL(Get , wxObject*) ; } + wxObject* wxVariantOfPtrToObjectConverterwxObject ( wxxVariant &data ) +{ return &data.wxTEMPLATED_MEMBER_CALL(Get , wxObject) ; } + wxxVariant wxObjectToVariantConverterwxObject ( wxObject *data ) + { return wxxVariant( dynamic_cast (data) ) ; } + wxClassInfo wxObject::ms_classInfo(ms_classParents , wxEmptyString , wxT("wxObject"), + (int) sizeof(wxObject), \ + (wxObjectConstructorFn) 0 , + NULL,NULL,0 , 0 , + 0 , wxVariantOfPtrToObjectConverterwxObject , wxVariantToObjectConverterwxObject , wxObjectToVariantConverterwxObject); + template<> void wxStringReadValue(const wxString & , wxObject * & ){ wxFAIL_MSG("unreachable"); } + template<> void wxStringWriteValue(wxString & , wxObject* const & ){ wxFAIL_MSG("unreachable"); } + template<> void wxStringReadValue(const wxString & , wxObject & ){ wxFAIL_MSG("unreachable"); } + template<> void wxStringWriteValue(wxString & , wxObject const & ){ wxFAIL_MSG("unreachable"); } + wxClassTypeInfo s_typeInfo(wxT_OBJECT_PTR , &wxObject::ms_classInfo , NULL , NULL , typeid(wxObject*).name() ) ; + wxClassTypeInfo s_typeInfowxObject(wxT_OBJECT , &wxObject::ms_classInfo , NULL , NULL , typeid(wxObject).name() ) ; #else -#define DEBUG_PRINTF(NAME) -#endif - -#endif - - -wxClassInfo wxObject::sm_classwxObject( wxT("wxObject"), 0, 0, +wxClassInfo wxObject::ms_classInfo( wxT("wxObject"), 0, 0, (int) sizeof(wxObject), (wxObjectConstructorFn) 0 ); -wxClassInfo* wxClassInfo::sm_first = 0; -wxHashTable* wxClassInfo::sm_classTable = 0; +#endif - // These are here so we can avoid 'always true/false' warnings - // by referring to these instead of TRUE/FALSE +// restore optimizations +#if defined __VISUALC__ && __VISUALC__ >= 1300 + #pragma optimize("", on) +#endif -const bool wxTrue = TRUE; -const bool wxFalse = FALSE; +wxClassInfo* wxClassInfo::sm_first = NULL; +wxHashTable* wxClassInfo::sm_classTable = NULL; - // Is this object a kind of (a subclass of) 'info'? - // E.g. is wxWindow a kind of wxObject? - // Go from this class to superclass, taking into account - // two possible base classes. +// when using XTI, this method is already implemented inline inside +// DECLARE_DYNAMIC_CLASS but otherwise we intentionally make this function +// non-inline because this allows us to have a non-inline virtual function in +// all wx classes and this solves linking problems for HP-UX native toolchain +// and possibly others (we could make dtor non-inline as well but it's more +// useful to keep it inline than this function) +#if !wxUSE_EXTENDED_RTTI -bool wxObject::IsKindOf(wxClassInfo *info) const +wxClassInfo *wxObject::GetClassInfo() const { - wxClassInfo *thisInfo = GetClassInfo(); - return (thisInfo) ? thisInfo->IsKindOf(info) : FALSE ; + return &wxObject::ms_classInfo; } -#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) -void wxObject::Dump(wxSTD ostream& str) +#endif // wxUSE_EXTENDED_RTTI + +// this variable exists only so that we can avoid 'always true/false' warnings +const bool wxFalse = false; + +// Is this object a kind of (a subclass of) 'info'? +// E.g. is wxWindow a kind of wxObject? +// Go from this class to superclass, taking into account +// two possible base classes. +bool wxObject::IsKindOf(const wxClassInfo *info) const { - if (GetClassInfo() && GetClassInfo()->GetClassName()) - str << GetClassInfo()->GetClassName(); - else - str << "unknown object class"; + const wxClassInfo *thisInfo = GetClassInfo(); + return (thisInfo) ? thisInfo->IsKindOf(info) : false ; } -#endif - -#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING -#ifdef new -#undef new +#if wxUSE_MEMORY_TRACING && defined( new ) + #undef new #endif -void *wxObject::operator new (size_t size, wxChar *fileName, int lineNum) + +#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT +void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum ) { - return wxDebugAlloc(size, fileName, lineNum, TRUE); + return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true); } +#endif -#ifndef __VISAGECPP__ -void wxObject::operator delete (void *buf) +#ifdef _WX_WANT_DELETE_VOID +void wxObject::operator delete ( void *buf ) { wxDebugFree(buf); } -#elif __DEBUG_ALLOC__ -void wxObject::operator delete (void *buf, const char *_fname, size_t _line) +#endif + +#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET +void wxObject::operator delete ( void *buf, const char *_fname, size_t _line ) { wxDebugFree(buf); } #endif - // VC++ 6.0 - -#if defined(__VISUALC__) && (__VISUALC__ >= 1200) -void wxObject::operator delete(void *pData, wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum)) +#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT +void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum) ) { - ::operator delete(pData); + wxDebugFree(buf); } #endif - // Cause problems for VC++ - crashes - -#if (!defined(__VISUALC__) && wxUSE_ARRAY_MEMORY_OPERATORS ) || defined(__MWERKS__) -void *wxObject::operator new[] (size_t size, wxChar *fileName, int lineNum) +#ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT +void *wxObject::operator new[] ( size_t size, const wxChar* fileName, int lineNum ) { - return wxDebugAlloc(size, fileName, lineNum, TRUE, TRUE); + return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true, true); } +#endif -void wxObject::operator delete[] (void *buf) +#ifdef _WX_WANT_ARRAY_DELETE_VOID +void wxObject::operator delete[] ( void *buf ) { - wxDebugFree(buf, TRUE); + wxDebugFree(buf, true); } #endif -#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING +#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT +void wxObject::operator delete[] (void * buf, const wxChar* WXUNUSED(fileName), int WXUNUSED(lineNum) ) +{ + wxDebugFree(buf, true); +} +#endif // ---------------------------------------------------------------------------- // wxClassInfo // ---------------------------------------------------------------------------- -wxClassInfo *wxClassInfo::FindClass(const wxChar *className) +wxClassInfo::~wxClassInfo() +{ + // remove this object from the linked list of all class infos: if we don't + // do it, loading/unloading a DLL containing static wxClassInfo objects is + // not going to work + if ( this == sm_first ) + { + sm_first = m_next; + } + else + { + wxClassInfo *info = sm_first; + while (info) + { + if ( info->m_next == this ) + { + info->m_next = m_next; + break; + } + + info = info->m_next; + } + } + Unregister(); +} + +wxClassInfo *wxClassInfo::FindClass(const wxString& className) { if ( sm_classTable ) { @@ -143,7 +198,7 @@ wxClassInfo *wxClassInfo::FindClass(const wxChar *className) { for ( wxClassInfo *info = sm_first; info ; info = info->m_next ) { - if ( wxStrcmp(info->GetClassName(), className) == 0 ) + if ( className == info->GetClassName() ) return info; } @@ -151,130 +206,227 @@ wxClassInfo *wxClassInfo::FindClass(const wxChar *className) } } - // Set pointers to base class(es) to speed up IsKindOf - -void wxClassInfo::InitializeClasses() +// Reentrance can occur on some platforms (Solaris for one), as the use of hash +// and string objects can cause other modules to load and register classes +// before the original call returns. This is handled by keeping the hash table +// local when it is first created and only assigning it to the global variable +// when the function is ready to return. +// +// That does make the assumption that after the function has completed the +// first time the problem will no longer happen; all the modules it depends on +// will have been loaded. The assumption is checked using the 'entry' variable +// as a reentrance guard, it checks that once the hash table is global it is +// not accessed multiple times simulateously. + +void wxClassInfo::Register() { - // using IMPLEMENT_DYNAMIC_CLASS() macro twice (which may happen if you - // link any object module twice mistakenly) will break this function - // because it will enter an infinite loop and eventually die with "out of - // memory" - as this is quite hard to detect if you're unaware of this, - // try to do some checks here - -#ifdef __WXDEBUG__ - static const size_t nMaxClasses = 10000; // more than we'll ever have - size_t nClass = 0; -#endif +#if wxDEBUG_LEVEL + // reentrance guard - see note above + static int entry = 0; +#endif // wxDEBUG_LEVEL - wxClassInfo::sm_classTable = new wxHashTable(wxKEY_STRING); + wxHashTable *classTable; - // Index all class infos by their class name + if ( !sm_classTable ) + { + // keep the hash local initially, reentrance is possible + classTable = new wxHashTable(wxKEY_STRING); + } + else + { + // guard againt reentrance once the global has been created + wxASSERT_MSG(++entry == 1, wxT("wxClassInfo::Register() reentrance")); + classTable = sm_classTable; + } - wxClassInfo *info; - for(info = sm_first; info; info = info->m_next) + // Using IMPLEMENT_DYNAMIC_CLASS() macro twice (which may happen if you + // link any object module twice mistakenly, or link twice against wx shared + // library) will break this function because it will enter an infinite loop + // and eventually die with "out of memory" - as this is quite hard to + // detect if you're unaware of this, try to do some checks here. + wxASSERT_MSG( classTable->Get(m_className) == NULL, + wxString::Format + ( + wxT("Class \"%s\" already in RTTI table - have you used IMPLEMENT_DYNAMIC_CLASS() multiple times or linked some object file twice)?"), + m_className + ) + ); + + classTable->Put(m_className, (wxObject *)this); + + // if we're using a local hash we need to try to make it global + if ( sm_classTable != classTable ) { - if (info->m_className) + if ( !sm_classTable ) + { + // make the hash global + sm_classTable = classTable; + } + else { - wxASSERT_MSG( ++nClass < nMaxClasses, - _T("an infinite loop detected - have you used IMPLEMENT_DYNAMIC_CLASS() twice (may be by linking some object module(s) twice)?") ); - sm_classTable->Put(info->m_className, (wxObject *)info); + // the gobal hash has already been created by a reentrant call, + // so delete the local hash and try again + delete classTable; + Register(); } } - // Set base pointers for each wxClassInfo - - for(info = sm_first; info; info = info->m_next) - { - if (info->GetBaseClassName1()) - info->m_baseInfo1 = (wxClassInfo *)sm_classTable->Get(info->GetBaseClassName1()); - if (info->GetBaseClassName2()) - info->m_baseInfo2 = (wxClassInfo *)sm_classTable->Get(info->GetBaseClassName2()); - } +#if wxDEBUG_LEVEL + entry = 0; +#endif // wxDEBUG_LEVEL } -void wxClassInfo::CleanUpClasses() +void wxClassInfo::Unregister() { - delete wxClassInfo::sm_classTable; - wxClassInfo::sm_classTable = 0; + if ( sm_classTable ) + { + sm_classTable->Delete(m_className); + if ( sm_classTable->GetCount() == 0 ) + { + delete sm_classTable; + sm_classTable = NULL; + } + } } - -wxObject *wxCreateDynamicObject(const wxChar *name) +wxObject *wxCreateDynamicObject(const wxString& name) { -#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT - DEBUG_PRINTF(wxObject *wxCreateDynamicObject) +#if wxUSE_DEBUG_CONTEXT + DEBUG_PRINTF(wxObject *wxCreateDynamicObject) #endif - if (wxClassInfo::sm_classTable) + if ( wxClassInfo::sm_classTable ) { wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name); - return info != 0 ? info->CreateObject() : 0; + return info ? info->CreateObject() : NULL; } - else + else // no sm_classTable yet { - for(wxClassInfo *info = wxClassInfo::sm_first; info; info = info->m_next) + for ( wxClassInfo *info = wxClassInfo::sm_first; + info; + info = info->m_next ) + { if (info->m_className && wxStrcmp(info->m_className, name) == 0) return info->CreateObject(); - return 0; + } + + return NULL; } } +// iterator interface +wxClassInfo::const_iterator::value_type +wxClassInfo::const_iterator::operator*() const +{ + return (wxClassInfo*)m_node->GetData(); +} + +wxClassInfo::const_iterator& wxClassInfo::const_iterator::operator++() +{ + m_node = m_table->Next(); + return *this; +} + +const wxClassInfo::const_iterator wxClassInfo::const_iterator::operator++(int) +{ + wxClassInfo::const_iterator tmp = *this; + m_node = m_table->Next(); + return tmp; +} + +wxClassInfo::const_iterator wxClassInfo::begin_classinfo() +{ + sm_classTable->BeginFind(); + + return const_iterator(sm_classTable->Next(), sm_classTable); +} + +wxClassInfo::const_iterator wxClassInfo::end_classinfo() +{ + return const_iterator(NULL, NULL); +} // ---------------------------------------------------------------------------- -// wxClassInfo +// wxObjectRefData +// ---------------------------------------------------------------------------- + +void wxRefCounter::DecRef() +{ + wxASSERT_MSG( m_count > 0, "invalid ref data count" ); + + if ( --m_count == 0 ) + delete this; +} + + +// ---------------------------------------------------------------------------- +// wxObject // ---------------------------------------------------------------------------- void wxObject::Ref(const wxObject& clone) { -#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT - DEBUG_PRINTF(wxObject::Ref) +#if wxUSE_DEBUG_CONTEXT + DEBUG_PRINTF(wxObject::Ref) #endif + // nothing to be done + if (m_refData == clone.m_refData) + return; + // delete reference to old data UnRef(); // reference new data - if( clone.m_refData ) + if ( clone.m_refData ) { m_refData = clone.m_refData; - ++(m_refData->m_count); + m_refData->IncRef(); } } void wxObject::UnRef() { - if( m_refData ) + if ( m_refData ) { - wxASSERT_MSG( m_refData->m_count > 0, _T("invalid ref data count") ); - - if ( !--m_refData->m_count ) - delete m_refData; - m_refData = 0; + m_refData->DecRef(); + m_refData = NULL; } } +void wxObject::AllocExclusive() +{ + if ( !m_refData ) + { + m_refData = CreateRefData(); + } + else if ( m_refData->GetRefCount() > 1 ) + { + // note that ref is not going to be destroyed in this case + const wxObjectRefData* ref = m_refData; + UnRef(); -#if defined(__DARWIN__) && defined(DYLIB_INIT) - -extern "C" { - void __initialize_Cplusplus(void); - void wxWindowsDylibInit(void); -}; + // ... so we can still access it + m_refData = CloneRefData(ref); + } + //else: ref count is 1, we are exclusive owners of m_refData anyhow - // Dynamic shared library (dylib) initialization routine - // required to initialize static C++ objects bacause of lazy dynamic linking - // http://developer.apple.com/techpubs/macosx/Essentials/ - // SystemOverview/Frameworks/Dynamic_Shared_Libraries.html + wxASSERT_MSG( m_refData && m_refData->GetRefCount() == 1, + wxT("wxObject::AllocExclusive() failed.") ); +} -void wxWindowsDylibInit() +wxObjectRefData *wxObject::CreateRefData() const { - // The function __initialize_Cplusplus() must be called from the shared - // library initialization routine to cause the static C++ objects in - // the library to be initialized (reference number 2441683). + // if you use AllocExclusive() you must override this method + wxFAIL_MSG( wxT("CreateRefData() must be overridden if called!") ); - __initialize_Cplusplus(); + return NULL; } -#endif +wxObjectRefData * +wxObject::CloneRefData(const wxObjectRefData * WXUNUSED(data)) const +{ + // if you use AllocExclusive() you must override this method + wxFAIL_MSG( wxT("CloneRefData() must be overridden if called!") ); -// vi:sts=4:sw=4:et + return NULL; +}