Updated list of subprojects.

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

diff --git a/src/common/memory.cpp b/src/common/memory.cpp
index 7509750cd35a37c46c1b0638f500f60998307e88..72169f2735aa64c1ee31a06f431fc199a968d43e 100644 (file)
--- a/src/common/memory.cpp
+++ b/src/common/memory.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        memory.cpp
+// Name:        src/common/memory.cpp

 // Purpose:     Memory checking implementation
 // Author:      Arthur Seaton, Julian Smart
 // Modified by:
 // Purpose:     Memory checking implementation
 // Author:      Arthur Seaton, Julian Smart
 // Modified by:


@@ -9,38 +9,31 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "memory.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
-#endif
-
-#ifndef WX_PRECOMP
-#include "wx/defs.h"
+    #pragma hdrstop

 #endif
 
 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 
 #endif
 
 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 

-#ifdef __GNUG__
-// #pragma implementation
-#endif
+#include "wx/memory.h"

 
 #ifndef WX_PRECOMP
 
 #ifndef WX_PRECOMP

-#include "wx/utils.h"
-#include "wx/app.h"
-#include "wx/hash.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
 #endif
 
 #if wxUSE_THREADS

-#include "wx/thread.h"
+    #include "wx/thread.h"

 #endif
 
 #endif
 

-#include "wx/log.h"

 #include <stdlib.h>
 
 #include "wx/ioswrap.h"
 #include <stdlib.h>
 
 #include "wx/ioswrap.h"


@@ -53,22 +46,7 @@
 #include <stdarg.h>
 #include <string.h>
 
 #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
 #define USE_THREADSAFE_MEMORY_ALLOCATION 1
 #else
 #define USE_THREADSAFE_MEMORY_ALLOCATION 0


@@ -117,7 +95,7 @@
 */
 void wxMemStruct::ErrorMsg (const char * mesg)
 {
 */
 void wxMemStruct::ErrorMsg (const char * mesg)
 {

-  wxLogMessage(wxT("wxWindows memory checking error: %s"), mesg);
+  wxLogMessage(wxT("wxWidgets memory checking error: %s"), mesg);

   PrintNode ();
 }
 
   PrintNode ();
 }
 


@@ -126,7 +104,7 @@ void wxMemStruct::ErrorMsg (const char * mesg)
 */
 void wxMemStruct::ErrorMsg ()
 {
 */
 void wxMemStruct::ErrorMsg ()
 {

-  wxLogMessage(wxT("wxWindows over/underwrite memory error:"));
+  wxLogMessage(wxT("wxWidgets over/underwrite memory error:"));

   PrintNode ();
 }
 
   PrintNode ();
 }
 


@@ -332,7 +310,7 @@ void wxMemStruct::PrintNode ()
 
     // Let's put this in standard form so IDEs can load the file at the appropriate
     // line
 
     // 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);
 
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);


@@ -343,20 +321,20 @@ void wxMemStruct::PrintNode ()
       msg += wxT("object");
 
     wxString msg2;
       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
   {
     msg += msg2;
 
     wxLogMessage(msg);
   }
   else
   {

-    wxString msg(wxT(""));
+    wxString msg;

 
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
     msg += wxT("non-object data");
     wxString msg2;
 
     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);
     msg += msg2;
 
     wxLogMessage(msg);


@@ -371,7 +349,7 @@ void wxMemStruct::Dump ()
   {
     wxObject *obj = (wxObject *)m_actualData;
 
   {
     wxObject *obj = (wxObject *)m_actualData;
 

-    wxString msg(wxT(""));
+    wxString msg;

     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
 
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
 


@@ -388,22 +366,22 @@ void wxMemStruct::Dump ()
     else
       msg += wxT("unknown object class");
 
     else
       msg += wxT("unknown object class");
 

-    wxString msg2(wxT(""));
-    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;
 
     msg += msg2;
 

-    wxLogMessage(msg);
+    wxDebugContext::OutputDumpLine(msg);

   }
   else
   {
   }
   else
   {

-    wxString msg(wxT(""));
+    wxString msg;

     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
 
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
 

-    wxString msg2(wxT(""));
-    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;
     msg += msg2;

-    wxLogMessage(msg);
+    wxDebugContext::OutputDumpLine(msg);

   }
 }
 
   }
 }
 


@@ -464,9 +442,9 @@ int wxMemStruct::ValidateNode ()
 wxMemStruct *wxDebugContext::m_head = NULL;
 wxMemStruct *wxDebugContext::m_tail = NULL;
 
 wxMemStruct *wxDebugContext::m_head = NULL;
 wxMemStruct *wxDebugContext::m_tail = NULL;
 

-bool wxDebugContext::m_checkPrevious = FALSE;
+bool wxDebugContext::m_checkPrevious = false;

 int wxDebugContext::debugLevel = 1;
 int wxDebugContext::debugLevel = 1;

-bool wxDebugContext::debugOn = TRUE;
+bool wxDebugContext::debugOn = true;

 wxMemStruct *wxDebugContext::checkPoint = NULL;
 
 // For faster alignment calculation
 wxMemStruct *wxDebugContext::checkPoint = NULL;
 
 // For faster alignment calculation


@@ -597,9 +575,9 @@ bool wxDebugContext::PrintList (void)
 #ifdef __WXDEBUG__
   TraverseList ((PmSFV)&wxMemStruct::PrintNode, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 
 #ifdef __WXDEBUG__
   TraverseList ((PmSFV)&wxMemStruct::PrintNode, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 

-  return TRUE;
+  return true;

 #else
 #else

-  return FALSE;
+  return false;

 #endif
 }
 
 #endif
 }
 


@@ -608,27 +586,27 @@ bool wxDebugContext::Dump(void)
 #ifdef __WXDEBUG__
   {
     wxChar* appName = (wxChar*) wxT("application");
 #ifdef __WXDEBUG__
   {
     wxChar* appName = (wxChar*) wxT("application");

-    wxString appNameStr(wxT(""));
+    wxString appNameStr;

     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
         appName = WXSTRINGCAST appNameStr;
     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
         appName = WXSTRINGCAST appNameStr;

-        wxLogMessage(wxT("----- Memory dump of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
+        OutputDumpLine(wxT("----- Memory dump of %s at %s -----"), appName, WXSTRINGCAST wxNow() );

     }
     else
     {
     }
     else
     {

-      wxLogMessage( wxT("----- Memory dump -----") );
+      OutputDumpLine( wxT("----- Memory dump -----") );

     }
   }
 
   TraverseList ((PmSFV)&wxMemStruct::Dump, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 
     }
   }
 
   TraverseList ((PmSFV)&wxMemStruct::Dump, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 

-  wxLogMessage( wxT("") );
-  wxLogMessage( wxT("") );
+  OutputDumpLine(wxEmptyString);
+  OutputDumpLine(wxEmptyString);

 
 

-  return TRUE;
+  return true;

 #else
 #else

-  return FALSE;
+  return false;

 #endif
 }
 
 #endif
 }
 


@@ -664,21 +642,21 @@ bool wxDebugContext::PrintStatistics(bool detailed)
 #ifdef __WXDEBUG__
   {
     wxChar* appName = (wxChar*) wxT("application");
 #ifdef __WXDEBUG__
   {
     wxChar* appName = (wxChar*) wxT("application");

-    wxString appNameStr(wxT(""));
+    wxString appNameStr;

     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
         appName = WXSTRINGCAST appNameStr;
     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
         appName = WXSTRINGCAST appNameStr;

-        wxLogMessage(wxT("----- Memory statistics of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
+        OutputDumpLine(wxT("----- Memory statistics of %s at %s -----"), appName, WXSTRINGCAST wxNow() );

     }
     else
     {
     }
     else
     {

-      wxLogMessage( wxT("----- Memory statistics -----") );
+      OutputDumpLine( wxT("----- Memory statistics -----") );

     }
   }
 
   bool currentMode = GetDebugMode();
     }
   }
 
   bool currentMode = GetDebugMode();

-  SetDebugMode(FALSE);
+  SetDebugMode(false);

 
   long noNonObjectNodes = 0;
   long noObjectNodes = 0;
 
   long noNonObjectNodes = 0;
   long noObjectNodes = 0;


@@ -730,27 +708,27 @@ bool wxDebugContext::PrintStatistics(bool detailed)
   {
     while (list)
     {
   {
     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);
     }
           list->instanceCount, list->instanceClass, list->totalSize);
       wxDebugStatsStruct *old = list;
       list = old->next;
       free((char *)old);
     }

-    wxLogMessage(wxT(""));
+    OutputDumpLine(wxEmptyString);

   }
 
   SetDebugMode(currentMode);
 
   }
 
   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;
 #else
   (void)detailed;

-  return FALSE;
+  return false;

 #endif
 }
 
 #endif
 }
 


@@ -758,7 +736,7 @@ bool wxDebugContext::PrintClasses(void)
 {
   {
     wxChar* appName = (wxChar*) wxT("application");
 {
   {
     wxChar* appName = (wxChar*) wxT("application");

-    wxString appNameStr(wxT(""));
+    wxString appNameStr;

     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();


@@ -768,7 +746,7 @@ bool wxDebugContext::PrintClasses(void)
   }
 
   int n = 0;
   }
 
   int n = 0;

-  wxNode *node;
+  wxHashTable::compatibility_iterator node;

   wxClassInfo *info;
 
   wxClassInfo::sm_classTable->BeginFind();
   wxClassInfo *info;
 
   wxClassInfo::sm_classTable->BeginFind();


@@ -801,11 +779,11 @@ bool wxDebugContext::PrintClasses(void)
     node = wxClassInfo::sm_classTable->Next();
     n ++;
   }
     node = wxClassInfo::sm_classTable->Next();
     n ++;
   }

-  wxLogMessage(wxT(""));
+  wxLogMessage(wxEmptyString);

   wxLogMessage(wxT("There are %d classes derived from wxObject."), n);
   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)
 }
 
 void wxDebugContext::SetCheckpoint(bool all)


@@ -858,22 +836,50 @@ int wxDebugContext::CountObjectsLeft(bool sinceCheckpoint)
   return n ;
 }
 
   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);
+}
+
+

 #if USE_THREADSAFE_MEMORY_ALLOCATION
 #if USE_THREADSAFE_MEMORY_ALLOCATION

-static bool memSectionOk = FALSE;
+static bool memSectionOk = false;

 
 class MemoryCriticalSection : public wxCriticalSection
 {
 public:
 
 class MemoryCriticalSection : public wxCriticalSection
 {
 public:

-       MemoryCriticalSection() {
-               memSectionOk = TRUE;
-       }
+    MemoryCriticalSection() {
+        memSectionOk = true;
+    }
+    ~MemoryCriticalSection() {
+        memSectionOk = false;
+    }

 };
 
 class MemoryCriticalSectionLocker
 {
 public:
     inline MemoryCriticalSectionLocker(wxCriticalSection& critsect)
 };
 
 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:
     inline ~MemoryCriticalSectionLocker() { if(m_locked) m_critsect.Leave(); }
 
 private:


@@ -882,11 +888,50 @@ private:
     MemoryCriticalSectionLocker& operator=(const MemoryCriticalSectionLocker&);
 
     wxCriticalSection& m_critsect;
     MemoryCriticalSectionLocker& operator=(const MemoryCriticalSectionLocker&);
 
     wxCriticalSection& m_critsect;

-       bool    m_locked;
+    bool m_locked;

 };
 
 static MemoryCriticalSection memLocker;
 };
 
 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) )
 
 // TODO: store whether this is a vector or not.
 void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, bool WXUNUSED(isVect) )


@@ -998,6 +1043,8 @@ void wxDebugFree(void * buf, bool WXUNUSED(isVect) )
     free((char *)st);
 }
 
     free((char *)st);
 }
 

+#endif // __WXDEBUG__
+

 // Trace: send output to the current debugging stream
 void wxTrace(const wxChar * ...)
 {
 // Trace: send output to the current debugging stream
 void wxTrace(const wxChar * ...)
 {


@@ -1075,13 +1122,27 @@ void wxTraceLevel(int, const wxChar * ...)
 #endif
 }
 
 #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
+//----------------------------------------------------------------------------

 
 

-void wxTraceLevel(int WXUNUSED(level), const char *WXUNUSED(fmt) ...)
+// 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;
+
+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