aboutsummaryrefslogtreecommitdiff
path: root/engines/wintermute/Base/scriptables/ScEngine.h
blob: 4d545bea662ca67db1a28f3565ac5b6ba3609aa9 (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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/* 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_SCENGINE_H
#define WINTERMUTE_SCENGINE_H

#include "engines/wintermute/persistent.h"
#include "engines/wintermute/coll_templ.h"
#include "engines/wintermute/Base/BBase.h"
#include "engines/wintermute/wme_debugger.h"
#include "engines/wintermute/utils/utils.h"
#include "engines/wintermute/PlatformSDL.h"

namespace WinterMute {

typedef byte *(*DLL_COMPILE_BUFFER)(byte  *Buffer, char *Source, uint32 BufferSize, uint32 *CompiledSize);
typedef byte *(*DLL_COMPILE_FILE)(char *Filename, uint32 *CompiledSize);
typedef void (*DLL_RELEASE_BUFFER)(unsigned char *Buffer);
typedef void (*DLL_SET_CALLBACKS)(CALLBACKS *callbacks, void *Data);
typedef int (*DLL_DEFINE_FUNCTION)(const char *Name); /* Was non-const, changed to silence warnings */
typedef int (*DLL_DEFINE_VARIABLE)(const char *Name); /* Was non-const, changed to silence warnings */

typedef void (*COMPILE_ERROR_CALLBACK)(int Line, char *Text , void *Data);
typedef void (*PARSE_ELEMENT_CALLBACK)(int Line, int Type, void *ElementData, void *Data);

#define MAX_CACHED_SCRIPTS 20
class CScScript;
class CScValue;
class CBObject;
class CBScriptHolder;
class CScEngine : public CBBase {
public:
	class CScCachedScript {
	public:
		CScCachedScript(const char *Filename, byte *Buffer, uint32 Size) {
			_timestamp = CBPlatform::GetTime();
			_buffer = new byte[Size];
			if (_buffer) memcpy(_buffer, Buffer, Size);
			_size = Size;
			_filename = Filename;
		};

		~CScCachedScript() {
			if (_buffer) delete [] _buffer;
		};

		uint32 _timestamp;
		byte *_buffer;
		uint32 _size;
		Common::String _filename;
	};

	class CScBreakpoint {
	public:
		CScBreakpoint(const char *Filename) {
			_filename = Filename;
		}

		~CScBreakpoint() {
			_lines.RemoveAll();
		}

		Common::String _filename;
		CBArray<int, int> _lines;
	};




public:
	HRESULT DbgSendScripts(IWmeDebugClient *Client);

	CBArray<CScBreakpoint *, CScBreakpoint *> _breakpoints;
	HRESULT AddBreakpoint(const char *ScriptFilename, int Line);
	HRESULT RemoveBreakpoint(const char *ScriptFilename, int Line);
	HRESULT RefreshScriptBreakpoints();
	HRESULT RefreshScriptBreakpoints(CScScript *Script);
	HRESULT SaveBreakpoints();
	HRESULT LoadBreakpoints();

	HRESULT ClearGlobals(bool IncludingNatives = false);
	HRESULT TickUnbreakable();
	HRESULT RemoveFinishedScripts();
	bool IsValidScript(CScScript *Script);
	void SetCompileErrorCallback(COMPILE_ERROR_CALLBACK Callback, void *Data);
	void SetParseElementCallback(PARSE_ELEMENT_CALLBACK Callback, void *Data);

	COMPILE_ERROR_CALLBACK _compileErrorCallback;
	void *_compileErrorCallbackData;

	PARSE_ELEMENT_CALLBACK _parseElementCallback;
	void *_parseElementCallbackData;

	HRESULT SetFileToCompile(const char *Filename);
	char *_fileToCompile;
	CScScript *_currentScript;
	HRESULT ResumeAll();
	HRESULT PauseAll();
	void EditorCleanup();
	HRESULT ResetObject(CBObject *Object);
	HRESULT ResetScript(CScScript *Script);
	HRESULT EmptyScriptCache();
	byte *GetCompiledScript(const char *Filename, uint32 *OutSize, bool IgnoreCache = false);
	DECLARE_PERSISTENT(CScEngine, CBBase)
	HRESULT Cleanup();
	int GetNumScripts(int *Running = NULL, int *Waiting = NULL, int *Persistent = NULL);
	HRESULT Tick();
	CScValue *_globals;
	CScScript *RunScript(const char *Filename, CBScriptHolder *Owner = NULL);
	bool _compilerAvailable;
	HINSTANCE _compilerDLL;
	CScEngine(CBGame *inGame);
	virtual ~CScEngine();
	static void WINAPI AddError(void *Data, int Line, char *Text);
	static byte *WINAPI LoadFile(void *Data, char *Filename, uint32 *Size);
	static void  WINAPI CloseFile(void *Data, byte *Buffer);
	static void WINAPI ParseElement(void *Data, int Line, int Type, void *ElementData);
	DLL_COMPILE_BUFFER  ExtCompileBuffer;
	DLL_COMPILE_FILE    ExtCompileFile;
	DLL_RELEASE_BUFFER  ExtReleaseBuffer;
	DLL_SET_CALLBACKS   ExtSetCallbacks;
	DLL_DEFINE_FUNCTION ExtDefineFunction;
	DLL_DEFINE_VARIABLE ExtDefineVariable;

	CBArray<CScScript *, CScScript *> _scripts;

	void EnableProfiling();
	void DisableProfiling();
	bool IsProfiling() {
		return _isProfiling;
	}

	void AddScriptTime(const char *Filename, uint32 Time);
	void DumpStats();

private:

	CScCachedScript *_cachedScripts[MAX_CACHED_SCRIPTS];
	bool _isProfiling;
	uint32 _profilingStartTime;

	typedef Common::HashMap<Common::String, uint32> ScriptTimes;
	ScriptTimes _scriptTimes;

};

} // end of namespace WinterMute

#endif