Initial commit

engines/director/debugger.h

@@ -0,0 +1,169 @@
+/* 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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef DIRECTOR_DEBUGGER_H
+#define DIRECTOR_DEBUGGER_H
+
+#include "common/array.h"
+#include "common/file.h"
+#include "common/str.h"
+#include "gui/debugger.h"
+
+namespace Director {
+
+struct Symbol;
+
+enum BreakpointType {
+	kBreakpointTypeNull = 0,
+	kBreakpointFunction = 1,
+	kBreakpointMovie = 2,
+	kBreakpointMovieFrame = 3,
+	kBreakpointVariable = 4,
+	kBreakpointEntity = 5,
+	kBreakpointEvent = 6,
+	kBreakpointProperty = 7,
+};
+
+struct Breakpoint {
+	bool enabled = true;
+	BreakpointType type = kBreakpointTypeNull;
+	int id = 0;
+
+	uint16 scriptId = 0;
+	Common::String funcName;
+	uint funcOffset = 0;
+	Common::String moviePath;
+	uint frameOffset = 0;
+	Common::String varName;
+	LEvent eventId = kEventNone;
+	int entity = 0;
+	int field = 0;
+	bool varRead = false;
+	bool varWrite = false;
+
+	Common::String format() const;
+};
+
+
+class Debugger : public GUI::Debugger {
+public:
+	Debugger();
+	~Debugger();
+	void debugLogFile(Common::String logs, bool prompt);
+	void stepHook();
+	void frameHook();
+	void movieHook();
+	void eventHook(LEvent eventId);
+	void pushContextHook();
+	void popContextHook();
+	void builtinHook(const Symbol &funcSym);
+	void propReadHook(const Common::String &varName);
+	void propWriteHook(const Common::String &varName);
+	void varReadHook(const Common::String &varName);
+	void varWriteHook(const Common::String &varName);
+	void entityReadHook(int entity, int field);
+	void entityWriteHook(int entity, int field);
+
+private:
+	bool cmdHelp(int argc, const char **argv);
+
+	bool cmdVersion(int argc, const char **argv);
+	bool cmdInfo(int argc, const char **argv);
+	bool cmdMovie(int argc, const char **argv);
+	bool cmdFrame(int argc, const char **argv);
+	bool cmdChannels(int argc, const char **argv);
+	bool cmdCast(int argc, const char **argv);
+	bool cmdNextFrame(int argc, const char **argv);
+	bool cmdNextMovie(int argc, const char **argv);
+	bool cmdPrint(int argc, const char **argv);
+	bool cmdRepl(int argc, const char **argv);
+	bool cmdBacktrace(int argc, const char **argv);
+	bool cmdDisasm(int argc, const char **argv);
+	bool cmdStack(int argc, const char **argv);
+	bool cmdScriptFrame(int argc, const char **argv);
+	bool cmdFuncs(int argc, const char **argv);
+	bool cmdActions(int argc, const char **argv);
+	bool cmdVar(int argc, const char **argv);
+	bool cmdMarkers(int argc, const char **argv);
+	bool cmdStep(int argc, const char **argv);
+	bool cmdNext(int argc, const char **argv);
+	bool cmdFinish(int argc, const char **argv);
+	bool cmdWindows(int argc, const char **argv);
+	bool cmdXLibs(int argc, const char **argv);
+
+	bool cmdBpSet(int argc, const char **argv);
+	bool cmdBpMovie(int argc, const char **argv);
+	bool cmdBpFrame(int argc, const char **argv);
+	bool cmdBpEntity(int argc, const char **argv);
+	bool cmdBpProp(int argc, const char **argv);
+	bool cmdBpVar(int argc, const char **argv);
+	bool cmdBpEvent(int argc, const char **argv);
+	bool cmdBpDel(int argc, const char **argv);
+	bool cmdBpEnable(int argc, const char **argv);
+	bool cmdBpDisable(int argc, const char **argv);
+	bool cmdBpList(int argc, const char **argv);
+
+	bool cmdDraw(int argc, const char **argv);
+	bool cmdForceRedraw(int argc, const char **argv);
+
+	void bpUpdateState();
+	void bpTest(bool forceCheck = false);
+
+	bool lingoCommandProcessor(const char *inputOrig);
+	bool lingoEval(const char *inputOrig);
+
+
+	Common::DumpFile _out;
+	Common::Path _outName;
+
+	bool _nextFrame;
+	int _nextFrameCounter;
+	bool _nextMovie;
+	bool _step;
+	int _stepCounter;
+	bool _finish;
+	int _finishCounter;
+	bool _next;
+	int _nextCounter;
+	bool _lingoEval;
+	bool _lingoReplMode;
+
+	bool _bpCheckFunc = false;
+	bool _bpCheckMoviePath = false;
+	bool _bpNextMovieMatch = false;
+	Common::String _bpMatchFuncName;
+	uint _bpMatchScriptId = 0;
+	Common::String _bpMatchMoviePath;
+	Common::HashMap<uint, void *> _bpMatchFuncOffsets;
+	Common::HashMap<uint, void *> _bpMatchFrameOffsets;
+	bool _bpCheckPropRead = false;
+	bool _bpCheckPropWrite = false;
+	bool _bpCheckVarRead = false;
+	bool _bpCheckVarWrite = false;
+	bool _bpCheckEntityRead = false;
+	bool _bpCheckEntityWrite = false;
+	bool _bpCheckEvent = false;
+};
+
+
+} // End of namespace Director
+
+#endif