aboutsummaryrefslogtreecommitdiff
path: root/engines/director/lingo/lingo.h
blob: 550156c1c759561491e2fdba0622fdad258dbb3c (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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
/* 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.
 *
 */

#ifndef DIRECTOR_LINGO_LINGO_H
#define DIRECTOR_LINGO_LINGO_H

#include "audio/audiostream.h"
#include "common/hash-str.h"

#include "director/director.h"
#include "director/score.h"
#include "director/lingo/lingo-gr.h"
#include "director/lingo/lingo-the.h"

namespace Director {

enum LEvent {
	kEventPrepareMovie,
	kEventStartMovie,
	kEventStepMovie,
	kEventStopMovie,

	kEventNew,
	kEventBeginSprite,
	kEventEndSprite,

	kEventNone,
	kEventEnterFrame,
	kEventPrepareFrame,
	kEventIdle,
	kEventStepFrame,
	kEventExitFrame,
	kEventTimeout,

	kEventActivateWindow,
	kEventDeactivateWindow,
	kEventMoveWindow,
	kEventResizeWindow,
	kEventOpenWindow,
	kEventCloseWindow,

	kEventKeyUp,
	kEventKeyDown,
	kEventMouseUp,
	kEventMouseDown,
	kEventRightMouseUp,
	kEventRightMouseDown,
	kEventMouseEnter,
	kEventMouseLeave,
	kEventMouseUpOutSide,
	kEventMouseWithin,

	kEventStart
};

typedef void (*inst)(void);
#define	STOP (inst)0
#define ENTITY_INDEX(t,id) ((t) * 100000 + (id))

typedef Common::Array<inst> ScriptData;
typedef Common::Array<double> FloatArray;

struct FuncDesc {
	Common::String name;
	const char *proto;

	FuncDesc(Common::String n, const char *p) { name = n; proto = p; }
};

struct Pointer_EqualTo {
	bool operator()(const void *x, const void *y) const { return x == y; }
};

struct Pointer_Hash {
	uint operator()(const void *x) const {
#ifdef SCUMM_64BITS
		uint64 v = (uint64)x;
		return (v >> 32) ^ (v & 0xffffffff);
#else
		return (uint)x;
#endif
	}
};

typedef Common::HashMap<void *, FuncDesc *, Pointer_Hash, Pointer_EqualTo> FuncHash;

struct Symbol {	/* symbol table entry */
	Common::String name;
	int type;
	union {
		int		i;			/* VAR */
		double	f;			/* FLOAT */
		ScriptData	*defn;	/* FUNCTION, PROCEDURE */
		void (*func)();		/* OPCODE */
		void (*bltin)(int);	/* BUILTIN */
		Common::String	*s;	/* STRING */
		FloatArray *arr;	/* ARRAY, POINT, RECT */
	} u;
	int nargs;		/* number of arguments */
	int maxArgs;	/* maximal number of arguments, for builtins */
	bool parens;	/* whether parens required or not, for builitins */

	bool global;

	Symbol();
};

struct Datum {	/* interpreter stack type */
	int type;

	union {
		int	i;
		double f;
		Common::String *s;
		Symbol	*sym;
		FloatArray *arr;	/* ARRAY, POINT, RECT */
	} u;

	Datum() { u.sym = NULL; type = VOID; }
	Datum(int val) { u.i = val; type = INT; }
	Datum(double val) { u.f = val; type = FLOAT; }
	Datum(Common::String *val) { u.s = val; type = STRING; }

	double toFloat();
	int toInt();
	Common::String *toString();

	const char *type2str(bool isk = false);
};

struct Builtin {
	void (*func)(void);
	int nargs;

	Builtin(void (*func1)(void), int nargs1) : func(func1), nargs(nargs1) {}
};

typedef Common::HashMap<int32, ScriptData *> ScriptHash;
typedef Common::Array<Datum> StackData;
typedef Common::HashMap<Common::String, Symbol *, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> SymbolHash;
typedef Common::HashMap<Common::String, Builtin *, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> BuiltinHash;

typedef Common::HashMap<Common::String, TheEntity *, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> TheEntityHash;
typedef Common::HashMap<Common::String, TheEntityField *, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> TheEntityFieldHash;

struct CFrame {	/* proc/func call stack frame */
	Symbol	*sp;	/* symbol table entry */
	int		retpc;	/* where to resume after return */
	ScriptData	*retscript;	 /* which script to resume after return */
	SymbolHash *localvars;
};

class Lingo {
public:
	Lingo(DirectorEngine *vm);
	~Lingo();

	void restartLingo();

	void addCode(const char *code, ScriptType type, uint16 id);
	void executeScript(ScriptType type, uint16 id);
	void printStack(const char *s);
	Common::String decodeInstruction(uint pc, uint *newPC = NULL);

	ScriptType event2script(LEvent ev);
	Symbol *getHandler(Common::String &name);

	void processEvent(LEvent event, ScriptType st, int entityId);

	void initBuiltIns();
	void initFuncs();
	void initTheEntities();

	Common::String *toLowercaseMac(Common::String *s);

	void runTests();

private:
	const char *findNextDefinition(const char *s);

public:
	void execute(uint pc);
	void pushContext();
	void popContext();
	Symbol *lookupVar(const char *name, bool create = true, bool putInGlobalList = false);
	void cleanLocalVars();
	void define(Common::String &s, int start, int nargs, Common::String *prefix = NULL, int end = -1);
	void processIf(int elselabel, int endlabel);

	int alignTypes(Datum &d1, Datum &d2);

	int code1(inst code) { _currentScript->push_back(code); return _currentScript->size() - 1; }
	int code2(inst code_1, inst code_2) { int o = code1(code_1); code1(code_2); return o; }
	int code3(inst code_1, inst code_2, inst code_3) { int o = code1(code_1); code1(code_2); code1(code_3); return o; }
	int codeString(const char *s);
	void codeLabel(int label);
	int codeConst(int val);
	int codeArray(int arraySize);

	int calcStringAlignment(const char *s) {
		return calcCodeAlignment(strlen(s) + 1);
	}
	int calcCodeAlignment(int l) {
		int instLen = sizeof(inst);
		return (l + instLen - 1) / instLen;
	}

	void codeArg(Common::String *s);
	void codeArgStore();
	int codeSetImmediate(bool state);
	int codeFunc(Common::String *s, int numpar);
	int codeMe(Common::String *method, int numpar);
	int codeFloat(double f);
	void codeFactory(Common::String &s);

	void pushVoid();

	static void c_xpop();
	static void c_printtop();

	static void c_add();
	static void c_sub();
	static void c_mul();
	static void c_div();
	static void c_mod();
	static void c_negate();

	static void c_and();
	static void c_or();
	static void c_not();

	static void c_ampersand();
	static void c_after();
	static void c_before();
	static void c_concat();
	static void c_contains();
	static void c_starts();

	static void c_intersects();
	static void c_within();
	static void c_charOf();
	static void c_charToOf();
	static void c_itemOf();
	static void c_itemToOf();
	static void c_lineOf();
	static void c_lineToOf();
	static void c_wordOf();
	static void c_wordToOf();

	static void c_constpush();
	static void c_voidpush();
	static void c_fconstpush();
	static void c_stringpush();
	static void c_symbolpush();
	static void c_varpush();
	static void c_arraypush();
	static void c_assign();
	bool verify(Symbol *s);
	static void c_eval();
	static void c_setImmediate();

	static void c_swap();

	static void c_theentitypush();
	static void c_theentityassign();

	static void c_repeatwhilecode();
	static void c_repeatwithcode();
	static void c_ifcode();
	static void c_whencode();
	static void c_tellcode();
	static void c_exitRepeat();
	static void c_eq();
	static void c_neq();
	static void c_gt();
	static void c_lt();
	static void c_ge();
	static void c_le();
	static void c_call();

	void call(Common::String name, int nargs);

	static void c_procret();

	static void c_mci();
	static void c_mciwait();
	static void c_goto();
	static void c_gotoloop();
	static void c_gotonext();
	static void c_gotoprevious();
	static void c_global();
	static void c_instance();
	static void c_property();

	static void c_play();
	static void c_playdone();

	static void c_open();

	void printSTUBWithArglist(const char *funcname, int nargs);
	void convertVOIDtoString(int arg, int nargs);
	void dropStack(int nargs);
	void drop(uint num);

	static void b_abs(int nargs);
	static void b_atan(int nargs);
	static void b_cos(int nargs);
	static void b_exp(int nargs);
	static void b_float(int nargs);
	static void b_integer(int nargs);
	static void b_log(int nargs);
	static void b_pi(int nargs);
	static void b_power(int nargs);
	static void b_random(int nargs);
	static void b_sin(int nargs);
	static void b_sqrt(int nargs);
	static void b_tan(int nargs);

	static void b_chars(int nargs);
	static void b_charToNum(int nargs);
	static void b_delete(int nargs);
	static void b_hilite(int nargs);
	static void b_length(int nargs);
	static void b_numToChar(int nargs);
	static void b_offset(int nargs);
	static void b_string(int nargs);

	static void b_add(int nargs);
	static void b_addAt(int nargs);
	static void b_addProp(int nargs);
	static void b_append(int nargs);
	static void b_count(int nargs);
	static void b_deleteAt(int nargs);
	static void b_deleteProp(int nargs);
	static void b_findPos(int nargs);
	static void b_findPosNear(int nargs);
	static void b_getaProp(int nargs);
	static void b_getAt(int nargs);
	static void b_getLast(int nargs);
	static void b_getOne(int nargs);
	static void b_getPos(int nargs);
	static void b_getProp(int nargs);
	static void b_getPropAt(int nargs);
	static void b_list(int nargs);
	static void b_listP(int nargs);
	static void b_max(int nargs);
	static void b_min(int nargs);
	static void b_setaProp(int nargs);
	static void b_setAt(int nargs);
	static void b_setProp(int nargs);
	static void b_sort(int nargs);

	static void b_floatP(int nargs);
	static void b_ilk(int nargs);
	static void b_integerp(int nargs);
	static void b_objectp(int nargs);
	static void b_pictureP(int nargs);
	static void b_stringp(int nargs);
	static void b_symbolp(int nargs);
	static void b_voidP(int nargs);

	static void b_alert(int nargs);
	static void b_birth(int nargs);
	static void b_clearGlobals(int nargs);
	static void b_cursor(int nargs);
	static void b_framesToHMS(int nargs);
	static void b_HMStoFrames(int nargs);
	static void b_param(int nargs);
	static void b_printFrom(int nargs);
	static void b_showGlobals(int nargs);
	static void b_showLocals(int nargs);
	static void b_value(int nargs);

	static void b_constrainH(int nargs);
	static void b_constrainV(int nargs);
	static void b_copyToClipBoard(int nargs);
	static void b_duplicate(int nargs);
	static void b_editableText(int nargs);
	static void b_erase(int nargs);
	static void b_findEmpty(int nargs);
	static void b_importFileInto(int nargs);
	static void b_installMenu(int nargs);
	static void b_label(int nargs);
	static void b_marker(int nargs);
	static void b_move(int nargs);
	static void b_moveableSprite(int nargs);
	static void b_pasteClipBoardInto(int nargs);
	static void b_puppetPalette(int nargs);
	static void b_puppetSound(int nargs);
	static void b_puppetSprite(int nargs);
	static void b_puppetTempo(int nargs);
	static void b_puppetTransition(int nargs);
	static void b_ramNeeded(int nargs);
	static void b_rollOver(int nargs);
	static void b_spriteBox(int nargs);
	static void b_unLoad(int nargs);
	static void b_unLoadCast(int nargs);
	static void b_updateStage(int nargs);
	static void b_zoomBox(int nargs);

	static void b_abort(int nargs);
	static void b_continue(int nargs);
	static void b_dontPassEvent(int nargs);
	static void b_delay(int nargs);
	static void b_do(int nargs);
	static void b_halt(int nargs);
	static void b_nothing(int nargs);
	static void b_pass(int nargs);
	static void b_pause(int nargs);
	static void b_playAccel(int nargs);
	static void b_preLoad(int nargs);
	static void b_preLoadCast(int nargs);
	static void b_quit(int nargs);
	static void b_restart(int nargs);
	static void b_shutDown(int nargs);
	static void b_startTimer(int nargs);

	static void b_closeDA(int nargs);
	static void b_closeResFile(int nargs);
	static void b_closeXlib(int nargs);
	static void b_getNthFileNameInFolder(int nargs);
	static void b_openDA(int nargs);
	static void b_openResFile(int nargs);
	static void b_openXlib(int nargs);
	static void b_setCallBack(int nargs);
	static void b_saveMovie(int nargs);
	static void b_showResFile(int nargs);
	static void b_showXlib(int nargs);
	static void b_xFactoryList(int nargs);

	static void b_point(int nargs);
	static void b_inside(int nargs);
	static void b_intersect(int nargs);
	static void b_map(int nargs);
	static void b_offsetRect(int nargs);
	static void b_rect(int nargs);
	static void b_union(int nargs);

	static void b_close(int nargs);
	static void b_forget(int nargs);
	static void b_inflate(int nargs);
	static void b_moveToBack(int nargs);
	static void b_moveToFront(int nargs);
	static void b_window(int nargs);

	static void b_beep(int nargs);
	static void b_mci(int nargs);
	static void b_mciwait(int nargs);
	static void b_soundBusy(int nargs);
	static void b_soundClose(int nargs);
	static void b_soundFadeIn(int nargs);
	static void b_soundFadeOut(int nargs);
	static void b_soundPlayFile(int nargs);
	static void b_soundStop(int nargs);

	static void b_ancestor(int nargs);
	static void b_backspace(int nargs);
	static void b_empty(int nargs);
	static void b_enter(int nargs);
	static void b_false(int nargs);
	static void b_quote(int nargs);
	static void b_return(int nargs);
	static void b_tab(int nargs);
	static void b_true(int nargs);
	static void b_version(int nargs);

	static void b_factory(int nargs);
	void factoryCall(Common::String &name, int nargs);

	static void b_cast(int nargs);
	static void b_field(int nargs);
	static void b_me(int nargs);
	static void b_script(int nargs);

	void func_mci(Common::String &s);
	void func_mciwait(Common::String &s);
	void func_beep(int repeats);
	void func_goto(Datum &frame, Datum &movie);
	void func_gotoloop();
	void func_gotonext();
	void func_gotoprevious();
	void func_cursor(int c);
	int func_marker(int m);

public:
	void setTheEntity(int entity, Datum &id, int field, Datum &d);
	void setTheSprite(Datum &id, int field, Datum &d);
	void setTheCast(Datum &id, int field, Datum &d);
	Datum getTheEntity(int entity, Datum &id, int field);
	Datum getTheSprite(Datum &id, int field);
	Datum getTheCast(Datum &id, int field);

public:
	ScriptData *_currentScript;
	ScriptType _currentScriptType;
	uint16 _currentEntityId;
	bool _returning;
	bool _indef;
	bool _ignoreMe;
	bool _immediateMode;

	Common::Array<CFrame *> _callstack;
	Common::Array<Common::String *> _argstack;
	TheEntityHash _theEntities;
	TheEntityFieldHash _theEntityFields;
	Common::Array<int> _labelstack;

	SymbolHash _builtins;
	Common::HashMap<Common::String, bool> _twoWordBuiltins;
	Common::HashMap<uint32, Symbol *> _handlers;

	int _linenumber;
	int _colnumber;

	Common::String _floatPrecisionFormat;

	bool _hadError;

	bool _inFactory;
	Common::String _currentFactory;

	bool _exitRepeat;

	bool _cursorOnStack;

private:
	int parse(const char *code);
	void parseMenu(const char *code);

	void push(Datum d);
	Datum pop(void);

	Common::HashMap<uint32, const char *> _eventHandlerTypes;
	Common::HashMap<Common::String, uint32> _eventHandlerTypeIds;
	Common::HashMap<Common::String, Audio::AudioStream *> _audioAliases;

	ScriptHash _scripts[kMaxScriptType + 1];

	SymbolHash _globalvars;
	SymbolHash *_localvars;

	FuncHash _functions;

	uint _pc;

	StackData _stack;

	DirectorEngine *_vm;

	int _floatPrecision;
};

extern Lingo *g_lingo;

} // End of namespace Director

#endif