Version: 3.0.2
wxDebugReport Class Reference

#include <wx/debugrpt.h>

+ Inheritance diagram for wxDebugReport:

Detailed Description

wxDebugReport is used to generate a debug report, containing information about the program current state.

It is usually used from wxApp::OnFatalException() as shown in the Debug Reporter Sample.

A wxDebugReport object contains one or more files. A few of them can be created by the class itself but more can be created from the outside and then added to the report. Also note that several virtual functions may be overridden to further customize the class behaviour.

Once a report is fully assembled, it can simply be left in the temporary directory so that the user can email it to the developers (in which case you should still use wxDebugReportCompress to compress it in a single file) or uploaded to a Web server using wxDebugReportUpload (setting up the Web server to accept uploads is your responsibility, of course). Other handlers, for example for automatically emailing the report, can be defined as well but are not currently included in wxWidgets.

A typical usage example:

report.AddCurrentContext(); // could also use AddAll()
report.AddCurrentDump(); // to do both at once
if ( preview.Show(report) )
report.Process();

Library:  wxQA
Category:  Debugging

Public Types

enum  Context {
  Context_Current,
  Context_Exception
}
 This enum is used for functions that report either the current state or the state during the last (fatal) exception. More...
 

Public Member Functions

 wxDebugReport ()
 The constructor creates a temporary directory where the files that will be included in the report are created.
 
virtual ~wxDebugReport ()
 The destructor normally destroys the temporary directory created in the constructor with all the files it contains.
 
void AddAll (Context context=Context_Exception)
 Adds all available information to the report.
 
virtual bool AddContext (Context ctx)
 Add an XML file containing the current or exception context and the stack trace.
 
bool AddCurrentContext ()
 The same as calling AddContext(Context_Current).
 
bool AddCurrentDump ()
 The same as calling AddDump(Context_Current).
 
virtual bool AddDump (Context ctx)
 Adds the minidump file to the debug report.
 
bool AddExceptionContext ()
 The same as calling AddContext(Context_Exception).
 
bool AddExceptionDump ()
 The same as calling AddDump(Context_Exception).
 
virtual void AddFile (const wxString &filename, const wxString &description)
 Add another file to the report.
 
bool AddText (const wxString &filename, const wxString &text, const wxString &description)
 This is a convenient wrapper around AddFile().
 
const wxStringGetDirectory () const
 This method should be used to construct the full name of the files which you wish to add to the report using AddFile().
 
bool GetFile (size_t n, wxString *name, wxString *desc) const
 Retrieves the name (relative to GetDirectory()) and the description of the file with the given index.
 
size_t GetFilesCount () const
 Gets the current number files in this report.
 
virtual wxString GetReportName () const
 Gets the name used as a base name for various files, by default wxApp::GetAppName() is used.
 
bool IsOk () const
 Returns true if the object was successfully initialized.
 
bool Process ()
 Processes this report: the base class simply notifies the user that the report has been generated.
 
void RemoveFile (const wxString &name)
 Removes the file from report: this is used by wxDebugReportPreview to allow the user to remove files potentially containing private information from the report.
 
void Reset ()
 Resets the directory name we use.
 

Protected Member Functions

virtual void DoAddCustomContext (wxXmlNode *nodeRoot)
 This function may be overridden to add arbitrary custom context to the XML context file created by AddContext().
 
virtual bool DoAddExceptionInfo (wxXmlNode *nodeContext)
 This function may be overridden to modify the contents of the exception tag in the XML context file.
 
virtual bool DoAddLoadedModules (wxXmlNode *nodeModules)
 This function may be overridden to modify the contents of the modules tag in the XML context file.
 
virtual bool DoAddSystemInfo (wxXmlNode *nodeSystemInfo)
 This function may be overridden to modify the contents of the system tag in the XML context file.
 

Member Enumeration Documentation

This enum is used for functions that report either the current state or the state during the last (fatal) exception.

Enumerator
Context_Current 
Context_Exception 

Constructor & Destructor Documentation

wxDebugReport::wxDebugReport ( )

The constructor creates a temporary directory where the files that will be included in the report are created.

Use IsOk() to check for errors.

virtual wxDebugReport::~wxDebugReport ( )
virtual

The destructor normally destroys the temporary directory created in the constructor with all the files it contains.

Call Reset() to prevent this from happening.

Member Function Documentation

void wxDebugReport::AddAll ( Context  context = Context_Exception)

Adds all available information to the report.

Currently this includes a text (XML) file describing the process context and, under Win32, a minidump file.

virtual bool wxDebugReport::AddContext ( Context  ctx)
virtual

Add an XML file containing the current or exception context and the stack trace.

bool wxDebugReport::AddCurrentContext ( )

The same as calling AddContext(Context_Current).

bool wxDebugReport::AddCurrentDump ( )

The same as calling AddDump(Context_Current).

virtual bool wxDebugReport::AddDump ( Context  ctx)
virtual

Adds the minidump file to the debug report.

Minidumps are only available under recent Win32 versions (dbghlp32.dll can be installed under older systems to make minidumps available).

bool wxDebugReport::AddExceptionContext ( )

The same as calling AddContext(Context_Exception).

bool wxDebugReport::AddExceptionDump ( )

The same as calling AddDump(Context_Exception).

virtual void wxDebugReport::AddFile ( const wxString filename,
const wxString description 
)
virtual

Add another file to the report.

If filename is an absolute path, it is copied to a file in the debug report directory with the same name. Otherwise the file will be searched in the temporary directory returned by GetDirectory().

The argument description only exists to be displayed to the user in the report summary shown by wxDebugReportPreview.

See Also
GetDirectory(), AddText()
bool wxDebugReport::AddText ( const wxString filename,
const wxString text,
const wxString description 
)

This is a convenient wrapper around AddFile().

It creates the file with the given name and writes text to it, then adds the file to the report. The filename shouldn't contain the path.

Returns
true if file could be added successfully, false if an IO error occurred.
virtual void wxDebugReport::DoAddCustomContext ( wxXmlNode nodeRoot)
protectedvirtual

This function may be overridden to add arbitrary custom context to the XML context file created by AddContext().

By default, it does nothing.

virtual bool wxDebugReport::DoAddExceptionInfo ( wxXmlNode nodeContext)
protectedvirtual

This function may be overridden to modify the contents of the exception tag in the XML context file.

virtual bool wxDebugReport::DoAddLoadedModules ( wxXmlNode nodeModules)
protectedvirtual

This function may be overridden to modify the contents of the modules tag in the XML context file.

virtual bool wxDebugReport::DoAddSystemInfo ( wxXmlNode nodeSystemInfo)
protectedvirtual

This function may be overridden to modify the contents of the system tag in the XML context file.

const wxString& wxDebugReport::GetDirectory ( ) const

This method should be used to construct the full name of the files which you wish to add to the report using AddFile().

Returns
The name of the temporary directory used for the files in this report.
bool wxDebugReport::GetFile ( size_t  n,
wxString name,
wxString desc 
) const

Retrieves the name (relative to GetDirectory()) and the description of the file with the given index.

If n is greater than or equal to the number of files, then false is returned.

size_t wxDebugReport::GetFilesCount ( ) const

Gets the current number files in this report.

virtual wxString wxDebugReport::GetReportName ( ) const
virtual

Gets the name used as a base name for various files, by default wxApp::GetAppName() is used.

bool wxDebugReport::IsOk ( ) const

Returns true if the object was successfully initialized.

If this method returns false the report can't be used.

bool wxDebugReport::Process ( )

Processes this report: the base class simply notifies the user that the report has been generated.

This is usually not enough – instead you should override this method to do something more useful to you.

void wxDebugReport::RemoveFile ( const wxString name)

Removes the file from report: this is used by wxDebugReportPreview to allow the user to remove files potentially containing private information from the report.

void wxDebugReport::Reset ( )

Resets the directory name we use.

The object can't be used any more after this as it becomes uninitialized and invalid.