mirror of https://github.com/OpenTTD/OpenTTD.git
91 lines
2.7 KiB
C++
91 lines
2.7 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file crashlog.h Functions to be called to log a crash */
|
|
|
|
#ifndef CRASHLOG_H
|
|
#define CRASHLOG_H
|
|
|
|
#include "3rdparty/nlohmann/json.hpp"
|
|
|
|
/**
|
|
* Helper class for creating crash logs.
|
|
*/
|
|
class CrashLog {
|
|
private:
|
|
/** Error message coming from #FatalError(format, ...). */
|
|
static std::string message;
|
|
|
|
/**
|
|
* Convert system crash reason to JSON.
|
|
*
|
|
* @param survey The JSON object.
|
|
*/
|
|
virtual void SurveyCrash(nlohmann::json &survey) const = 0;
|
|
|
|
/**
|
|
* Convert stacktrace to JSON.
|
|
*
|
|
* @param survey The JSON object.
|
|
*/
|
|
virtual void SurveyStacktrace(nlohmann::json &survey) const = 0;
|
|
|
|
/**
|
|
* Execute the func() and return its value. If any exception / signal / crash happens,
|
|
* catch it and return false. This function should, in theory, never not return, even
|
|
* in the worst conditions.
|
|
*
|
|
* @param section_name The name of the section to be executed. Printed when a crash happens.
|
|
* @param func The function to call.
|
|
* @return true iff the function returned true.
|
|
*/
|
|
virtual bool TryExecute(std::string_view section_name, std::function<bool()> &&func) = 0;
|
|
|
|
protected:
|
|
std::string CreateFileName(const char *ext, bool with_dir = true) const;
|
|
|
|
public:
|
|
/** Stub destructor to silence some compilers. */
|
|
virtual ~CrashLog() = default;
|
|
|
|
nlohmann::json survey;
|
|
std::string crashlog_filename;
|
|
std::string crashdump_filename;
|
|
std::string savegame_filename;
|
|
std::string screenshot_filename;
|
|
|
|
void FillCrashLog();
|
|
void PrintCrashLog() const;
|
|
|
|
bool WriteCrashLog();
|
|
virtual bool WriteCrashDump();
|
|
bool WriteSavegame();
|
|
bool WriteScreenshot();
|
|
|
|
void SendSurvey() const;
|
|
|
|
void MakeCrashLog();
|
|
|
|
/**
|
|
* Initialiser for crash logs; do the appropriate things so crashes are
|
|
* handled by our crash handler instead of returning straight to the OS.
|
|
* @note must be implemented by all implementers of CrashLog.
|
|
*/
|
|
static void InitialiseCrashLog();
|
|
|
|
/**
|
|
* Prepare crash log handler for a newly started thread.
|
|
* @note must be implemented by all implementers of CrashLog.
|
|
*/
|
|
static void InitThread();
|
|
|
|
static void SetErrorMessage(const std::string &message);
|
|
static void AfterCrashLogCleanup();
|
|
};
|
|
|
|
#endif /* CRASHLOG_H */
|