]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/memory.h
Wrappers for *ToText
[wxWidgets.git] / include / wx / memory.h
index 92f28769aca877a0c4473e0d1a67e703684124d0..3b58cb55d95124dce74c9f70e26b838a69a8b13b 100644 (file)
@@ -6,18 +6,19 @@
 // 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
 
 #include <stddef.h>
 
-#if wxUSE_IOSTREAMH
-    // N.B. BC++ doesn't have istream.h, ostream.h
-#   include <iostream.h>
-#else
-#   include <ostream>
-#   if defined(__VISUALC__) || defined(__MWERKS__)
-        using namespace std;
-#   endif
-#endif
-
 #ifdef __WXDEBUG__
 
-// devik 2000-8-27: export these because new/delete operators are now inline
-WXDLLEXPORT void * wxDebugAlloc(size_t size, wxChar * fileName, int lineNum, bool isObject, bool isVect = FALSE);
-WXDLLEXPORT 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);
 
 //**********************************************************************************
 /*
@@ -82,28 +72,28 @@ WXDLLEXPORT 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)
@@ -112,15 +102,15 @@ inline void operator delete[] (void * buf)
 }
 #endif
 
-// VC++ 6.0
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
+// 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);
+    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
@@ -135,9 +125,9 @@ 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:
@@ -204,16 +194,16 @@ typedef void (wxMemStruct::*PmSFV) ();
 
 
 /*
-  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.
@@ -227,14 +217,11 @@ protected:
     // 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
+    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
@@ -243,13 +230,6 @@ public:
     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; }
 
@@ -309,6 +289,9 @@ public:
     // that are outstanding
     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
     // needing to have a wxMemStruct object.
@@ -320,23 +303,56 @@ private:
     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 WXDLLEXPORT wxTrace(const wxChar *fmt ...);
-void WXDLLEXPORT wxTraceLevel(int level, const wxChar *fmt ...);
+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 wxChar *WXUNUSED(fmt)) {}
-inline void wxTraceLevel(int WXUNUSED(level), const wxChar *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
 
-#endif // __WXDEBUG__
+#endif // (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
 
 #endif
     // _WX_MEMORYH__