GOB: Add Debug Console.

This allows interactive control of debug flags and variables and provides a base to allow
for commands to aid in tracking down script bugs which are tricky to replicate.

svn-id: r53398

engines/gob/console.cpp

@@ -0,0 +1,63 @@
+/* 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.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#include "gob/console.h"
+#include "gob/gob.h"
+#include "gob/inter.h"
+
+namespace Gob {
+
+GobConsole::GobConsole(GobEngine *vm) : GUI::Debugger(), _vm(vm) {
+	DCmd_Register("var",				WRAP_METHOD(GobConsole, Cmd_Var));
+}
+
+GobConsole::~GobConsole() {
+}
+
+void GobConsole::preEnter() {
+}
+
+void GobConsole::postEnter() {
+}
+
+bool GobConsole::Cmd_Var(int argc, const char **argv) {
+	if (argc == 1) {
+		DebugPrintf("Usage: var <var> (<value>)\n");
+		return true;
+	}
+
+	uint32 varNum = atoi(argv[1]);
+
+	if (argc > 2) {
+		uint32 varVal = atoi(argv[2]);
+		_vm->_inter->_variables->writeVar32(varNum, varVal);
+	}
+
+	DebugPrintf("%d = %d\n", varNum, _vm->_inter->_variables->readVar32(varNum));
+
+	return true;
+}
+
+} // End of namespace Gob

engines/gob/console.h

@@ -0,0 +1,52 @@
+/* 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.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef GOB_CONSOLE_H
+#define GOB_CONSOLE_H
+
+#include "gui/debugger.h"
+
+namespace Gob {
+
+class GobEngine;
+
+class GobConsole : public GUI::Debugger {
+public:
+	GobConsole(GobEngine *vm);
+	virtual ~GobConsole(void);
+
+protected:
+	virtual void preEnter();
+	virtual void postEnter();
+
+private:
+	GobEngine *_vm;
+
+	bool Cmd_Var(int argc, const char **argv);
+};
+
+} // End of namespace Mohawk
+
+#endif

engines/gob/gob.cpp

@@ -136,6 +136,8 @@ GobEngine::GobEngine(OSystem *syst) : Engine(syst) {
 
 	_copyProtection = ConfMan.getBool("copy_protection");
 
+	_console = new GobConsole(this);
+
 	DebugMan.addDebugChannel(kDebugFuncOp, "FuncOpcodes", "Script FuncOpcodes debug level");
 	DebugMan.addDebugChannel(kDebugDrawOp, "DrawOpcodes", "Script DrawOpcodes debug level");
 	DebugMan.addDebugChannel(kDebugGobOp, "GoblinOpcodes", "Script GoblinOpcodes debug level");
@@ -153,6 +155,8 @@ GobEngine::GobEngine(OSystem *syst) : Engine(syst) {
 }
 
 GobEngine::~GobEngine() {
+	delete _console;
+
 	deinitGameParts();
 }
 

engines/gob/gob.h

@@ -32,6 +32,8 @@
 
 #include "engines/engine.h"
 
+#include "gob/console.h"
+
 namespace GUI {
 	class StaticTextWidget;
 }
@@ -62,6 +64,7 @@ class PalAnim;
 class Scenery;
 class Util;
 class SaveLoad;
+class GobConsole;
 
 #define WRITE_VAR_UINT32(var, val)  _vm->_inter->_variables->writeVar32(var, val)
 #define WRITE_VAR_UINT16(var, val)  _vm->_inter->_variables->writeVar16(var, val)
@@ -152,6 +155,7 @@ private:
 	GameType _gameType;
 	int32 _features;
 	Common::Platform _platform;
+	GobConsole *_console;
 
 	uint32 _pauseStart;
 
@@ -221,6 +225,8 @@ public:
 	bool isTrueColor() const;
 	bool isDemo() const;
 
+	GUI::Debugger *getDebugger() { return _console; }
+
 	const Graphics::PixelFormat &getPixelFormat() const;
 
 	GobEngine(OSystem *syst);

engines/gob/module.mk

@@ -1,6 +1,7 @@
 MODULE := engines/gob
 
 MODULE_OBJS := \
+	console.o \
 	dataio.o \
 	detection.o \
 	draw.o \

engines/gob/util.cpp

@@ -121,6 +121,10 @@ void Util::processInput(bool scroll) {
 					_fastMode ^= 2;
 				else if (event.kbd.keycode == Common::KEYCODE_p)
 					_vm->pauseGame();
+				else if (event.kbd.keycode == Common::KEYCODE_d) {
+					_vm->getDebugger()->attach();
+					_vm->getDebugger()->onFrame();
+				}
 				break;
 			}
 			addKeyToBuffer(event.kbd);