Correct weak ref usage which triggered an assert

[wxWidgets.git] / src / common / object.cpp

diff --git a/src/common/object.cpp b/src/common/object.cpp
index 44e8d36ef3511a3e4850fe10fea6ef036cc7c37a..247c365f661f2009f3fabf33618bac61831c2601 100644 (file)
--- a/src/common/object.cpp
+++ b/src/common/object.cpp
@@ -10,32 +10,23 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "object.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

-    #include "wx/hash.h"

     #include "wx/object.h"
     #include "wx/object.h"

+    #include "wx/hash.h"
+    #include "wx/memory.h"
+    #include "wx/crt.h"

 #endif
 
 #include <string.h>
 
 #endif
 
 #include <string.h>
 

-#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
-#include "wx/memory.h"
-#endif
-

 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 #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 defined(__VISAGECPP__)
         #define DEBUG_PRINTF(NAME) { static int raz=0; \
             printf( #NAME " %i\n",raz); fflush(stdout); raz++; }


@@ -52,28 +43,26 @@
 #endif
 
 #if wxUSE_EXTENDED_RTTI
 #endif
 
 #if wxUSE_EXTENDED_RTTI

-const wxClassInfo* wxObject::sm_classParentswxObject[] = { NULL } ;
+const wxClassInfo* wxObject::ms_classParents[] = { NULL } ;

  wxObject* wxVariantToObjectConverterwxObject ( wxxVariant &data )
  wxObject* wxVariantToObjectConverterwxObject ( wxxVariant &data )

-{ return data.Get<wxObject*>() ; }
+{ return data.wxTEMPLATED_MEMBER_CALL(Get , wxObject*) ; }

  wxObject* wxVariantOfPtrToObjectConverterwxObject ( wxxVariant &data )
  wxObject* wxVariantOfPtrToObjectConverterwxObject ( wxxVariant &data )

-{ return &data.Get<wxObject>() ; }
+{ return &data.wxTEMPLATED_MEMBER_CALL(Get , wxObject) ; }

  wxxVariant wxObjectToVariantConverterwxObject ( wxObject *data )
  { return wxxVariant( dynamic_cast<wxObject*> (data)  ) ; }
  wxxVariant wxObjectToVariantConverterwxObject ( wxObject *data )
  { return wxxVariant( dynamic_cast<wxObject*> (data)  ) ; }

- wxClassInfo wxObject::sm_classwxObject(sm_classParentswxObject , wxT("") , wxT("wxObject"),
+ wxClassInfo wxObject::ms_classInfo(ms_classParents , wxEmptyString , wxT("wxObject"),

             (int) sizeof(wxObject),                              \
             (wxObjectConstructorFn) 0   ,
             (int) sizeof(wxObject),                              \
             (wxObjectConstructorFn) 0   ,

-                       (wxPropertyInfo*) NULL,(wxHandlerInfo*) NULL,0 , 0 ,
-                       0 , wxVariantOfPtrToObjectConverterwxObject , wxVariantToObjectConverterwxObject , wxObjectToVariantConverterwxObject);
+            (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) ;}
  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) ;}

- template<> const wxTypeInfo* wxGetTypeInfo( wxObject ** )
- { static wxClassTypeInfo s_typeInfo(wxT_OBJECT_PTR , &wxObject::sm_classwxObject) ; return &s_typeInfo ; }
- template<> const wxTypeInfo* wxGetTypeInfo( wxObject * )
- { static wxClassTypeInfo s_typeInfo(wxT_OBJECT , &wxObject::sm_classwxObject) ; return &s_typeInfo ; }
+ 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
 #else

-wxClassInfo wxObject::sm_classwxObject( wxT("wxObject"), 0, 0,
+wxClassInfo wxObject::ms_classInfo( wxT("wxObject"), 0, 0,

                                         (int) sizeof(wxObject),
                                         (wxObjectConstructorFn) 0 );
 #endif
                                         (int) sizeof(wxObject),
                                         (wxObjectConstructorFn) 0 );
 #endif


@@ -86,10 +75,23 @@ wxClassInfo wxObject::sm_classwxObject( wxT("wxObject"), 0, 0,
 wxClassInfo* wxClassInfo::sm_first = NULL;
 wxHashTable* wxClassInfo::sm_classTable = NULL;
 
 wxClassInfo* wxClassInfo::sm_first = NULL;
 wxHashTable* wxClassInfo::sm_classTable = 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;
+// 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
+
+wxClassInfo *wxObject::GetClassInfo() const
+{
+    return &wxObject::ms_classInfo;
+}
+
+#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?
 
 // Is this object a kind of (a subclass of) 'info'?
 // E.g. is wxWindow a kind of wxObject?


@@ -98,29 +100,18 @@ const bool wxFalse = FALSE;
 bool wxObject::IsKindOf(wxClassInfo *info) const
 {
     wxClassInfo *thisInfo = GetClassInfo();
 bool wxObject::IsKindOf(wxClassInfo *info) const
 {
     wxClassInfo *thisInfo = GetClassInfo();

-    return (thisInfo) ? thisInfo->IsKindOf(info) : FALSE ;
-}
-
-#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
-void wxObject::Dump(wxSTD ostream& str)
-{
-    if (GetClassInfo() && GetClassInfo()->GetClassName())
-        str << GetClassInfo()->GetClassName();
-    else
-        str << _T("unknown object class");
+    return (thisInfo) ? thisInfo->IsKindOf(info) : false ;

 }
 }

-#endif
-

 
 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING && defined( new )
 
 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING && defined( new )

-       #undef new
+    #undef new

 #endif
 
 
 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
 void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum )
 {
 #endif
 
 
 #ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
 void *wxObject::operator new ( size_t size, const wxChar *fileName, int lineNum )
 {

-    return wxDebugAlloc(size, (wxChar*) fileName, lineNum, TRUE);
+    return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true);

 }
 #endif
 
 }
 #endif
 


@@ -148,21 +139,21 @@ void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), in
 #ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
 void *wxObject::operator new[] ( size_t size, const 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, (wxChar*) fileName, lineNum, TRUE, TRUE);
+    return wxDebugAlloc(size, (wxChar*) fileName, lineNum, true, true);

 }
 #endif
 
 #ifdef _WX_WANT_ARRAY_DELETE_VOID
 void wxObject::operator delete[] ( void *buf )
 {
 }
 #endif
 
 #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) )
 {
 }
 #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);
+    wxDebugFree(buf, true);

 }
 #endif
 
 }
 #endif
 


@@ -194,10 +185,10 @@ wxClassInfo::~wxClassInfo()
             info = info->m_next;
         }
     }
             info = info->m_next;
         }
     }

-       Unregister();
+    Unregister();

 }
 
 }
 

-wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
+wxClassInfo *wxClassInfo::FindClass(const wxString& className)

 {
     if ( sm_classTable )
     {
 {
     if ( sm_classTable )
     {


@@ -207,7 +198,7 @@ wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
     {
         for ( wxClassInfo *info = sm_first; info ; info = info->m_next )
         {
     {
         for ( wxClassInfo *info = sm_first; info ; info = info->m_next )
         {

-            if ( wxStrcmp(info->GetClassName(), className) == 0 )
+            if ( className == info->GetClassName() )

                 return info;
         }
 
                 return info;
         }
 


@@ -215,31 +206,49 @@ wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
     }
 }
 
     }
 }
 

-void wxClassInfo::CleanUp()
-{
-    if ( sm_classTable )
-    {
-        delete sm_classTable;
-        sm_classTable = NULL;
-    }
-}
+// This function wasn't written to be reentrant but there is a possiblity of
+// reentrance if something it does causes a shared lib to load and register
+// classes. On Solaris this happens when the wxHashTable is newed, so the first
+// part of the function has been modified to handle it, and a wxASSERT checks
+// against reentrance in the remainder of the function.

 
 void wxClassInfo::Register()
 {
     if ( !sm_classTable )
     {
 
 void wxClassInfo::Register()
 {
     if ( !sm_classTable )
     {

-        sm_classTable = new wxHashTable(wxKEY_STRING);
+        wxHashTable *classTable = new wxHashTable(wxKEY_STRING);
+
+        // check for reentrance
+        if ( sm_classTable )
+            delete classTable;
+        else
+            sm_classTable = classTable;

     }
 
     }
 

-    // 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__
+    // reentrance guard - see note above
+    static int entry = 0;
+    wxASSERT_MSG(++entry == 1, _T("wxClassInfo::Register() reentrance"));
+#endif
+
+    // 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,
     wxASSERT_MSG( sm_classTable->Get(m_className) == NULL,

-                  _T("class already in RTTI table - have you used IMPLEMENT_DYNAMIC_CLASS() twice (may be by linking some object module(s) twice)?") );
-    
+        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);
     sm_classTable->Put(m_className, (wxObject *)this);

+
+#ifdef __WXDEBUG__
+    --entry;
+#endif

 }
 
 void wxClassInfo::Unregister()
 }
 
 void wxClassInfo::Unregister()


@@ -255,7 +264,7 @@ void wxClassInfo::Unregister()
     }
 }
 
     }
 }
 

-wxObject *wxCreateDynamicObject(const wxChar *name)
+wxObject *wxCreateDynamicObject(const wxString& name)

 {
 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
     DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
 {
 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
     DEBUG_PRINTF(wxObject *wxCreateDynamicObject)


@@ -280,20 +289,53 @@ wxObject *wxCreateDynamicObject(const wxChar *name)
     }
 }
 
     }
 }
 

+// 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);
+}

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// wxObject
+// wxObjectRefData

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-// Initialize ref data from another object (needed for copy constructor and
-// assignment operator)
-void wxObject::InitFrom(const wxObject& other)
+void wxObjectRefData::DecRef()

 {
 {

-    m_refData = other.m_refData;
-    if ( m_refData )
-        m_refData->m_count++;
+    if ( --m_count == 0 )
+        delete this;

 }
 
 }
 

+
+// ----------------------------------------------------------------------------
+// wxObject
+// ----------------------------------------------------------------------------
+

 void wxObject::Ref(const wxObject& clone)
 {
 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 void wxObject::Ref(const wxObject& clone)
 {
 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT


@@ -311,7 +353,7 @@ void wxObject::Ref(const wxObject& clone)
     if ( clone.m_refData )
     {
         m_refData = clone.m_refData;
     if ( clone.m_refData )
     {
         m_refData = clone.m_refData;

-        ++(m_refData->m_count);
+        m_refData->IncRef();

     }
 }
 
     }
 }
 


@@ -321,8 +363,7 @@ void wxObject::UnRef()
     {
         wxASSERT_MSG( m_refData->m_count > 0, _T("invalid ref data count") );
 
     {
         wxASSERT_MSG( m_refData->m_count > 0, _T("invalid ref data count") );
 

-        if ( !--m_refData->m_count )
-            delete m_refData;
+        m_refData->DecRef();

         m_refData = NULL;
     }
 }
         m_refData = NULL;
     }
 }