// Name: memory.h
// Purpose: interface of wxDebugContext
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
success. Returns -1 if an error was detected that prevents
further checking.
*/
- int Check();
+ static int Check(bool checkAll = false);
/**
Performs a memory dump from the currently set checkpoint, writing to the
@return @true if the function succeeded, @false otherwise.
*/
- bool Dump();
+ static bool Dump();
/**
Returns @true if the memory allocator checks all previous memory blocks for
@see SetCheckPrevious()
*/
- bool GetCheckPrevious();
+ static bool GetCheckPrevious();
/**
Returns @true if debug mode is on.
@see SetDebugMode()
*/
- bool GetDebugMode();
+ static bool GetDebugMode();
/**
Gets the debug level (default 1).
@see SetLevel()
*/
- int GetLevel();
-
- /**
- Returns the output stream associated with the debug context.
-
- @deprecated
- This is obsolete, replaced by wxLog functionality.
-
- @see SetStream()
- */
- ostream GetStream();
-
- /**
- 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.
-
- @deprecated
- This is obsolete, replaced by wxLog functionality.
- */
- streambuf* GetStreamBuf();
-
- /**
- Returns @true if there is a stream currently associated
- with the debug context.
-
- @deprecated
- This is obsolete, replaced by wxLog functionality.
-
- @see SetStream(), GetStream()
- */
- bool HasStream();
+ static int GetLevel();
/**
Prints a list of the classes declared in this application, giving derivation
@see PrintStatistics()
*/
- bool PrintClasses();
+ static bool PrintClasses();
/**
Performs a statistics analysis from the currently set checkpoint, writing
@see PrintStatistics()
*/
- bool PrintStatistics(bool detailed = true);
+ static bool PrintStatistics(bool detailed = true);
/**
Tells the memory allocator to check all previous memory blocks for errors.
@see GetCheckPrevious()
*/
- void SetCheckPrevious(bool check);
+ static void SetCheckPrevious(bool check);
/**
Sets the current checkpoint: Dump and PrintStatistics operations will
If @true, the checkpoint is reset to include all memory allocations
since the program started.
*/
- void SetCheckpoint(bool all = false);
+ static void SetCheckpoint(bool all = false);
/**
Sets the debug mode on or off.
@see GetDebugMode()
*/
- void SetDebugMode(bool debug);
-
- /**
- 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).
- */
- bool SetFile(const wxString& filename);
+ static void SetDebugMode(bool debug);
/**
Sets the debug level (default 1).
@see GetLevel()
*/
- void SetLevel(int level);
+ static void SetLevel(int level);
/**
Installs a function to be called at the end of wxWidgets shutdown.
The shutdown function must be take no parameters and return nothing.
*/
- void SetShutdownNotifyFunction(wxShutdownNotifyFunction func);
-
- /**
- 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.
-
- @deprecated
- This is obsolete, replaced by wxLog functionality.
- */
- bool SetStandardError();
-
- /**
- 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).
-
- @deprecated
- This is obsolete, replaced by wxLog functionality.
-
- @param stream
- Stream to associate with the debug context. Do not set this to @NULL.
- @param streamBuf
- Stream buffer to associate with the debug context.
- */
- void SetStream(ostream* stream, streambuf* streamBuf = NULL);
+ static void SetShutdownNotifyFunction(wxShutdownNotifyFunction func);
};
// Global functions/macros
// ============================================================================
-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */
//@{
/**