/////////////////////////////////////////////////////////////////////////////
// Name: memory.h
-// Purpose: documentation for wxDebugStreamBuf class
+// Purpose: interface of wxDebugStreamBuf
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxbase}
@category{FIXME}
- @seealso
- Overview
+ @see Overview()
*/
class wxDebugStreamBuf
{
};
+
/**
@class wxDebugContext
@wxheader{memory.h}
@library{wxbase}
@category{debugging}
- @seealso
- Overview
+ @see Overview()
*/
class wxDebugContext
{
/**
Checks the memory blocks for errors, starting from the currently set
checkpoint.
-
- @returns Returns the number of errors, so a value of zero represents
+
+ @return Returns the number of errors, so a value of zero represents
success. Returns -1 if an error was detected that
prevents further checking.
*/
Performs a memory dump from the currently set checkpoint, writing to the
current debug stream. Calls the @b Dump member function for each wxObject
derived instance.
-
- @returns @true if the function succeeded, @false otherwise.
+
+ @return @true if the function succeeded, @false otherwise.
*/
bool Dump();
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 SetCheckPrevious()
*/
bool GetCheckPrevious();
delete
operators store or use information about memory allocation. Otherwise,
a straight malloc and free will be performed by these operators.
-
+
@see SetDebugMode()
*/
bool GetDebugMode();
application
specify a value other than one.
This is obsolete, replaced by wxLog functionality.
-
+
@see SetLevel()
*/
int GetLevel();
/**
Returns the output stream associated with the debug context.
This is obsolete, replaced by wxLog functionality.
-
+
@see SetStream()
*/
ostream GetStream();
Returns @true if there is a stream currently associated
with the debug context.
This is obsolete, replaced by wxLog functionality.
-
+
@see SetStream(), GetStream()
*/
bool HasStream();
/**
Prints a list of the classes declared in this application, giving derivation
and whether instances of this class can be dynamically created.
-
+
@see PrintStatistics()
*/
bool PrintClasses();
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.
-
+
@param 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 PrintStatistics()
*/
bool PrintStatistics(bool detailed = true);
/**
Tells the memory allocator to check all previous memory blocks for errors.
By default, this is @false since it slows down execution considerably.
-
+
@see GetCheckPrevious()
*/
void SetCheckPrevious(bool check);
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.
-
+
@param all
If @true, the checkpoint is reset to include all
memory allocations since the program started.
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 GetDebugMode()
*/
void SetDebugMode(bool debug);
application
specify a value other than one.
This is obsolete, replaced by wxLog functionality.
-
+
@see GetLevel()
*/
void SetLevel(int level);
This operation flushes and deletes the existing stream (and stream buffer if
any).
This is obsolete, replaced by wxLog functionality.
-
+
@param stream
Stream to associate with the debug context. Do not set this to @NULL.
@param streamBuf
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
+/** @ingroup group_funcmacro_log */
+//@{
+
/**
- @b NB: This function is now obsolete, replaced by @ref overview_logfunctions
- "Log functions".
- Calls wxTraceLevel with printf-style variable argument syntax. Output
- is directed to the current output stream (see wxDebugContext).
- The first argument should be the level at which this information is appropriate.
- It will only be output if the level returned by wxDebugContext::GetLevel is
- equal to or greater than
- this value.
+ @deprecated Use one of the wxLogTrace() functions or one of the
+ wxVLogTrace() functions instead.
+
+ Calls wxTrace() with printf-style variable argument syntax. Output is
+ directed to the current output stream (see wxDebugContext).
+
+ @header{wx/memory.h}
*/
-#define WXTRACELEVEL() /* implementation is private */
+#define WXTRACE(format, ...)
/**
- @b NB: This function is now obsolete, replaced by @ref overview_logfunctions
- "Log functions".
- Takes printf-style variable argument syntax. Output
- is directed to the current output stream (see wxDebugContext).
+ @deprecated Use one of the wxLogTrace() functions or one of the
+ wxVLogTrace() functions instead.
+
+ Calls wxTraceLevel with printf-style variable argument syntax. Output is
+ directed to the current output stream (see wxDebugContext). The first
+ argument should be the level at which this information is appropriate. It
+ will only be output if the level returned by wxDebugContext::GetLevel is
+ equal to or greater than this value.
+
+ @header{wx/memory.h}
*/
-void wxTrace(const wxString& fmt, ... );
+#define WXTRACELEVEL(level, format, ...)
/**
- @b NB: This macro is now obsolete, replaced by @ref overview_logfunctions "Log
- functions".
- Calls wxTrace with printf-style variable argument syntax. Output
- is directed to the current output stream (see wxDebugContext).
+ @deprecated Use one of the wxLogTrace() functions or one of the
+ wxVLogTrace() functions instead.
+
+ Takes printf-style variable argument syntax. Output is directed to the
+ current output stream (see wxDebugContext).
+
+ @header{wx/memory.h}
*/
-#define Include files WXTRACE() /* implementation is private */
+void wxTrace(const wxString& format, ...);
+
+/**
+ @deprecated Use one of the wxLogTrace() functions or one of the
+ wxVLogTrace() functions instead.
+
+ Takes @e printf() style variable argument syntax. Output is directed to the
+ current output stream (see wxDebugContext). The first argument should be
+ the level at which this information is appropriate. It will only be output
+ if the level returned by wxDebugContext::GetLevel() is equal to or greater
+ than this value.
+
+ @header{wx/memory.h}
+*/
+void wxTraceLevel(int level, const wxString& format, ...);
+
+//@}
projects / wxWidgets.git / blobdiff