]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/memory.cpp
Warning fixes, source cleaning.
[wxWidgets.git] / src / common / memory.cpp
index bfd1e61d413bd772a022e6b4c05f5904c1a9e3e6..9e6c3beaed7b98fce4c235b808c75e9f1f0a2e64 100644 (file)
@@ -5,11 +5,11 @@
 // 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__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma implementation "memory.h"
 #endif
 
 
 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 // #pragma implementation
 #endif
 
 #ifndef WX_PRECOMP
 #include "wx/utils.h"
 #include "wx/app.h"
+#include "wx/hash.h"
 #endif
 
 #if wxUSE_THREADS
 
 #include "wx/ioswrap.h"
 
-// Obsolete
-#if 0
-#if wxUSE_IOSTREAMH
-    #include <fstream.h>
-#else
-    #include <fstream>
-#endif
-#endif
-
 #if !defined(__WATCOMC__) && !(defined(__VMS__) && ( __VMS_VER < 70000000 ) )\
      && !defined( __MWERKS__ ) && !defined(__SALFORDC__)
 #include <memory.h>
@@ -62,7 +54,7 @@
 #include <string.h>
 
 #ifdef __WXMSW__
-#include <windows.h>
+#include "wx/msw/wrapwin.h"
 
 #ifdef GetClassInfo
 #undef GetClassInfo
 
 #include "wx/memory.h"
 
+#if wxUSE_THREADS && defined(__WXDEBUG__)
+#define USE_THREADSAFE_MEMORY_ALLOCATION 1
+#else
+#define USE_THREADSAFE_MEMORY_ALLOCATION 0
+#endif
+
+
 #ifdef new
 #undef new
 #endif
 */
 void wxMemStruct::ErrorMsg (const char * mesg)
 {
-  wxLogMessage(wxT("wxWindows memory checking error: %s"), mesg);
+  wxLogMessage(wxT("wxWidgets memory checking error: %s"), mesg);
   PrintNode ();
 }
 
@@ -127,7 +126,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 ();
 }
 
@@ -333,7 +332,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);
@@ -344,20 +343,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);
@@ -372,7 +371,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);
 
@@ -389,22 +388,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);
   }
   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);
   }
 }
 
@@ -465,9 +464,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
@@ -598,9 +597,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
 }
 
@@ -609,27 +608,27 @@ bool wxDebugContext::Dump(void)
 #ifdef __WXDEBUG__
   {
     wxChar* appName = (wxChar*) wxT("application");
-    wxString appNameStr("");
+    wxString 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
     {
-      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
 }
 
@@ -665,21 +664,21 @@ bool wxDebugContext::PrintStatistics(bool detailed)
 #ifdef __WXDEBUG__
   {
     wxChar* appName = (wxChar*) wxT("application");
-    wxString appNameStr(wxT(""));
+    wxString 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
     {
-      wxLogMessage( wxT("----- Memory statistics -----") );
+      OutputDumpLine( wxT("----- Memory statistics -----") );
     }
   }
 
   bool currentMode = GetDebugMode();
-  SetDebugMode(FALSE);
+  SetDebugMode(false);
 
   long noNonObjectNodes = 0;
   long noObjectNodes = 0;
@@ -731,27 +730,27 @@ 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
 }
 
@@ -759,7 +758,7 @@ bool wxDebugContext::PrintClasses(void)
 {
   {
     wxChar* appName = (wxChar*) wxT("application");
-    wxString appNameStr(wxT(""));
+    wxString appNameStr;
     if (wxTheApp)
     {
         appNameStr = wxTheApp->GetAppName();
@@ -769,14 +768,14 @@ bool wxDebugContext::PrintClasses(void)
   }
 
   int n = 0;
-  wxNode *node;
+  wxHashTable::compatibility_iterator node;
   wxClassInfo *info;
 
   wxClassInfo::sm_classTable->BeginFind();
   node = wxClassInfo::sm_classTable->Next();
   while (node)
   {
-    info = (wxClassInfo *)node->Data();
+    info = (wxClassInfo *)node->GetData();
     if (info->GetClassName())
     {
         wxString msg(info->GetClassName());
@@ -802,11 +801,11 @@ bool wxDebugContext::PrintClasses(void)
     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)
@@ -859,43 +858,104 @@ int wxDebugContext::CountObjectsLeft(bool sinceCheckpoint)
   return n ;
 }
 
-#if wxUSE_THREADS
+// 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
 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:
     // no assignment operator nor copy ctor
     MemoryCriticalSectionLocker(const MemoryCriticalSectionLocker&);
     MemoryCriticalSectionLocker& operator=(const MemoryCriticalSectionLocker&);
-       
+
     wxCriticalSection& m_critsect;
-       bool    m_locked;
+    bool m_locked;
 };
 
 static MemoryCriticalSection memLocker;
+
+#endif
+
+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
 
 // TODO: store whether this is a vector or not.
 void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, bool WXUNUSED(isVect) )
 {
-#if wxUSE_THREADS
+#if USE_THREADSAFE_MEMORY_ALLOCATION
   MemoryCriticalSectionLocker lock(memLocker);
 #endif
-    
+
   // If not in debugging allocation mode, do the normal thing
   // so we don't leave any trace of ourselves in the node list.
 
@@ -952,10 +1012,10 @@ void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject,
 // TODO: check whether was allocated as a vector
 void wxDebugFree(void * buf, bool WXUNUSED(isVect) )
 {
-#if wxUSE_THREADS
+#if USE_THREADSAFE_MEMORY_ALLOCATION
   MemoryCriticalSectionLocker lock(memLocker);
 #endif
-  
+
   if (!buf)
     return;
 
@@ -1076,13 +1136,28 @@ 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
+//----------------------------------------------------------------------------
 
-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