scummvm/engines/agi/console.cpp
Martin Kiewitz f840eaf736 AGI: add new debug command "version"
Tries to figure out the game version
It does this by scanning through all game scripts
Sadly there is no better way, because there is no common
location of the game version
2015-11-23 22:51:21 +01:00

463 lines
12 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#include "agi/agi.h"
#include "agi/opcodes.h"
#include "agi/preagi.h"
#include "agi/preagi_mickey.h"
#include "agi/preagi_winnie.h"
namespace Agi {
Console::Console(AgiEngine *vm) : GUI::Debugger() {
_vm = vm;
registerCmd("debug", WRAP_METHOD(Console, Cmd_Debug));
registerCmd("cont", WRAP_METHOD(Console, Cmd_Cont));
registerCmd("agiver", WRAP_METHOD(Console, Cmd_Agiver));
registerCmd("version", WRAP_METHOD(Console, Cmd_Version));
registerCmd("flags", WRAP_METHOD(Console, Cmd_Flags));
registerCmd("logic0", WRAP_METHOD(Console, Cmd_Logic0));
registerCmd("objs", WRAP_METHOD(Console, Cmd_Objs));
registerCmd("runopcode", WRAP_METHOD(Console, Cmd_RunOpcode));
registerCmd("opcode", WRAP_METHOD(Console, Cmd_Opcode));
registerCmd("step", WRAP_METHOD(Console, Cmd_Step));
registerCmd("trigger", WRAP_METHOD(Console, Cmd_Trigger));
registerCmd("vars", WRAP_METHOD(Console, Cmd_Vars));
registerCmd("setvar", WRAP_METHOD(Console, Cmd_SetVar));
registerCmd("setflag", WRAP_METHOD(Console, Cmd_SetFlag));
registerCmd("setobj", WRAP_METHOD(Console, Cmd_SetObj));
registerCmd("room", WRAP_METHOD(Console, Cmd_Room));
registerCmd("bt", WRAP_METHOD(Console, Cmd_BT));
}
bool Console::Cmd_SetVar(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Usage: setvar <varnum> <value>\n");
return true;
}
int p1 = (int)atoi(argv[1]);
int p2 = (int)atoi(argv[2]);
_vm->setvar(p1, p2);
return true;
}
bool Console::Cmd_SetFlag(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Usage: setvar <varnum> <value>\n");
return true;
}
int p1 = (int)atoi(argv[1]);
int p2 = (int)atoi(argv[2]);
_vm->setflag(p1, !!p2);
return true;
}
bool Console::Cmd_SetObj(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Usage: setvar <varnum> <value>\n");
return true;
}
int p1 = (int)atoi(argv[1]);
int p2 = (int)atoi(argv[2]);
_vm->objectSetLocation(p1, p2);
return true;
}
bool Console::Cmd_RunOpcode(int argc, const char **argv) {
if (argc < 2) {
debugPrintf("Usage: runopcode <name> <parameter0> ....\n");
return true;
}
for (int i = 0; logicNamesCmd[i].name; i++) {
if (!strcmp(argv[1], logicNamesCmd[i].name)) {
uint8 p[16];
if ((argc - 2) != logicNamesCmd[i].argumentsLength()) {
debugPrintf("AGI command wants %d arguments\n", logicNamesCmd[i].argumentsLength());
return 0;
}
p[0] = argv[2] ? (char)strtoul(argv[2], NULL, 0) : 0;
p[1] = argv[3] ? (char)strtoul(argv[3], NULL, 0) : 0;
p[2] = argv[4] ? (char)strtoul(argv[4], NULL, 0) : 0;
p[3] = argv[5] ? (char)strtoul(argv[5], NULL, 0) : 0;
p[4] = argv[6] ? (char)strtoul(argv[6], NULL, 0) : 0;
debugC(5, kDebugLevelMain, "Opcode: %s %s %s %s", logicNamesCmd[i].name, argv[1], argv[2], argv[3]);
_vm->executeAgiCommand(i, p);
return true;
}
}
debugPrintf("Unknown opcode\n");
return true;
}
bool Console::Cmd_Agiver(int argc, const char **argv) {
int ver, maj, min;
ver = _vm->getVersion();
maj = (ver >> 12) & 0xf;
min = ver & 0xfff;
debugPrintf("AGI version: ");
debugPrintf(maj <= 2 ? "%x.%03x\n" : "%x.002.%03x\n", maj, min);
return true;
}
#define CONSOLE_VERSION_MAXLEN 10
bool Console::Cmd_Version(int argc, const char **argv) {
AgiGame *game = &_vm->_game;
int scriptNr = 0;
int scriptTextCount = 0;
int scriptTextNr = 0;
const char *scriptTextPtr = NULL;
const char *wordScanPtr = NULL;
const char *wordStartPtr = NULL;
const char *versionStartPtr = NULL;
const char *versionPtr = NULL;
int wordLen = 0;
char curChar = 0;
int versionLen = 0;
bool wordFound = false;
bool versionFound = false;
char versionString[CONSOLE_VERSION_MAXLEN];
bool scriptLoadedByUs = false;
// Show AGI version
Cmd_Agiver(argc, argv);
// And now try to figure out the version of the game
// We do this by scanning through all script texts
// This is the best we can do about it. There is no special location for the game version number.
// There are multiple variations, like "ver. X.XX", "ver X.XX" and even "verion X.XX".
for (scriptNr = 0; scriptNr < MAX_DIRS; scriptNr++) {
if (game->dirLogic[scriptNr].offset != _EMPTY) {
// Script is supposed to exist?
scriptLoadedByUs = false;
if (!(game->dirLogic[scriptNr].flags & RES_LOADED)) {
// But not currently loaded? -> load it now
if (_vm->agiLoadResource(rLOGIC, scriptNr) != errOK) {
// In case we can't load the source, skip it
continue;
}
scriptLoadedByUs = true;
}
// Script currently loaded
// Now scan all texts
scriptTextCount = game->logics[scriptNr].numTexts;
for (scriptTextNr = 0; scriptTextNr < scriptTextCount; scriptTextNr++) {
scriptTextPtr = game->logics[scriptNr].texts[scriptTextNr];
// Now scan this text for version information
wordScanPtr = scriptTextPtr;
versionPtr = NULL;
do {
curChar = *wordScanPtr;
if ((curChar == 'V') || (curChar == 'v')) {
// "V" gefunden, ggf. beginning of version?
wordStartPtr = wordScanPtr;
wordFound = false;
do {
curChar = *wordScanPtr;
if (curChar == ' ') {
break;
}
wordScanPtr++;
} while (curChar);
if (curChar) {
// end of "version" found
wordLen = wordScanPtr - wordStartPtr;
if (wordLen >= 3) {
if (strncmp(wordStartPtr, "ver", wordLen) == 0)
wordFound = true;
if (strncmp(wordStartPtr, "Ver", wordLen) == 0)
wordFound = true;
}
if ((!wordFound) && (wordLen >= 4)) {
if (strncmp(wordStartPtr, "ver.", wordLen) == 0)
wordFound = true;
if (strncmp(wordStartPtr, "Ver.", wordLen) == 0)
wordFound = true;
}
if ((!versionFound) && (wordLen >= 7)) {
if (strncmp(wordStartPtr, "version", wordLen) == 0)
wordFound = true;
if (strncmp(wordStartPtr, "Version", wordLen) == 0)
wordFound = true;
if (strncmp(wordStartPtr, "VERSION", wordLen) == 0)
wordFound = true;
}
if (wordFound) {
// We found something interesting
//debugPrintf("%d: %s\n", scriptNr, scriptTextPtr);
wordScanPtr++; // skip space
versionStartPtr = wordScanPtr;
curChar = *wordScanPtr;
if ((curChar >= '0') && (curChar <= '9')) {
// Next word starts with a number
wordScanPtr++;
curChar = *wordScanPtr;
if (curChar == '.') {
// Followed by a point? then we assume that we found a version number
// Now we try to find the end of it
wordScanPtr++;
do {
curChar = *wordScanPtr;
if ((curChar == ' ') || (curChar == '\\') || (!curChar))
break; // space or potential new line or NUL? -> found the end
wordScanPtr++;
} while (1);
versionLen = wordScanPtr - versionStartPtr;
if (versionLen < CONSOLE_VERSION_MAXLEN) {
// Looks fine, now extract and show it
memcpy(versionString, versionStartPtr, versionLen);
versionString[versionLen] = 0;
debugPrintf("Scanned game version: %s\n", versionString);
versionFound = true;
}
}
}
}
}
// Seek back
wordScanPtr = wordStartPtr;
}
wordScanPtr++;
} while (curChar);
}
if (scriptLoadedByUs) {
_vm->agiUnloadResource(rLOGIC, scriptNr);
}
}
}
if (!versionFound) {
debugPrintf("Scanned game version: [not found]\n");
}
return true;
}
bool Console::Cmd_Flags(int argc, const char **argv) {
int i, j;
debugPrintf(" ");
for (j = 0; j < 10; j++)
debugPrintf("%d ", j);
debugPrintf("\n");
for (i = 0; i < 255;) {
debugPrintf("%3d ", i);
for (j = 0; j < 10; j++, i++) {
debugPrintf("%c ", _vm->getflag(i) ? 'T' : 'F');
}
debugPrintf("\n");
}
return true;
}
bool Console::Cmd_Vars(int argc, const char **argv) {
int i, j;
for (i = 0; i < 255;) {
for (j = 0; j < 5; j++, i++) {
debugPrintf("%03d:%3d ", i, _vm->getvar(i));
}
debugPrintf("\n");
}
return true;
}
bool Console::Cmd_Objs(int argc, const char **argv) {
unsigned int i;
for (i = 0; i < _vm->_game.numObjects; i++) {
debugPrintf("%3d]%-24s(%3d)\n", i, _vm->objectName(i), _vm->objectGetLocation(i));
}
return true;
}
bool Console::Cmd_Opcode(int argc, const char **argv) {
if (argc != 2 || (strcmp(argv[1], "on") && strcmp(argv[1], "off"))) {
debugPrintf("Usage: opcode on|off\n");
return true;
}
_vm->_debug.opcodes = !strcmp(argv[1], "on");
return true;
}
bool Console::Cmd_Logic0(int argc, const char **argv) {
if (argc != 2 || (strcmp(argv[1], "on") && strcmp(argv[1], "off"))) {
debugPrintf("Usage: logic0 on|off\n");
return true;
}
_vm->_debug.logic0 = !strcmp(argv[1], "on");
return true;
}
bool Console::Cmd_Trigger(int argc, const char **argv) {
if (argc != 2 || (strcmp(argv[1], "on") && strcmp(argv[1], "off"))) {
debugPrintf("Usage: trigger on|off\n");
return true;
}
_vm->_debug.ignoretriggers = strcmp (argv[1], "on");
return true;
}
bool Console::Cmd_Step(int argc, const char **argv) {
_vm->_debug.enabled = 1;
if (argc == 1) {
_vm->_debug.steps = 1;
return true;
}
_vm->_debug.steps = strtoul(argv[1], NULL, 0);
return true;
}
bool Console::Cmd_Debug(int argc, const char **argv) {
_vm->_debug.enabled = 1;
_vm->_debug.steps = 0;
return true;
}
bool Console::Cmd_Cont(int argc, const char **argv) {
_vm->_debug.enabled = 0;
_vm->_debug.steps = 0;
return true;
}
bool Console::Cmd_Room(int argc, const char **argv) {
if (argc == 2) {
_vm->newRoom(strtoul(argv[1], NULL, 0));
}
debugPrintf("Current room: %d\n", _vm->getvar(0));
return true;
}
bool Console::Cmd_BT(int argc, const char **argv) {
debugPrintf("Current script: %d\nStack depth: %d\n", _vm->_game.lognum, _vm->_game.execStack.size());
uint8 *code = NULL;
uint8 op = 0;
uint8 p[CMD_BSIZE] = { 0 };
int num;
Common::Array<ScriptPos>::iterator it;
for (it = _vm->_game.execStack.begin(); it != _vm->_game.execStack.end(); ++it) {
code = _vm->_game.logics[it->script].data;
op = code[it->curIP];
num = logicNamesCmd[op].argumentsLength();
memmove(p, &code[it->curIP], num);
memset(p + num, 0, CMD_BSIZE - num);
debugPrintf("%d(%d): %s(", it->script, it->curIP, logicNamesCmd[op].name);
for (int i = 0; i < num; i++)
debugPrintf("%d, ", p[i]);
debugPrintf(")\n");
}
return true;
}
MickeyConsole::MickeyConsole(MickeyEngine *mickey) : GUI::Debugger() {
_mickey = mickey;
registerCmd("room", WRAP_METHOD(MickeyConsole, Cmd_Room));
registerCmd("drawPic", WRAP_METHOD(MickeyConsole, Cmd_DrawPic));
registerCmd("drawObj", WRAP_METHOD(MickeyConsole, Cmd_DrawObj));
}
bool MickeyConsole::Cmd_Room(int argc, const char **argv) {
if (argc == 2)
_mickey->debugGotoRoom(atoi(argv[1]));
_mickey->debugCurRoom();
return true;
}
bool MickeyConsole::Cmd_DrawPic(int argc, const char **argv) {
if (argc != 2)
debugPrintf("Usage: %s <Picture number>\n", argv[0]);
else
_mickey->drawPic(atoi(argv[1]));
return true;
}
bool MickeyConsole::Cmd_DrawObj(int argc, const char **argv) {
if (argc != 2)
debugPrintf("Usage: %s <Object number>\n", argv[0]);
else
_mickey->drawObj((ENUM_MSA_OBJECT)atoi(argv[1]), 0, 0);
return true;
}
WinnieConsole::WinnieConsole(WinnieEngine *winnie) : GUI::Debugger() {
_winnie = winnie;
registerCmd("curRoom", WRAP_METHOD(WinnieConsole, Cmd_CurRoom));
}
bool WinnieConsole::Cmd_CurRoom(int argc, const char **argv) {
_winnie->debugCurRoom();
return true;
}
} // End of namespace Agi