Document wxRendererNative::DrawTitleBarBitmap() and use it properly.

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

diff --git a/include/wx/memory.h b/include/wx/memory.h
index 017a51f056d2c5883858d3233fc849851d9a3c79..1bece9a2d72489c535a4ba24eddd8e289fa7491e 100644 (file)
--- a/include/wx/memory.h
+++ b/include/wx/memory.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        memory.h
-// Purpose:     MDI classes
+// Name:        wx/memory.h
+// Purpose:     Memory operations
 // Author:      Arthur Seaton, Julian Smart
 // Modified by:
 // Created:     29/01/98
@@ -9,28 +9,17 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_MEMORYH__
-#define _WX_MEMORYH__
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "memory.h"
-#endif
+#ifndef _WX_MEMORY_H_
+#define _WX_MEMORY_H_
 
 #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
-  info, or to be a straight call to the new operator.
-*/
-
-#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
+#if wxUSE_MEMORY_TRACING || wxUSE_DEBUG_CONTEXT
 
 #include <stddef.h>
 
-#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);
 
@@ -74,33 +63,33 @@ WXDLLIMPEXP_BASE void wxDebugFree(void * buf, bool isVect = false);
 #if defined(__WXMSW__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL_BASE))
 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 // wxUSE_ARRAY_MEMORY_OPERATORS
 
@@ -133,7 +122,6 @@ inline void operator delete[](void* pData, wxChar* /* fileName */, int /* lineNu
 }
 #endif // __VISUALC__>=1200
 #endif // wxUSE_GLOBAL_MEMORY_OPERATORS
-#endif // __WXDEBUG__
 
 //**********************************************************************************
 
@@ -146,7 +134,7 @@ typedef unsigned int wxMarkerType;
 
 class WXDLLIMPEXP_BASE wxMemStruct {
 
-friend class WXDLLIMPEXP_BASE wxDebugContext; // access to the m_next pointer for list traversal.
+friend class WXDLLIMPEXP_FWD_BASE wxDebugContext; // access to the m_next pointer for list traversal.
 
 public:
 public:
@@ -211,6 +199,9 @@ public:
 
 typedef void (wxMemStruct::*PmSFV) ();
 
+// Type of the app function that can be installed and called at wxWidgets shutdown
+// (after all other registered files with global destructors have been closed down).
+typedef void (*wxShutdownNotifyFunction)();
 
 /*
   Debugging class. This will only have a single instance, but it's
@@ -311,6 +302,8 @@ public:
     // This function is used to output the dump
     static void OutputDumpLine(const wxChar *szFormat, ...);
 
+    static void SetShutdownNotifyFunction(wxShutdownNotifyFunction shutdownFn);
+
 private:
     // Store these here to allow access to the list without
     // needing to have a wxMemStruct object.
@@ -320,23 +313,25 @@ private:
     // 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;
+
+    // Holds a pointer to an optional application function to call at shutdown.
+    static wxShutdownNotifyFunction sm_shutdownFn;
+
+    // Have to access our shutdown hook
+    friend class wxDebugContextDumpDelayCounter;
 };
 
 // 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();
-    }
+    wxDebugContextDumpDelayCounter();
+    ~wxDebugContextDumpDelayCounter();
+
 private:
     void DoDump();
     static int sm_count;
@@ -348,13 +343,13 @@ static wxDebugContextDumpDelayCounter wxDebugContextDumpDelayCounter_File;
     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;
+void WXDLLIMPEXP_BASE wxTrace(const wxChar *fmt ...) WX_ATTRIBUTE_PRINTF_1;
+void WXDLLIMPEXP_BASE wxTraceLevel(int level, const wxChar *fmt ...) WX_ATTRIBUTE_PRINTF_2;
 
 #define WXTRACE wxTrace
 #define WXTRACELEVEL wxTraceLevel
 
-#else // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
+#else // wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 
 #define WXDEBUG_DUMPDELAYCOUNTER
 
@@ -371,8 +366,6 @@ void WXDLLIMPEXP_BASE wxTraceLevel(int level, const wxChar *fmt ...) ATTRIBUTE_P
 #define WXTRACE true ? (void)0 : wxTrace
 #define WXTRACELEVEL true ? (void)0 : wxTraceLevel
 
-#endif // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
-
-#endif
-    // _WX_MEMORYH__
+#endif // wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 
+#endif // _WX_MEMORY_H_