aboutsummaryrefslogtreecommitdiff
path: root/saga/script.h
blob: b45c64e6fd3506b7037a9f5f6433639d8fc28fca (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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/* ScummVM - Scumm Interpreter
 * Copyright (C) 2004 The ScummVM project
 *
 * The ReInherit Engine is (C)2000-2003 by Daniel Balsom.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * $Header$
 *
 */

// Scripting module private header

#ifndef SAGA_SCRIPT_H
#define SAGA_SCRIPT_H

#include "saga/text.h"
#include "saga/yslib.h"

namespace Saga {

#define SCRIPT_DATABUF_NUM 5
#define SCRIPT_DATABUF_LEN 1024

#define S_LUT_ENTRYLEN_ITECD 22
#define S_LUT_ENTRYLEN_ITEDISK 16

#define SCRIPT_TBLENTRY_LEN 4

#define SCRIPT_MAX 5000
#define SCRIPTLIST_HDR 12
#define SCRIPT_STRINGLIMIT 255
#define TAB "    "

#define S_ERROR_PREFIX "SError: "
#define S_WARN_PREFIX "SWarning: "

#define SFUNC_NUM 78

typedef unsigned int SDataWord_T;

enum SCRIPT_VERBS {
	S_VERB_WALKTO = 0,
	S_VERB_LOOKAT = 2,
	S_VERB_PICKUP = 1,
	S_VERB_TALKTO,
	S_VERB_OPEN = 5,
	S_VERB_CLOSE = 6,
	S_VERB_USE = 8,
	S_VERB_GIVE
};

#define STHREAD_TIMESLICE 8

struct SEMAPHORE {
	int hold_count;
};

enum {
	kVarObject = 0,
	kVarWithObject,
	kVarAction,
	kVarActor
};

enum {
	kTFlagNone = 0,
	kTFlagWaiting = 1,	// wait for even denoted in waitType
	kTFlagFinished = 2,
	kTFlagAborted = 4,
	kTFlagAsleep = 7	// Combination of all flags which can halt a thread
};

enum {
	kTWaitNone = 0,		// waiting for nothing
	kTWaitDelay,		// waiting for a timer
	kTWaitSpeech,		// waiting for speech to finish
	kTWaitDialogEnd,	// waiting for my dialog to finish
	kTWaitDialogBegin,	// waiting for other dialog to finish
	kTWaitWalk,			// waiting to finish walking
	kTWaitRequest,		// a request is up
	kTWaitPause
};

struct SCRIPT_THREAD {
	int flags;
	int waitType;

	uint sleepTime;
	int ep_num; // Entrypoint number
	unsigned long ep_offset; // Entrypoint offset
	unsigned long i_offset; // Instruction offset

	SEMAPHORE sem; // FIXME: no equivalent. should be replaced with flags

	// The scripts are allowed to access the stack like any other memory
	// area. It's therefore probably quite important that our stacks work
	// the same as in the original interpreter.

	SDataWord_T stackBuf[64];

	int stackPtr;
	int framePtr;

	SDataWord_T threadVars[4];

	SDataWord_T retVal;

	SDataWord_T stackTop() {
		return stackBuf[stackPtr];
	}

	int stackSize() {
		return ARRAYSIZE(stackBuf) - stackPtr - 1;
	}

	void push(SDataWord_T n) {
		assert(stackPtr > 0);
		stackBuf[--stackPtr] = n;
	}

	SDataWord_T pop() {
		assert(stackPtr < ARRAYSIZE(stackBuf));
		return stackBuf[stackPtr++];
	}
};

struct PROC_TBLENTRY {
	size_t name_offset;
	size_t offset;
};

struct SCRIPT_BYTECODE {
	unsigned char *bytecode_p;
	size_t bytecode_len;
	size_t ep_tbl_offset;
	unsigned long n_entrypoints;
	PROC_TBLENTRY *entrypoints;
};

struct DIALOGUE_LIST {
	unsigned int n_dialogue;
	const char **str;
	size_t *str_off;
};

struct VOICE_LUT {
	int n_voices;
	int *voices;
};

struct SCRIPTDATA {
	int loaded;
	SCRIPT_BYTECODE *bytecode;
	DIALOGUE_LIST *diag;
	VOICE_LUT *voice;
};

struct SCRIPT_LUT_ENTRY {
	int script_rn;
	int diag_list_rn;
	int voice_lut_rn;
};

struct SCRIPT_DATABUF {
	SDataWord_T *data;
	int len;
};

#define SCRIPTFUNC_PARAMS SCRIPT_THREAD *thread, int nArgs

class Script {
public:
	Script();
	~Script();
	
	int reg(void);
	int loadScript(int scriptNum);
	int freeScript();
	SCRIPT_BYTECODE *loadBytecode(byte *bytecode_p, size_t bytecode_len);
	DIALOGUE_LIST *loadDialogue(const byte *dialogue_p, size_t dialogue_len);
	VOICE_LUT *loadVoiceLUT(const byte *voicelut_p, size_t voicelut_len, SCRIPTDATA *script);
	int disassemble(SCRIPT_BYTECODE *script_list, DIALOGUE_LIST *diag_list);

	bool isInitialized() const { return _initialized;  }
	bool isVoiceLUTPresent() const { return _voiceLUTPresent; }
	SCRIPTDATA *currentScript() { return _currentScript; }
	void setBuffer(int idx, SCRIPT_DATABUF *ptr) { _dataBuf[idx] = ptr; }
	SCRIPT_DATABUF *dataBuffer(int idx) { return _dataBuf[idx]; }
	YS_DL_LIST *threadList() { return _threadList; }

	void scriptInfo(int argc, char *argv[]);
	void scriptExec(int argc, char *argv[]);
	
protected:
	bool _initialized;
	bool _voiceLUTPresent;
	RSCFILE_CONTEXT *_scriptContext;
	SCRIPT_LUT_ENTRY *_scriptLUT;
	int _scriptLUTMax;
	uint16 _scriptLUTEntryLen;
	SCRIPTDATA *_currentScript;
	SCRIPT_DATABUF *_dataBuf[SCRIPT_DATABUF_NUM];
	YS_DL_LIST *_threadList;

	bool _skipSpeeches;
	bool _abortEnabled;

public:
	int _dbg_singlestep;
	int _dbg_dostep;
	SCRIPT_THREAD *_dbg_thread;
	TEXTLIST_ENTRY *_dbg_txtentry;

public:
	SCRIPT_THREAD *SThreadCreate();
	int SThreadExecute(SCRIPT_THREAD *thread, int ep_num);
	int SThreadExecThreads(uint msec);
	int SThreadHoldSem(SEMAPHORE *sem);
	int SThreadReleaseSem(SEMAPHORE *sem);
	int SThreadDebugStep();
	void SThreadCompleteThread(void);
	int SThreadDestroy(SCRIPT_THREAD *thread);
	void SThreadAbortAll(void);

private:
	void setFramePtr(SCRIPT_THREAD *thread, int newPtr);
	unsigned char *SThreadGetReadPtr(SCRIPT_THREAD *thread);
	unsigned long SThreadGetReadOffset(const byte *read_p);
	size_t SThreadGetReadLen(SCRIPT_THREAD *thread);
	int SThreadRun(SCRIPT_THREAD *thread, int instr_limit);
	int SThreadSetEntrypoint(SCRIPT_THREAD *thread, int ep_num);

private:
	typedef int (Script::*SFunc_T)(SCRIPTFUNC_PARAMS);

	const SFunc_T *_SFuncList;

	void setupScriptFuncList(void);
	int SDebugPrintInstr(SCRIPT_THREAD *thread);

	int SF_putString(SCRIPTFUNC_PARAMS);
	int SF_sleep(SCRIPTFUNC_PARAMS);
	int SF_takeObject(SCRIPTFUNC_PARAMS);
	int SF_objectIsCarried(SCRIPTFUNC_PARAMS);
	int SF_setStatusText(SCRIPTFUNC_PARAMS);
	int SF_commandMode(SCRIPTFUNC_PARAMS);
	int SF_actorWalkTo(SCRIPTFUNC_PARAMS);
	int SF_doAction(SCRIPTFUNC_PARAMS);
	int SF_setFacing(SCRIPTFUNC_PARAMS);
	int SF_startBgdAnim(SCRIPTFUNC_PARAMS);
	int SF_stopBgdAnim(SCRIPTFUNC_PARAMS);
	int SF_freezeInterface(SCRIPTFUNC_PARAMS);
	int SF_dialogMode(SCRIPTFUNC_PARAMS);
	int SF_killActorThreads(SCRIPTFUNC_PARAMS);
	int SF_faceTowards(SCRIPTFUNC_PARAMS);
	int SF_setFollower(SCRIPTFUNC_PARAMS);
	int SF_gotoScene(SCRIPTFUNC_PARAMS);
	int SF_setObjImage(SCRIPTFUNC_PARAMS);
	int SF_setObjName(SCRIPTFUNC_PARAMS);
	int SF_getObjImage(SCRIPTFUNC_PARAMS);
	int SF_getNumber(SCRIPTFUNC_PARAMS);
	int SF_openDoor(SCRIPTFUNC_PARAMS);
	int SF_closeDoor(SCRIPTFUNC_PARAMS);
	int SF_setBgdAnimSpeed(SCRIPTFUNC_PARAMS);
	int SF_cycleColors(SCRIPTFUNC_PARAMS);
	int SF_centerActor(SCRIPTFUNC_PARAMS);
	int SF_startAnim(SCRIPTFUNC_PARAMS);
	int SF_actorWalkToAsync(SCRIPTFUNC_PARAMS);
	int SF_enableZone(SCRIPTFUNC_PARAMS);
	int SF_setActorState(SCRIPTFUNC_PARAMS);
	int SF_moveTo(SCRIPTFUNC_PARAMS);
	int SF_sceneEq(SCRIPTFUNC_PARAMS);
	int SF_dropObject(SCRIPTFUNC_PARAMS);
	int SF_finishBgdAnim(SCRIPTFUNC_PARAMS);
	int SF_swapActors(SCRIPTFUNC_PARAMS);
	int SF_simulSpeech(SCRIPTFUNC_PARAMS);
	int SF_actorWalk(SCRIPTFUNC_PARAMS);
	int SF_cycleActorFrames(SCRIPTFUNC_PARAMS);
	int SF_setFrame(SCRIPTFUNC_PARAMS);
	int SF_setRightPortrait(SCRIPTFUNC_PARAMS);
	int SF_setLeftPortrait(SCRIPTFUNC_PARAMS);
	int SF_linkAnim(SCRIPTFUNC_PARAMS);
	int SF_scriptSpecialWalk(SCRIPTFUNC_PARAMS);
	int SF_placeActor(SCRIPTFUNC_PARAMS);
	int SF_checkUserInterrupt(SCRIPTFUNC_PARAMS);
	int SF_walkRelative(SCRIPTFUNC_PARAMS);
	int SF_moveRelative(SCRIPTFUNC_PARAMS);
	int SF_simulSpeech2(SCRIPTFUNC_PARAMS);
	int SF_placard(SCRIPTFUNC_PARAMS);
	int SF_placardOff(SCRIPTFUNC_PARAMS);
	int SF_setProtagState(SCRIPTFUNC_PARAMS);
	int SF_resumeBgdAnim(SCRIPTFUNC_PARAMS);
	int SF_throwActor(SCRIPTFUNC_PARAMS);
	int SF_waitWalk(SCRIPTFUNC_PARAMS);
	int SF_sceneID(SCRIPTFUNC_PARAMS);
	int SF_changeActorScene(SCRIPTFUNC_PARAMS);
	int SF_climb(SCRIPTFUNC_PARAMS);
	int SF_setDoorState(SCRIPTFUNC_PARAMS);
	int SF_setActorZ(SCRIPTFUNC_PARAMS);
	int SF_text(SCRIPTFUNC_PARAMS);
	int SF_getActorX(SCRIPTFUNC_PARAMS);
	int SF_getActorY(SCRIPTFUNC_PARAMS);
	int SF_eraseDelta(SCRIPTFUNC_PARAMS);
	int SF_playMusic(SCRIPTFUNC_PARAMS);
	int SF_pickClimbOutPos(SCRIPTFUNC_PARAMS);
	int SF_tossRif(SCRIPTFUNC_PARAMS);
	int SF_showControls(SCRIPTFUNC_PARAMS);
	int SF_showMap(SCRIPTFUNC_PARAMS);
	int SF_puzzleWon(SCRIPTFUNC_PARAMS);
	int SF_enableEscape(SCRIPTFUNC_PARAMS);
	int SF_playSound(SCRIPTFUNC_PARAMS);
	int SF_playLoopedSound(SCRIPTFUNC_PARAMS);
	int SF_getDeltaFrame(SCRIPTFUNC_PARAMS);
	int SF_showProtect(SCRIPTFUNC_PARAMS);
	int SF_protectResult(SCRIPTFUNC_PARAMS);
	int SF_rand(SCRIPTFUNC_PARAMS);
	int SF_fadeMusic(SCRIPTFUNC_PARAMS);
	int SF_playVoice(SCRIPTFUNC_PARAMS);
};

} // End of namespace Saga

#endif