wxURL - doc cleanups, depreciated more methods, more source comments. wxURI - enclos...

[wxWidgets.git] / include / wx / memory.h

diff --git a/include/wx/memory.h b/include/wx/memory.h
index 8ae2be6e811e4a869fcb8b6008e09e74510f1dbb..22820dcb91215fba21224fba8a5c606ad687e378 100644 (file)
--- a/include/wx/memory.h
+++ b/include/wx/memory.h
@@ -18,6 +18,7 @@
 
 #include "wx/defs.h"
 #include "wx/string.h"
+#include "wx/msgout.h"
 
 /*
   The macro which will be expanded to include the file and line number
@@ -30,8 +31,8 @@
 
 #ifdef __WXDEBUG__
 
-WXDLLIMPEXP_BASE void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, bool isVect = FALSE);
-WXDLLIMPEXP_BASE void wxDebugFree(void * buf, bool isVect = FALSE);
+WXDLLIMPEXP_BASE void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, bool isVect = false);
+WXDLLIMPEXP_BASE void wxDebugFree(void * buf, bool isVect = false);
 
 //**********************************************************************************
 /*
@@ -71,33 +72,33 @@ WXDLLIMPEXP_BASE void wxDebugFree(void * buf, bool isVect = FALSE);
 
 inline void * operator new (size_t size, wxChar * fileName, int lineNum)
 {
-    return wxDebugAlloc(size, fileName, lineNum, FALSE, FALSE);
+    return wxDebugAlloc(size, fileName, lineNum, false, false);
 }
 
 inline void * operator new (size_t size)
 {
-    return wxDebugAlloc(size, NULL, 0, FALSE);
+    return wxDebugAlloc(size, NULL, 0, false);
 }
 
 inline void operator delete (void * buf)
 {
-    wxDebugFree(buf, FALSE);
+    wxDebugFree(buf, false);
 }
 
 #if wxUSE_ARRAY_MEMORY_OPERATORS
 inline void * operator new[] (size_t size)
 {
-    return wxDebugAlloc(size, NULL, 0, FALSE, TRUE);
+    return wxDebugAlloc(size, NULL, 0, false, true);
 }
 
 inline void * operator new[] (size_t size, wxChar * fileName, int lineNum)
 {
-    return wxDebugAlloc(size, fileName, lineNum, FALSE, TRUE);
+    return wxDebugAlloc(size, fileName, lineNum, false, true);
 }
 
 inline void operator delete[] (void * buf)
 {
-  wxDebugFree(buf, TRUE);
+  wxDebugFree(buf, true);
 }
 #endif
 
@@ -105,11 +106,11 @@ inline void operator delete[] (void * buf)
 #if ( defined(__VISUALC__) && (__VISUALC__ >= 1200) ) || defined(__MWERKS__)
 inline void operator delete(void* pData, wxChar* /* fileName */, int /* lineNum */)
 {
-    wxDebugFree(pData, FALSE);
+    wxDebugFree(pData, false);
 }
 inline void operator delete[](void* pData, wxChar* /* fileName */, int /* lineNum */)
 {
-    wxDebugFree(pData, TRUE);
+    wxDebugFree(pData, true);
 }
 #endif // __VISUALC__>=1200
 #endif // wxUSE_GLOBAL_MEMORY_OPERATORS
@@ -235,7 +236,7 @@ public:
     static bool GetDebugMode(void) { return debugOn; }
     static void SetDebugMode(bool flag) { debugOn = flag; }
 
-    static void SetCheckpoint(bool all = FALSE);
+    static void SetCheckpoint(bool all = false);
     static wxMemStruct *GetCheckpoint(void) { return checkPoint; }
 
     // Calculated from the request size and any padding needed
@@ -269,8 +270,8 @@ public:
     static bool GetCheckPrevious () { return m_checkPrevious; }
     static void SetCheckPrevious (bool value) { m_checkPrevious = value; }
 
-    // Checks all nodes, or all nodes if checkAll is TRUE
-    static int Check(bool checkAll = FALSE);
+    // Checks all nodes, or all nodes if checkAll is true
+    static int Check(bool checkAll = false);
 
     // Print out the list of wxMemStruct nodes.
     static bool PrintList(void);
@@ -279,14 +280,17 @@ public:
     static bool Dump(void);
 
     // Print statistics
-    static bool PrintStatistics(bool detailed = TRUE);
+    static bool PrintStatistics(bool detailed = true);
 
     // Print out the classes in the application.
     static bool PrintClasses(void);
 
     // Count the number of non-wxDebugContext-related objects
     // that are outstanding
-    static int CountObjectsLeft(bool sinceCheckpoint = FALSE);
+    static int CountObjectsLeft(bool sinceCheckpoint = false);
+
+    // This function is used to output the dump
+    static void OutputDumpLine(const wxChar *szFormat, ...);
 
 private:
     // Store these here to allow access to the list without
@@ -294,11 +298,36 @@ private:
     static wxMemStruct*         m_head;
     static wxMemStruct*         m_tail;
 
-    // Set to FALSE if we're not checking all previous nodes when
-    // we do a new. Set to TRUE when we are.
+    // Set to false if we're not checking all previous nodes when
+    // we do a new. Set to true when we are.
     static bool                 m_checkPrevious;
 };
 
+// Final cleanup (e.g. deleting the log object and doing memory leak checking)
+// will be delayed until all wxDebugContextDumpDelayCounter objects have been
+// destructed. Adding one wxDebugContextDumpDelayCounter per file will delay
+// memory leak checking until after destructing all global objects.
+class WXDLLIMPEXP_BASE wxDebugContextDumpDelayCounter
+{
+public:
+    wxDebugContextDumpDelayCounter() {
+        sm_count++;
+    }
+
+    ~wxDebugContextDumpDelayCounter() {
+        sm_count--;
+        if(!sm_count) DoDump();
+    }
+private:
+    void DoDump();
+    static int sm_count;
+};
+
+// make leak dump after all globals have been destructed
+static wxDebugContextDumpDelayCounter wxDebugContextDumpDelayCounter_File;
+#define WXDEBUG_DUMPDELAYCOUNTER \
+    static wxDebugContextDumpDelayCounter wxDebugContextDumpDelayCounter_Extra;
+
 // Output a debug message, in a system dependent fashion.
 void WXDLLIMPEXP_BASE wxTrace(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1;
 void WXDLLIMPEXP_BASE wxTraceLevel(int level, const wxChar *fmt ...) ATTRIBUTE_PRINTF_2;
@@ -306,7 +335,9 @@ void WXDLLIMPEXP_BASE wxTraceLevel(int level, const wxChar *fmt ...) ATTRIBUTE_P
 #define WXTRACE wxTrace
 #define WXTRACELEVEL wxTraceLevel
 
-#else // else part for the #if __WXDEBUG__
+#else // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
+
+#define WXDEBUG_DUMPDELAYCOUNTER
 
 // Borland C++ Builder 6 seems to have troubles with inline functions (see bug
 // 819700)
@@ -318,10 +349,10 @@ void WXDLLIMPEXP_BASE wxTraceLevel(int level, const wxChar *fmt ...) ATTRIBUTE_P
     #define wxTraceLevel(l, fmt)
 #endif
 
-#define WXTRACE TRUE ? (void)0 : wxTrace
-#define WXTRACELEVEL TRUE ? (void)0 : wxTraceLevel
+#define WXTRACE true ? (void)0 : wxTrace
+#define WXTRACELEVEL true ? (void)0 : wxTraceLevel
 
-#endif // __WXDEBUG__
+#endif // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 
 #endif
     // _WX_MEMORYH__