]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/object.cpp
Added inline setters for wxTreeEvent so we don't need to add new
[wxWidgets.git] / src / common / object.cpp
index 86b84c8a4370cf79d26e2f740fc90192a834068a..cb965e7c45fcf009d4c1a550d9d8da570ccb27c9 100644 (file)
@@ -1,21 +1,20 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        object.cpp
+// Name:        src/common/object.cpp
 // Purpose:     wxObject implementation
 // Author:      Julian Smart
 // Modified by: Ron Lee
 // Created:     04/01/98
 // RCS-ID:      $Id$
-// Copyright:   (c) 1998 Julian Smart and Markus Holzem
+// Copyright:   (c) 1998 Julian Smart
 //              (c) 2001 Ron Lee <ron@debian.org>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
 #pragma implementation "object.h"
 #endif
 
-    // For compilers that support precompilation, includes "wx.h".
-
+// For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
@@ -27,7 +26,6 @@
 #endif
 
 #include <string.h>
-#include <assert.h>
 
 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 #include "wx/memory.h"
 
 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
     // for wxObject::Dump
-#include "wx/ioswrap.h"
+    #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
+    #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
 
 wxClassInfo wxObject::sm_classwxObject( wxT("wxObject"), 0, 0,
                                         (int) sizeof(wxObject),
                                         (wxObjectConstructorFn) 0 );
-wxClassInfo* wxClassInfo::sm_first = 0;
-wxHashTable* wxClassInfo::sm_classTable = 0;
 
-    // These are here so we can avoid 'always true/false' warnings
-    // by referring to these instead of TRUE/FALSE
+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;
 
-    // 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
 {
     wxClassInfo *thisInfo = GetClassInfo();
@@ -76,63 +72,95 @@ void wxObject::Dump(wxSTD ostream& str)
     if (GetClassInfo() && GetClassInfo()->GetClassName())
         str << GetClassInfo()->GetClassName();
     else
-        str << "unknown object class";
+        str << _T("unknown object class");
 }
 #endif
 
-#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
 
-#ifdef new
-#undef new
+#if defined(__WXDEBUG__) && 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
 
-#ifndef __VISAGECPP__
-void wxObject::operator delete (void *buf)
+#ifdef _WX_WANT_DELETE_VOID
+void wxObject::operator delete ( void *buf )
 {
     wxDebugFree(buf);
 }
-#elif __DEBUG_ALLOC__
-void wxObject::operator delete (void *buf, const char *_fname, size_t _line)
+#endif
+
+#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
+void wxObject::operator delete ( void *buf, const char *_fname, size_t _line )
 {
     wxDebugFree(buf);
 }
 #endif
 
-    // VC++ 6.0
-
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
-void wxObject::operator delete(void *pData, wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum))
+#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
+void wxObject::operator delete ( void *buf, const wxChar *WXUNUSED(fileName), int WXUNUSED(lineNum) )
 {
-    ::operator delete(pData);
+     wxDebugFree(buf);
 }
 #endif
 
-    // Cause problems for VC++ - crashes
-
-#if (!defined(__VISUALC__) && wxUSE_ARRAY_MEMORY_OPERATORS ) || defined(__MWERKS__)
-void *wxObject::operator new[] (size_t size, 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, fileName, lineNum, TRUE, TRUE);
+    return wxDebugAlloc(size, (wxChar*) fileName, lineNum, TRUE, TRUE);
 }
+#endif
 
-void wxObject::operator delete[] (void *buf)
+#ifdef _WX_WANT_ARRAY_DELETE_VOID
+void wxObject::operator delete[] ( void *buf )
 {
     wxDebugFree(buf, TRUE);
 }
 #endif
 
-#endif  // __WXDEBUG__  && wxUSE_MEMORY_TRACING
+#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
+void wxObject::operator delete[] (void * buf, const wxChar*  WXUNUSED(fileName), int WXUNUSED(lineNum) )
+{
+    wxDebugFree(buf, TRUE);
+}
+#endif
 
 
 // ----------------------------------------------------------------------------
 // wxClassInfo
 // ----------------------------------------------------------------------------
 
+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;
+        }
+    }
+}
+
 wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
 {
     if ( sm_classTable )
@@ -151,8 +179,27 @@ wxClassInfo *wxClassInfo::FindClass(const wxChar *className)
     }
 }
 
-    // Set pointers to base class(es) to speed up IsKindOf
+// a tiny InitializeClasses() helper
+/* static */
+inline wxClassInfo *wxClassInfo::GetBaseByName(const wxChar *name)
+{
+    if ( !name )
+        return NULL;
 
+    wxClassInfo *classInfo = (wxClassInfo *)sm_classTable->Get(name);
+
+    // 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 classInfo;
+}
+
+// Set pointers to base class(es) to speed up IsKindOf
 void wxClassInfo::InitializeClasses()
 {
     // using IMPLEMENT_DYNAMIC_CLASS() macro twice (which may happen if you
@@ -166,7 +213,7 @@ void wxClassInfo::InitializeClasses()
     size_t nClass = 0;
 #endif
 
-    wxClassInfo::sm_classTable = new wxHashTable(wxKEY_STRING);
+    sm_classTable = new wxHashTable(wxKEY_STRING);
 
         // Index all class infos by their class name
 
@@ -185,56 +232,72 @@ void wxClassInfo::InitializeClasses()
 
     for(info = sm_first; info; info = info->m_next)
     {
-        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->m_baseInfo1 = GetBaseByName(info->GetBaseClassName1());
+        info->m_baseInfo2 = GetBaseByName(info->GetBaseClassName2());
     }
 }
 
 void wxClassInfo::CleanUpClasses()
 {
     delete wxClassInfo::sm_classTable;
-    wxClassInfo::sm_classTable = 0;
+    wxClassInfo::sm_classTable = NULL;
 }
 
 
 wxObject *wxCreateDynamicObject(const wxChar *name)
 {
 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
- DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
   DEBUG_PRINTF(wxObject *wxCreateDynamicObject)
 #endif
 
-    if (wxClassInfo::sm_classTable)
+    if ( wxClassInfo::sm_classTable )
     {
         wxClassInfo *info = (wxClassInfo *)wxClassInfo::sm_classTable->Get(name);
-        return info != 0 ? info->CreateObject() : 0;
+        return info ? info->CreateObject() : NULL;
     }
-    else
+    else // no sm_classTable yet
     {
-        for(wxClassInfo *info = wxClassInfo::sm_first; info; info = info->m_next)
+        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 0;
+        }
+
+        return NULL;
     }
 }
 
 
 // ----------------------------------------------------------------------------
-// wxClassInfo
+// 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)
   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);
@@ -243,28 +306,69 @@ void wxObject::Ref(const wxObject& clone)
 
 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 = 0;
+        m_refData = NULL;
+    }
+}
+
+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 *wxObject::CreateRefData() const
+{
+    // if you use AllocExclusive() you must override this method
+    wxFAIL_MSG( _T("CreateRefData() must be overridden if called!") );
+
+    return NULL;
+}
+
+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;
+}
+
+// ----------------------------------------------------------------------------
+// misc
+// ----------------------------------------------------------------------------
 
-#if defined(__DARWIN__) && defined(DYLIB_INIT)
+#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
+// 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()
 {
@@ -272,6 +376,8 @@ void wxWindowsDylibInit()
     // 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();
 }