X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c801d85f158c4cba50b588807daabdcbd0ed3853..abd474ea63667f727940a009cc3e0b23ba9f418f:/src/common/object.cpp diff --git a/src/common/object.cpp b/src/common/object.cpp index 4dc8b093b3..fbcd2766b5 100644 --- a/src/common/object.cpp +++ b/src/common/object.cpp @@ -1,304 +1,430 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: object.cpp +// Name: src/common/object.cpp // Purpose: wxObject implementation // Author: Julian Smart -// Modified by: +// Modified by: Ron Lee // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) 1998 Julian Smart +// (c) 2001 Ron Lee +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "object.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -#include "wx/hash.h" +#ifndef WX_PRECOMP + #include "wx/object.h" + #include "wx/hash.h" + #include "wx/memory.h" + #include "wx/crt.h" +#endif #include -#include -#if (DEBUG && USE_MEMORY_TRACING) || USE_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 DEBUG || USE_DEBUG_CONTEXT - // for wxObject::Dump - #include +#if wxUSE_EXTENDED_RTTI +const wxClassInfo* wxObject::ms_classParents[] = { NULL } ; +wxObject* wxVariantOfPtrToObjectConverterwxObject ( const wxAny &data ) +{ return wxANY_AS(data, wxObject*); } + wxAny wxObjectToVariantConverterwxObject ( wxObject *data ) + { return wxAny( dynamic_cast (data) ) ; } + + wxClassInfo wxObject::ms_classInfo(ms_classParents , wxEmptyString , wxT("wxObject"), + (int) sizeof(wxObject), \ + (wxObjectConstructorFn) 0 , + NULL,NULL,0 , 0 , + 0 , wxVariantOfPtrToObjectConverterwxObject , 0 , wxObjectToVariantConverterwxObject); + + template<> void wxStringWriteValue(wxString & , wxObject* const & ){ 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 +wxClassInfo wxObject::ms_classInfo( wxT("wxObject"), 0, 0, + (int) sizeof(wxObject), + (wxObjectConstructorFn) 0 ); #endif -#if !USE_SHARED_LIBRARY -wxClassInfo wxObject::classwxObject("wxObject", NULL, NULL, sizeof(wxObject), NULL); -wxClassInfo *wxClassInfo::first = NULL; +// restore optimizations +#if defined __VISUALC__ && __VISUALC__ >= 1300 + #pragma optimize("", on) #endif -/* - * wxWindows root object. - */ +wxClassInfo* wxClassInfo::sm_first = NULL; +wxHashTable* wxClassInfo::sm_classTable = NULL; -wxObject::wxObject(void) -{ - m_refData = NULL; -} +// 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 -wxObject::~wxObject(void) +wxClassInfo *wxObject::GetClassInfo() const { - UnRef(); + return &wxObject::ms_classInfo; } -/* - * 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(wxClassInfo *info) +#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 { - wxClassInfo *thisInfo = GetClassInfo(); - if (thisInfo) - return thisInfo->IsKindOf(info); - else - return FALSE; + const wxClassInfo *thisInfo = GetClassInfo(); + return (thisInfo) ? thisInfo->IsKindOf(info) : false ; } -#if DEBUG || USE_DEBUG_CONTEXT -void wxObject::Dump(ostream& str) +#if wxUSE_MEMORY_TRACING && defined( new ) + #undef new +#endif + + +#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT +void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum ) { - if (GetClassInfo() && GetClassInfo()->GetClassName()) - str << GetClassInfo()->GetClassName(); - else - str << "unknown object class"; + return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true); } #endif -#if DEBUG && USE_MEMORY_TRACING - -#ifdef new -#undef new +#ifdef _WX_WANT_DELETE_VOID +void wxObject::operator delete ( void *buf ) +{ + wxDebugFree(buf); +} #endif -void * wxObject::operator new (size_t size, char * fileName, int lineNum) +#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET +void wxObject::operator delete ( void *buf, const char *_fname, size_t _line ) { - return wxDebugAlloc(size, fileName, lineNum, TRUE); + wxDebugFree(buf); } +#endif -void wxObject::operator delete (void * buf) +#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT +void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum) ) { - wxDebugFree(buf); + wxDebugFree(buf); } +#endif -// Cause problems for VC++ - crashes -#ifndef _MSC_VER -void * wxObject::operator new[] (size_t size, char * 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 +#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 -/* - * Class info: provides run-time class type information. - */ -#ifdef USE_STORABLE_CLASSES +// ---------------------------------------------------------------------------- +// wxClassInfo +// ---------------------------------------------------------------------------- -wxClassInfo::wxClassInfo(char *cName, char *baseName1, char *baseName2, int sz, wxObjectConstructorFn fn, - wxStorableConstructorFn stoFn ) +wxClassInfo::~wxClassInfo() { - className = cName; - baseClassName1 = baseName1; - baseClassName2 = baseName2; - - objectSize = sz; - objectConstructor = fn; - storableConstructor = stoFn; - - next = first; - first = this; - - baseInfo1 = NULL; - baseInfo2 = NULL; + // 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(); } - -wxObject* wxClassInfo::CreateObject( istream &stream, char *data ) + +wxClassInfo *wxClassInfo::FindClass(const wxString& className) { - if (storableConstructor) - return (wxObject *)(*storableConstructor)( stream, data ); - else - return NULL; + if ( sm_classTable ) + { + return (wxClassInfo *)wxClassInfo::sm_classTable->Get(className); + } + else + { + for ( wxClassInfo *info = sm_first; info ; info = info->m_next ) + { + if ( className == info->GetClassName() ) + return info; + } + + return NULL; + } } -#else - -wxClassInfo::wxClassInfo(char *cName, char *baseName1, char *baseName2, int sz, wxObjectConstructorFn constr) +// 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() { - className = cName; - baseClassName1 = baseName1; - baseClassName2 = baseName2; - - objectSize = sz; - objectConstructor = constr; - - next = first; - first = this; - - baseInfo1 = NULL; - baseInfo2 = NULL; -} +#if wxDEBUG_LEVEL + // reentrance guard - see note above + static int entry = 0; +#endif // wxDEBUG_LEVEL -#endif + wxHashTable *classTable; -wxObject *wxClassInfo::CreateObject(void) -{ - if (objectConstructor) - return (wxObject *)(*objectConstructor)(); - else - return NULL; + 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; + } + + // 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 ( !sm_classTable ) + { + // make the hash global + sm_classTable = classTable; + } + else + { + // the gobal hash has already been created by a reentrant call, + // so delete the local hash and try again + delete classTable; + Register(); + } + } + +#if wxDEBUG_LEVEL + entry = 0; +#endif // wxDEBUG_LEVEL } -wxClassInfo *wxClassInfo::FindClass(char *c) +void wxClassInfo::Unregister() { - wxClassInfo *p = first; - while (p) - { - if (p && p->GetClassName() && strcmp(p->GetClassName(), c) == 0) - return p; - p = p->next; - } - return NULL; + if ( sm_classTable ) + { + sm_classTable->Delete(m_className); + if ( sm_classTable->GetCount() == 0 ) + { + wxDELETE(sm_classTable); + } + } } -// Climb upwards through inheritance hierarchy. -// Dual inheritance is catered for. -bool wxClassInfo::IsKindOf(wxClassInfo *info) +wxObject *wxCreateDynamicObject(const wxString& name) { - if (info == NULL) - return FALSE; - - // For some reason, when making/using a DLL, static data has to be included - // in both the DLL and the application. This can lead to duplicate - // wxClassInfo objects, so we have to test the name instead of the pointers. -#if WXMAKINGDLL - if (GetClassName() && info->GetClassName() && (strcmp(GetClassName(), info->GetClassName()) == 0)) - return TRUE; -#else - if (this == info) - return TRUE; +#if wxUSE_DEBUG_CONTEXT + DEBUG_PRINTF(wxObject *wxCreateDynamicObject) #endif - if (baseInfo1) - if (baseInfo1->IsKindOf(info)) - return TRUE; + if ( wxClassInfo::sm_classTable ) + { + wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name); + return info ? info->CreateObject() : NULL; + } + else // no sm_classTable yet + { + 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 NULL; + } +} - if (baseInfo2) - return baseInfo2->IsKindOf(info); +// 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; +} - return FALSE; +const wxClassInfo::const_iterator wxClassInfo::const_iterator::operator++(int) +{ + wxClassInfo::const_iterator tmp = *this; + m_node = m_table->Next(); + return tmp; } -// Set pointers to base class(es) to speed up IsKindOf -void wxClassInfo::InitializeClasses(void) +wxClassInfo::const_iterator wxClassInfo::begin_classinfo() { - wxHashTable table(wxKEY_STRING); - - // Index all class infos by their class name - wxClassInfo *info = first; - while (info) - { - if (info->className) - table.Put(info->className, (wxObject *)info); - info = info->next; - } - - // Set base pointers for each wxClassInfo - info = first; - while (info) - { - if (info->GetBaseClassName1()) - info->baseInfo1 = (wxClassInfo *)table.Get(info->GetBaseClassName1()); - if (info->GetBaseClassName2()) - info->baseInfo2 = (wxClassInfo *)table.Get(info->GetBaseClassName2()); - info = info->next; - } + sm_classTable->BeginFind(); + + return const_iterator(sm_classTable->Next(), sm_classTable); } -wxObject *wxCreateDynamicObject(char *name) +wxClassInfo::const_iterator wxClassInfo::end_classinfo() { - wxClassInfo *info = wxClassInfo::first; - while (info) - { - if (info->className && strcmp(info->className, name) == 0) - return info->CreateObject(); - info = info->next; - } - return NULL; + return const_iterator(NULL, NULL); } -#ifdef USE_STORABLE_CLASSES +// ---------------------------------------------------------------------------- +// wxObjectRefData +// ---------------------------------------------------------------------------- -wxObject* wxCreateStoredObject( char *name, istream &stream, char *data ) +void wxRefCounter::DecRef() { - wxClassInfo *info = wxClassInfo::first; - while (info) - { - if (info->className && strcmp(info->className, name) == 0) - return info->CreateObject( stream, data ); - info = info->next; - } - return NULL; -}; + wxASSERT_MSG( m_count > 0, "invalid ref data count" ); + + if ( --m_count == 0 ) + delete this; +} -#endif -/* - * wxObject: cloning of objects - */ +// ---------------------------------------------------------------------------- +// wxObject +// ---------------------------------------------------------------------------- void wxObject::Ref(const wxObject& clone) { +#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(void) +void wxObject::UnRef() { - if (m_refData) { - assert(m_refData->m_count > 0); - --(m_refData->m_count); - if (m_refData->m_count == 0) - delete m_refData; + if ( m_refData ) + { + m_refData->DecRef(); + m_refData = NULL; } - m_refData = NULL; } -/* - * wxObjectData - */ - -wxObjectRefData::wxObjectRefData(void) : m_count(1) +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(); + + // ... so we can still access it + m_refData = CloneRefData(ref); + } + //else: ref count is 1, we are exclusive owners of m_refData anyhow + + wxASSERT_MSG( m_refData && m_refData->GetRefCount() == 1, + wxT("wxObject::AllocExclusive() failed.") ); } -wxObjectRefData::~wxObjectRefData(void) +wxObjectRefData *wxObject::CreateRefData() const { + // if you use AllocExclusive() you must override this method + wxFAIL_MSG( wxT("CreateRefData() must be overridden if called!") ); + + return NULL; } +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!") ); + + return NULL; +}