X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ce4fd7b577cdeb1ceb085cb1380c0df97b6ceef4..e276acb530f41f0b87c4576c0215201a8a767dff:/include/wx/debugrpt.h diff --git a/include/wx/debugrpt.h b/include/wx/debugrpt.h index b193fc550f..86ecdb5ab3 100644 --- a/include/wx/debugrpt.h +++ b/include/wx/debugrpt.h @@ -13,20 +13,23 @@ #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 // ---------------------------------------------------------------------------- -class wxDebugReport +class WXDLLIMPEXP_QA wxDebugReport { public: // this is used for the functions which may report either the current state // or the state during the last (fatal) exception - enum Context { Context_Curent, Context_Exception }; + enum Context { Context_Current, Context_Exception }; // ctor creates a temporary directory where we create the files which will @@ -48,21 +51,31 @@ public: 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 // stack trace - bool AddCurrentContext() { return AddContext(Context_Curent); } + bool AddCurrentContext() { return AddContext(Context_Current); } bool AddExceptionContext() { return AddContext(Context_Exception); } virtual bool AddContext(Context ctx); +#endif #if wxUSE_CRASHREPORT // add a file with crash report - bool AddCurrentDump() { return AddDump(Context_Curent); } + bool AddCurrentDump() { return AddDump(Context_Current); } bool AddExceptionDump() { return AddDump(Context_Exception); } virtual bool AddDump(Context ctx); #endif // wxUSE_CRASHREPORT @@ -90,11 +103,13 @@ public: void RemoveFile(const wxString& name); protected: +#if wxUSE_STACKWALKER // used by AddContext() virtual bool DoAddSystemInfo(wxXmlNode *nodeSystemInfo); virtual bool DoAddLoadedModules(wxXmlNode *nodeModules); virtual bool DoAddExceptionInfo(wxXmlNode *nodeContext); virtual void DoAddCustomContext(wxXmlNode * WXUNUSED(nodeRoot)) { } +#endif // used by Process() virtual bool DoProcess(); @@ -114,7 +129,7 @@ private: // wxDebugReportCompress: compress all files of this debug report in a .ZIP // ---------------------------------------------------------------------------- -class wxDebugReportCompress : public wxDebugReport +class WXDLLIMPEXP_QA wxDebugReportCompress : public wxDebugReport { public: wxDebugReportCompress() { } @@ -134,7 +149,7 @@ private: // wxDebugReportUploader: uploads compressed file using HTTP POST request // ---------------------------------------------------------------------------- -class wxDebugReportUpload : public wxDebugReportCompress +class WXDLLIMPEXP_QA wxDebugReportUpload : public wxDebugReportCompress { public: // this class will upload the compressed file created by its base class to @@ -182,7 +197,7 @@ private: // to veto report entirely or remove some parts of it // ---------------------------------------------------------------------------- -class wxDebugReportPreview +class WXDLLIMPEXP_QA wxDebugReportPreview { public: // ctor is trivial @@ -205,7 +220,7 @@ public: // wxDebugReportPreviewStd: standard debug report preview window // ---------------------------------------------------------------------------- -class wxDebugReportPreviewStd : public wxDebugReportPreview +class WXDLLIMPEXP_QA wxDebugReportPreviewStd : public wxDebugReportPreview { public: wxDebugReportPreviewStd() { } @@ -215,7 +230,6 @@ public: #endif // wxUSE_GUI -#endif // wxUSE_DEBUGREPORT +#endif // wxUSE_DEBUGREPORT && wxUSE_XML #endif // _WX_DEBUGRPT_H_ -