]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/memory.cpp
safe destruction, even if redraws might be triggered
[wxWidgets.git] / src / common / memory.cpp
index a1659e5bd1b3c3e0e68c3bd06ece4c983cc769b9..c980106cbbaf6bfd47a129ea26b1808fcc7af6cf 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/thread.h"
 #endif
 
 #include "wx/log.h"
 
 #include "wx/ioswrap.h"
 
-#if wxUSE_IOSTREAMH
-    #include <fstream.h>
-#else
-    #include <fstream>
-#endif
-
 #if !defined(__WATCOMC__) && !(defined(__VMS__) && ( __VMS_VER < 70000000 ) )\
      && !defined( __MWERKS__ ) && !defined(__SALFORDC__)
 #include <memory.h>
@@ -55,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__) && !defined(__WXMAC__)
+#define USE_THREADSAFE_MEMORY_ALLOCATION 1
+#else
+#define USE_THREADSAFE_MEMORY_ALLOCATION 0
+#endif
+
+
 #ifdef new
 #undef new
 #endif
@@ -113,8 +119,6 @@ void wxMemStruct::ErrorMsg (const char * mesg)
 {
   wxLogMessage(wxT("wxWindows memory checking error: %s"), mesg);
   PrintNode ();
-
-//         << m_fileName << ' ' << m_lineNum << endl;
 }
 
 /*
@@ -124,8 +128,6 @@ void wxMemStruct::ErrorMsg ()
 {
   wxLogMessage(wxT("wxWindows over/underwrite memory error:"));
   PrintNode ();
-
-//    cerr << m_fileName << ' ' << m_lineNum << endl;
 }
 
 
@@ -341,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(wxT(""));
 
     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);
@@ -386,11 +388,11 @@ void wxMemStruct::Dump ()
     else
       msg += wxT("unknown object class");
 
-    wxString msg2("");
-    msg2.Printf(wxT(" at $%lX, size %d"), (long)GetActualData(), (int)RequestSize());
+    wxString msg2(wxT(""));
+    msg2.Printf(wxT(" at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize());
     msg += msg2;
 
-    wxLogMessage(msg);
+    wxDebugContext::OutputDumpLine(msg);
   }
   else
   {
@@ -398,10 +400,10 @@ void wxMemStruct::Dump ()
     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(wxT(""));
+    msg2.Printf(wxT("non-object data at 0x%lX, size %d"), (long)GetActualData(), (int)RequestSize() );
     msg += msg2;
-    wxLogMessage(msg);
+    wxDebugContext::OutputDumpLine(msg);
   }
 }
 
@@ -461,12 +463,6 @@ int wxMemStruct::ValidateNode ()
 
 wxMemStruct *wxDebugContext::m_head = NULL;
 wxMemStruct *wxDebugContext::m_tail = NULL;
-// ostream *wxDebugContext::m_debugStream = NULL;
-// streambuf *wxDebugContext::m_streamBuf = NULL;
-
-// Must initialise these in wxEntry, and then delete them just before wxEntry exits
-streambuf *wxDebugContext::m_streamBuf = NULL;
-ostream *wxDebugContext::m_debugStream = NULL;
 
 bool wxDebugContext::m_checkPrevious = FALSE;
 int wxDebugContext::debugLevel = 1;
@@ -480,76 +476,12 @@ int wxDebugContext::m_balignmask = (int)((char *)&markerCalc[1] - (char*)&marker
 
 wxDebugContext::wxDebugContext(void)
 {
-//  m_streamBuf = new wxDebugStreamBuf;
-//  m_debugStream = new ostream(m_streamBuf);
 }
 
 wxDebugContext::~wxDebugContext(void)
 {
-  SetStream(NULL, NULL);
-}
-
-/*
- * It's bizarre, but with BC++ 4.5, the value of str changes
- * between SetFile and SetStream.
- */
-
-void wxDebugContext::SetStream(ostream *str, streambuf *buf)
-{
-  if (m_debugStream)
-  {
-    m_debugStream->flush();
-    delete m_debugStream;
-  }
-  m_debugStream = NULL;
-
-  // Not allowed in Watcom (~streambuf is protected).
-  // Is this trying to say something significant to us??
-#ifndef __WATCOMC__
-  if (m_streamBuf)
-  {
-    streambuf* oldBuf = m_streamBuf;
-    m_streamBuf = NULL;
-    delete oldBuf;
-  }
-#endif
-  m_streamBuf = buf;
-  m_debugStream = str;
-}
-
-bool wxDebugContext::SetFile(const wxString& file)
-{
-  ofstream *str = new ofstream(file.mb_str());
-
-  if (str->bad())
-  {
-    delete str;
-    return FALSE;
-  }
-  else
-  {
-    SetStream(str);
-    return TRUE;
-  }
-}
-
-bool wxDebugContext::SetStandardError(void)
-{
-    // Obsolete
-#if 0
-#if !defined(_WINDLL)
-  wxDebugStreamBuf *buf = new wxDebugStreamBuf;
-  ostream *stream = new ostream(m_streamBuf);
-  SetStream(stream, buf);
-  return TRUE;
-#else
-  return FALSE;
-#endif
-#endif
-  return FALSE;
 }
 
-
 /*
   Work out the positions of the markers by creating an array of 2 markers
   and comparing the addresses of the 2 elements. Use this number as the
@@ -615,18 +547,13 @@ size_t wxDebugContext::PaddedSize (const size_t size)
 {
     // Added by Terry Farnham <TJRT@pacbell.net> to replace
     // slow GetPadding call.
-       int padb;
-
-       padb = size & m_balignmask;
-       if(padb)
-               return(size + m_balign - padb);
-       else
-               return(size);
+    int padb;
 
-// Old (slow) code
-#if 0
-    return size + GetPadding (size);
-#endif
+    padb = size & m_balignmask;
+    if(padb)
+        return(size + m_balign - padb);
+    else
+        return(size);
 }
 
 /*
@@ -668,9 +595,6 @@ void wxDebugContext::TraverseList (PmSFV func, wxMemStruct *from)
 bool wxDebugContext::PrintList (void)
 {
 #ifdef __WXDEBUG__
-//  if (!HasStream())
-//    return FALSE;
-
   TraverseList ((PmSFV)&wxMemStruct::PrintNode, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 
   return TRUE;
@@ -682,28 +606,25 @@ bool wxDebugContext::PrintList (void)
 bool wxDebugContext::Dump(void)
 {
 #ifdef __WXDEBUG__
-//  if (!HasStream())
-//    return FALSE;
-
-//  if (TRUE)
   {
-    wxChar* appName = wxT("application");
-    wxString appNameStr("");
+    wxChar* appName = (wxChar*) wxT("application");
+    wxString appNameStr(wxT(""));
     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( wxT("") );
+  OutputDumpLine( wxT("") );
 
   return TRUE;
 #else
@@ -711,6 +632,7 @@ bool wxDebugContext::Dump(void)
 #endif
 }
 
+#ifdef __WXDEBUG__
 struct wxDebugStatsStruct
 {
   long instanceCount;
@@ -735,26 +657,23 @@ static wxDebugStatsStruct *InsertStatsStruct(wxDebugStatsStruct *head, wxDebugSt
   st->next = head;
   return st;
 }
+#endif
 
 bool wxDebugContext::PrintStatistics(bool detailed)
 {
 #ifdef __WXDEBUG__
-//  if (!HasStream())
-//    return FALSE;
-
-//  if (TRUE)
   {
-    wxChar* appName = wxT("application");
+    wxChar* appName = (wxChar*) wxT("application");
     wxString appNameStr(wxT(""));
     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 -----") );
     }
   }
 
@@ -775,15 +694,14 @@ bool wxDebugContext::PrintStatistics(bool detailed)
   for (st = from; st != 0; st = st->m_next)
   {
     void* data = st->GetActualData();
-//    if (detailed && (data != (void*)m_debugStream) && (data != (void*) m_streamBuf))
-      if (detailed && (data != (void*) wxLog::GetActiveTarget()))
+    if (detailed && (data != (void*) wxLog::GetActiveTarget()))
     {
-      wxChar *className = wxT("nonobject");
+      wxChar *className = (wxChar*) wxT("nonobject");
       if (st->m_isObject && st->GetActualData())
       {
         wxObject *obj = (wxObject *)st->GetActualData();
         if (obj->GetClassInfo()->GetClassName())
-          className = obj->GetClassInfo()->GetClassName();
+          className = (wxChar*)obj->GetClassInfo()->GetClassName();
       }
       wxDebugStatsStruct *stats = FindStatsStruct(list, className);
       if (!stats)
@@ -798,7 +716,6 @@ bool wxDebugContext::PrintStatistics(bool detailed)
       stats->totalSize += st->RequestSize();
     }
 
-//    if ((data != (void*)m_debugStream) && (data != (void*) m_streamBuf))
     if (data != (void*) wxLog::GetActiveTarget())
     {
         totalSize += st->RequestSize();
@@ -813,37 +730,34 @@ 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(wxT(""));
   }
 
   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(wxT(""));
+  OutputDumpLine(wxT(""));
 
   return TRUE;
 #else
+  (void)detailed;
   return FALSE;
 #endif
 }
 
 bool wxDebugContext::PrintClasses(void)
 {
-//  if (!HasStream())
-//    return FALSE;
-
-//  if (TRUE)
   {
-    wxChar* appName = wxT("application");
+    wxChar* appName = (wxChar*) wxT("application");
     wxString appNameStr(wxT(""));
     if (wxTheApp)
     {
@@ -854,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());
@@ -937,7 +851,6 @@ int wxDebugContext::CountObjectsLeft(bool sinceCheckpoint)
   for (wxMemStruct * st = from; st != 0; st = st->m_next)
   {
       void* data = st->GetActualData();
-//      if ((data != (void*)m_debugStream) && (data != (void*) m_streamBuf))
       if (data != (void*) wxLog::GetActiveTarget())
           n ++;
   }
@@ -945,12 +858,75 @@ 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)-1] = _T('\0');
+
+    // keep 3 bytes for a \r\n\0
+    count = wxVsnprintf(buf, sizeof(buf)-3, szFormat, argptr);
+
+    if ( count < 0 )
+        count = sizeof(buf)-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;
+       }
+};
+
+class MemoryCriticalSectionLocker
+{
+public:
+    inline MemoryCriticalSectionLocker(wxCriticalSection& critsect)
+       : 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;
+};
+
+static MemoryCriticalSection memLocker;
+#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 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.
 
+#if defined(__VISAGECPP__) && (__IBMCPP__ < 400 || __IBMC__ < 400 )
+// VA 3.0 still has trouble in here
+  return (void *)malloc(size);
+#endif
   if (!wxDebugContext::GetDebugMode())
   {
     return (void *)malloc(size);
@@ -1000,9 +976,17 @@ 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 USE_THREADSAFE_MEMORY_ALLOCATION
+  MemoryCriticalSectionLocker lock(memLocker);
+#endif
+
   if (!buf)
     return;
 
+#if defined(__VISAGECPP__) && (__IBMCPP__ < 400 || __IBMC__ < 400 )
+// VA 3.0 still has trouble in here
+  free((char *)buf);
+#endif
   // If not in debugging allocation mode, do the normal thing
   // so we don't leave any trace of ourselves in the node list.
   if (!wxDebugContext::GetDebugMode())
@@ -1036,14 +1020,11 @@ void wxDebugFree(void * buf, bool WXUNUSED(isVect) )
     (void) memset (wxDebugContext::CallerMemPos (startPointer), MemFillChar,
                    st->RequestSize ());
 
-    // Don't allow delayed freeing of memory in this version
-//    if (!wxDebugContext::GetDelayFree())
-//    free((void *)st);
     free((char *)st);
 }
 
 // Trace: send output to the current debugging stream
-void wxTrace(const wxChar *fmt ...)
+void wxTrace(const wxChar * ...)
 {
 #if 1
     wxFAIL_MSG(wxT("wxTrace is now obsolete. Please use wxDebugXXX instead."));
@@ -1080,7 +1061,7 @@ void wxTrace(const wxChar *fmt ...)
 }
 
 // Trace with level
-void wxTraceLevel(int level, const wxChar *fmt ...)
+void wxTraceLevel(int, const wxChar * ...)
 {
 #if 1
     wxFAIL_MSG(wxT("wxTrace is now obsolete. Please use wxDebugXXX instead."));
@@ -1119,13 +1100,28 @@ void wxTraceLevel(int level, const wxChar *fmt ...)
 #endif
 }
 
-#else // wxUSE_MEMORY_TRACING && defined(__WXDEBUG__)
-void wxTrace(const char *WXUNUSED(fmt) ...)
-{
-}
+//----------------------------------------------------------------------------
+// Final cleanup after all global objects in all files have been destructed
+//----------------------------------------------------------------------------
+
+// Don't set it to 0 by dynamic initialization
+// Some compilers will realy do the asignment later
+// All global variables are initialized to 0 at the very beginning, and this is just fine.
+int wxDebugContextDumpDelayCounter::sm_count;
 
-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 clenup counter object
+static wxDebugContextDumpDelayCounter wxDebugContextDumpDelayCounter_One;
+
+#endif // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT