X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3f4a0c5be34be837210768501c13dbcff81e533c..15fa9a1f82dc8e17bc0dc0fc6d330f430650edfb:/src/common/object.cpp diff --git a/src/common/object.cpp b/src/common/object.cpp index acebb41729..1c74d57dbd 100644 --- a/src/common/object.cpp +++ b/src/common/object.cpp @@ -1,366 +1,343 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 #ifndef WX_PRECOMP + #include "wx/object.h" #include "wx/hash.h" - #if wxUSE_SERIAL - #include "wx/objstrm.h" - #include "wx/serbase.h" - - // for error messages - #include "wx/log.h" - #include "wx/intl.h" - #endif // wxUSE_SERIAL -#endif // WX_PRECOMP + #include "wx/memory.h" +#endif #include -#include - -#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT -#include "wx/memory.h" -#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++; } + #else + #define DEBUG_PRINTF(NAME) + #endif +#endif // __WXDEBUG__ || 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 !USE_SHARED_LIBRARY -wxClassInfo wxObject::sm_classwxObject((char *) "wxObject", (char *) NULL, (char *) NULL, (int ) sizeof(wxObject), (wxObjectConstructorFn) NULL); -wxClassInfo* wxClassInfo::sm_first = (wxClassInfo *) NULL; -wxHashTable* wxClassInfo::sm_classTable = (wxHashTable*) NULL; +#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 , + (wxPropertyInfo*) NULL,(wxHandlerInfo*) NULL,0 , 0 , + 0 , wxVariantOfPtrToObjectConverterwxObject , wxVariantToObjectConverterwxObject , wxObjectToVariantConverterwxObject); + template<> void wxStringReadValue(const wxString & , wxObject * & ){assert(0) ;} + template<> void wxStringWriteValue(wxString & , wxObject* const & ){assert(0) ;} + template<> void wxStringReadValue(const wxString & , wxObject & ){assert(0) ;} + template<> void wxStringWriteValue(wxString & , wxObject const & ){assert(0) ;} + 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 -/* - * wxWindows root object. - */ - -wxObject::wxObject(void) -{ - m_refData = (wxObjectRefData *) NULL; -#if wxUSE_SERIAL - m_serialObj = (wxObject_Serialize *)NULL; +// restore optimizations +#if defined __VISUALC__ && __VISUALC__ >= 1300 + #pragma optimize("", on) #endif -} -wxObject::~wxObject(void) -{ - UnRef(); -#if wxUSE_SERIAL - 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) const -{ - wxClassInfo *thisInfo = GetClassInfo(); - if (thisInfo) - return thisInfo->IsKindOf(info); - else - return FALSE; -} +// 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 -#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT -void wxObject::Dump(ostream& str) +wxClassInfo *wxObject::GetClassInfo() const { - if (GetClassInfo() && GetClassInfo()->GetClassName()) - str << GetClassInfo()->GetClassName(); - else - str << "unknown object class"; + return &wxObject::ms_classInfo; } -#endif -#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING +#endif // wxUSE_EXTENDED_RTTI -#ifdef new -#undef new -#endif +// this variable exists only so that we can avoid 'always true/false' warnings +const bool wxFalse = false; -void * wxObject::operator new (size_t size, char * fileName, int lineNum) +// 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 { - return wxDebugAlloc(size, fileName, lineNum, TRUE); + wxClassInfo *thisInfo = GetClassInfo(); + return (thisInfo) ? thisInfo->IsKindOf(info) : false ; } -void wxObject::operator delete (void * buf) -{ - wxDebugFree(buf); -} +#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING && defined( new ) + #undef new +#endif -// VC++ 6.0 -#if defined(__VISUALC__) && (__VISUALC__ >= 1200) -void wxObject::operator delete(void* pData, char* /* fileName */, int /* lineNum */) + +#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT +void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum ) { - ::operator delete(pData); + return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true); } #endif -// Cause problems for VC++ - crashes -#if !defined(__VISUALC__) && wxUSE_ARRAY_MEMORY_OPERATORS -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) ) { - m_className = cName; - m_baseClassName1 = baseName1; - m_baseClassName2 = baseName2; - - m_objectSize = sz; - m_objectConstructor = constr; - - m_next = sm_first; - sm_first = this; - - m_baseInfo1 = (wxClassInfo *) NULL; - m_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 (m_objectConstructor) - return (wxObject *)(*m_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 = sm_first; - while (p) - { - if (p && p->GetClassName() && strcmp(p->GetClassName(), c) == 0) - return p; - p = p->m_next; - } - return (wxClassInfo *) NULL; + wxDebugFree(buf, true); } +#endif -// Climb upwards through inheritance hierarchy. -// Dual inheritance is catered for. -bool wxClassInfo::IsKindOf(wxClassInfo *info) const +#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. - // PROBABLY NO LONGER TRUE now I've done DLL creation right. -/* -#if WXMAKINGDLL - if (GetClassName() && info->GetClassName() && (strcmp(GetClassName(), info->GetClassName()) == 0)) - return TRUE; -#else -*/ - if (this == info) - return TRUE; - - if (m_baseInfo1) - if (m_baseInfo1->IsKindOf(info)) - return TRUE; - - if (m_baseInfo2) - return m_baseInfo2->IsKindOf(info); - - return FALSE; + wxDebugFree(buf, true); } +#endif -// Set pointers to base class(es) to speed up IsKindOf -void wxClassInfo::InitializeClasses(void) -{ - wxClassInfo::sm_classTable = new wxHashTable(wxKEY_STRING); - - // Index all class infos by their class name - wxClassInfo *info = sm_first; - while (info) - { - if (info->m_className) - sm_classTable->Put(info->m_className, (wxObject *)info); - info = info->m_next; - } - - // Set base pointers for each wxClassInfo - info = sm_first; - while (info) - { - if (info->GetBaseClassName1()) - info->m_baseInfo1 = (wxClassInfo *)sm_classTable->Get(info->GetBaseClassName1()); - if (info->GetBaseClassName2()) - info->m_baseInfo2 = (wxClassInfo *)sm_classTable->Get(info->GetBaseClassName2()); - info = info->m_next; - } -} -void wxClassInfo::CleanUpClasses(void) -{ - delete wxClassInfo::sm_classTable; - wxClassInfo::sm_classTable = NULL; -} +// ---------------------------------------------------------------------------- +// wxClassInfo +// ---------------------------------------------------------------------------- -wxObject *wxCreateDynamicObject(const char *name) +wxClassInfo::~wxClassInfo() { - if (wxClassInfo::sm_classTable) + // 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 ) { - wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name); - if (!info) - return (wxObject *)NULL; - - return info->CreateObject(); + sm_first = m_next; } else { - wxClassInfo *info = wxClassInfo::sm_first; + wxClassInfo *info = sm_first; while (info) { - if (info->m_className && strcmp(info->m_className, name) == 0) - return info->CreateObject(); + if ( info->m_next == this ) + { + info->m_next = m_next; + break; + } + info = info->m_next; } - return (wxObject*) NULL; } - return (wxObject*) NULL; + Unregister(); } -#if wxUSE_SERIAL +wxClassInfo *wxClassInfo::FindClass(const wxChar *className) +{ + 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; + } -#include "wx/serbase.h" -#include "wx/dynlib.h" -#include "wx/msgdlg.h" + return NULL; + } +} -wxObject* wxCreateStoredObject( wxInputStream &stream ) +void wxClassInfo::Register() { - wxObjectInputStream obj_s(stream); - return obj_s.LoadObject(); -}; + if ( !sm_classTable ) + { + sm_classTable = new wxHashTable(wxKEY_STRING); + } -void wxObject::StoreObject( wxObjectOutputStream& stream ) + // 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( sm_classTable->Get(m_className) == NULL, + wxString::Format + ( + _T("Class \"%s\" already in RTTI table - have you used IMPLEMENT_DYNAMIC_CLASS() multiple times or linked some object file twice)?"), + m_className + ) + ); + + sm_classTable->Put(m_className, (wxObject *)this); +} + +void wxClassInfo::Unregister() { - wxString obj_name = wxString(GetClassInfo()->GetClassName()) + "_Serialize"; - wxLibrary *lib = wxTheLibraries.LoadLibrary("wxserial"); - - if (!lib) { - wxLogError(_("Can't load wxSerial dynamic library.")); - return; - } - if (!m_serialObj) { - m_serialObj = (WXSERIAL(wxObject) *)lib->CreateObject( obj_name ); - - if (!m_serialObj) { - wxLogError(_("Can't find the serialization object '%s' " - "for the object '%s'."), - obj_name.c_str(), - GetClassInfo()->GetClassName()); - return; + if ( sm_classTable ) + { + sm_classTable->Delete(m_className); + if ( sm_classTable->GetCount() == 0 ) + { + delete sm_classTable; + sm_classTable = NULL; + } } - m_serialObj->SetObject(this); - } - - m_serialObj->StoreObject(stream); } -void wxObject::LoadObject( wxObjectInputStream& stream ) +wxObject *wxCreateDynamicObject(const wxChar *name) { - wxString obj_name = wxString(GetClassInfo()->GetClassName()) + "_Serialize"; - wxLibrary *lib = wxTheLibraries.LoadLibrary("wxserial"); - - if (!m_serialObj) { - m_serialObj = (WXSERIAL(wxObject) *)lib->CreateObject( obj_name ); - - if (!m_serialObj) { - wxLogError(_("Can't find the serialization object '%s' " - "for the object '%s'."), - obj_name.c_str(), - GetClassInfo()->GetClassName()); - return; +#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT + DEBUG_PRINTF(wxObject *wxCreateDynamicObject) +#endif + + if ( wxClassInfo::sm_classTable ) + { + wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name); + return info ? info->CreateObject() : NULL; } - m_serialObj->SetObject(this); - } + 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(); + } - m_serialObj->LoadObject(stream); + return NULL; + } } -#endif -/* - * wxObject: cloning of objects - */ +// ---------------------------------------------------------------------------- +// wxObject +// ---------------------------------------------------------------------------- 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 == 0 ) delete m_refData; + m_refData = NULL; } - m_refData = (wxObjectRefData *) 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, + _T("wxObject::AllocExclusive() failed.") ); } -wxObjectRefData::~wxObjectRefData(void) +wxObjectRefData *wxObject::CreateRefData() const { + // if you use AllocExclusive() you must override this method + wxFAIL_MSG( _T("CreateRefData() must be overridden if called!") ); + + return NULL; } -// 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; +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; +}