X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8429bec1e8e3fcb7d071bc3ef7c665c484b5fdc1..edd802c67c82f95d773635a813645287a47594e4:/src/common/object.cpp diff --git a/src/common/object.cpp b/src/common/object.cpp index 2c8864b956..bbbf5350e3 100644 --- a/src/common/object.cpp +++ b/src/common/object.cpp @@ -1,12 +1,13 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 and Markus Holzem +// (c) 2001 Ron Lee +// Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// #ifdef __GNUG__ @@ -22,311 +23,364 @@ #ifndef WX_PRECOMP #include "wx/hash.h" -#ifdef USE_STORABLE_CLASSES -#include "wx/objstrm.h" -#include "wx/serbase.h" -#endif #endif #include -#include -#if (WXDEBUG && USE_MEMORY_TRACING) || USE_DEBUG_CONTEXT +#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT #include "wx/memory.h" #endif -#if WXDEBUG || USE_DEBUG_CONTEXT - // for wxObject::Dump - #include -#endif +#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT + // for wxObject::Dump + #include "wx/ioswrap.h" -#if !USE_SHARED_LIBRARY -wxClassInfo wxObject::classwxObject((char *) "wxObject", (char *) NULL, (char *) NULL, (int ) sizeof(wxObject), (wxObjectConstructorFn) NULL); -wxClassInfo *wxClassInfo::first = (wxClassInfo *) NULL; -wxHashTable wxClassInfo::classTable(wxKEY_STRING); -#endif + #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 // __WXDEBUG__ || wxUSE_DEBUG_CONTEXT -/* - * wxWindows root object. - */ -wxObject::wxObject(void) -{ - m_refData = (wxObjectRefData *) NULL; -#ifdef USE_STORABLE_CLASSES - m_serialObj = (wxObject_Serialize *)NULL; -#endif -} +wxClassInfo wxObject::sm_classwxObject( wxT("wxObject"), 0, 0, + (int) sizeof(wxObject), + (wxObjectConstructorFn) 0 ); -wxObject::~wxObject(void) -{ - UnRef(); -#ifdef USE_STORABLE_CLASSES - if (m_serialObj) - delete m_serialObj; -#endif -} +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. - */ - -bool wxObject::IsKindOf(wxClassInfo *info) +// These are here so we can avoid 'always true/false' warnings +// by referring to these instead of TRUE/FALSE +const bool wxTrue = TRUE; +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(wxClassInfo *info) const { - wxClassInfo *thisInfo = GetClassInfo(); - if (thisInfo) - return thisInfo->IsKindOf(info); - else - return FALSE; + wxClassInfo *thisInfo = GetClassInfo(); + return (thisInfo) ? thisInfo->IsKindOf(info) : FALSE ; } -#if WXDEBUG || USE_DEBUG_CONTEXT -void wxObject::Dump(ostream& str) +#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT) +void wxObject::Dump(wxSTD ostream& str) { - if (GetClassInfo() && GetClassInfo()->GetClassName()) - str << GetClassInfo()->GetClassName(); - else - str << "unknown object class"; + if (GetClassInfo() && GetClassInfo()->GetClassName()) + str << GetClassInfo()->GetClassName(); + else + str << _T("unknown object class"); } #endif -#if WXDEBUG && USE_MEMORY_TRACING -#ifdef new -#undef new +#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING && defined( new ) + #undef new #endif -void * wxObject::operator new (size_t size, char * fileName, int lineNum) -{ - return wxDebugAlloc(size, fileName, lineNum, TRUE); -} -void wxObject::operator delete (void * buf) +#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT +void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum ) { - wxDebugFree(buf); + return wxDebugAlloc(size, (wxChar*) fileName, lineNum, TRUE); } +#endif -// Cause problems for VC++ - crashes -#ifndef _MSC_VER -void * wxObject::operator new[] (size_t size, char * fileName, int lineNum) +#ifdef _WX_WANT_DELETE_VOID +void wxObject::operator delete ( void *buf ) { - return wxDebugAlloc(size, fileName, lineNum, TRUE, TRUE); + wxDebugFree(buf); } +#endif -void wxObject::operator delete[] (void * buf) +#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET +void wxObject::operator delete ( void *buf, const char *_fname, size_t _line ) { - wxDebugFree(buf, TRUE); + wxDebugFree(buf); } #endif -#endif - -/* - * Class info: provides run-time class type information. - */ - -wxClassInfo::wxClassInfo(char *cName, char *baseName1, char *baseName2, int sz, wxObjectConstructorFn constr) +#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT +void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum) ) { - className = cName; - baseClassName1 = baseName1; - baseClassName2 = baseName2; - - objectSize = sz; - objectConstructor = constr; - - next = first; - first = this; - - baseInfo1 = (wxClassInfo *) NULL; - baseInfo2 = (wxClassInfo *) NULL; + wxDebugFree(buf); } +#endif -wxObject *wxClassInfo::CreateObject(void) +#ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT +void *wxObject::operator new[] ( size_t size, const wxChar* fileName, int lineNum ) { - if (objectConstructor) - return (wxObject *)(*objectConstructor)(); - else - return (wxObject *) NULL; + return wxDebugAlloc(size, (wxChar*) fileName, lineNum, TRUE, TRUE); } +#endif -wxClassInfo *wxClassInfo::FindClass(char *c) +#ifdef _WX_WANT_ARRAY_DELETE_VOID +void wxObject::operator delete[] ( void *buf ) { - wxClassInfo *p = first; - while (p) - { - if (p && p->GetClassName() && strcmp(p->GetClassName(), c) == 0) - return p; - p = p->next; - } - return (wxClassInfo *) NULL; + wxDebugFree(buf, TRUE); } +#endif -// Climb upwards through inheritance hierarchy. -// Dual inheritance is catered for. -bool wxClassInfo::IsKindOf(wxClassInfo *info) +#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT +void wxObject::operator delete[] (void * buf, const wxChar* WXUNUSED(fileName), int WXUNUSED(lineNum) ) { - 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; + wxDebugFree(buf, TRUE); +} #endif - if (baseInfo1) - if (baseInfo1->IsKindOf(info)) - return TRUE; - if (baseInfo2) - return baseInfo2->IsKindOf(info); +// ---------------------------------------------------------------------------- +// wxClassInfo +// ---------------------------------------------------------------------------- - return FALSE; +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; + } + } } -// Set pointers to base class(es) to speed up IsKindOf -void wxClassInfo::InitializeClasses(void) +wxClassInfo *wxClassInfo::FindClass(const wxChar *className) { - // Index all class infos by their class name - wxClassInfo *info = first; - while (info) - { - if (info->className) - classTable.Put(info->className, (wxObject *)info); - info = info->next; - } - - // Set base pointers for each wxClassInfo - info = first; - while (info) - { - if (info->GetBaseClassName1()) - info->baseInfo1 = (wxClassInfo *)classTable.Get(info->GetBaseClassName1()); - if (info->GetBaseClassName2()) - info->baseInfo2 = (wxClassInfo *)classTable.Get(info->GetBaseClassName2()); - info = info->next; - } - first = NULL; + if ( sm_classTable ) + { + return (wxClassInfo *)wxClassInfo::sm_classTable->Get(className); + } + else + { + for ( wxClassInfo *info = sm_first; info ; info = info->m_next ) + { + if ( wxStrcmp(info->GetClassName(), className) == 0 ) + return info; + } + + return NULL; + } } -wxObject *wxCreateDynamicObject(char *name) +// a tiny InitializeClasses() helper +/* static */ +inline wxClassInfo *wxClassInfo::GetBaseByName(const wxChar *name) { - wxClassInfo *info; + if ( !name ) + return NULL; + + wxClassInfo *classInfo = (wxClassInfo *)sm_classTable->Get(name); - info = (wxClassInfo *)wxClassInfo::classTable.Get(name); - if (!info) - return (wxObject *)NULL; + // this must be fixed, other things risk work wrongly later if you get this + wxASSERT_MSG( classInfo, + wxString::Format + ( + _T("base class '%s' is unknown to wxWindows RTTI"), + name + ) ); - return info->CreateObject(); + return classInfo; } -#ifdef USE_SERIAL +// Set pointers to base class(es) to speed up IsKindOf +void wxClassInfo::InitializeClasses() +{ + // 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 -#include "wx/serbase.h" -#include "wx/dynlib.h" -#include "wx/msgdlg.h" + sm_classTable = new wxHashTable(wxKEY_STRING); -wxObject* wxCreateStoredObject( wxInputStream &stream ) -{ - wxObjectInputStream obj_s(stream); - return obj_s.LoadObject(); -}; + // Index all class infos by their class name -void wxObject::StoreObject( wxObjectOutputStream& stream ) -{ - wxString obj_name = wxString(GetClassInfo()->GetClassName()) + "_Serialize"; - wxLibrary *lib = wxTheLibraries.LoadLibrary("wxserial"); - - if (!lib) { - wxMessageBox("Can't load wxSerial dynamic library.", "Alert !"); - return; - } - if (!m_serialObj) { - m_serialObj = (WXSERIAL(wxObject) *)lib->CreateObject( obj_name ); - - if (!m_serialObj) { - wxString message; - - message.Printf("Can't find the serialization object (%s) for the object %s", - WXSTRINGCAST obj_name, - WXSTRINGCAST GetClassInfo()->GetClassName()); - wxMessageBox(message, "Alert !"); - return; + wxClassInfo *info; + for(info = sm_first; info; info = info->m_next) + { + if (info->m_className) + { + 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); + } } - m_serialObj->SetObject(this); - } - m_serialObj->StoreObject(stream); + // Set base pointers for each wxClassInfo + + for(info = sm_first; info; info = info->m_next) + { + info->m_baseInfo1 = GetBaseByName(info->GetBaseClassName1()); + info->m_baseInfo2 = GetBaseByName(info->GetBaseClassName2()); + } } -void wxObject::LoadObject( wxObjectInputStream& stream ) +void wxClassInfo::CleanUpClasses() { - wxString obj_name = wxString(GetClassInfo()->GetClassName()) + "_Serialize"; - wxLibrary *lib = wxTheLibraries.LoadLibrary("wxserial"); + delete wxClassInfo::sm_classTable; + wxClassInfo::sm_classTable = NULL; +} - if (!m_serialObj) { - m_serialObj = (WXSERIAL(wxObject) *)lib->CreateObject( obj_name ); - if (!m_serialObj) { - wxString message; +wxObject *wxCreateDynamicObject(const wxChar *name) +{ +#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT + DEBUG_PRINTF(wxObject *wxCreateDynamicObject) +#endif - message.Printf("Can't find the serialization object (%s) for the object %s", - WXSTRINGCAST obj_name, - WXSTRINGCAST GetClassInfo()->GetClassName()); - wxMessageBox(message, "Alert !"); - return; + 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; } - m_serialObj->SetObject(this); - } - - m_serialObj->LoadObject(stream); } -#endif -/* - * wxObject: cloning of objects - */ +// ---------------------------------------------------------------------------- +// wxObject +// ---------------------------------------------------------------------------- + +// Initialize ref data from another object (needed for copy constructor and +// assignment operator) +void wxObject::InitFrom(const wxObject& other) +{ + m_refData = other.m_refData; + if ( m_refData ) + m_refData->m_count++; +} void wxObject::Ref(const wxObject& clone) { +#if defined(__WXDEBUG__) || 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); } } -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) + 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 = NULL; + } +} + +void wxObject::AllocExclusive() +{ + if ( !m_refData ) + { + m_refData = CreateRefData(); } - m_refData = (wxObjectRefData *) NULL; + 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, + _T("wxObject::AllocExclusive() failed.") ); } -/* - * wxObjectData - */ +wxObjectRefData *wxObject::CreateRefData() const +{ + // if you use AllocExclusive() you must override this method + wxFAIL_MSG( _T("CreateRefData() must be overridden if called!") ); + + return NULL; +} -wxObjectRefData::wxObjectRefData(void) : m_count(1) +wxObjectRefData * +wxObject::CloneRefData(const wxObjectRefData * WXUNUSED(data)) const { + // if you use AllocExclusive() you must override this method + wxFAIL_MSG( _T("CloneRefData() must be overridden if called!") ); + + return NULL; } -wxObjectRefData::~wxObjectRefData(void) +// ---------------------------------------------------------------------------- +// misc +// ---------------------------------------------------------------------------- + +#if defined(__DARWIN__) && defined(WXMAKINGDLL) + +extern "C" { + void __initialize_Cplusplus(void); + void wxWindowsDylibInit(void); +}; + +// 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 + +void wxWindowsDylibInit() { + // 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). + + // This only seems to be necessary if the library initialization routine + // needs to use the static C++ objects + __initialize_Cplusplus(); } +#endif + +// vi:sts=4:sw=4:et