]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/memory.cpp
Removed treelay sample
[wxWidgets.git] / src / common / memory.cpp
index a67263d476e9137ccadfb11ccd2104ee5f979b2e..7509750cd35a37c46c1b0638f500f60998307e88 100644 (file)
@@ -5,8 +5,8 @@
 // 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__
 #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>
 
 #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
 */
 void wxMemStruct::ErrorMsg (const char * mesg)
 {
-  wxLogDebug(wxT("wxWindows memory checking error: %s"), mesg);
+  wxLogMessage(wxT("wxWindows memory checking error: %s"), mesg);
   PrintNode ();
-
-//         << m_fileName << ' ' << m_lineNum << endl;
 }
 
 /*
@@ -122,10 +126,8 @@ void wxMemStruct::ErrorMsg (const char * mesg)
 */
 void wxMemStruct::ErrorMsg ()
 {
-  wxLogDebug(wxT("wxWindows over/underwrite memory error:"));
+  wxLogMessage(wxT("wxWindows over/underwrite memory error:"));
   PrintNode ();
-
-//    cerr << m_fileName << ' ' << m_lineNum << endl;
 }
 
 
@@ -344,11 +346,11 @@ void wxMemStruct::PrintNode ()
     msg2.Printf(wxT(" at $%lX, size %d"), (long)GetActualData(), (int)RequestSize());
     msg += msg2;
 
-    wxLogDebug(msg);
+    wxLogMessage(msg);
   }
   else
   {
-    wxString msg("");
+    wxString msg(wxT(""));
 
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
@@ -357,7 +359,7 @@ void wxMemStruct::PrintNode ()
     msg2.Printf(wxT(" at $%lX, size %d\n"), (long)GetActualData(), (int)RequestSize());
     msg += msg2;
 
-    wxLogDebug(msg);
+    wxLogMessage(msg);
   }
 }
 
@@ -386,11 +388,11 @@ void wxMemStruct::Dump ()
     else
       msg += wxT("unknown object class");
 
-    wxString msg2("");
+    wxString msg2(wxT(""));
     msg2.Printf(wxT(" at $%lX, size %d"), (long)GetActualData(), (int)RequestSize());
     msg += msg2;
 
-    wxLogDebug(msg);
+    wxLogMessage(msg);
   }
   else
   {
@@ -398,10 +400,10 @@ void wxMemStruct::Dump ()
     if (m_fileName)
       msg.Printf(wxT("%s(%d): "), m_fileName, (int)m_lineNum);
 
-    wxString msg2("");
+    wxString msg2(wxT(""));
     msg2.Printf(wxT("non-object data at $%lX, size %d"), (long)GetActualData(), (int)RequestSize() );
     msg += msg2;
-    wxLogDebug(msg);
+    wxLogMessage(msg);
   }
 }
 
@@ -419,7 +421,7 @@ int wxMemStruct::ValidateNode ()
         else {
             // Can't use the error routines as we have no recognisable object.
 #ifndef __WXGTK__
-             wxLogDebug(wxT("Can't verify memory struct - all bets are off!"));
+             wxLogMessage(wxT("Can't verify memory struct - all bets are off!"));
 #endif
         }
         return 0;
@@ -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.fn_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);
 }
 
 /*
@@ -649,7 +576,8 @@ void wxDebugContext::TraverseList (PmSFV func, wxMemStruct *from)
   if (!from)
     from = wxDebugContext::GetHead ();
 
-  for (wxMemStruct * st = from; st != 0; st = st->m_next)
+  wxMemStruct * st = NULL;
+  for (st = from; st != 0; st = st->m_next)
   {
       void* data = st->GetActualData();
 //      if ((data != (void*)m_debugStream) && (data != (void*) m_streamBuf))
@@ -667,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;
@@ -681,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;
-        wxLogDebug(wxT("----- Memory dump of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
+        wxLogMessage(wxT("----- Memory dump of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
     }
     else
     {
-      wxLogDebug( wxT("----- Memory dump -----") );
+      wxLogMessage( wxT("----- Memory dump -----") );
     }
   }
+
   TraverseList ((PmSFV)&wxMemStruct::Dump, (checkPoint ? checkPoint->m_next : (wxMemStruct*)NULL));
 
-  wxLogDebug( wxT("") );
-  wxLogDebug( wxT("") );
+  wxLogMessage( wxT("") );
+  wxLogMessage( wxT("") );
 
   return TRUE;
 #else
@@ -710,6 +632,7 @@ bool wxDebugContext::Dump(void)
 #endif
 }
 
+#ifdef __WXDEBUG__
 struct wxDebugStatsStruct
 {
   long instanceCount;
@@ -734,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;
-        wxLogDebug(wxT("----- Memory statistics of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
+        wxLogMessage(wxT("----- Memory statistics of %s at %s -----"), appName, WXSTRINGCAST wxNow() );
     }
     else
     {
-      wxLogDebug( wxT("----- Memory statistics -----") );
+      wxLogMessage( wxT("----- Memory statistics -----") );
     }
   }
 
@@ -774,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)
@@ -797,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();
@@ -812,43 +730,40 @@ bool wxDebugContext::PrintStatistics(bool detailed)
   {
     while (list)
     {
-      wxLogDebug(wxT("%ld objects of class %s, total size %ld"),
+      wxLogMessage(wxT("%ld objects of class %s, total size %ld"),
           list->instanceCount, list->instanceClass, list->totalSize);
       wxDebugStatsStruct *old = list;
       list = old->next;
       free((char *)old);
     }
-    wxLogDebug(wxT(""));
+    wxLogMessage(wxT(""));
   }
 
   SetDebugMode(currentMode);
 
-  wxLogDebug(wxT("Number of object items: %ld"), noObjectNodes);
-  wxLogDebug(wxT("Number of non-object items: %ld"), noNonObjectNodes);
-  wxLogDebug(wxT("Total allocated size: %ld"), totalSize);
-  wxLogDebug(wxT(""));
-  wxLogDebug(wxT(""));
+  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(""));
 
   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)
     {
         appNameStr = wxTheApp->GetAppName();
         appName = WXSTRINGCAST appNameStr;
-        wxLogDebug(wxT("----- Classes in %s -----"), appName);
+        wxLogMessage(wxT("----- Classes in %s -----"), appName);
     }
   }
 
@@ -860,7 +775,7 @@ bool wxDebugContext::PrintClasses(void)
   node = wxClassInfo::sm_classTable->Next();
   while (node)
   {
-    info = (wxClassInfo *)node->Data();
+    info = (wxClassInfo *)node->GetData();
     if (info->GetClassName())
     {
         wxString msg(info->GetClassName());
@@ -881,15 +796,15 @@ bool wxDebugContext::PrintClasses(void)
         if (info->GetConstructor())
             msg += wxT(": dynamic");
 
-        wxLogDebug(msg);
+        wxLogMessage(msg);
     }
     node = wxClassInfo::sm_classTable->Next();
     n ++;
   }
-  wxLogDebug(wxT(""));
-  wxLogDebug(wxT("There are %d classes derived from wxObject."), n);
-  wxLogDebug(wxT(""));
-  wxLogDebug(wxT(""));
+  wxLogMessage(wxT(""));
+  wxLogMessage(wxT("There are %d classes derived from wxObject."), n);
+  wxLogMessage(wxT(""));
+  wxLogMessage(wxT(""));
   return TRUE;
 }
 
@@ -936,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 ++;
   }
@@ -944,114 +858,50 @@ int wxDebugContext::CountObjectsLeft(bool sinceCheckpoint)
   return n ;
 }
 
-/*
-  The global operator new used for everything apart from getting
-  dynamic storage within this function itself.
-*/
-
-// We'll only do malloc and free for the moment: leave the interesting
-// stuff for the wxObject versions.
-
-#if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS
-
-#ifdef new
-#undef new
-#endif
-
-// Seems OK all of a sudden. Maybe to do with linking with multithreaded library?
-#if 0 // def __VISUALC__
-#define NO_DEBUG_ALLOCATION
-#endif
-
-// Unfortunately ~wxDebugStreamBuf doesn't work (VC++ 5) when we enable the debugging
-// code. I have no idea why. In BC++ 4.5, we have a similar problem the debug
-// stream myseriously changing pointer address between being passed from SetFile to SetStream.
-// See docs/msw/issues.txt.
-void * operator new (size_t size, wxChar * fileName, int lineNum)
-{
-#ifdef NO_DEBUG_ALLOCATION
-  return malloc(size);
-#else
-  return wxDebugAlloc(size, fileName, lineNum, FALSE, FALSE);
-#endif
-}
-
-// Added JACS 25/11/98
-void * operator new (size_t size)
-{
-#ifdef NO_DEBUG_ALLOCATION
-  return malloc(size);
-#else
-  return wxDebugAlloc(size, NULL, 0, FALSE);
-#endif
-}
-
-#if wxUSE_ARRAY_MEMORY_OPERATORS
-void * operator new[] (size_t size)
-{
-#ifdef NO_DEBUG_ALLOCATION
-  return malloc(size);
-#else
-  return wxDebugAlloc(size, NULL, 0, FALSE, TRUE);
-#endif
-}
-#endif
-
-#if wxUSE_ARRAY_MEMORY_OPERATORS
-void * operator new[] (size_t size, wxChar * fileName, int lineNum)
-{
-#ifdef NO_DEBUG_ALLOCATION
-  return malloc(size);
-#else
-  return wxDebugAlloc(size, fileName, lineNum, FALSE, TRUE);
-#endif
-}
-#endif
+#if USE_THREADSAFE_MEMORY_ALLOCATION
+static bool memSectionOk = FALSE;
 
-#if !defined(__VISAGECPP__) // already defines this by default
-void operator delete (void * buf)
+class MemoryCriticalSection : public wxCriticalSection
 {
-#ifdef NO_DEBUG_ALLOCATION
-  free((char*) buf);
-#else
-  wxDebugFree(buf);
-#endif
-}
-#endif
-
-// VC++ 6.0
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
-void operator delete(void* pData, wxChar* /* fileName */, int /* lineNum */)
-{
-  wxDebugFree(pData, FALSE);
-}
-// New operator 21/11/1998
-void operator delete[](void* pData, char* /* fileName */, int /* lineNum */)
-{
-  wxDebugFree(pData, TRUE);
-}
-#endif
-
-#if wxUSE_ARRAY_MEMORY_OPERATORS
+public:
+       MemoryCriticalSection() {
+               memSectionOk = TRUE;
+       }
+};
 
-void operator delete[] (void * buf)
+class MemoryCriticalSectionLocker
 {
-#ifdef NO_DEBUG_ALLOCATION
-  free((char*) buf);
-#else
-  wxDebugFree(buf, TRUE);
-#endif
-}
-#endif
+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);
@@ -1060,7 +910,7 @@ void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject,
     int totSize = wxDebugContext::TotSize (size);
     char * buf = (char *) malloc(totSize);
     if (!buf) {
-        wxLogDebug(wxT("Call to malloc (%ld) failed."), (long)size);
+        wxLogMessage(wxT("Call to malloc (%ld) failed."), (long)size);
         return 0;
     }
     wxMemStruct * st = (wxMemStruct *)buf;
@@ -1101,9 +951,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())
@@ -1137,16 +995,16 @@ 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 * ...)
 {
-  va_list ap;
+#if 1
+    wxFAIL_MSG(wxT("wxTrace is now obsolete. Please use wxDebugXXX instead."));
+#else
+    va_list ap;
   static wxChar buffer[512];
 
   va_start(ap, fmt);
@@ -1174,11 +1032,15 @@ void wxTrace(const wxChar *fmt ...)
 #else
     fprintf(stderr, buffer);
 #endif
+#endif
 }
 
 // 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."));
+#else
   if (wxDebugContext::GetLevel() < level)
     return;
 
@@ -1188,7 +1050,7 @@ void wxTraceLevel(int level, const wxChar *fmt ...)
   va_start(ap, fmt);
 
 #ifdef __WXMSW__
-  wvsprintf(buffer,fmt,ap) ;
+  wxWvsprintf(buffer,fmt,ap) ;
 #else
   vsprintf(buffer,fmt,ap) ;
 #endif
@@ -1210,6 +1072,7 @@ void wxTraceLevel(int level, const wxChar *fmt ...)
 #else
     fprintf(stderr, buffer);
 #endif
+#endif
 }
 
 #else // wxUSE_MEMORY_TRACING && defined(__WXDEBUG__)