Files
@ r23043:1d97d12bf3bc
Branch filter:
Location: cpp/openttd-patchpack/source/src/crashlog.h - annotation
r23043:1d97d12bf3bc
4.7 KiB
text/x-c
Update: Translations from eints
italian: 2 changes by lorenzodv
italian: 2 changes by lorenzodv
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r14293:a7858a5997d3 r14293:a7858a5997d3 r14293:a7858a5997d3 r14293:a7858a5997d3 r14293:a7858a5997d3 r14293:a7858a5997d3 r14293:a7858a5997d3 r14293:a7858a5997d3 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r13060:e57594b0ca84 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r19944:25a78576fb5e r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r22793:0c646694741d r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r14680:22ff8daf391f r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r13622:200502780bca r13622:200502780bca r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 r12947:776ad783fe07 | /* $Id$ */
/*
* 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:
/** Pointer to the error message. */
static const char *message;
/** Temporary 'local' location of the buffer. */
static char *gamelog_buffer;
/** Temporary 'local' location of the end of the buffer. */
static const char *gamelog_last;
static void GamelogFillCrashLog(const char *s);
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 possible errors. Can be NULL.
* @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;
public:
/** Stub destructor to silence some compilers. */
virtual ~CrashLog() {}
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();
static void SetErrorMessage(const char *message);
static void AfterCrashLogCleanup();
};
#endif /* CRASHLOG_H */
|