aboutsummaryrefslogtreecommitdiff
path: root/engines/wintermute/Base/BDebugger.h
blob: a3da66cc9f9ea153536012c2ce0e895a26b083fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/* 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.
 *
 */

/*
 * This file is based on WME Lite.
 * http://dead-code.org/redir.php?target=wmelite
 * Copyright (c) 2011 Jan Nedoma
 */

#ifndef WINTERMUTE_BDEBUGGER_H
#define WINTERMUTE_BDEBUGGER_H


#include "engines/wintermute/Base/BBase.h"
#include "engines/wintermute/wme_debugger.h"

// TODO: The entire debugger should possibly be removed

namespace WinterMute {
class CScScript;
class CScValue;
class CBDebugger : public CBBase, public IWmeDebugServer {
public:
	CBDebugger(CBGame *inGame);
	virtual ~CBDebugger(void);

	// initialization
	bool _enabled;
	ERRORCODE initialize();
	ERRORCODE shutdown();

	// internal interface
	ERRORCODE onGameInit();
	ERRORCODE onGameShutdown();
	ERRORCODE onGameTick();
	ERRORCODE onLog(unsigned int errorCode, const char *text);
	ERRORCODE onScriptInit(CScScript *script);
	ERRORCODE onScriptEventThreadInit(CScScript *script, CScScript *parentScript, const char *name);
	ERRORCODE onScriptMethodThreadInit(CScScript *script, CScScript *parentScript, const char *name);

	ERRORCODE onScriptShutdown(CScScript *script);
	ERRORCODE onScriptChangeLine(CScScript *script, int line);
	ERRORCODE onScriptChangeScope(CScScript *script, CScValue *scope);
	ERRORCODE onScriptShutdownScope(CScScript *script, CScValue *scope);
	ERRORCODE onVariableInit(EWmeDebuggerVariableType type, CScScript *script, CScValue *scope, CScValue *var, const char *variableName);
	ERRORCODE onVariableChangeValue(CScValue *var, CScValue *value);

	ERRORCODE onScriptHitBreakpoint(CScScript *script);

	// IWmeDebugServer interface
	virtual bool attachClient(IWmeDebugClient *client);
	virtual bool detachClient(IWmeDebugClient *client);
	virtual bool queryData(IWmeDebugClient *client);

	virtual int getPropInt(const char *propName);
	virtual double getPropFloat(const char *propName);
	virtual const char *getPropString(const char *propName);
	virtual bool getPropBool(const char *propName);

	virtual bool setProp(const char *propName, int propValue);
	virtual bool setProp(const char *propName, double propValue);
	virtual bool setProp(const char *propName, const char *propValue);
	virtual bool setProp(const char *propName, bool propValue);

	virtual bool resolveFilename(const char *relativeFilename, char *absFilenameBuf, int absBufSize);

	virtual bool addBreakpoint(const char *scriptFilename, int line);
	virtual bool removeBreakpoint(const char *scriptFilename, int line);

	virtual bool continueExecution();
private:
};

} // end of namespace WinterMute

#endif