X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0fd28ea3dffb30ab1631784775f84ef3825c849b..fa3d4aaf0fdffa51372d15f17862cb7081687107:/src/common/memory.cpp

diff --git a/src/common/memory.cpp b/src/common/memory.cpp
index a7439bacfd..a1728fca67 100644
--- a/src/common/memory.cpp
+++ b/src/common/memory.cpp
@@ -1,73 +1,52 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        memory.cpp
+// Name:        src/common/memory.cpp
 // Purpose:     Memory checking implementation
 // Author:      Arthur Seaton, Julian Smart
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "memory.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
-#endif
-
-#ifndef WX_PRECOMP
-#include "wx/defs.h"
+    #pragma hdrstop
 #endif
 
 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 
-#ifdef __GNUG__
-// #pragma implementation
-#endif
+#include "wx/memory.h"
 
 #ifndef WX_PRECOMP
-#include "wx/utils.h"
-#include "wx/app.h"
+    #ifdef __WXMSW__
+        #include "wx/msw/wrapwin.h"
+    #endif
+    #include "wx/utils.h"
+    #include "wx/app.h"
+    #include "wx/hash.h"
+    #include "wx/log.h"
 #endif
 
 #if wxUSE_THREADS
-#include "wx/thread.h"
+    #include "wx/thread.h"
 #endif
 
-#include "wx/log.h"
 #include <stdlib.h>
 
 #include "wx/ioswrap.h"
 
 #if !defined(__WATCOMC__) && !(defined(__VMS__) && ( __VMS_VER < 70000000 ) )\
-     && !defined( __MWERKS__ ) && !defined(__SALFORDC__)
+     && !defined( __MWERKS__ )
 #include <memory.h>
 #endif
 
 #include <stdarg.h>
 #include <string.h>
 
-#ifdef __WXMSW__
-#include <windows.h>
-
-#ifdef GetClassInfo
-#undef GetClassInfo
-#endif
-
-#ifdef GetClassName
-#undef GetClassName
-#endif
-
-#endif
-
-#include "wx/memory.h"
-
-#if wxUSE_THREADS && defined(__WXDEBUG__) && !defined(__WXMAC__)
+#if wxUSE_THREADS && defined(__WXDEBUG__)
 #define USE_THREADSAFE_MEMORY_ALLOCATION 1
 #else
 #define USE_THREADSAFE_MEMORY_ALLOCATION 0
@@ -116,7 +95,7 @@
 */
 void wxMemStruct::ErrorMsg (const char * mesg)
 {
-  wxLogMessage(wxT("wxWindows memory checking error: %s"), mesg);
+  wxLogMessage(wxT("wxWidgets memory checking error: %s"), mesg);
   PrintNode ();
 }
 
@@ -125,7 +104,7 @@ void wxMemStruct::ErrorMsg (const char * mesg)
 */
 void wxMemStruct::ErrorMsg ()
 {
-  wxLogMessage(wxT("wxWindows over/underwrite memory error:"));
+  wxLogMessage(wxT("wxWidgets over/underwrite memory error:"));
   PrintNode ();
 }
 
@@ -331,7 +310,7 @@ void wxMemStruct::PrintNode ()
 
     // Let's put this in standard form so IDEs can load the file at the appropriate
     // line
-    wxString msg(wxT(""));
+    wxString msg;
 
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
@@ -342,20 +321,20 @@ void wxMemStruct::PrintNode ()
       msg += wxT("object");
 
     wxString msg2;
-    msg2.Printf(wxT(" at $%lX, size %d"), (long)GetActualData(), (int)RequestSize());
+    msg2.Printf(wxT(" at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize());
     msg += msg2;
 
     wxLogMessage(msg);
   }
   else
   {
-    wxString msg("");
+    wxString msg;
 
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
     msg += wxT("non-object data");
     wxString msg2;
-    msg2.Printf(wxT(" at $%lX, size %d\n"), (long)GetActualData(), (int)RequestSize());
+    msg2.Printf(wxT(" at 0x%lX, size %d\n"), (long)GetActualData(), (int)RequestSize());
     msg += msg2;
 
     wxLogMessage(msg);
@@ -370,7 +349,7 @@ void wxMemStruct::Dump ()
   {
     wxObject *obj = (wxObject *)m_actualData;
 
-    wxString msg(wxT(""));
+    wxString msg;
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
 
@@ -387,22 +366,22 @@ void wxMemStruct::Dump ()
     else
       msg += wxT("unknown object class");
 
-    wxString msg2("");
-    msg2.Printf(wxT(" at $%lX, size %d"), (long)GetActualData(), (int)RequestSize());
+    wxString msg2;
+    msg2.Printf(wxT(" at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize());
     msg += msg2;
 
-    wxLogMessage(msg);
+    wxDebugContext::OutputDumpLine(msg.c_str());
   }
   else
   {
-    wxString msg(wxT(""));
+    wxString msg;
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
 
-    wxString msg2("");
-    msg2.Printf(wxT("non-object data at $%lX, size %d"), (long)GetActualData(), (int)RequestSize() );
+    wxString msg2;
+    msg2.Printf(wxT("non-object data at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize() );
     msg += msg2;
-    wxLogMessage(msg);
+    wxDebugContext::OutputDumpLine(msg.c_str());
   }
 }
 
@@ -463,9 +442,9 @@ int wxMemStruct::ValidateNode ()
 wxMemStruct *wxDebugContext::m_head = NULL;
 wxMemStruct *wxDebugContext::m_tail = NULL;
 
-bool wxDebugContext::m_checkPrevious = FALSE;
+bool wxDebugContext::m_checkPrevious = false;
 int wxDebugContext::debugLevel = 1;
-bool wxDebugContext::debugOn = TRUE;
+bool wxDebugContext::debugOn = true;
 wxMemStruct *wxDebugContext::checkPoint = NULL;
 
 // For faster alignment calculation
@@ -473,6 +452,9 @@ static wxMarkerType markerCalc[2];
 int wxDebugContext::m_balign = (int)((char *)&markerCalc[1] - (char*)&markerCalc[0]);
 int wxDebugContext::m_balignmask = (int)((char *)&markerCalc[1] - (char*)&markerCalc[0]) - 1;
 
+// Pointer to global function to call at shutdown
+wxShutdownNotifyFunction wxDebugContext::sm_shutdownFn;
+
 wxDebugContext::wxDebugContext(void)
 {
 }
@@ -596,9 +578,9 @@ bool wxDebugContext::PrintList (void)
 #ifdef __WXDEBUG__
   TraverseList ((PmSFV)&wxMemStruct::PrintNode, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 
-  return TRUE;
+  return true;
 #else
-  return FALSE;
+  return false;
 #endif
 }
 
@@ -606,28 +588,28 @@ bool wxDebugContext::Dump(void)
 {
 #ifdef __WXDEBUG__
   {
-    wxChar* appName = (wxChar*) wxT("application");
-    wxString appNameStr("");
+    const wxChar* appName = wxT("application");
+    wxString appNameStr;
     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
-        appName = WXSTRINGCAST appNameStr;
-        wxLogMessage(wxT("----- Memory dump of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
+        appName = appNameStr.c_str();
+        OutputDumpLine(wxT("----- Memory dump of %s at %s -----"), appName, static_cast<const wxChar *>(wxNow().c_str()));
     }
     else
     {
-      wxLogMessage( wxT("----- Memory dump -----") );
+      OutputDumpLine( wxT("----- Memory dump -----") );
     }
   }
 
   TraverseList ((PmSFV)&wxMemStruct::Dump, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 
-  wxLogMessage( wxT("") );
-  wxLogMessage( wxT("") );
+  OutputDumpLine(wxEmptyString);
+  OutputDumpLine(wxEmptyString);
 
-  return TRUE;
+  return true;
 #else
-  return FALSE;
+  return false;
 #endif
 }
 
@@ -662,22 +644,22 @@ bool wxDebugContext::PrintStatistics(bool detailed)
 {
 #ifdef __WXDEBUG__
   {
-    wxChar* appName = (wxChar*) wxT("application");
-    wxString appNameStr(wxT(""));
+    const wxChar* appName = wxT("application");
+    wxString appNameStr;
     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
-        appName = WXSTRINGCAST appNameStr;
-        wxLogMessage(wxT("----- Memory statistics of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
+        appName = appNameStr.c_str();
+        OutputDumpLine(wxT("----- Memory statistics of %s at %s -----"), appName, static_cast<const wxChar *>(wxNow().c_str()));
     }
     else
     {
-      wxLogMessage( wxT("----- Memory statistics -----") );
+      OutputDumpLine( wxT("----- Memory statistics -----") );
     }
   }
 
   bool currentMode = GetDebugMode();
-  SetDebugMode(FALSE);
+  SetDebugMode(false);
 
   long noNonObjectNodes = 0;
   long noObjectNodes = 0;
@@ -729,52 +711,51 @@ bool wxDebugContext::PrintStatistics(bool detailed)
   {
     while (list)
     {
-      wxLogMessage(wxT("%ld objects of class %s, total size %ld"),
+      OutputDumpLine(wxT("%ld objects of class %s, total size %ld"),
           list->instanceCount, list->instanceClass, list->totalSize);
       wxDebugStatsStruct *old = list;
       list = old->next;
       free((char *)old);
     }
-    wxLogMessage(wxT(""));
+    OutputDumpLine(wxEmptyString);
   }
 
   SetDebugMode(currentMode);
 
-  wxLogMessage(wxT("Number of object items: %ld"), noObjectNodes);
-  wxLogMessage(wxT("Number of non-object items: %ld"), noNonObjectNodes);
-  wxLogMessage(wxT("Total allocated size: %ld"), totalSize);
-  wxLogMessage(wxT(""));
-  wxLogMessage(wxT(""));
+  OutputDumpLine(wxT("Number of object items: %ld"), noObjectNodes);
+  OutputDumpLine(wxT("Number of non-object items: %ld"), noNonObjectNodes);
+  OutputDumpLine(wxT("Total allocated size: %ld"), totalSize);
+  OutputDumpLine(wxEmptyString);
+  OutputDumpLine(wxEmptyString);
 
-  return TRUE;
+  return true;
 #else
   (void)detailed;
-  return FALSE;
+  return false;
 #endif
 }
 
 bool wxDebugContext::PrintClasses(void)
 {
   {
-    wxChar* appName = (wxChar*) wxT("application");
-    wxString appNameStr(wxT(""));
+    const wxChar* appName = wxT("application");
+    wxString appNameStr;
     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
-        appName = WXSTRINGCAST appNameStr;
+        appName = appNameStr.c_str();
         wxLogMessage(wxT("----- Classes in %s -----"), appName);
     }
   }
 
   int n = 0;
-  wxNode *node;
-  wxClassInfo *info;
+  const wxClassInfo *info;
 
-  wxClassInfo::sm_classTable->BeginFind();
-  node = wxClassInfo::sm_classTable->Next();
-  while (node)
+  for (wxClassInfo::const_iterator node = wxClassInfo::begin_classinfo(),
+                                    end = wxClassInfo::end_classinfo();
+       node != end; ++node)
   {
-    info = (wxClassInfo *)node->Data();
+    info = *node;
     if (info->GetClassName())
     {
         wxString msg(info->GetClassName());
@@ -797,14 +778,13 @@ bool wxDebugContext::PrintClasses(void)
 
         wxLogMessage(msg);
     }
-    node = wxClassInfo::sm_classTable->Next();
     n ++;
   }
-  wxLogMessage(wxT(""));
+  wxLogMessage(wxEmptyString);
   wxLogMessage(wxT("There are %d classes derived from wxObject."), n);
-  wxLogMessage(wxT(""));
-  wxLogMessage(wxT(""));
-  return TRUE;
+  wxLogMessage(wxEmptyString);
+  wxLogMessage(wxEmptyString);
+  return true;
 }
 
 void wxDebugContext::SetCheckpoint(bool all)
@@ -857,22 +837,55 @@ int wxDebugContext::CountObjectsLeft(bool sinceCheckpoint)
   return n ;
 }
 
+// This function is used to output the dump
+void wxDebugContext::OutputDumpLine(const wxChar *szFormat, ...)
+{
+    // a buffer of 2048 bytes should be long enough for a file name
+    // and a class name
+    wxChar buf[2048];
+    int count;
+    va_list argptr;
+    va_start(argptr, szFormat);
+    buf[sizeof(buf)/sizeof(wxChar)-1] = _T('\0');
+
+    // keep 3 bytes for a \r\n\0
+    count = wxVsnprintf(buf, sizeof(buf)/sizeof(wxChar)-3, szFormat, argptr);
+
+    if ( count < 0 )
+        count = sizeof(buf)/sizeof(wxChar)-3;
+    buf[count]=_T('\r');
+    buf[count+1]=_T('\n');
+    buf[count+2]=_T('\0');
+
+    wxMessageOutputDebug dbgout;
+    dbgout.Printf(buf);
+}
+
+void wxDebugContext::SetShutdownNotifyFunction(wxShutdownNotifyFunction shutdownFn)
+{
+    sm_shutdownFn = shutdownFn;
+}
+
+
 #if USE_THREADSAFE_MEMORY_ALLOCATION
-static bool memSectionOk = FALSE;
+static bool memSectionOk = false;
 
 class MemoryCriticalSection : public wxCriticalSection
 {
 public:
-	MemoryCriticalSection() {
-		memSectionOk = TRUE;
-	}
+    MemoryCriticalSection() {
+        memSectionOk = true;
+    }
+    ~MemoryCriticalSection() {
+        memSectionOk = false;
+    }
 };
 
 class MemoryCriticalSectionLocker
 {
 public:
     inline MemoryCriticalSectionLocker(wxCriticalSection& critsect)
-	: m_critsect(critsect), m_locked(memSectionOk) { if(m_locked) m_critsect.Enter(); }
+    : m_critsect(critsect), m_locked(memSectionOk) { if(m_locked) m_critsect.Enter(); }
     inline ~MemoryCriticalSectionLocker() { if(m_locked) m_critsect.Leave(); }
 
 private:
@@ -881,11 +894,50 @@ private:
     MemoryCriticalSectionLocker& operator=(const MemoryCriticalSectionLocker&);
 
     wxCriticalSection& m_critsect;
-	bool	m_locked;
+    bool m_locked;
 };
 
 static MemoryCriticalSection memLocker;
-#endif
+
+#endif // USE_THREADSAFE_MEMORY_ALLOCATION
+
+
+#ifdef __WXDEBUG__
+#if !(defined(__WXMSW__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL_BASE)))
+#if wxUSE_GLOBAL_MEMORY_OPERATORS
+void * operator new (size_t size, wxChar * fileName, int lineNum)
+{
+    return wxDebugAlloc(size, fileName, lineNum, false, false);
+}
+
+void * operator new (size_t size)
+{
+    return wxDebugAlloc(size, NULL, 0, false);
+}
+
+void operator delete (void * buf)
+{
+    wxDebugFree(buf, false);
+}
+
+#if wxUSE_ARRAY_MEMORY_OPERATORS
+void * operator new[] (size_t size)
+{
+    return wxDebugAlloc(size, NULL, 0, false, true);
+}
+
+void * operator new[] (size_t size, wxChar * fileName, int lineNum)
+{
+    return wxDebugAlloc(size, fileName, lineNum, false, true);
+}
+
+void operator delete[] (void * buf)
+{
+  wxDebugFree(buf, true);
+}
+#endif // wxUSE_ARRAY_MEMORY_OPERATORS
+#endif // wxUSE_GLOBAL_MEMORY_OPERATORS
+#endif // !(defined(__WXMSW__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL_BASE)))
 
 // TODO: store whether this is a vector or not.
 void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, bool WXUNUSED(isVect) )
@@ -997,6 +1049,8 @@ void wxDebugFree(void * buf, bool WXUNUSED(isVect) )
     free((char *)st);
 }
 
+#endif // __WXDEBUG__
+
 // Trace: send output to the current debugging stream
 void wxTrace(const wxChar * ...)
 {
@@ -1074,13 +1128,43 @@ void wxTraceLevel(int, const wxChar * ...)
 #endif
 }
 
-#else // wxUSE_MEMORY_TRACING && defined(__WXDEBUG__)
-void wxTrace(const char *WXUNUSED(fmt) ...)
+//----------------------------------------------------------------------------
+// Final cleanup after all global objects in all files have been destroyed
+//----------------------------------------------------------------------------
+
+// Don't set it to 0 by dynamic initialization
+// Some compilers will really do the assignment later
+// All global variables are initialized to 0 at the very beginning, and this is just fine.
+int wxDebugContextDumpDelayCounter::sm_count;
+
+wxDebugContextDumpDelayCounter::wxDebugContextDumpDelayCounter()
+{
+    sm_count++;
+}
+
+wxDebugContextDumpDelayCounter::~wxDebugContextDumpDelayCounter()
 {
+    if ( !--sm_count )
+    {
+        // Notify app if we've been asked to do that
+        if( wxDebugContext::sm_shutdownFn )
+            wxDebugContext::sm_shutdownFn();
+        DoDump();
+    }
 }
 
-void wxTraceLevel(int WXUNUSED(level), const char *WXUNUSED(fmt) ...)
+void wxDebugContextDumpDelayCounter::DoDump()
 {
+    if (wxDebugContext::CountObjectsLeft(true) > 0)
+    {
+        wxDebugContext::OutputDumpLine(wxT("There were memory leaks.\n"));
+        wxDebugContext::Dump();
+        wxDebugContext::PrintStatistics();
+    }
 }
-#endif
 
+// Even if there is nothing else, make sure that there is at
+// least one cleanup counter object
+static wxDebugContextDumpDelayCounter wxDebugContextDumpDelayCounter_One;
+
+#endif // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT