take const wxConfig object in wxDocManager::FileHistoryLoad() and wxFileHistory:...

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

diff --git a/include/wx/memory.h b/include/wx/memory.h
index 8f5c81ae95b4657ac0118b83ee75e5174e055872..3291e38eb6f6f9694d99f284b141168362a5293e 100644 (file)
--- a/include/wx/memory.h
+++ b/include/wx/memory.h
@@ -1,77 +1,137 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        memory.h
-// Purpose:     MDI classes
+// Name:        wx/memory.h
+// Purpose:     Memory operations

 // Author:      Arthur Seaton, Julian Smart
 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
 // Author:      Arthur Seaton, Julian Smart
 // Modified by:
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart

-// Licence:    wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MEMORYH__
 #define _WX_MEMORYH__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MEMORYH__
 #define _WX_MEMORYH__
 

-#ifdef __GNUG__
-#pragma interface "memory.h"
-#endif
-

 #include "wx/defs.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.
 */
 
 
 /*
   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 (WXDEBUG && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
+#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT

 
 #include <stddef.h>
 
 
 #include <stddef.h>
 

-#if wxUSE_IOSTREAMH
-#  include <ostream.h>
-#else
-#  include <ostream>
-#  ifdef _MSC_VER
-      using namespace std;
-#  endif
-#endif
+#ifdef __WXDEBUG__

 
 

-#include "wx/string.h"
+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);

 
 

-#if WXDEBUG
+//**********************************************************************************
+/*
+  The global operator new used for everything apart from getting
+  dynamic storage within this function itself.
+*/

 
 

-// #ifndef WXDEBUG_NEW
-// #define WXDEBUG_NEW new(__FILE__,__LINE__)
-// #endif
+// We'll only do malloc and free for the moment: leave the interesting
+// stuff for the wxObject versions.

 
 

-void * wxDebugAlloc(size_t size, char * fileName, int lineNum, bool isObject, bool isVect = FALSE);
-void wxDebugFree(void * buf, bool isVect = FALSE);

 
 

-// Global versions of the new and delete operators.
-// Currently, these merely call malloc and free; only the wxObject
-// operators do something interesting. But this allows WXDEBUG_NEW to
-// work for all 'new's in a file.

 #if wxUSE_GLOBAL_MEMORY_OPERATORS
 
 #if wxUSE_GLOBAL_MEMORY_OPERATORS
 

+// Undefine temporarily (new is #defined in object.h) because we want to
+// declare some new operators.

 #ifdef new
 #ifdef new

-#undef new
+    #undef new
+#endif
+
+#if defined(__SUNCC__)
+    #define wxUSE_ARRAY_MEMORY_OPERATORS 0
+#elif !( defined (__VISUALC__) && (__VISUALC__ <= 1020) ) || defined( __MWERKS__)
+    #define wxUSE_ARRAY_MEMORY_OPERATORS 1
+#elif defined (__SGI_CC_)
+    // only supported by -n32 compilers
+    #ifndef __EDG_ABI_COMPATIBILITY_VERSION
+        #define wxUSE_ARRAY_MEMORY_OPERATORS 0
+    #endif
+#elif !( defined (__VISUALC__) && (__VISUALC__ <= 1020) ) || defined( __MWERKS__)
+    #define wxUSE_ARRAY_MEMORY_OPERATORS 1
+#else
+    // ::operator new[] is a recent C++ feature, so assume it's not supported
+    #define wxUSE_ARRAY_MEMORY_OPERATORS 0

 #endif
 
 #endif
 

-void * operator new (size_t size, char * fileName, int lineNum);
+// devik 2000-8-29: All new/delete ops are now inline because they can't
+// be marked as dllexport/dllimport. It then leads to weird bugs when
+// used on MSW as DLL
+#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);
+}
+
+inline void * operator new (size_t size)
+{
+    return wxDebugAlloc(size, NULL, 0, false);
+}
+
+inline void operator delete (void * buf)
+{
+    wxDebugFree(buf, false);
+}
+
+#if wxUSE_ARRAY_MEMORY_OPERATORS
+inline void * operator new[] (size_t size)
+{
+    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);
+}
+
+inline void operator delete[] (void * buf)
+{
+    wxDebugFree(buf, true);
+}
+#endif // wxUSE_ARRAY_MEMORY_OPERATORS
+
+#else
+
+void * operator new (size_t size, wxChar * fileName, int lineNum);
+
+void * operator new (size_t size);
+

 void operator delete (void * buf);
 
 void operator delete (void * buf);
 

-// VC++ 6.0
-#if _MSC_VER >= 1200
-void operator delete(void *buf, char*, int);
-#endif
+#if wxUSE_ARRAY_MEMORY_OPERATORS
+void * operator new[] (size_t size);

 
 

-#if !( defined (_MSC_VER) && (_MSC_VER <= 1020) )
-void * operator new[] (size_t size, char * fileName, int lineNum);
-void operator delete[] (void * buf);
-#endif
+void * operator new[] (size_t size, wxChar * fileName, int lineNum);

 
 

-#endif
-#endif
+void operator delete[] (void * buf);
+#endif // wxUSE_ARRAY_MEMORY_OPERATORS
+#endif // defined(__WXMSW__) && (defined(WXUSINGDLL) || defined(WXMAKINGDLL_BASE))
+
+// VC++ 6.0 and MWERKS
+#if ( defined(__VISUALC__) && (__VISUALC__ >= 1200) ) || defined(__MWERKS__)
+inline void operator delete(void* pData, wxChar* /* fileName */, int /* lineNum */)
+{
+    wxDebugFree(pData, false);
+}
+inline void operator delete[](void* pData, wxChar* /* fileName */, int /* lineNum */)
+{
+    wxDebugFree(pData, true);
+}
+#endif // __VISUALC__>=1200
+#endif // wxUSE_GLOBAL_MEMORY_OPERATORS
+#endif // __WXDEBUG__
+
+//**********************************************************************************

 
 typedef unsigned int wxMarkerType;
 
 
 typedef unsigned int wxMarkerType;
 


@@ -80,9 +140,9 @@ typedef unsigned int wxMarkerType;
   allocated memory.
 */
 
   allocated memory.
 */
 

-class WXDLLEXPORT wxMemStruct {
+class WXDLLIMPEXP_BASE wxMemStruct {

 
 

-friend class WXDLLEXPORT 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:
 
 public:
 public:


@@ -126,7 +186,7 @@ public:
     wxMarkerType        m_firstMarker;
 
     // File name and line number are from cpp.
     wxMarkerType        m_firstMarker;
 
     // File name and line number are from cpp.

-    char*               m_fileName;
+    wxChar*             m_fileName;

     int                 m_lineNum;
 
     // The amount of memory requested by the caller.
     int                 m_lineNum;
 
     // The amount of memory requested by the caller.


@@ -147,18 +207,21 @@ public:
 
 typedef void (wxMemStruct::*PmSFV) ();
 
 
 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
+  Debugging class. This will only have a single instance, but it's

   a reasonable way to keep everything together and to make this
   available for change if needed by someone else.
   A lot of this stuff would be better off within the wxMemStruct class, but
   a reasonable way to keep everything together and to make this
   available for change if needed by someone else.
   A lot of this stuff would be better off within the wxMemStruct class, but

-  it\'s stuff which we need to access at times when there is no wxMemStruct
+  it's stuff which we need to access at times when there is no wxMemStruct

   object so we use this class instead. Think of it as a collection of
   globals which have to do with the wxMemStruct class.
 */
 
   object so we use this class instead. Think of it as a collection of
   globals which have to do with the wxMemStruct class.
 */
 

-class WXDLLEXPORT wxDebugContext {
+class WXDLLIMPEXP_BASE wxDebugContext {

 
 protected:
     // Used to set alignment for markers.
 
 protected:
     // Used to set alignment for markers.


@@ -172,12 +235,11 @@ protected:
     // Traverse the list.
     static void TraverseList (PmSFV, wxMemStruct *from = NULL);
 
     // Traverse the list.
     static void TraverseList (PmSFV, wxMemStruct *from = NULL);
 

-    static streambuf *m_streamBuf;
-    static ostream *m_debugStream;
-

     static int debugLevel;
     static bool debugOn;
 
     static int debugLevel;
     static bool debugOn;
 

+    static int m_balign;            // byte alignment
+    static int m_balignmask;        // mask for performing byte alignment

 public:
     // Set a checkpoint to dump only the memory from
     // a given point
 public:
     // Set a checkpoint to dump only the memory from
     // a given point


@@ -186,22 +248,15 @@ public:
     wxDebugContext(void);
     ~wxDebugContext(void);
 
     wxDebugContext(void);
     ~wxDebugContext(void);
 

-    static bool HasStream(void) { return (m_debugStream != NULL); };
-    static ostream& GetStream(void) { return *m_debugStream; }
-    static streambuf *GetStreamBuf(void) { return m_streamBuf; }
-    static void SetStream(ostream *stream, streambuf *buf = NULL);
-    static bool SetFile(const wxString& file);
-    static bool SetStandardError(void);
-

     static int GetLevel(void) { return debugLevel; }
     static void SetLevel(int level) { debugLevel = level; }
 
     static bool GetDebugMode(void) { return debugOn; }
     static void SetDebugMode(bool flag) { debugOn = flag; }
 
     static int GetLevel(void) { return debugLevel; }
     static void SetLevel(int level) { debugLevel = level; }
 
     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; }
     static wxMemStruct *GetCheckpoint(void) { return checkPoint; }

-    
+

     // Calculated from the request size and any padding needed
     // before the final marker.
     static size_t PaddedSize (const size_t reqSize);
     // Calculated from the request size and any padding needed
     // before the final marker.
     static size_t PaddedSize (const size_t reqSize);


@@ -233,8 +288,8 @@ public:
     static bool GetCheckPrevious () { return m_checkPrevious; }
     static void SetCheckPrevious (bool value) { m_checkPrevious = value; }
 
     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);
 
     // Print out the list of wxMemStruct nodes.
     static bool PrintList(void);


@@ -243,14 +298,19 @@ public:
     static bool Dump(void);
 
     // Print statistics
     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
 
     // 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(void);
+    static int CountObjectsLeft(bool sinceCheckpoint = false);
+
+    // 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
 
 private:
     // Store these here to allow access to the list without


@@ -258,29 +318,63 @@ private:
     static wxMemStruct*         m_head;
     static wxMemStruct*         m_tail;
 
     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;
     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();
+    ~wxDebugContextDumpDelayCounter();
+
+private:
+    void DoDump();
+    static int sm_count;

 };
 
 };
 

-// Output a debug mess., in a system dependent fashion.
-void WXDLLEXPORT wxTrace(const char *fmt ...);
-void WXDLLEXPORT wxTraceLevel(int level, const char *fmt ...);
+// 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;

 
 #define WXTRACE wxTrace
 #define WXTRACELEVEL wxTraceLevel
 
 
 #define WXTRACE wxTrace
 #define WXTRACELEVEL wxTraceLevel
 

-#else // else part for the #if WXDEBUG
+#else // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT

 
 

-inline void wxTrace(const char *WXUNUSED(fmt)) {}
-inline void wxTraceLevel(int WXUNUSED(level), const char *WXUNUSED(fmt)) {}
+#define WXDEBUG_DUMPDELAYCOUNTER

 
 

-#define WXTRACE TRUE ? (void)0 : wxTrace
-#define WXTRACELEVEL TRUE ? (void)0 : wxTraceLevel
-// #define WXDEBUG_NEW new
+// Borland C++ Builder 6 seems to have troubles with inline functions (see bug
+// 819700)
+#if 0
+    inline void wxTrace(const wxChar *WXUNUSED(fmt)) {}
+    inline void wxTraceLevel(int WXUNUSED(level), const wxChar *WXUNUSED(fmt)) {}
+#else
+    #define wxTrace(fmt)
+    #define wxTraceLevel(l, fmt)
+#endif

 
 

-#endif // WXDEBUG
+#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
     // _WX_MEMORYH__

-