mirror of
https://github.com/1dot13/source.git
synced 2026-07-22 13:40:22 +02:00
majcostaandGitHub
aaa8b094c9
UTIL is never used, and JA2 is always used. assumption being we'll never make 1.13 for Wizardry 8. video2.h doesn't exist, which prevented me from deleting it.
657 lines
15 KiB
C++
657 lines
15 KiB
C++
|
|
// JA2
|
|
|
|
//**************************************************************************
|
|
//
|
|
// Filename : debug.c
|
|
//
|
|
// Purpose : debug manager implementation
|
|
//
|
|
// Modification history :
|
|
//
|
|
// xxxxx96:LH - Creation
|
|
// xxnov96:HJH - made it work
|
|
//
|
|
//**************************************************************************
|
|
|
|
// Because we're in a library, define SGP_DEBUG here - the client may not always
|
|
// use the code to write text, because the header switches on the define
|
|
//#define SGP_DEBUG
|
|
//#undef _DEBUG
|
|
|
|
// WDS: Note: To compile with VS2005 in release mode you might have to not define SGP_DEBUG and
|
|
// undefine _DEBUG or you get linker errors.
|
|
|
|
|
|
#include "types.h"
|
|
#include <windows.h>
|
|
#include <stdio.h>
|
|
#include <string>
|
|
#include <sstream>
|
|
#include "debug.h"
|
|
|
|
//Kris addition
|
|
#include "screenids.h"
|
|
#include "Sys Globals.h"
|
|
#include "jascreens.h"
|
|
#include "gameloop.h"
|
|
#include "input.h"
|
|
|
|
// CJC added
|
|
#ifndef _NO_DEBUG_TXT
|
|
#include "fileman.h"
|
|
#endif
|
|
#include "GameSettings.h"
|
|
#include "SaveLoadGame.h"
|
|
|
|
#include "debug_util.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
BOOLEAN gfRecordToFile = FALSE;
|
|
BOOLEAN gfRecordToDebugger = TRUE;
|
|
|
|
// moved from header file: 24mar98:HJH
|
|
UINT32 guiProfileStart, guiExecutions, guiProfileTime;
|
|
INT32 giProfileCount;
|
|
|
|
// Had to move these outside the ifdef SGP_DEBUG below, because
|
|
// they are required for the String() function, which is NOT a
|
|
// debug-mode only function, it's used in release-mode as well! -- DB
|
|
|
|
CHAR8 gubAssertString[512];
|
|
|
|
#define MAX_MSG_LENGTH2 512
|
|
CHAR8 gbTmpDebugString[8][MAX_MSG_LENGTH2];
|
|
UINT8 gubStringIndex = 0;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#ifdef SGP_DEBUG
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
//**************************************************************************
|
|
//
|
|
// Defines
|
|
//
|
|
//**************************************************************************
|
|
|
|
#define BUFSIZE 100
|
|
#define TIMER_TIMEOUT 1000
|
|
|
|
//**************************************************************************
|
|
//
|
|
// Variables
|
|
//
|
|
//**************************************************************************
|
|
|
|
|
|
UINT32 guiTimerID = 0;
|
|
|
|
bool gfDebugTopics[MAX_TOPICS_ALLOTED];
|
|
|
|
// remove debug .txt file
|
|
void RemoveDebugText( void );
|
|
|
|
STRING512 debugLogFileName;
|
|
FILE * debugLogFile = 0;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
//**************************************************************************
|
|
//
|
|
// Functions
|
|
//
|
|
//**************************************************************************
|
|
|
|
|
|
//**************************************************************************
|
|
//
|
|
// DbgGetLogFileName
|
|
//
|
|
//
|
|
//
|
|
// Parameter List :
|
|
// Return Value :
|
|
// Modification history :
|
|
//
|
|
// xxjun98:CJC ->creation
|
|
//
|
|
//**************************************************************************
|
|
bool DbgGetLogFileName( STRING512 pcName )
|
|
{
|
|
// use the provided buffer to get the directory name, then tack on
|
|
// "\debug.txt"
|
|
#ifndef _NO_DEBUG_TXT
|
|
if ( ! GetExecutableDirectory( pcName ) )
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if ( strlen( pcName ) > (512 - strlen( "\\debug.txt" ) - 1 ) )
|
|
{
|
|
// no room!
|
|
return false;
|
|
}
|
|
|
|
strcat( pcName, "\\debug.txt" );
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
//**************************************************************************
|
|
//
|
|
// DbgInitialize
|
|
//
|
|
//
|
|
//
|
|
// Parameter List :
|
|
// Return Value :
|
|
// Modification history :
|
|
//
|
|
// xxnov96:HJH ->creation
|
|
//
|
|
//**************************************************************************
|
|
|
|
bool DbgInitialize()
|
|
{
|
|
DbgClearAllTopics();
|
|
|
|
gfRecordToFile = TRUE;
|
|
gfRecordToDebugger = TRUE;
|
|
gubAssertString[0] = '\0';
|
|
|
|
#ifndef _NO_DEBUG_TXT
|
|
if (! DbgGetLogFileName( debugLogFileName ) ) {
|
|
return false;
|
|
}
|
|
// clear debug text file out
|
|
RemoveDebugText( );
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
//**************************************************************************
|
|
//
|
|
// DbgShutdown
|
|
//
|
|
//
|
|
//
|
|
// Parameter List :
|
|
// Return Value :
|
|
// Modification history :
|
|
//
|
|
// xxnov96:HJH ->creation
|
|
//
|
|
//**************************************************************************
|
|
|
|
void DbgShutdown()
|
|
{
|
|
DbgMessageReal( -1, CLIENT_SHUTDOWN, 0, "SGP Going Down" );
|
|
}
|
|
|
|
|
|
//**************************************************************************
|
|
//
|
|
// DbgTopicRegistration
|
|
//
|
|
//
|
|
// Parameter List :
|
|
// Return Value :
|
|
// Modification history :
|
|
//
|
|
// June 97: BR ->creation
|
|
//
|
|
//**************************************************************************
|
|
|
|
void DbgTopicRegistration( unsigned ubCmd, const unsigned usTopicID, const char *zMessage )
|
|
{
|
|
if ( usTopicID == NULL )
|
|
return;
|
|
|
|
AssertGE(ubCmd, TOPIC_REGISTER);
|
|
AssertLE(ubCmd, TOPIC_UNREGISTER);
|
|
|
|
if( ubCmd == TOPIC_REGISTER )
|
|
{
|
|
gfDebugTopics[ usTopicID ] = true;
|
|
DbgMessageReal(usTopicID, TOPIC_MESSAGE, DBG_LEVEL_0, zMessage );
|
|
}
|
|
else if( ubCmd == TOPIC_UNREGISTER )
|
|
{
|
|
if ( usTopicID >= MAX_TOPICS_ALLOTED )
|
|
return;
|
|
|
|
DbgMessageReal( usTopicID, TOPIC_MESSAGE, DBG_LEVEL_0, zMessage );
|
|
gfDebugTopics[ usTopicID ] = false;
|
|
}
|
|
}
|
|
|
|
|
|
// *************************************************************************
|
|
// Clear the debug txt file out to prevent it from getting huge
|
|
//
|
|
//
|
|
// *************************************************************************
|
|
|
|
void RemoveDebugText()
|
|
{
|
|
DeleteFile( debugLogFileName );
|
|
debugLogFile = 0;
|
|
}
|
|
|
|
|
|
//**************************************************************************
|
|
//
|
|
// DbgClearAllTopics
|
|
//
|
|
//
|
|
// Parameter List :
|
|
// Return Value :
|
|
// Modification history :
|
|
//
|
|
// June 97: BR ->creation
|
|
//
|
|
//**************************************************************************
|
|
|
|
void DbgClearAllTopics( void )
|
|
{
|
|
for( unsigned usIndex = 0; usIndex < MAX_TOPICS_ALLOTED; usIndex++)
|
|
{
|
|
gfDebugTopics[ usIndex ] = false;
|
|
}
|
|
}
|
|
|
|
//**************************************************************************
|
|
//
|
|
// DbgMessageReal
|
|
//
|
|
//
|
|
//
|
|
// Parameter List :
|
|
// Return Value :
|
|
// Modification history :
|
|
//
|
|
// xxnov96:HJH ->creation
|
|
//
|
|
//**************************************************************************
|
|
void DbgMessageReal(unsigned uiTopicId, unsigned uiCommand, unsigned uiDebugLevel, const char* strMessage)
|
|
{
|
|
#ifndef _NO_DEBUG_TXT
|
|
static FILE *OutFile = 0;
|
|
#endif
|
|
// Check for a registered topic ID
|
|
if ( (uiTopicId < MAX_TOPICS_ALLOTED) && (gfDebugTopics[uiTopicId]) )
|
|
{
|
|
OutputDebugString ( strMessage );
|
|
OutputDebugString ( "\n" );
|
|
|
|
//add _NO_DEBUG_TXT to your SGP preprocessor definitions to avoid this f**king huge file from
|
|
//slowly growing behind the scenes!!!!
|
|
#ifndef _NO_DEBUG_TXT
|
|
if (!debugLogFile)
|
|
debugLogFile = fopen(debugLogFileName, "a+t");
|
|
if (debugLogFile) {
|
|
fprintf(debugLogFile, "%s\n", strMessage);
|
|
fflush( debugLogFile );
|
|
}
|
|
#endif
|
|
}
|
|
}
|
|
|
|
//**************************************************************************
|
|
//
|
|
// DbgSetDebugLevel
|
|
//
|
|
//
|
|
//
|
|
// Parameter List :
|
|
// Return Value :
|
|
// Modification history :
|
|
//
|
|
// 11nov96:HJH ->creation
|
|
//
|
|
//**************************************************************************
|
|
|
|
bool DbgSetDebugLevel(unsigned uiTopicId, unsigned uiDebugLevel)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void _DebugRecordToFile(BOOLEAN gfState)
|
|
{
|
|
gfRecordToFile = gfState;
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void _DebugRecordToDebugger(BOOLEAN gfState)
|
|
{
|
|
gfRecordToDebugger = gfState;
|
|
}
|
|
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// Wiz8 compatible debug messaging
|
|
|
|
void _DebugMessage(const char *pString, unsigned uiLineNum, const char *pSourceFile)
|
|
{
|
|
CHAR8 ubOutputString[512];
|
|
|
|
//
|
|
// Build the output string
|
|
//
|
|
|
|
sprintf( ubOutputString, "{ %ld } %s [Line %d in %s]\n", GetTickCount(), pString, uiLineNum, pSourceFile );
|
|
|
|
//
|
|
// Output to debugger
|
|
//
|
|
|
|
if (gfRecordToDebugger)
|
|
{
|
|
OutputDebugString( (LPCSTR) ubOutputString );
|
|
}
|
|
|
|
//
|
|
// Record to file if required
|
|
//
|
|
|
|
#ifndef _NO_DEBUG_TXT
|
|
if (gfRecordToFile)
|
|
{
|
|
if (!debugLogFile)
|
|
debugLogFile = fopen( debugLogFileName, "a+t" );
|
|
if (debugLogFile) {
|
|
fputs( ubOutputString, debugLogFile );
|
|
fflush( debugLogFile );
|
|
}
|
|
}
|
|
#endif
|
|
}
|
|
#else
|
|
bool DbgInitialize() { return true; };
|
|
void DbgShutdown() {};
|
|
#endif
|
|
|
|
|
|
#ifdef FORCE_ASSERTS_ON
|
|
|
|
|
|
//////////////////////////////////////////////////////////////////////
|
|
|
|
extern HVOBJECT FontObjs[25];
|
|
|
|
#include <vfs/Core/vfs_os_functions.h>
|
|
void _FailMessage(const char* message, unsigned lineNum, const char * functionName, const char* sourceFileName)
|
|
{
|
|
// This function shouldn't recurse
|
|
static bool alreadyInThisFunction = false;
|
|
if (alreadyInThisFunction)
|
|
return;
|
|
alreadyInThisFunction = true;
|
|
|
|
sgp::dumpStackTrace(message);
|
|
|
|
std::stringstream basicInformation;
|
|
basicInformation << "Assertion Failure [Line " << lineNum;
|
|
if (functionName) {
|
|
basicInformation << " in function " << functionName;
|
|
}
|
|
basicInformation << " in file " << sourceFileName << "]";
|
|
|
|
std::stringstream outputString;
|
|
outputString << "{ " << GetTickCount() << " } " << basicInformation.str();
|
|
|
|
//Build the output strings
|
|
if( message )
|
|
sprintf( gubAssertString, message );
|
|
else
|
|
sprintf( gubAssertString, "" );
|
|
|
|
//Output to debugger
|
|
if (gfRecordToDebugger)
|
|
OutputDebugString( outputString.str().c_str() );
|
|
|
|
DbgMessage( TOPIC_GAME, DBG_LEVEL_1, outputString.str().c_str());
|
|
|
|
//This will actually bring up a screen that prints out the assert message
|
|
//until the user hits esc or alt-x.
|
|
// WDS - Automatically try to save when an assertion failure occurs
|
|
if (gGameExternalOptions.autoSaveOnAssertionFailure &&
|
|
!alreadySaving) {
|
|
sprintf( gubErrorText, "%s. Attempting to do a debug save as SaveGame%d.sav (this may fail)", basicInformation.str().c_str(), SAVE__ASSERTION_FAILURE );
|
|
} else {
|
|
sprintf( gubErrorText, "%s", basicInformation.str().c_str());
|
|
}
|
|
SetPendingNewScreen( ERROR_SCREEN );
|
|
SetCurrentScreen( ERROR_SCREEN );
|
|
|
|
// WDS - Automatically try to save when an assertion failure occurs
|
|
if (gGameExternalOptions.autoSaveOnAssertionFailure &&
|
|
!alreadySaving) {
|
|
SaveGame( SAVE__ASSERTION_FAILURE, L"Assertion Failure Auto Save" );
|
|
}
|
|
|
|
MSG Message;
|
|
while (gfProgramIsRunning)
|
|
{
|
|
if (PeekMessage(&Message, NULL, 0, 0, PM_NOREMOVE))
|
|
{ // We have a message on the WIN95 queue, let's get it
|
|
if (!GetMessage(&Message, NULL, 0, 0))
|
|
{ // It's quitting time
|
|
continue;
|
|
}
|
|
// Ok, now that we have the message, let's handle it
|
|
TranslateMessage(&Message);
|
|
DispatchMessage(&Message);
|
|
}
|
|
else
|
|
{ // Windows hasn't processed any messages, therefore we handle the rest
|
|
GameLoop();
|
|
gfSGPInputReceived = FALSE;
|
|
}
|
|
}
|
|
|
|
alreadyInThisFunction = false;
|
|
exit(0);
|
|
}
|
|
|
|
#endif
|
|
|
|
// This is NOT a _DEBUG only function! It is also needed in
|
|
// release mode builds. -- DB
|
|
STR8 String(const STR8 String, ...)
|
|
{
|
|
|
|
va_list ArgPtr;
|
|
UINT8 usIndex;
|
|
|
|
// Record string index. This index is used since we live in a multitasking environment.
|
|
// It is still not bulletproof, but it's better than a single string
|
|
usIndex = gubStringIndex++;
|
|
if (gubStringIndex == 8)
|
|
{ // reset string pointer
|
|
gubStringIndex = 0;
|
|
}
|
|
|
|
va_start(ArgPtr, String);
|
|
vsprintf( gbTmpDebugString[usIndex], String, ArgPtr);
|
|
va_end(ArgPtr);
|
|
|
|
return gbTmpDebugString[usIndex];
|
|
|
|
}
|
|
|
|
void _ExceptionMessage( sgp::Exception &ex )
|
|
{
|
|
g_ExceptionList.clear();
|
|
std::list<sgp::Exception::Excp>::iterator it = ex._msg.begin();
|
|
for(; it!=ex._msg.end(); ++it)
|
|
{
|
|
SExceptionData exd;
|
|
exd.message = (*it).msg;
|
|
exd.function = (*it).function;
|
|
exd.file = (*it).file;
|
|
exd.line = (*it).line;
|
|
g_ExceptionList.push_back(exd);
|
|
}
|
|
_FailMessage("",0,"");
|
|
}
|
|
|
|
void _ExceptionMessage( vfs::Exception &ex )
|
|
{
|
|
g_ExceptionList.clear();
|
|
vfs::Exception::CALLSTACK::iterator it = ex.m_CallStack.begin();
|
|
for(; it!=ex.m_CallStack.end(); ++it)
|
|
{
|
|
SExceptionData exd;
|
|
exd.message = (*it).message;
|
|
exd.function = (*it).function;
|
|
exd.file = (*it).file;
|
|
exd.line = (*it).line;
|
|
g_ExceptionList.push_back(exd);
|
|
}
|
|
_FailMessage("",0,"");
|
|
}
|
|
|
|
#include <vfs/Core/vfs_string.h>
|
|
#include <vfs/Core/vfs_debug.h>
|
|
|
|
sgp::Exception::Exception(sgp::WString const& msg SGP_CALLER_LOCATION_IMPL)
|
|
{
|
|
Excp excp;
|
|
excp.line = line;
|
|
excp.file = file ? file : "";
|
|
excp.function = function ? function : "";
|
|
excp.msg = msg.str;
|
|
|
|
_msg.push_back(excp);
|
|
}
|
|
|
|
sgp::Exception::Exception(sgp::WString const& msg, Exception& ex SGP_CALLER_LOCATION_IMPL)
|
|
{
|
|
_msg.insert(_msg.end(), ex._msg.begin(), ex._msg.end());
|
|
|
|
Excp excp;
|
|
excp.line = line;
|
|
excp.file = file ? file : "";
|
|
excp.function = function ? function : "";
|
|
excp.msg = msg.str;
|
|
|
|
_msg.push_back(excp);
|
|
}
|
|
|
|
#if defined(USE_VFS)
|
|
sgp::Exception::Exception(sgp::WString const& msg, vfs::Exception& ex SGP_CALLER_LOCATION_IMPL)
|
|
{
|
|
vfs::Exception::CALLSTACK::iterator it = ex.m_CallStack.begin();
|
|
for(; it != ex.m_CallStack.end(); ++it)
|
|
{
|
|
Excp excp;
|
|
excp.file = it->file.utf8();
|
|
excp.function = it->function.utf8();
|
|
excp.line = it->line;
|
|
excp.msg = it->message.c_wcs();
|
|
_msg.push_back(excp);
|
|
}
|
|
|
|
Excp excp;
|
|
excp.line = line;
|
|
excp.file = file ? file : "";
|
|
excp.function = function ? function : "";
|
|
excp.msg = msg.str;
|
|
|
|
_msg.push_back(excp);
|
|
}
|
|
#endif
|
|
|
|
sgp::Exception::Exception(WString const& msg, std::exception& ex SGP_CALLER_LOCATION_IMPL)
|
|
{
|
|
if(dynamic_cast<sgp::Exception*>(&ex))
|
|
{
|
|
sgp::Exception& sgp_ex = *static_cast<sgp::Exception*>(&ex);
|
|
_msg.insert(_msg.end(), sgp_ex._msg.begin(), sgp_ex._msg.end());
|
|
}
|
|
else if(dynamic_cast<vfs::Exception*>(&ex))
|
|
{
|
|
vfs::Exception& vfs_ex = *static_cast<vfs::Exception*>(&ex);
|
|
vfs::Exception::CALLSTACK::iterator it = vfs_ex.m_CallStack.begin();
|
|
for(; it != vfs_ex.m_CallStack.end(); ++it)
|
|
{
|
|
Excp excp;
|
|
excp.file = it->file.utf8();
|
|
excp.function = it->function.utf8();
|
|
excp.line = it->line;
|
|
excp.msg = it->message.c_wcs();
|
|
_msg.push_back(excp);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
Excp excp;
|
|
excp.file = "";
|
|
excp.function = "";
|
|
excp.line = -1;
|
|
convert_string(ex.what(), excp.msg);
|
|
_msg.push_back(excp);
|
|
}
|
|
|
|
Excp excp;
|
|
excp.line = line;
|
|
excp.file = file ? file : "";
|
|
excp.function = function ? function : "";
|
|
excp.msg = msg.str;
|
|
|
|
_msg.push_back(excp);
|
|
}
|
|
|
|
|
|
#if defined(_WIN32) || defined(WIN64)
|
|
# define ENDL "\r\n"
|
|
#else
|
|
# define ENDL "\n"
|
|
#endif
|
|
|
|
static std::string gs_exception_string;
|
|
|
|
const char* sgp::Exception::what() const
|
|
{
|
|
// cannot return pointer local variable
|
|
std::stringstream ss;
|
|
ss.str("");
|
|
ss.clear();
|
|
|
|
std::list<Excp>::const_reverse_iterator rit = _msg.rbegin();
|
|
for(; rit != _msg.rend(); ++rit)
|
|
{
|
|
std::string msg;
|
|
convert_string(rit->msg, msg);
|
|
//wss << "========== " << rit->time << " =========="ENDL;
|
|
ss << "File : " << rit->file << ENDL;
|
|
ss << "Line : " << rit->line << ENDL;
|
|
ss << "Location : " << rit->function << ENDL;
|
|
ss << " " << msg << ENDL;
|
|
}
|
|
|
|
gs_exception_string = ss.str();
|
|
return gs_exception_string.c_str();
|
|
}
|
|
|
|
|