// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Julian Smart
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_MEMORYH__
#define _WX_MEMORYH__
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "memory.h"
#endif
#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 (WXDEBUG && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
+#if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
#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
-
-// #ifndef WXDEBUG_NEW
-// #define WXDEBUG_NEW new(__FILE__,__LINE__)
-// #endif
+//**********************************************************************************
+/*
+ The global operator new used for everything apart from getting
+ dynamic storage within this function itself.
+*/
-void * wxDebugAlloc(size_t size, char * fileName, int lineNum, bool isObject, bool isVect = FALSE);
-void wxDebugFree(void * buf, bool isVect = FALSE);
+// We'll only do malloc and free for the moment: leave the interesting
+// stuff for the wxObject versions.
+// 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
-// 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
+// Undefine temporarily (new is #defined in object.h) because we want to
+// declare some new operators.
#ifdef new
-#undef new
+ #undef new
#endif
-void * operator new (size_t size, char * fileName, int lineNum);
+#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
+
+void * operator new (size_t size, wxChar * fileName, int lineNum);
+
+void * operator new (size_t size);
+
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);
+
+void * operator new[] (size_t size, wxChar * fileName, int lineNum);
-#if !( defined (_MSC_VER) && (_MSC_VER <= 1020) )
-void * operator new[] (size_t size, char * fileName, int lineNum);
void operator delete[] (void * buf);
#endif
-#endif
-#endif
+// 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;
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_BASE wxDebugContext; // access to the m_next pointer for list traversal.
public:
public:
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.
/*
- 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
- 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.
*/
-class WXDLLEXPORT wxDebugContext {
+class WXDLLIMPEXP_BASE wxDebugContext {
protected:
// Used to set alignment for markers.
// 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 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
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 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
// before the final marker.
static size_t PaddedSize (const size_t reqSize);
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);
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(void);
+ 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
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;
};
-// Output a debug mess., in a system dependent fashion.
-void WXDLLEXPORT wxTrace(const char *fmt ...);
-void WXDLLEXPORT wxTraceLevel(int level, const char *fmt ...);
+// 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;
#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
+
+// 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
-#define WXTRACE TRUE ? (void)0 : wxTrace
-#define WXTRACELEVEL TRUE ? (void)0 : wxTraceLevel
-// #define WXDEBUG_NEW new
+#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__
projects / wxWidgets.git / blobdiff