/* 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 3 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, see .
*
*/
#include "engines/wintermute/debugger.h"
#include "engines/wintermute/base/base_engine.h"
#include "engines/wintermute/base/base_file_manager.h"
#include "engines/wintermute/base/scriptables/script_value.h"
#include "engines/wintermute/debugger/debugger_controller.h"
#include "engines/wintermute/wintermute.h"
#define CONTROLLER _engineRef->_dbgController
namespace Wintermute {
Console::Console(WintermuteEngine *vm) : GUI::Debugger(), _engineRef(vm) {
registerCmd("show_fps", WRAP_METHOD(Console, Cmd_ShowFps));
registerCmd("dump_file", WRAP_METHOD(Console, Cmd_DumpFile));
registerCmd("show_fps", WRAP_METHOD(Console, Cmd_ShowFps));
registerCmd("dump_file", WRAP_METHOD(Console, Cmd_DumpFile));
registerCmd("help", WRAP_METHOD(Console, Cmd_Help));
// Actual (script) debugger commands
registerCmd(STEP_CMD, WRAP_METHOD(Console, Cmd_Step));
registerCmd(CONTINUE_CMD, WRAP_METHOD(Console, Cmd_Continue));
registerCmd(FINISH_CMD, WRAP_METHOD(Console, Cmd_Finish));
registerCmd(WATCH_CMD, WRAP_METHOD(Console, Cmd_Watch));
registerCmd(BREAK_CMD, WRAP_METHOD(Console, Cmd_AddBreakpoint));
registerCmd(LIST_CMD, WRAP_METHOD(Console, Cmd_List));
registerCmd(REMOVE_BREAKPOINT_CMD, WRAP_METHOD(Console, Cmd_RemoveBreakpoint));
registerCmd(DISABLE_BREAKPOINT_CMD, WRAP_METHOD(Console, Cmd_DisableBreakpoint));
registerCmd(ENABLE_BREAKPOINT_CMD, WRAP_METHOD(Console, Cmd_EnableBreakpoint));
registerCmd(REMOVE_WATCH_CMD, WRAP_METHOD(Console, Cmd_RemoveWatch));
registerCmd(DISABLE_WATCH_CMD, WRAP_METHOD(Console, Cmd_DisableWatch));
registerCmd(ENABLE_WATCH_CMD, WRAP_METHOD(Console, Cmd_EnableWatch));
registerCmd(PRINT_CMD, WRAP_METHOD(Console, Cmd_Print));
registerCmd(SET_CMD, WRAP_METHOD(Console, Cmd_Set));
registerCmd(INFO_CMD, WRAP_METHOD(Console, Cmd_Info));
registerCmd(SET_PATH_CMD, WRAP_METHOD(Console, Cmd_SourcePath));
registerCmd(TOP_CMD, WRAP_METHOD(Console, Cmd_Top));
}
Console::~Console(void) {
}
bool Console::Cmd_Help(int argc, const char **argv) {
if (argc == 1) {
// Debugger::Cmd_Help(argc, argv);
debugPrintf("\nType help somecommand to get specific help.\n");
} else {
printUsage(argv[1]);
}
return true;
}
void Console::printUsage(const Common::String &command) {
// TODO: This is horrible and would probably benefit from a map or something.
if (command.equals(BREAK_CMD)) {
debugPrintf("Usage: %s to break at line of file \n", command.c_str());
} else if (command.equals(REMOVE_BREAKPOINT_CMD)) {
debugPrintf("Usage: %s to remove breakpoint #id\n", command.c_str());
} else if (command.equals(ENABLE_BREAKPOINT_CMD)) {
debugPrintf("Usage: %s to enable breakpoint #id\n", command.c_str());
} else if (command.equals(DISABLE_BREAKPOINT_CMD)) {
debugPrintf("Usage: %s to disable breakpoint #id\n", command.c_str());
} else if (command.equals(REMOVE_WATCH_CMD)) {
debugPrintf("Usage: %s to remove watchpoint #id\n", command.c_str());
} else if (command.equals(ENABLE_WATCH_CMD)) {
debugPrintf("Usage: %s to enable watchpoint #id\n", command.c_str());
} else if (command.equals(DISABLE_WATCH_CMD)) {
debugPrintf("Usage: %s to disable watchpoint #id\n", command.c_str());
} else if (command.equals(INFO_CMD)) {
debugPrintf("Usage: %s [watch|breakpoints]\n", command.c_str());
} else if (command.equals(WATCH_CMD)) {
debugPrintf("Usage: %s to watch for in file \n", command.c_str());
} else if (command.equals(STEP_CMD)) {
debugPrintf("Usage: %s to step\n", command.c_str());
} else if (command.equals(CONTINUE_CMD)) {
debugPrintf("Usage: %s to continue\n", command.c_str());
} else if (command.equals(FINISH_CMD)) {
debugPrintf("Usage: %s to finish\n", command.c_str());
} else if (command.equals(PRINT_CMD)) {
debugPrintf("Usage: %s to print value of \n", command.c_str());
} else if (command.equals(SET_CMD)) {
debugPrintf("Usage: %s = to set to \n", command.c_str());
} else {
debugPrintf("No help about this command, sorry.");
}
}
bool Console::Cmd_AddBreakpoint(int argc, const char **argv) {
if (argc == 3) {
Wintermute::Error error = CONTROLLER->addBreakpoint(argv[1], atoi(argv[2]));
printError(argv[0], error);
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_RemoveBreakpoint(int argc, const char **argv) {
if (argc == 2) {
Error error = CONTROLLER->removeBreakpoint(atoi(argv[1]));
printError(argv[0], error);
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_EnableBreakpoint(int argc, const char **argv) {
if (argc == 2) {
Error error = CONTROLLER->enableBreakpoint(atoi(argv[1]));
printError(argv[0], error);
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_DisableBreakpoint(int argc, const char **argv) {
if (argc == 2) {
Error error = CONTROLLER->disableBreakpoint(atoi(argv[1]));
debugPrintf("%s: %s\n", argv[0], error.getErrorDisplayStr().c_str());
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_RemoveWatch(int argc, const char **argv) {
if (argc == 2) {
Error error = CONTROLLER->removeWatchpoint(atoi(argv[1]));
printError(argv[0], error);
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_EnableWatch(int argc, const char **argv) {
if (argc == 2) {
Error error = CONTROLLER->enableWatchpoint(atoi(argv[1]));
printError(argv[0], error);
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_DisableWatch(int argc, const char **argv) {
if (argc == 2) {
Error error = CONTROLLER->disableWatchpoint(atoi(argv[1]));
printError(argv[0], error);
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_Watch(int argc, const char **argv) {
if (argc == 3) {
Error error = CONTROLLER->addWatch(argv[1], argv[2]);
printError(argv[0], error);
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_Info(int argc, const char **argv) {
if (argc == 2 && !strncmp(argv[1], "breakpoints", 10)) {
Common::Array breakpoints = CONTROLLER->getBreakpoints();
for (uint i = 0; i < breakpoints.size(); i++) {
debugPrintf("%d %s:%d x%d, enabled: %d \n", i, breakpoints[i]._filename.c_str(), breakpoints[i]._line, breakpoints[i]._hits, breakpoints[i]._enabled);
}
return 1;
} else if (argc == 2 && !strncmp(argv[1], WATCH_CMD, 5)) {
Common::Arraywatchlist = CONTROLLER->getWatchlist();
for (uint i = 0; i < watchlist.size(); i++) {
debugPrintf("%d %s:%s x%d \n", i, watchlist[i]._filename.c_str(), watchlist[i]._symbol.c_str(), watchlist[i]._hits);
}
return 1;
} else {
printUsage(argv[0]);
return 1;
}
}
bool Console::Cmd_Step(int argc, const char **argv) {
if (argc == 1) {
Error error = CONTROLLER->step();
if (error.getErrorLevel() == SUCCESS) {
return false;
} else {
printError(argv[0], error);
return true;
}
} else {
printUsage(argv[0]);
return true;
}
}
bool Console::Cmd_Continue(int argc, const char **argv) {
if (argc == 1) {
Error error = CONTROLLER->stepContinue();
if (error.getErrorLevel() == SUCCESS) {
return false;
} else {
printError(argv[0], error);
return true;
}
} else {
printUsage(argv[0]);
return true;
}
}
bool Console::Cmd_Finish(int argc, const char **argv) {
if (argc == 1) {
Error error = CONTROLLER->stepFinish();
printError(argv[0], error);
if (error.getErrorLevel() == SUCCESS) {
return false;
} else {
printError(argv[0], error);
return true;
}
} else {
printUsage(argv[0]);
return true;
}
}
bool Console::Cmd_List(int argc, const char **argv) {
Error error = printSource();
if (error.getErrorLevel() != SUCCESS) {
printError(argv[0], error);
}
return true;
}
bool Console::Cmd_Print(int argc, const char **argv) {
if (argc == 2) {
Error error = Error(SUCCESS, OK, 0);
Common::String temp = CONTROLLER->readValue(argv[1], &error);
if (error.getErrorLevel() == SUCCESS) {
debugPrintf("%s = %s \n", argv[1], temp.c_str());
return true;
} else {
printError(argv[0], error);
return true;
}
} else {
printUsage(argv[0]);
return true;
}
}
bool Console::Cmd_Set(int argc, const char **argv) {
if (argc == 4 && !strncmp("=", argv[2], 1)) {
ScValue *val = nullptr;
Error error = CONTROLLER->setValue(argv[1], argv[3], val);
if (error.getErrorLevel() == SUCCESS) {
assert(val);
debugPrintf("%s = %s\n", argv[1], val->getString());
} else {
printError(argv[0], error);
}
} else {
printUsage(argv[0]);
}
return true;
}
bool Console::Cmd_ShowFps(int argc, const char **argv) {
if (argc == 2) {
if (Common::String(argv[1]) == "true") {
CONTROLLER->showFps(true);
} else if (Common::String(argv[1]) == "false") {
CONTROLLER->showFps(false);
} else {
debugPrintf("%s: argument 1 must be \"true\" or \"false\"\n", argv[0]);
}
} else {
debugPrintf("Usage: %s [true|false]\n", argv[0]);
}
return true;
}
bool Console::Cmd_DumpFile(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Usage: %s