1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: MDI classes
4 // Author: Arthur Seaton, Julian Smart
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "memory.h"
20 #include "wx/string.h"
23 The macro which will be expanded to include the file and line number
24 info, or to be a straight call to the new operator.
27 #if (defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING) || wxUSE_DEBUG_CONTEXT
32 // N.B. BC++ doesn't have istream.h, ostream.h
33 # include <iostream.h>
36 # if defined(__VISUALC__) || defined(__MWERKS__)
43 void * wxDebugAlloc(size_t size
, wxChar
* fileName
, int lineNum
, bool isObject
, bool isVect
= FALSE
);
44 void wxDebugFree(void * buf
, bool isVect
= FALSE
);
46 // Global versions of the new and delete operators.
47 #if wxUSE_GLOBAL_MEMORY_OPERATORS
49 // Undefine temporarily (new is #defined in object.h) because we want to
50 // declare some new operators.
55 #if defined(__SUNCC__)
56 #define wxUSE_ARRAY_MEMORY_OPERATORS 0
57 #elif !( defined (__VISUALC__) && (__VISUALC__ <= 1020) ) || defined( __MWERKS__)
58 #define wxUSE_ARRAY_MEMORY_OPERATORS 1
59 #elif defined (__SGI_CC_)
60 // only supported by -n32 compilers
61 #ifndef __EDG_ABI_COMPATIBILITY_VERSION
62 #define wxUSE_ARRAY_MEMORY_OPERATORS 0
65 // ::operator new[] is a recent C++ feature, so assume it's not supported
66 #define wxUSE_ARRAY_MEMORY_OPERATORS 0
69 // Added JACS 25/11/98: needed for some compilers
70 void * operator new (size_t size
);
71 void * operator new (size_t size
, wxChar
* fileName
, int lineNum
);
72 #if !defined(__VISAGECPP__)
73 void operator delete (void * buf
);
76 #if wxUSE_ARRAY_MEMORY_OPERATORS
77 void * operator new[] (size_t size
);
78 void * operator new[] (size_t size
, wxChar
* fileName
, int lineNum
);
79 void operator delete[] (void * buf
);
83 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
84 void operator delete(void *buf
, wxChar
*, int);
85 void operator delete[](void *buf
, wxChar
*, int);
89 // wxUSE_GLOBAL_MEMORY_OPERATORS
93 typedef unsigned int wxMarkerType
;
96 Define the struct which will be placed at the start of all dynamically
100 class WXDLLEXPORT wxMemStruct
{
102 friend class WXDLLEXPORT wxDebugContext
; // access to the m_next pointer for list traversal.
108 size_t RequestSize () { return m_reqSize
; }
109 wxMarkerType
Marker () { return m_firstMarker
; }
111 // When an object is deleted we set the id slot to a specific value.
112 inline void SetDeleted ();
113 inline int IsDeleted ();
118 // Used to determine if the object is really a wxMemStruct.
119 // Not a foolproof test by any means, but better than none I hope!
122 // Do all validation on a node.
125 // Check the integrity of a node and of the list, node by node.
127 int CheckAllPrevious ();
129 // Print a single node.
132 // Called when the memory linking functions get an error.
133 void ErrorMsg (const char *);
136 inline void *GetActualData(void) const { return m_actualData
; }
141 // Check for underwriting. There are 2 of these checks. This one
142 // inside the struct and another right after the struct.
143 wxMarkerType m_firstMarker
;
145 // File name and line number are from cpp.
149 // The amount of memory requested by the caller.
152 // Used to try to verify that we really are dealing with an object
153 // of the required class. Can be 1 of 2 values these indicating a valid
154 // wxMemStruct object, or a deleted wxMemStruct object.
157 wxMemStruct
* m_prev
;
158 wxMemStruct
* m_next
;
165 typedef void (wxMemStruct::*PmSFV
) ();
169 Debugging class. This will only have a single instance, but it\'s
170 a reasonable way to keep everything together and to make this
171 available for change if needed by someone else.
172 A lot of this stuff would be better off within the wxMemStruct class, but
173 it\'s stuff which we need to access at times when there is no wxMemStruct
174 object so we use this class instead. Think of it as a collection of
175 globals which have to do with the wxMemStruct class.
178 class WXDLLEXPORT wxDebugContext
{
181 // Used to set alignment for markers.
182 static size_t CalcAlignment ();
184 // Returns the amount of padding needed after something of the given
185 // size. This is so that when we cast pointers backwards and forwards
186 // the pointer value will be valid for a wxMarkerType.
187 static size_t GetPadding (const size_t size
) ;
189 // Traverse the list.
190 static void TraverseList (PmSFV
, wxMemStruct
*from
= NULL
);
192 static streambuf
*m_streamBuf
;
193 static ostream
*m_debugStream
;
195 static int debugLevel
;
199 // Set a checkpoint to dump only the memory from
201 static wxMemStruct
*checkPoint
;
203 wxDebugContext(void);
204 ~wxDebugContext(void);
206 static bool HasStream(void) { return (m_debugStream
!= NULL
); };
207 static ostream
& GetStream(void) { return *m_debugStream
; }
208 static streambuf
*GetStreamBuf(void) { return m_streamBuf
; }
209 static void SetStream(ostream
*stream
, streambuf
*buf
= NULL
);
210 static bool SetFile(const wxString
& file
);
211 static bool SetStandardError(void);
213 static int GetLevel(void) { return debugLevel
; }
214 static void SetLevel(int level
) { debugLevel
= level
; }
216 static bool GetDebugMode(void) { return debugOn
; }
217 static void SetDebugMode(bool flag
) { debugOn
= flag
; }
219 static void SetCheckpoint(bool all
= FALSE
);
220 static wxMemStruct
*GetCheckpoint(void) { return checkPoint
; }
222 // Calculated from the request size and any padding needed
223 // before the final marker.
224 static size_t PaddedSize (const size_t reqSize
);
226 // Calc the total amount of space we need from the system
227 // to satisfy a caller request. This includes all padding.
228 static size_t TotSize (const size_t reqSize
);
230 // Return valid pointers to offsets within the allocated memory.
231 static char * StructPos (const char * buf
);
232 static char * MidMarkerPos (const char * buf
);
233 static char * CallerMemPos (const char * buf
);
234 static char * EndMarkerPos (const char * buf
, const size_t size
);
236 // Given a pointer to the start of the caller requested area
237 // return a pointer to the start of the entire alloc\'d buffer.
238 static char * StartPos (const char * caller
);
240 // Access to the list.
241 static wxMemStruct
* GetHead () { return m_head
; }
242 static wxMemStruct
* GetTail () { return m_tail
; }
244 // Set the list sentinals.
245 static wxMemStruct
* SetHead (wxMemStruct
* st
) { return (m_head
= st
); }
246 static wxMemStruct
* SetTail (wxMemStruct
* st
) { return (m_tail
= st
); }
248 // If this is set then every new operation checks the validity
249 // of the all previous nodes in the list.
250 static bool GetCheckPrevious () { return m_checkPrevious
; }
251 static void SetCheckPrevious (bool value
) { m_checkPrevious
= value
; }
253 // Checks all nodes, or all nodes if checkAll is TRUE
254 static int Check(bool checkAll
= FALSE
);
256 // Print out the list of wxMemStruct nodes.
257 static bool PrintList(void);
260 static bool Dump(void);
263 static bool PrintStatistics(bool detailed
= TRUE
);
265 // Print out the classes in the application.
266 static bool PrintClasses(void);
268 // Count the number of non-wxDebugContext-related objects
269 // that are outstanding
270 static int CountObjectsLeft(bool sinceCheckpoint
= FALSE
);
273 // Store these here to allow access to the list without
274 // needing to have a wxMemStruct object.
275 static wxMemStruct
* m_head
;
276 static wxMemStruct
* m_tail
;
278 // Set to FALSE if we're not checking all previous nodes when
279 // we do a new. Set to TRUE when we are.
280 static bool m_checkPrevious
;
283 // Output a debug message, in a system dependent fashion.
284 void WXDLLEXPORT
wxTrace(const wxChar
*fmt
...);
285 void WXDLLEXPORT
wxTraceLevel(int level
, const wxChar
*fmt
...);
287 #define WXTRACE wxTrace
288 #define WXTRACELEVEL wxTraceLevel
290 #else // else part for the #if __WXDEBUG__
292 inline void wxTrace(const wxChar
*WXUNUSED(fmt
)) {}
293 inline void wxTraceLevel(int WXUNUSED(level
), const wxChar
*WXUNUSED(fmt
)) {}
295 #define WXTRACE TRUE ? (void)0 : wxTrace
296 #define WXTRACELEVEL TRUE ? (void)0 : wxTraceLevel
297 // #define WXDEBUG_NEW new
299 #endif // __WXDEBUG__