wxWidgets/interface/memory.h

/////////////////////////////////////////////////////////////////////////////
// Name:        memory.h
// Purpose:     documentation for wxDebugStreamBuf class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxDebugStreamBuf
    @wxheader{memory.h}

    This class allows you to treat debugging output in a similar
    (stream-based) fashion on different platforms. Under
    Windows, an ostream constructed with this buffer outputs
    to the debugger, or other program that intercepts debugging
    output. On other platforms, the output goes to standard error (cerr).

    This is soon to be obsolete, replaced by wxLog functionality.

    @library{wxbase}
    @category{FIXME}

    @seealso
    Overview
*/
class wxDebugStreamBuf
{
public:

};


/**
    @class wxDebugContext
    @wxheader{memory.h}

    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}

    @seealso
    Overview
*/
class wxDebugContext
{
public:
    /**
        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.
    */
    int Check();

    /**
        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.
    */
    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.
        
        @sa SetCheckPrevious()
    */
    bool GetCheckPrevious();

    /**
        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.
        
        @sa SetDebugMode()
    */
    bool GetDebugMode();

    /**
        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.
        
        @sa SetLevel()
    */
    int GetLevel();

    /**
        Returns the output stream associated with the debug context.
        
        This is obsolete, replaced by wxLog functionality.
        
        @sa 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.
        
        This is obsolete, replaced by wxLog functionality.
    */
    streambuf* GetStreamBuf();

    /**
        Returns @true if there is a stream currently associated
        with the debug context.
        
        This is obsolete, replaced by wxLog functionality.
        
        @sa 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.
        
        @sa 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.
        
        @sa 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.
        
        @sa 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.
    */
    void SetCheckpoint(bool all = @false);

    /**
        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.
        
        @sa 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);

    /**
        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.
        
        @sa GetLevel()
    */
    void SetLevel(int level);

    /**
        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.
    */
    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.
        
        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).
        
        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);
};


// ============================================================================
// Global functions/macros
// ============================================================================

/**
    @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.
*/
#define WXTRACELEVEL()     /* implementation is private */

/**
    @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).
*/
void wxTrace(const wxString& fmt, ... );

/**
    @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).
*/
#define Include files WXTRACE()     /* implementation is private */