Add information about the log message generation location to wxLog.

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

diff --git a/src/common/object.cpp b/src/common/object.cpp
index 8f49548b59af370888257885456abf40e3464360..622aa2f2eb3d810612e3e66d5af408909186dab3 100644 (file)
--- a/src/common/object.cpp
+++ b/src/common/object.cpp
@@ -10,36 +10,30 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#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 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
     #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
+#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,
 
 // we must disable optimizations for VC.NET because otherwise its too eager
 // linker discards wxClassInfo objects in release build thus breaking many,


@@ -49,26 +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);
+            NULL,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) ;}

- wxClassTypeInfo s_typeInfo(wxT_OBJECT_PTR , &wxObject::sm_classwxObject , NULL , NULL , typeid(wxObject*).name() ) ; 
- wxClassTypeInfo s_typeInfowxObject(wxT_OBJECT , &wxObject::sm_classwxObject , NULL , NULL , typeid(wxObject).name() ) ; 
+ 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


@@ -81,30 +75,43 @@ 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?
 // Go from this class to superclass, taking into account
 // two possible base classes.
 
 // 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
+bool wxObject::IsKindOf(const wxClassInfo *info) const

 {
 {

-    wxClassInfo *thisInfo = GetClassInfo();
-    return (thisInfo) ? thisInfo->IsKindOf(info) : FALSE ;
+    const wxClassInfo *thisInfo = GetClassInfo();
+    return (thisInfo) ? thisInfo->IsKindOf(info) : false ;

 }
 
 }
 

-#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING && defined( new )
-       #undef new
+#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 )
 {
 #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
 


@@ -132,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
 


@@ -178,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 )
     {


@@ -191,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;
         }
 


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

-void wxClassInfo::CleanUp()
-{
-    if ( sm_classTable )
-    {
-        delete sm_classTable;
-        sm_classTable = NULL;
-    }
-}
+// 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()
 {
 
 void wxClassInfo::Register()
 {

+#if wxDEBUG_LEVEL
+    // reentrance guard - see note above
+    static int entry = 0;
+#endif // wxDEBUG_LEVEL
+
+    wxHashTable *classTable;
+

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

-        sm_classTable = new wxHashTable(wxKEY_STRING);
+        // 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, _T("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
+        (
+            _T("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();
+        }

     }
 
     }
 

-    // 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
-    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)?") );
-    
-    sm_classTable->Put(m_className, (wxObject *)this);
+#if wxDEBUG_LEVEL
+    entry = 0;
+#endif // wxDEBUG_LEVEL

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


@@ -239,9 +289,9 @@ void wxClassInfo::Unregister()
     }
 }
 
     }
 }
 

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

 {
 {

-#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
+#if wxUSE_DEBUG_CONTEXT

     DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
 #endif
 
     DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
 #endif
 


@@ -264,23 +314,58 @@ 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 wxRefCounter::DecRef()

 {
 {

-    m_refData = other.m_refData;
-    if ( m_refData )
-        m_refData->m_count++;
+    wxASSERT_MSG( m_count > 0, "invalid ref data count" );
+
+    if ( --m_count == 0 )
+        delete this;

 }
 
 }
 

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

 void wxObject::Ref(const wxObject& clone)
 {
 void wxObject::Ref(const wxObject& clone)
 {

-#if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
+#if wxUSE_DEBUG_CONTEXT

     DEBUG_PRINTF(wxObject::Ref)
 #endif
 
     DEBUG_PRINTF(wxObject::Ref)
 #endif
 


@@ -295,7 +380,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();

     }
 }
 
     }
 }
 


@@ -303,10 +388,7 @@ void wxObject::UnRef()
 {
     if ( m_refData )
     {
 {
     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->DecRef();

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