// Purpose: declaration of wxDebugReport class
// Author: Vadim Zeitlin
// Created: 2005-01-17
-// RCS-ID: $Id$
// Copyright: (c) 2005 Vadim Zeitlin <vadim@wxwindows.org>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#include "wx/defs.h"
-#if wxUSE_DEBUGREPORT
+#if wxUSE_DEBUGREPORT && wxUSE_XML
-class WXDLLIMPEXP_XML wxXmlNode;
+#include "wx/string.h"
+#include "wx/arrstr.h"
+
+class WXDLLIMPEXP_FWD_XML wxXmlNode;
// ----------------------------------------------------------------------------
// wxDebugReport: generate a debug report, processing is done in derived class
void Reset() { m_dir.clear(); }
- // add another file to the report: the file must already exist, its name is
- // relative to GetDirectory()
+ // add another file to the report: the file must already exist, its name
+ // can be either absolute in which case it is copied to the debug report
+ // directory or relative to GetDirectory()
//
// description is shown to the user in the report summary
- virtual void AddFile(const wxString& name, const wxString& description);
+ virtual void AddFile(const wxString& filename, const wxString& description);
+
+ // convenience function: write the given text to a file with the given name
+ // and then add it to the report (the difference with AddFile() is that the
+ // file will be created by this function and doesn't have to already exist)
+ bool AddText(const wxString& filename,
+ const wxString& text,
+ const wxString& description);
#if wxUSE_STACKWALKER
// add an XML file containing the current or exception context and the
public:
wxDebugReportCompress() { }
+ // you can optionally specify the directory and/or name of the file where
+ // the debug report should be generated, a default location under the
+ // directory containing temporary files will be used if you don't
+ //
+ // both of these functions should be called before Process()ing the report
+ // if they're called at all
+ void SetCompressedFileDirectory(const wxString& dir);
+ void SetCompressedFileBaseName(const wxString& name);
+
// returns the full path of the compressed file (empty if creation failed)
const wxString& GetCompressedFileName() const { return m_zipfile; }
virtual bool DoProcess();
private:
+ // user-specified file directory/base name, use defaults if empty
+ wxString m_zipDir,
+ m_zipName;
+
// full path to the ZIP file we created
wxString m_zipfile;
};
wxDebugReportUpload(const wxString& url,
const wxString& input,
const wxString& action,
- const wxString& curl = _T("curl"));
+ const wxString& curl = wxT("curl"));
protected:
virtual bool DoProcess();
#endif // wxUSE_GUI
-#endif // wxUSE_DEBUGREPORT
+#endif // wxUSE_DEBUGREPORT && wxUSE_XML
#endif // _WX_DEBUGRPT_H_
-