wxDebugContext Class Reference
[Debugging]

#include <wx/memory.h>

List of all members.


Detailed Description

A class for performing various debugging and memory tracing operations. Full functionality (such as printing out objects currently allocated) is only present in a debugging build of wxWidgets, i.e. if the __WXDEBUG__ symbol is defined. wxDebugContext and related functions and macros can be compiled out by setting wxUSE_DEBUG_CONTEXT to 0 is setup.h

Library:  wxBase

Category:  Debugging

See also:
Overview()

Public Member Functions

int Check ()
bool Dump ()
bool GetCheckPrevious ()
bool GetDebugMode ()
int GetLevel ()
ostream GetStream ()
streambuf * GetStreamBuf ()
bool HasStream ()
bool PrintClasses ()
bool PrintStatistics (bool detailed=true)
void SetCheckPrevious (bool check)
void SetCheckpoint (bool all=false)
void SetDebugMode (bool debug)
bool SetFile (const wxString &filename)
void SetLevel (int level)
void SetShutdownNotifyFunction (wxShutdownNotifyFunction func)
bool SetStandardError ()
void SetStream (ostream *stream, streambuf *streamBuf=NULL)

Member Function Documentation

int wxDebugContext::Check (  ) 

Checks the memory blocks for errors, starting from the currently set checkpoint.

Returns:
Returns the number of errors, so a value of zero represents success. Returns -1 if an error was detected that prevents further checking.

bool wxDebugContext::Dump (  ) 

Performs a memory dump from the currently set checkpoint, writing to the current debug stream. Calls the Dump member function for each wxObject derived instance.

Returns:
true if the function succeeded, false otherwise.

bool wxDebugContext::GetCheckPrevious (  ) 

Returns true if the memory allocator checks all previous memory blocks for errors. By default, this is false since it slows down execution considerably.

See also:
SetCheckPrevious()

bool wxDebugContext::GetDebugMode (  ) 

Returns true if debug mode is on. If debug mode is on, the wxObject new and delete operators store or use information about memory allocation. Otherwise, a straight malloc and free will be performed by these operators.

See also:
SetDebugMode()

int wxDebugContext::GetLevel (  ) 

Gets the debug level (default 1). The debug level is used by the wxTraceLevel function and the WXTRACELEVEL macro to specify how detailed the trace information is; setting a different level will only have an effect if trace statements in the application specify a value other than one. This is obsolete, replaced by wxLog functionality.

See also:
SetLevel()

ostream wxDebugContext::GetStream (  ) 

Returns the output stream associated with the debug context. This is obsolete, replaced by wxLog functionality.

See also:
SetStream()

streambuf* wxDebugContext::GetStreamBuf (  ) 

Returns a pointer to the output stream buffer associated with the debug context. There may not necessarily be a stream buffer if the stream has been set by the user. This is obsolete, replaced by wxLog functionality.

bool wxDebugContext::HasStream (  ) 

Returns true if there is a stream currently associated with the debug context. This is obsolete, replaced by wxLog functionality.

See also:
SetStream(), GetStream()

bool wxDebugContext::PrintClasses (  ) 

Prints a list of the classes declared in this application, giving derivation and whether instances of this class can be dynamically created.

See also:
PrintStatistics()

bool wxDebugContext::PrintStatistics ( bool  detailed = true  ) 

Performs a statistics analysis from the currently set checkpoint, writing to the current debug stream. The number of object and non-object allocations is printed, together with the total size.

Parameters:
detailed If true, the function will also print how many objects of each class have been allocated, and the space taken by these class instances.
See also:
PrintStatistics()

void wxDebugContext::SetCheckPrevious ( bool  check  ) 

Tells the memory allocator to check all previous memory blocks for errors. By default, this is false since it slows down execution considerably.

See also:
GetCheckPrevious()

void wxDebugContext::SetCheckpoint ( bool  all = false  ) 

Sets the current checkpoint: Dump and PrintStatistics operations will be performed from this point on. This allows you to ignore allocations that have been performed up to this point.

Parameters:
all If true, the checkpoint is reset to include all memory allocations since the program started.

void wxDebugContext::SetDebugMode ( bool  debug  ) 

Sets the debug mode on or off. If debug mode is on, the wxObject new and delete operators store or use information about memory allocation. Otherwise, a straight malloc and free will be performed by these operators. By default, debug mode is on if __WXDEBUG__ is defined. If the application uses this function, it should make sure that all object memory allocated is deallocated with the same value of debug mode. Otherwise, the delete operator might try to look for memory information that does not exist.

See also:
GetDebugMode()

bool wxDebugContext::SetFile ( const wxString filename  ) 

Sets the current debug file and creates a stream. This will delete any existing stream and stream buffer. By default, the debug context stream outputs to the debugger (Windows) or standard error (other platforms).

void wxDebugContext::SetLevel ( int  level  ) 

Sets the debug level (default 1). The debug level is used by the wxTraceLevel function and the WXTRACELEVEL macro to specify how detailed the trace information is; setting a different level will only have an effect if trace statements in the application specify a value other than one. This is obsolete, replaced by wxLog functionality.

See also:
GetLevel()

void wxDebugContext::SetShutdownNotifyFunction ( wxShutdownNotifyFunction  func  ) 

Installs a function to be called at the end of wxWidgets shutdown. It will be called after all files with global instances of wxDebugContextDumpDelayCounter have run their destructors. The shutdown function must be take no parameters and return nothing.

bool wxDebugContext::SetStandardError (  ) 

Sets the debugging stream to be the debugger (Windows) or standard error (other platforms). This is the default setting. The existing stream will be flushed and deleted. This is obsolete, replaced by wxLog functionality.

void wxDebugContext::SetStream ( ostream *  stream,
streambuf *  streamBuf = NULL 
)

Sets the stream and optionally, stream buffer associated with the debug context. This operation flushes and deletes the existing stream (and stream buffer if any). This is obsolete, replaced by wxLog functionality.

Parameters:
stream Stream to associate with the debug context. Do not set this to NULL.
streamBuf Stream buffer to associate with the debug context.



wxWidgets logo

[ top ]