## wxDebugContext

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

Derived from

No parent class.

Include files

<wx/memory.h>

See also

Overview

Members

wxDebugContext::Check
wxDebugContext::Dump
wxDebugContext::GetCheckPrevious
wxDebugContext::GetDebugMode
wxDebugContext::GetLevel
wxDebugContext::GetStream
wxDebugContext::GetStreamBuf
wxDebugContext::HasStream
wxDebugContext::PrintClasses
wxDebugContext::PrintStatistics
wxDebugContext::SetCheckpoint
wxDebugContext::SetCheckPrevious
wxDebugContext::SetDebugMode
wxDebugContext::SetFile
wxDebugContext::SetLevel
wxDebugContext::SetStandardError
wxDebugContext::SetStream

### wxDebugContext::Check

int Check()

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

Return value

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

### wxDebugContext::Dump

bool 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.

Return value

true if the function succeeded, false otherwise.

### wxDebugContext::GetCheckPrevious

bool 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

wxDebugContext::SetCheckPrevious

### wxDebugContext::GetDebugMode

bool 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

wxDebugContext::SetDebugMode

### wxDebugContext::GetLevel

int 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

wxDebugContext::SetLevel

### wxDebugContext::GetStream

ostream& GetStream()

Returns the output stream associated with the debug context.

This is obsolete, replaced by wxLog functionality.

See also

wxDebugContext::SetStream

### wxDebugContext::GetStreamBuf

streambuf* 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.

### wxDebugContext::HasStream

bool HasStream()

Returns true if there is a stream currently associated with the debug context.

This is obsolete, replaced by wxLog functionality.

See also

wxDebugContext::SetStream, wxDebugContext::GetStream

### wxDebugContext::PrintClasses

bool 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

wxDebugContext::PrintStatistics

### wxDebugContext::PrintStatistics

bool 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

wxDebugContext::PrintStatistics

### wxDebugContext::SetCheckpoint

void 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.

### wxDebugContext::SetCheckPrevious

void 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

wxDebugContext::GetCheckPrevious

### wxDebugContext::SetDebugMode

void 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

wxDebugContext::GetDebugMode

### wxDebugContext::SetFile

bool 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).

### wxDebugContext::SetLevel

void 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

wxDebugContext::GetLevel

### wxDebugContext::SetStandardError

bool 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.

### wxDebugContext::SetStream

void 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.

See also

wxDebugContext::GetStream, wxDebugContext::HasStream