OpenTTD
|
Helper class for creating crash logs. More...
#include <crashlog.h>
Public Member Functions | |
virtual | ~CrashLog () |
Stub destructor to silence some compilers. | |
char * | FillCrashLog (char *buffer, const char *last) const |
Fill the crash log buffer with all data of a crash log. | |
bool | WriteCrashLog (const char *buffer, char *filename, const char *filename_last) const |
Write the crash log to a file. | |
virtual int | WriteCrashDump (char *filename, const char *filename_last) const |
Write the (crash) dump to a file. | |
bool | WriteSavegame (char *filename, const char *filename_last) const |
Write the (crash) savegame to a file. | |
bool | WriteScreenshot (char *filename, const char *filename_last) const |
Write the (crash) screenshot to a file. | |
bool | MakeCrashLog () const |
Makes the crash log, writes it to a file and then subsequently tries to make a crash dump and crash savegame. |
Static Public Member Functions | |
static void | InitialiseCrashLog () |
Initialiser for crash logs; do the appropriate things so crashes are handled by our crash handler instead of returning straight to the OS. | |
static void | SetErrorMessage (const char *message) |
Sets a message for the error message handler. | |
static void | AfterCrashLogCleanup () |
Try to close the sound/video stuff so it doesn't keep lingering around incorrect video states or so, e.g. |
Protected Member Functions | |
virtual char * | LogOSVersion (char *buffer, const char *last) const =0 |
Writes OS' version to the buffer. | |
virtual char * | LogCompiler (char *buffer, const char *last) const |
Writes compiler (and its version, if available) to the buffer. | |
virtual char * | LogError (char *buffer, const char *last, const char *message) const =0 |
Writes actually encountered error to the buffer. | |
virtual char * | LogStacktrace (char *buffer, const char *last) const =0 |
Writes the stack trace to the buffer, if there is information about it available. | |
virtual char * | LogRegisters (char *buffer, const char *last) const |
Writes information about the data in the registers, if there is information about it available. | |
virtual char * | LogModules (char *buffer, const char *last) const |
Writes the dynamically linked libraries/modules to the buffer, if there is information about it available. | |
char * | LogOpenTTDVersion (char *buffer, const char *last) const |
Writes OpenTTD's version to the buffer. | |
char * | LogConfiguration (char *buffer, const char *last) const |
Writes the (important) configuration settings to the buffer. | |
char * | LogLibraries (char *buffer, const char *last) const |
Writes information (versions) of the used libraries. | |
char * | LogGamelog (char *buffer, const char *last) const |
Writes the gamelog data to the buffer. |
Static Private Member Functions | |
static void | GamelogFillCrashLog (const char *s) |
Helper function for printing the gamelog. |
Static Private Attributes | |
static const char * | message = NULL |
Pointer to the error message. | |
static char * | gamelog_buffer = NULL |
Temporary 'local' location of the buffer. | |
static const char * | gamelog_last = NULL |
Temporary 'local' location of the end of the buffer. |
Helper class for creating crash logs.
Definition at line 18 of file crashlog.h.
|
inlinevirtual |
Stub destructor to silence some compilers.
Definition at line 91 of file crashlog.h.
|
static |
Try to close the sound/video stuff so it doesn't keep lingering around incorrect video states or so, e.g.
keeping dpmi disabled.
Definition at line 490 of file crashlog.cpp.
References SoundDriver::GetInstance(), MusicDriver::GetInstance(), VideoDriver::GetInstance(), and Driver::Stop().
Referenced by HandleCrash().
char * CrashLog::FillCrashLog | ( | char * | buffer, |
const char * | last | ||
) | const |
Fill the crash log buffer with all data of a crash log.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 318 of file crashlog.cpp.
References _date, _date_fract, ConvertDateToYMD(), YearMonthDay::day, LogCompiler(), LogConfiguration(), LogError(), LogGamelog(), LogLibraries(), LogModules(), LogOpenTTDVersion(), LogOSVersion(), LogRegisters(), LogStacktrace(), message, YearMonthDay::month, seprintf(), and YearMonthDay::year.
Referenced by MakeCrashLog(), and CrashLogOSX::MakeCrashLog().
|
staticprivate |
Helper function for printing the gamelog.
s | the string to print. |
Definition at line 293 of file crashlog.cpp.
References gamelog_buffer, gamelog_last, and seprintf().
Referenced by LogGamelog().
|
static |
Initialiser for crash logs; do the appropriate things so crashes are handled by our crash handler instead of returning straight to the OS.
Definition at line 251 of file crashlog_osx.cpp.
References endof, and HandleCrash().
|
protectedvirtual |
Writes compiler (and its version, if available) to the buffer.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 45 of file crashlog.cpp.
References seprintf().
Referenced by FillCrashLog().
|
protected |
Writes the (important) configuration settings to the buffer.
E.g. graphics set, sound set, blitter and AIs.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 126 of file crashlog.cpp.
References _current_language, _local_company, _network_server, _networking, LanguageMetadata::file, FS_LARGE, FS_MONO, FS_NORMAL, FS_SMALL, FontCache::Get(), BlitterFactory::GetCurrentBlitter(), Game::GetInfo(), SoundDriver::GetInstance(), MusicDriver::GetInstance(), VideoDriver::GetInstance(), Driver::GetName(), ScriptInfo::GetName(), BaseMedia< MusicSet >::GetUsedSet(), BaseMedia< GraphicsSet >::GetUsedSet(), BaseMedia< SoundsSet >::GetUsedSet(), ScriptInfo::GetVersion(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, BaseSet< T, Tnum_files, Tsearch_in_tars >::name, seprintf(), and BaseSet< T, Tnum_files, Tsearch_in_tars >::version.
Referenced by FillCrashLog().
|
protectedpure virtual |
Writes actually encountered error to the buffer.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
message | Message passed to use for possible errors. Can be NULL. |
'\0'
character after the buffer. Referenced by FillCrashLog().
|
protected |
Writes the gamelog data to the buffer.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 304 of file crashlog.cpp.
References gamelog_buffer, gamelog_last, GamelogFillCrashLog(), GamelogPrint(), and seprintf().
Referenced by FillCrashLog().
|
protected |
Writes information (versions) of the used libraries.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 222 of file crashlog.cpp.
References seprintf().
Referenced by FillCrashLog().
|
protectedvirtual |
Writes the dynamically linked libraries/modules to the buffer, if there is information about it available.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 75 of file crashlog.cpp.
Referenced by FillCrashLog().
|
protected |
Writes OpenTTD's version to the buffer.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 87 of file crashlog.cpp.
References seprintf(), and TTD_LITTLE_ENDIAN.
Referenced by FillCrashLog().
|
protectedpure virtual |
Writes OS' version to the buffer.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Referenced by FillCrashLog().
|
protectedvirtual |
Writes information about the data in the registers, if there is information about it available.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Definition at line 69 of file crashlog.cpp.
Referenced by FillCrashLog().
|
protectedpure virtual |
Writes the stack trace to the buffer, if there is information about it available.
buffer | The begin where to write at. |
last | The last position in the buffer to write to. |
'\0'
character after the buffer. Referenced by FillCrashLog().
bool CrashLog::MakeCrashLog | ( | ) | const |
Makes the crash log, writes it to a file and then subsequently tries to make a crash dump and crash savegame.
It uses DEBUG to write information like paths to the console.
Definition at line 422 of file crashlog.cpp.
References FillCrashLog(), lastof, WriteCrashDump(), WriteCrashLog(), WriteSavegame(), and WriteScreenshot().
Referenced by HandleCrash().
|
static |
Sets a message for the error message handler.
message | The error message of the error. |
Definition at line 481 of file crashlog.cpp.
References message.
Referenced by error().
|
virtual |
Write the (crash) dump to a file.
MAX_PATH
big. filename | Output for the filename of the written file. |
filename_last | The last position in the filename buffer. |
Definition at line 366 of file crashlog.cpp.
Referenced by MakeCrashLog().
bool CrashLog::WriteCrashLog | ( | const char * | buffer, |
char * | filename, | ||
const char * | filename_last | ||
) | const |
Write the crash log to a file.
MAX_PATH
big. buffer | The begin of the buffer to write to the disk. |
filename | Output for the filename of the written file. |
filename_last | The last position in the filename buffer. |
Definition at line 352 of file crashlog.cpp.
References _personal_dir, FioFCloseFile(), FioFOpenFile(), NO_DIRECTORY, and seprintf().
Referenced by MakeCrashLog(), and CrashLogOSX::MakeCrashLog().
bool CrashLog::WriteSavegame | ( | char * | filename, |
const char * | filename_last | ||
) | const |
Write the (crash) savegame to a file.
MAX_PATH
big. filename | Output for the filename of the written file. |
filename_last | The last position in the filename buffer. |
Definition at line 380 of file crashlog.cpp.
References _m, _personal_dir, GamelogEmergency(), NO_DIRECTORY, SaveOrLoad(), seprintf(), SL_OK, and SL_SAVE.
Referenced by MakeCrashLog(), and CrashLogOSX::MakeCrashLog().
bool CrashLog::WriteScreenshot | ( | char * | filename, |
const char * | filename_last | ||
) | const |
Write the (crash) screenshot to a file.
MAX_PATH
big. filename | Output for the filename of the written file. |
filename_last | The last position in the filename buffer. |
Definition at line 406 of file crashlog.cpp.
References _full_screenshot_name, MakeScreenshot(), SC_CRASHLOG, and strecpy().
Referenced by MakeCrashLog(), and CrashLogOSX::MakeCrashLog().
|
staticprivate |
Temporary 'local' location of the buffer.
Definition at line 24 of file crashlog.h.
Referenced by GamelogFillCrashLog(), and LogGamelog().
|
staticprivate |
Temporary 'local' location of the end of the buffer.
Definition at line 27 of file crashlog.h.
Referenced by GamelogFillCrashLog(), and LogGamelog().
|
staticprivate |
Pointer to the error message.
Definition at line 21 of file crashlog.h.
Referenced by FillCrashLog(), and SetErrorMessage().