/////////////////////////////////////////////////////////////////////////////
-// 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 <ron@debian.org>
+// 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"
+ #include "wx/crt.h"
+#endif
#include <string.h>
-#include <assert.h>
-#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"
-#endif
+#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<wxObject*> (data) ) ; }
-#if !USE_SHARED_LIBRARY
-wxClassInfo wxObject::sm_classwxObject((wxChar *) _T("wxObject"), (wxChar *) NULL, (wxChar *) NULL, (int ) sizeof(wxObject), (wxObjectConstructorFn) NULL);
-wxClassInfo* wxClassInfo::sm_first = (wxClassInfo *) NULL;
-wxHashTable* wxClassInfo::sm_classTable = (wxHashTable*) NULL;
-#endif
+ wxClassInfo wxObject::ms_classInfo(ms_classParents , wxEmptyString , wxT("wxObject"),
+ (int) sizeof(wxObject), \
+ (wxObjectConstructorFn) 0 ,
+ NULL,NULL,0 , 0 ,
+ 0 , wxVariantOfPtrToObjectConverterwxObject , 0 , wxObjectToVariantConverterwxObject);
-/*
- * wxWindows root object.
- */
+ template<> void wxStringWriteValue(wxString & , wxObject* const & ){ wxFAIL_MSG("unreachable"); }
+ template<> void wxStringWriteValue(wxString & , wxObject const & ){ wxFAIL_MSG("unreachable"); }
-wxObject::wxObject()
-{
- m_refData = (wxObjectRefData *) NULL;
-#if wxUSE_SERIAL
- m_serialObj = (wxObject_Serialize *)NULL;
+ 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
-}
-wxObject::~wxObject()
-{
- UnRef();
-#if wxUSE_SERIAL
- if (m_serialObj)
- delete m_serialObj;
+// restore optimizations
+#if defined __VISUALC__ && __VISUALC__ >= 1300
+ #pragma optimize("", on)
#endif
-}
-/*
- * 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.
- */
+wxClassInfo* wxClassInfo::sm_first = NULL;
+wxHashTable* wxClassInfo::sm_classTable = 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
-bool wxObject::IsKindOf(wxClassInfo *info) const
+wxClassInfo *wxObject::GetClassInfo() const
{
- wxClassInfo *thisInfo = GetClassInfo();
- if (thisInfo)
- return thisInfo->IsKindOf(info);
- else
- return FALSE;
+ return &wxObject::ms_classInfo;
}
-#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
-void wxObject::Dump(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
-void wxObject::operator delete (void * buf)
+#ifdef _WX_WANT_DELETE_VOID
+void wxObject::operator delete ( void *buf )
{
wxDebugFree(buf);
}
+#endif
-// VC++ 6.0
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
-void wxObject::operator delete(void* pData, char* /* fileName */, int /* lineNum */)
+#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
+void wxObject::operator delete ( void *buf, const char *_fname, size_t _line )
{
- ::operator delete(pData);
+ wxDebugFree(buf);
}
#endif
-// Cause problems for VC++ - crashes
-#if !defined(__VISUALC__) && wxUSE_ARRAY_MEMORY_OPERATORS
-void * wxObject::operator new[] (size_t size, wxChar * fileName, int lineNum)
+#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
+void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum) )
{
- return wxDebugAlloc(size, fileName, lineNum, TRUE, TRUE);
+ wxDebugFree(buf);
}
+#endif
-void wxObject::operator delete[] (void * buf)
+#ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
+void *wxObject::operator new[] ( size_t size, const wxChar* fileName, int lineNum )
{
- wxDebugFree(buf, TRUE);
+ return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true, true);
}
#endif
+#ifdef _WX_WANT_ARRAY_DELETE_VOID
+void wxObject::operator delete[] ( void *buf )
+{
+ wxDebugFree(buf, true);
+}
#endif
-/*
- * Class info: provides run-time class type information.
- */
-
-wxClassInfo::wxClassInfo(wxChar *cName, wxChar *baseName1, wxChar *baseName2, int sz, wxObjectConstructorFn constr)
+#ifdef _WX_WANT_ARRAY_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;
+ wxDebugFree(buf, true);
+}
+#endif
- m_objectSize = sz;
- m_objectConstructor = constr;
- m_next = sm_first;
- sm_first = this;
+// ----------------------------------------------------------------------------
+// wxClassInfo
+// ----------------------------------------------------------------------------
- m_baseInfo1 = (wxClassInfo *) NULL;
- m_baseInfo2 = (wxClassInfo *) NULL;
-}
-
-wxObject *wxClassInfo::CreateObject()
+wxClassInfo::~wxClassInfo()
{
- if (m_objectConstructor)
- return (wxObject *)(*m_objectConstructor)();
+ // 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
- return (wxObject *) NULL;
-}
-
-wxClassInfo *wxClassInfo::FindClass(wxChar *c)
-{
- wxClassInfo *p = sm_first;
- while (p)
{
- if (p && p->GetClassName() && wxStrcmp(p->GetClassName(), c) == 0)
- return p;
- p = p->m_next;
+ wxClassInfo *info = sm_first;
+ while (info)
+ {
+ if ( info->m_next == this )
+ {
+ info->m_next = m_next;
+ break;
+ }
+
+ info = info->m_next;
+ }
}
- return (wxClassInfo *) NULL;
+ Unregister();
}
-// Climb upwards through inheritance hierarchy.
-// Dual inheritance is catered for.
-bool wxClassInfo::IsKindOf(wxClassInfo *info) const
+wxClassInfo *wxClassInfo::FindClass(const wxString& className)
{
- 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);
+ 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 FALSE;
+ return NULL;
+ }
}
-// 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()
{
- wxClassInfo::sm_classTable = new wxHashTable(wxKEY_STRING);
+#if wxDEBUG_LEVEL
+ // reentrance guard - see note above
+ static int entry = 0;
+#endif // wxDEBUG_LEVEL
+
+ wxHashTable *classTable;
- // Index all class infos by their class name
- wxClassInfo *info = sm_first;
- while (info)
+ if ( !sm_classTable )
{
- if (info->m_className)
- sm_classTable->Put(info->m_className, (wxObject *)info);
- info = info->m_next;
+ // 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;
}
- // Set base pointers for each wxClassInfo
- info = sm_first;
- while (info)
+ // 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->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;
+ 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
}
-void wxClassInfo::CleanUpClasses()
+void wxClassInfo::Unregister()
{
- delete wxClassInfo::sm_classTable;
- wxClassInfo::sm_classTable = NULL;
+ if ( sm_classTable )
+ {
+ sm_classTable->Delete(m_className);
+ if ( sm_classTable->GetCount() == 0 )
+ {
+ wxDELETE(sm_classTable);
+ }
+ }
}
-wxObject *wxCreateDynamicObject(const wxChar *name)
+wxObject *wxCreateDynamicObject(const wxString& name)
{
- if (wxClassInfo::sm_classTable)
+#if wxUSE_DEBUG_CONTEXT
+ DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
+#endif
+
+ if ( wxClassInfo::sm_classTable )
{
wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name);
- if (!info)
- return (wxObject *)NULL;
-
- return info->CreateObject();
+ return info ? info->CreateObject() : NULL;
}
- else
+ else // no sm_classTable yet
{
- wxClassInfo *info = wxClassInfo::sm_first;
- while (info)
+ for ( wxClassInfo *info = wxClassInfo::sm_first;
+ info;
+ info = info->m_next )
{
if (info->m_className && wxStrcmp(info->m_className, name) == 0)
return info->CreateObject();
- info = info->m_next;
}
- return (wxObject*) NULL;
+
+ return NULL;
}
- return (wxObject*) NULL;
}
-#if wxUSE_SERIAL
+// iterator interface
+wxClassInfo::const_iterator::value_type
+wxClassInfo::const_iterator::operator*() const
+{
+ return (wxClassInfo*)m_node->GetData();
+}
-#include "wx/serbase.h"
-#include "wx/dynlib.h"
-#include "wx/msgdlg.h"
+wxClassInfo::const_iterator& wxClassInfo::const_iterator::operator++()
+{
+ m_node = m_table->Next();
+ return *this;
+}
-wxObject* wxCreateStoredObject( wxInputStream &stream )
+const wxClassInfo::const_iterator wxClassInfo::const_iterator::operator++(int)
{
- wxObjectInputStream obj_s(stream);
- return obj_s.LoadObject();
-};
+ wxClassInfo::const_iterator tmp = *this;
+ m_node = m_table->Next();
+ return tmp;
+}
-void wxObject::StoreObject( wxObjectOutputStream& stream )
+wxClassInfo::const_iterator wxClassInfo::begin_classinfo()
{
- wxString obj_name = wxString(GetClassInfo()->GetClassName()) + "_Serialize";
- wxLibrary *lib = wxTheLibraries.LoadLibrary("wxserial");
+ sm_classTable->BeginFind();
- 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;
- }
- m_serialObj->SetObject(this);
- }
+ return const_iterator(sm_classTable->Next(), sm_classTable);
+}
- m_serialObj->StoreObject(stream);
+wxClassInfo::const_iterator wxClassInfo::end_classinfo()
+{
+ return const_iterator(NULL, NULL);
}
-void wxObject::LoadObject( wxObjectInputStream& stream )
+// ----------------------------------------------------------------------------
+// wxObjectRefData
+// ----------------------------------------------------------------------------
+
+void wxRefCounter::DecRef()
{
- 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;
- }
- m_serialObj->SetObject(this);
- }
+ wxASSERT_MSG( m_count > 0, "invalid ref data count" );
- m_serialObj->LoadObject(stream);
+ if ( --m_count == 0 )
+ delete this;
}
-#endif // wxUSE_SERIAL
-/*
- * 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()
{
- 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 = (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,
+ wxT("wxObject::AllocExclusive() failed.") );
}
-wxObjectRefData::~wxObjectRefData()
+wxObjectRefData *wxObject::CreateRefData() const
{
+ // if you use AllocExclusive() you must override this method
+ wxFAIL_MSG( wxT("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( wxT("CloneRefData() must be overridden if called!") );
+
+ return NULL;
+}
projects / wxWidgets.git / blobdiff