Merge branch 'master' of https://github.com/scummvm/scummvm into cge2

8 files changed, 76 insertions, 105 deletions

diff --git a/engines/agos/agos.cpp b/engines/agos/agos.cpp
index 7266c75474..6eda2eb9aa 100644
--- a/engines/agos/agos.cpp
+++ b/engines/agos/agos.cpp
@@ -21,6 +21,7 @@
  */
 
 #include "common/config-manager.h"
+#include "common/debug-channels.h"
 #include "common/file.h"
 #include "common/fs.h"
 #include "common/textconsole.h"
@@ -144,6 +145,14 @@ AGOSEngine_Elvira1::AGOSEngine_Elvira1(OSystem *system, const AGOSGameDescriptio
 AGOSEngine::AGOSEngine(OSystem *system, const AGOSGameDescription *gd)
 	: Engine(system), _rnd("agos"), _gameDescription(gd) {
 
+	DebugMan.addDebugChannel(kDebugOpcode, "opcode", "Opcode debug level");
+	DebugMan.addDebugChannel(kDebugVGAOpcode, "vga_opcode", "VGA Opcode debug level");
+	DebugMan.addDebugChannel(kDebugSubroutine, "subroutine", "Subroutine debug level");
+	DebugMan.addDebugChannel(kDebugVGAScript, "vga_script", "VGA Script debug level");
+	//Image dumping command disabled as it doesn't work well
+#if 0
+	DebugMan.addDebugChannel(kDebugImageDump, "image_dump", "Enable dumping of images to files");
+#endif
 	_vcPtr = 0;
 	_vcGetOutOfCode = 0;
 	_gameOffsetsPtr = 0;
@@ -243,13 +252,6 @@ AGOSEngine::AGOSEngine(OSystem *system, const AGOSGameDescription *gd)
 
 	_backFlag = false;
 
-	_debugMode = 0;
-	_dumpScripts = false;
-	_dumpOpcodes = false;
-	_dumpVgaScripts = false;
-	_dumpVgaOpcodes = false;
-	_dumpImages = false;
-
 	_copyProtection = false;
 	_pause = false;
 	_speech = false;
@@ -675,15 +677,6 @@ Common::Error AGOSEngine::init() {
 		_subtitles = true;
 	}
 
-	// TODO: Use special debug levels instead of the following hack.
-	_debugMode = (gDebugLevel >= 0);
-	switch (gDebugLevel) {
-	case 2: _dumpOpcodes    = true; break;
-	case 3: _dumpVgaOpcodes = true; break;
-	case 4: _dumpScripts    = true; break;
-	case 5: _dumpVgaScripts = true; break;
-	}
-
 	return Common::kNoError;
 }
 
diff --git a/engines/agos/agos.h b/engines/agos/agos.h
index 5e49fce5ff..b6b5e427e1 100644
--- a/engines/agos/agos.h
+++ b/engines/agos/agos.h
@@ -61,6 +61,14 @@ struct Surface;
 
 namespace AGOS {
 
+enum {
+	kDebugOpcode = 1 << 0,
+	kDebugVGAOpcode = 1 << 1,
+	kDebugSubroutine = 1 << 2,
+	kDebugVGAScript = 1 << 3,
+	kDebugImageDump = 1 << 4
+};
+
 uint fileReadItemID(Common::SeekableReadStream *in);
 
 #define CHECK_BOUNDS(x, y) assert((uint)(x) < ARRAYSIZE(y))
@@ -324,15 +332,9 @@ protected:
 	bool _fastMode;
 	bool _backFlag;
 
-	uint16 _debugMode;
 	Common::Language _language;
 	bool _copyProtection;
 	bool _pause;
-	bool _dumpScripts;
-	bool _dumpOpcodes;
-	bool _dumpVgaScripts;
-	bool _dumpVgaOpcodes;
-	bool _dumpImages;
 	bool _speech;
 	bool _subtitles;
 	bool _vgaVar9;
diff --git a/engines/agos/debugger.cpp b/engines/agos/debugger.cpp
index 512137b685..7ad742c928 100644
--- a/engines/agos/debugger.cpp
+++ b/engines/agos/debugger.cpp
@@ -32,44 +32,21 @@ Debugger::Debugger(AGOSEngine *vm)
 	: GUI::Debugger() {
 	_vm = vm;
 
-	DCmd_Register("continue", WRAP_METHOD(Debugger, Cmd_Exit));
-	DCmd_Register("level",    WRAP_METHOD(Debugger, Cmd_DebugLevel));
-	DCmd_Register("music",    WRAP_METHOD(Debugger, Cmd_PlayMusic));
-	DCmd_Register("sound",    WRAP_METHOD(Debugger, Cmd_PlaySound));
-	DCmd_Register("voice",    WRAP_METHOD(Debugger, Cmd_PlayVoice));
-	DCmd_Register("bit",      WRAP_METHOD(Debugger, Cmd_SetBit));
-	DCmd_Register("bit2",     WRAP_METHOD(Debugger, Cmd_SetBit2));
-	DCmd_Register("bit3",     WRAP_METHOD(Debugger, Cmd_SetBit3));
-	DCmd_Register("var",      WRAP_METHOD(Debugger, Cmd_SetVar));
-	DCmd_Register("obj",      WRAP_METHOD(Debugger, Cmd_SetObjectFlag));
-	DCmd_Register("sub",      WRAP_METHOD(Debugger, Cmd_StartSubroutine));
-	DCmd_Register("dumpimage",      WRAP_METHOD(Debugger, Cmd_dumpImage));
-	DCmd_Register("dumpscript",     WRAP_METHOD(Debugger, Cmd_dumpScript));
+	registerCmd("continue", WRAP_METHOD(Debugger, cmdExit));
+	registerCmd("music",    WRAP_METHOD(Debugger, Cmd_PlayMusic));
+	registerCmd("sound",    WRAP_METHOD(Debugger, Cmd_PlaySound));
+	registerCmd("voice",    WRAP_METHOD(Debugger, Cmd_PlayVoice));
+	registerCmd("bit",      WRAP_METHOD(Debugger, Cmd_SetBit));
+	registerCmd("bit2",     WRAP_METHOD(Debugger, Cmd_SetBit2));
+	registerCmd("bit3",     WRAP_METHOD(Debugger, Cmd_SetBit3));
+	registerCmd("var",      WRAP_METHOD(Debugger, Cmd_SetVar));
+	registerCmd("obj",      WRAP_METHOD(Debugger, Cmd_SetObjectFlag));
+	registerCmd("sub",      WRAP_METHOD(Debugger, Cmd_StartSubroutine));
+	registerCmd("dumpimage",      WRAP_METHOD(Debugger, Cmd_dumpImage));
+	registerCmd("dumpscript",     WRAP_METHOD(Debugger, Cmd_dumpScript));
 
 }
 
-
-bool Debugger::Cmd_DebugLevel(int argc, const char **argv) {
-	if (argc == 1) {
-		if (_vm->_debugMode == false)
-			DebugPrintf("Debugging is not enabled at this time\n");
-		else
-			DebugPrintf("Debugging is currently set at level %d\n", gDebugLevel);
-	} else { // set level
-		gDebugLevel = atoi(argv[1]);
-		if (0 <= gDebugLevel && gDebugLevel < 11) {
-			_vm->_debugMode = true;
-			DebugPrintf("Debug level set to level %d\n", gDebugLevel);
-		} else if (gDebugLevel < 0) {
-			_vm->_debugMode = false;
-			DebugPrintf("Debugging is now disabled\n");
-		} else
-			DebugPrintf("Not a valid debug level (0 - 10)\n");
-	}
-
-	return true;
-}
-
 bool Debugger::Cmd_PlayMusic(int argc, const char **argv) {
 	if (argc > 1) {
 		uint music = atoi(argv[1]);
@@ -83,9 +60,9 @@ bool Debugger::Cmd_PlayMusic(int argc, const char **argv) {
 				_vm->playMusic(music, 0);
 			}
 		} else
-			DebugPrintf("Music out of range (0 - %d)\n", _vm->_numMusic);
+			debugPrintf("Music out of range (0 - %d)\n", _vm->_numMusic);
 	} else
-		DebugPrintf("Syntax: music <musicnum>\n");
+		debugPrintf("Syntax: music <musicnum>\n");
 
 	return true;
 }
@@ -96,9 +73,9 @@ bool Debugger::Cmd_PlaySound(int argc, const char **argv) {
 		if (sound <= _vm->_numSFX)
 			_vm->_sound->playEffects(sound);
 		else
-			DebugPrintf("Sound out of range (0 - %d)\n", _vm->_numSFX);
+			debugPrintf("Sound out of range (0 - %d)\n", _vm->_numSFX);
 	} else
-		DebugPrintf("Syntax: sound <soundnum>\n");
+		debugPrintf("Syntax: sound <soundnum>\n");
 
 	return true;
 }
@@ -109,9 +86,9 @@ bool Debugger::Cmd_PlayVoice(int argc, const char **argv) {
 		if (voice <= _vm->_numSpeech)
 			_vm->_sound->playVoice(voice);
 		else
-			DebugPrintf("Voice out of range (0 - %d)\n", _vm->_numSpeech);
+			debugPrintf("Voice out of range (0 - %d)\n", _vm->_numSpeech);
 	} else
-		DebugPrintf("Syntax: voice <voicenum>\n");
+		debugPrintf("Syntax: voice <voicenum>\n");
 
 	return true;
 }
@@ -123,15 +100,15 @@ bool Debugger::Cmd_SetBit(int argc, const char **argv) {
 		value = atoi(argv[2]);
 		if (value <= 1) {
 			_vm->setBitFlag(bit, value != 0);
-			DebugPrintf("Set bit %d to %d\n", bit, value);
+			debugPrintf("Set bit %d to %d\n", bit, value);
 		} else
-			DebugPrintf("Bit value out of range (0 - 1)\n");
+			debugPrintf("Bit value out of range (0 - 1)\n");
 	} else if (argc > 1) {
 		bit = atoi(argv[1]);
 		value = _vm->getBitFlag(bit);
-		DebugPrintf("Bit %d is %d\n", bit, value);
+		debugPrintf("Bit %d is %d\n", bit, value);
 	} else
-		DebugPrintf("Syntax: bit <bitnum> <value>\n");
+		debugPrintf("Syntax: bit <bitnum> <value>\n");
 
 	return true;
 }
@@ -143,18 +120,18 @@ bool Debugger::Cmd_SetBit2(int argc, const char **argv) {
 		value = atoi(argv[2]);
 		if (value == 0) {
 			_vm->_bitArrayTwo[bit / 16] &= ~(1 << (bit & 15));
-			DebugPrintf("Set bit2 %d to %d\n", bit, value);
+			debugPrintf("Set bit2 %d to %d\n", bit, value);
 		} else if (value == 1) {
 			_vm->_bitArrayTwo[bit / 16] |= (1 << (bit & 15));
-			DebugPrintf("Set bit2 %d to %d\n", bit, value);
+			debugPrintf("Set bit2 %d to %d\n", bit, value);
 		} else
-			DebugPrintf("Bit2 value out of range (0 - 1)\n");
+			debugPrintf("Bit2 value out of range (0 - 1)\n");
 	} else if (argc > 1) {
 		bit = atoi(argv[1]);
 		value = (_vm->_bitArrayTwo[bit / 16] & (1 << (bit & 15))) != 0;
-		DebugPrintf("Bit2 %d is %d\n", bit, value);
+		debugPrintf("Bit2 %d is %d\n", bit, value);
 	} else
-		DebugPrintf("Syntax: bit2 <bitnum> <value>\n");
+		debugPrintf("Syntax: bit2 <bitnum> <value>\n");
 
 	return true;
 }
@@ -166,18 +143,18 @@ bool Debugger::Cmd_SetBit3(int argc, const char **argv) {
 		value = atoi(argv[2]);
 		if (value == 0) {
 			_vm->_bitArrayThree[bit / 16] &= ~(1 << (bit & 15));
-			DebugPrintf("Set bit3 %d to %d\n", bit, value);
+			debugPrintf("Set bit3 %d to %d\n", bit, value);
 		} else if (value == 1) {
 			_vm->_bitArrayThree[bit / 16] |= (1 << (bit & 15));
-			DebugPrintf("Set bit3 %d to %d\n", bit, value);
+			debugPrintf("Set bit3 %d to %d\n", bit, value);
 		} else
-			DebugPrintf("Bit3 value out of range (0 - 1)\n");
+			debugPrintf("Bit3 value out of range (0 - 1)\n");
 	} else if (argc > 1) {
 		bit = atoi(argv[1]);
 		value = (_vm->_bitArrayThree[bit / 16] & (1 << (bit & 15))) != 0;
-		DebugPrintf("Bit3 %d is %d\n", bit, value);
+		debugPrintf("Bit3 %d is %d\n", bit, value);
 	} else
-		DebugPrintf("Syntax: bit3 <bitnum> <value>\n");
+		debugPrintf("Syntax: bit3 <bitnum> <value>\n");
 
 	return true;
 }
@@ -190,15 +167,15 @@ bool Debugger::Cmd_SetVar(int argc, const char **argv) {
 			if (argc > 2) {
 				value = atoi(argv[2]);
 				_vm->writeVariable(var, value);
-				DebugPrintf("Set var %d to %d\n", var, value);
+				debugPrintf("Set var %d to %d\n", var, value);
 			} else {
 				value = _vm->readVariable(var);
-				DebugPrintf("Var %d is %d\n", var, value);
+				debugPrintf("Var %d is %d\n", var, value);
 			}
 		} else
-			DebugPrintf("Var out of range (0 - %d)\n", _vm->_numVars - 1);
+			debugPrintf("Var out of range (0 - %d)\n", _vm->_numVars - 1);
 	} else
-		DebugPrintf("Syntax: var <varnum> <value>\n");
+		debugPrintf("Syntax: var <varnum> <value>\n");
 
 	return true;
 }
@@ -217,22 +194,22 @@ bool Debugger::Cmd_SetObjectFlag(int argc, const char **argv) {
 					if (argc > 3) {
 						value = atoi(argv[3]);
 						o->objectFlagValue[offs] = value;
-						DebugPrintf("Object %d Flag %d set to %d\n", obj, prop, value);
+						debugPrintf("Object %d Flag %d set to %d\n", obj, prop, value);
 					} else {
 						value = o->objectFlagValue[offs];
-						DebugPrintf("Object %d Flag %d is %d\n", obj, prop, value);
+						debugPrintf("Object %d Flag %d is %d\n", obj, prop, value);
 					}
 				} else {
-					DebugPrintf("Object flag out of range\n");
+					debugPrintf("Object flag out of range\n");
 				}
 			} else {
-				DebugPrintf("Item isn't an object\n");
+				debugPrintf("Item isn't an object\n");
 			}
 		} else {
-			DebugPrintf("Item out of range (1 - %d)\n", _vm->_itemArraySize - 1);
+			debugPrintf("Item out of range (1 - %d)\n", _vm->_itemArraySize - 1);
 		}
 	} else {
-		DebugPrintf("Syntax: obj <itemnum> <flag> <value>\n");
+		debugPrintf("Syntax: obj <itemnum> <flag> <value>\n");
 	}
 
 	return true;
@@ -246,7 +223,7 @@ bool Debugger::Cmd_StartSubroutine(int argc, const char **argv) {
 		if (sub != NULL)
 			_vm->startSubroutine(sub);
 	} else
-		DebugPrintf("Subroutine %d\n", _vm->_currentTable->id);
+		debugPrintf("Subroutine %d\n", _vm->_currentTable->id);
 
 	return true;
 }
@@ -259,11 +236,11 @@ bool Debugger::Cmd_dumpImage(int argc, const char **argv) {
 		if (vpe->vgaFile2 != NULL) {
 			_vm->dumpVgaBitmaps(zoneNum);
 		} else {
-			DebugPrintf("Invalid Zone Number %d\n", zoneNum);
+			debugPrintf("Invalid Zone Number %d\n", zoneNum);
 
 		}
 	} else
-		DebugPrintf("Syntax: dumpimage <zonenum>\n");
+		debugPrintf("Syntax: dumpimage <zonenum>\n");
 
 	return true;
 }
@@ -276,11 +253,11 @@ bool Debugger::Cmd_dumpScript(int argc, const char **argv) {
 		if (vpe->vgaFile1 != NULL) {
 			_vm->dumpVgaFile(vpe->vgaFile1);
 		} else {
-			DebugPrintf("Invalid Zone Number %d\n", zoneNum);
+			debugPrintf("Invalid Zone Number %d\n", zoneNum);
 
 		}
 	} else
-		DebugPrintf("Syntax: dumpscript <zonenum>\n");
+		debugPrintf("Syntax: dumpscript <zonenum>\n");
 
 	return true;
 }
diff --git a/engines/agos/debugger.h b/engines/agos/debugger.h
index caac6e2caf..026194410f 100644
--- a/engines/agos/debugger.h
+++ b/engines/agos/debugger.h
@@ -37,7 +37,6 @@ public:
 private:
 	AGOSEngine *_vm;
 
-	bool Cmd_DebugLevel(int argc, const char **argv);
 	bool Cmd_PlayMusic(int argc, const char **argv);
 	bool Cmd_PlaySound(int argc, const char **argv);
 	bool Cmd_PlayVoice(int argc, const char **argv);
diff --git a/engines/agos/gfx.cpp b/engines/agos/gfx.cpp
index 6e97084811..33145b7d0d 100644
--- a/engines/agos/gfx.cpp
+++ b/engines/agos/gfx.cpp
@@ -20,6 +20,7 @@
  *
  */
 
+#include "common/debug-channels.h"
 #include "common/endian.h"
 #include "common/system.h"
 #include "common/textconsole.h"
@@ -1129,7 +1130,7 @@ void AGOSEngine::animate(uint16 windowNum, uint16 zoneNum, uint16 vgaSpriteId, i
 		assert(READ_BE_UINT16(&((AnimationHeader_WW *) p)->id) == vgaSpriteId);
 	}
 
-	if (_dumpVgaScripts) {
+	if (DebugMan.isDebugChannelEnabled(kDebugVGAScript)) {
 		if (getGameType() == GType_FF || getGameType() == GType_PP) {
 			dumpVgaScript(_curVgaFile1 + READ_LE_UINT16(&((AnimationHeader_Feeble*)p)->scriptOffs), zoneNum, vgaSpriteId);
 		} else if (getGameType() == GType_SIMON1 || getGameType() == GType_SIMON2) {
@@ -1235,7 +1236,7 @@ void AGOSEngine::setImage(uint16 vgaSpriteId, bool vgaScript) {
 		}
 	}
 
-	if (_dumpVgaScripts) {
+	if (DebugMan.isDebugChannelEnabled(kDebugVGAScript)) {
 		if (getGameType() == GType_FF || getGameType() == GType_PP) {
 			dumpVgaScript(_curVgaFile1 + READ_LE_UINT16(&((ImageHeader_Feeble*)b)->scriptOffs), zoneNum, vgaSpriteId);
 		} else if (getGameType() == GType_SIMON1 || getGameType() == GType_SIMON2) {
diff --git a/engines/agos/script.cpp b/engines/agos/script.cpp
index 6f809d9e2d..1dbb9c255a 100644
--- a/engines/agos/script.cpp
+++ b/engines/agos/script.cpp
@@ -22,6 +22,7 @@
 
 // Item script opcodes for Simon1/Simon2
 
+#include "common/debug-channels.h"
 #include "common/endian.h"
 #include "common/system.h"
 #include "common/textconsole.h"
@@ -987,7 +988,7 @@ int AGOSEngine::runScript() {
 		return 1;
 
 	do {
-		if (_dumpOpcodes)
+		if (DebugMan.isDebugChannelEnabled(kDebugOpcode))
 			dumpOpcode(_codePtr);
 
 		if (getGameType() == GType_ELVIRA1) {
diff --git a/engines/agos/subroutine.cpp b/engines/agos/subroutine.cpp
index 39bc468dea..1e6ecaa829 100644
--- a/engines/agos/subroutine.cpp
+++ b/engines/agos/subroutine.cpp
@@ -20,8 +20,7 @@
  *
  */
 
-
-
+#include "common/debug-channels.h"
 #include "common/file.h"
 #include "common/textconsole.h"
 
@@ -531,7 +530,7 @@ int AGOSEngine::startSubroutine(Subroutine *sub) {
 	_classMode1 = 0;
 	_classMode2 = 0;
 
-	if (_dumpScripts)
+	if (DebugMan.isDebugChannelEnabled(kDebugSubroutine))
 		dumpSubroutine(sub);
 
 	if (++_recursionDepth > 40)
@@ -564,8 +563,7 @@ restart:
 			else
 				_codePtr += 8;
 
-			if (_dumpOpcodes)
-				debug("; %d", sub->id);
+				debugC(kDebugOpcode, "; %d", sub->id);
 			result = runScript();
 			if (result != 0) {
 				break;
diff --git a/engines/agos/vga.cpp b/engines/agos/vga.cpp
index c656c0167a..f761c3fc3f 100644
--- a/engines/agos/vga.cpp
+++ b/engines/agos/vga.cpp
@@ -27,6 +27,7 @@
 #include "agos/intern.h"
 #include "agos/vga.h"
 
+#include "common/debug-channels.h"
 #include "common/endian.h"
 #include "common/system.h"
 #include "common/textconsole.h"
@@ -152,7 +153,7 @@ void AGOSEngine::runVgaScript() {
 	for (;;) {
 		uint opcode;
 
-		if (_dumpVgaOpcodes) {
+		if (DebugMan.isDebugChannelEnabled(kDebugVGAOpcode)) {
 			if (_vcPtr != (const byte *)&_vcGetOutOfCode) {
 				debugN("%.5d %.5X: %5d %4d ", _vgaTickCounter, (unsigned int)(_vcPtr - _curVgaFile1), _vgaCurSpriteId, _vgaCurZoneNum);
 				dumpVideoScript(_vcPtr, true);
@@ -381,8 +382,7 @@ void AGOSEngine::vcSkipNextInstruction() {
 		_vcPtr += opcodeParamLenPN[opcode];
 	}
 
-	if (_dumpVgaOpcodes)
-		debugN("; skipped\n");
+	debugCN(kDebugVGAOpcode, "; skipped\n");
 }
 
 // VGA Script commands
@@ -648,7 +648,7 @@ void AGOSEngine::drawImage_init(int16 image, uint16 palette, int16 x, int16 y, u
 	if (height == 0 || width == 0)
 		return;
 
-	if (_dumpImages)
+	if (DebugMan.isDebugChannelEnabled(kDebugImageDump))
 		dumpSingleBitmap(_vgaCurZoneNum, state.image, state.srcPtr, width, height,
 											 state.palette);
 	state.width = state.draw_width = width;		/* cl */