You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
122 lines
4.8 KiB
C++
122 lines
4.8 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
|
|
|
|
/**
|
|
* Helper class for creating crash logs.
|
|
*/
|
|
class CrashLog {
|
|
private:
|
|
/** Error message coming from #FatalError(format, ...). */
|
|
static std::string message;
|
|
protected:
|
|
/**
|
|
* Writes OS' version to the buffer.
|
|
* @param buffer The begin where to write at.
|
|
* @param last The last position in the buffer to write to.
|
|
* @return the position of the \c '\0' character after the buffer.
|
|
*/
|
|
virtual char *LogOSVersion(char *buffer, const char *last) const = 0;
|
|
|
|
/**
|
|
* Writes compiler (and its version, if available) to the buffer.
|
|
* @param buffer The begin where to write at.
|
|
* @param last The last position in the buffer to write to.
|
|
* @return the position of the \c '\0' character after the buffer.
|
|
*/
|
|
virtual char *LogCompiler(char *buffer, const char *last) const;
|
|
|
|
/**
|
|
* Writes actually encountered error to the buffer.
|
|
* @param buffer The begin where to write at.
|
|
* @param last The last position in the buffer to write to.
|
|
* @param message Message passed to use for errors.
|
|
* @return the position of the \c '\0' character after the buffer.
|
|
*/
|
|
virtual char *LogError(char *buffer, const char *last, const char *message) const = 0;
|
|
|
|
/**
|
|
* Writes the stack trace to the buffer, if there is information about it
|
|
* available.
|
|
* @param buffer The begin where to write at.
|
|
* @param last The last position in the buffer to write to.
|
|
* @return the position of the \c '\0' character after the buffer.
|
|
*/
|
|
virtual char *LogStacktrace(char *buffer, const char *last) const = 0;
|
|
|
|
/**
|
|
* Writes information about the data in the registers, if there is
|
|
* information about it available.
|
|
* @param buffer The begin where to write at.
|
|
* @param last The last position in the buffer to write to.
|
|
* @return the position of the \c '\0' character after the buffer.
|
|
*/
|
|
virtual char *LogRegisters(char *buffer, const char *last) const;
|
|
|
|
/**
|
|
* Writes the dynamically linked libraries/modules to the buffer, if there
|
|
* is information about it available.
|
|
* @param buffer The begin where to write at.
|
|
* @param last The last position in the buffer to write to.
|
|
* @return the position of the \c '\0' character after the buffer.
|
|
*/
|
|
virtual char *LogModules(char *buffer, const char *last) const;
|
|
|
|
|
|
char *LogOpenTTDVersion(char *buffer, const char *last) const;
|
|
char *LogConfiguration(char *buffer, const char *last) const;
|
|
char *LogLibraries(char *buffer, const char *last) const;
|
|
char *LogGamelog(char *buffer, const char *last) const;
|
|
char *LogRecentNews(char *buffer, const char *list) const;
|
|
|
|
int CreateFileName(char *filename, const char *filename_last, const char *ext, bool with_dir = true) const;
|
|
|
|
public:
|
|
/** Stub destructor to silence some compilers. */
|
|
virtual ~CrashLog() = default;
|
|
|
|
char *FillCrashLog(char *buffer, const char *last) const;
|
|
bool WriteCrashLog(const char *buffer, char *filename, const char *filename_last) const;
|
|
|
|
/**
|
|
* Write the (crash) dump to a file.
|
|
* @note On success the filename will be filled with the full path of the
|
|
* crash dump file. Make sure filename is at least \c MAX_PATH big.
|
|
* @param filename Output for the filename of the written file.
|
|
* @param filename_last The last position in the filename buffer.
|
|
* @return if less than 0, error. If 0 no dump is made, otherwise the dump
|
|
* was successful (not all OSes support dumping files).
|
|
*/
|
|
virtual int WriteCrashDump(char *filename, const char *filename_last) const;
|
|
bool WriteSavegame(char *filename, const char *filename_last) const;
|
|
bool WriteScreenshot(char *filename, const char *filename_last) const;
|
|
|
|
bool MakeCrashLog() const;
|
|
|
|
/**
|
|
* 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 */
|