aboutsummaryrefslogtreecommitdiff
path: root/engines/draci/script.cpp
blob: 5f4edf07b534d70dcb05637c59e5d6e06ea1fd97 (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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
/* 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.
 *
 * $URL$
 * $Id$
 *
 */

#include "common/debug.h"
#include "common/stream.h"
#include "common/stack.h"
#include "common/queue.h"

#include "draci/draci.h"
#include "draci/script.h"
#include "draci/game.h"

namespace Draci {

// FIXME: Change parameter types to names once I figure out what they are exactly

void Script::setupCommandList() {
	/** A table of all the commands the game player uses */
	static const GPL2Command gplCommands[] = {
		{ 0,  0, "gplend",				0, { 0 }, NULL },
		{ 0,  1, "exit",				0, { 0 }, NULL },
		{ 1,  1, "goto", 				1, { 3 }, &Script::c_Goto },
		{ 2,  1, "Let", 				2, { 3, 4 }, &Script::c_Let },
		{ 3,  1, "if", 					2, { 4, 3 }, &Script::c_If },
		{ 4,  1, "Start", 				2, { 3, 2 }, &Script::start },
		{ 5,  1, "Load", 				2, { 3, 2 }, &Script::load },
		{ 5,  2, "StartPlay", 			2, { 3, 2 }, &Script::startPlay },
		{ 5,  3, "JustTalk", 			0, { 0 }, &Script::justTalk },
		{ 5,  4, "JustStay", 			0, { 0 }, &Script::justStay },
		{ 6,  1, "Talk", 				2, { 3, 2 }, &Script::talk },
		{ 7,  1, "ObjStat", 			2, { 3, 3 }, &Script::objStat },
		{ 7,  2, "ObjStat_On", 			2, { 3, 3 }, &Script::objStatOn },
		{ 8,  1, "IcoStat", 			2, { 3, 3 }, &Script::icoStat },
		{ 9,  1, "Dialogue", 			1, { 2 }, &Script::dialogue },
		{ 9,  2, "ExitDialogue", 		0, { 0 }, &Script::exitDialogue },
		{ 9,  3, "ResetDialogue", 		0, { 0 }, &Script::resetDialogue },
		{ 9,  4, "ResetDialogueFrom", 	0, { 0 }, &Script::resetDialogueFrom },
		{ 9,  5, "ResetBlock", 			1, { 3 }, &Script::resetBlock },
		{ 10, 1, "WalkOn", 				3, { 1, 1, 3 }, &Script::walkOn },
		{ 10, 2, "StayOn", 				3, { 1, 1, 3 }, &Script::walkOn }, // HACK: not a proper implementation
		{ 10, 3, "WalkOnPlay", 			3, { 1, 1, 3 }, &Script::walkOnPlay },
		{ 11, 1, "LoadPalette", 		1, { 2 }, &Script::loadPalette },
		{ 12, 1, "SetPalette", 			0, { 0 }, &Script::setPalette },
		{ 12, 2, "BlackPalette", 		0, { 0 }, &Script::blackPalette },
		{ 13, 1, "FadePalette", 		3, { 1, 1, 1 }, NULL },
		{ 13, 2, "FadePalettePlay", 	3, { 1, 1, 1 }, NULL },
		{ 14, 1, "NewRoom", 			2, { 3, 1 }, &Script::newRoom },
		{ 15, 1, "ExecInit", 			1, { 3 }, &Script::execInit },
		{ 15, 2, "ExecLook", 			1, { 3 }, &Script::execLook },
		{ 15, 3, "ExecUse", 			1, { 3 }, &Script::execUse },
		{ 16, 1, "RepaintInventory", 	0, { 0 }, NULL },	// not used in the original game files
		{ 16, 2, "ExitInventory", 		0, { 0 }, NULL },	// not used in the original game files
		{ 17, 1, "ExitMap", 			0, { 0 }, NULL },	// not used in the original game files
		{ 18, 1, "LoadMusic", 			1, { 2 }, NULL },
		{ 18, 2, "StartMusic", 			0, { 0 }, NULL },
		{ 18, 3, "StopMusic", 			0, { 0 }, NULL },
		{ 18, 4, "FadeOutMusic",		1, { 1 }, NULL },
		{ 18, 5, "FadeInMusic", 		1, { 1 }, NULL },
		{ 19, 1, "Mark", 				0, { 0 }, &Script::mark },
		{ 19, 2, "Release", 			0, { 0 }, &Script::release },
		{ 20, 1, "Play", 				0, { 0 }, &Script::play },
		{ 21, 1, "LoadMap", 			1, { 2 }, &Script::loadMap },
		{ 21, 2, "RoomMap", 			0, { 0 }, &Script::roomMap },
		{ 22, 1, "DisableQuickHero", 	0, { 0 }, NULL },
		{ 22, 2, "EnableQuickHero", 	0, { 0 }, NULL },
		{ 23, 1, "DisableSpeedText", 	0, { 0 }, NULL },
		{ 23, 2, "EnableSpeedText", 	0, { 0 }, NULL },
		{ 24, 1, "QuitGame", 			0, { 0 }, &Script::quitGame },
		{ 25, 1, "PushNewRoom", 		0, { 0 }, &Script::pushNewRoom },
		{ 25, 2, "PopNewRoom", 			0, { 0 }, &Script::popNewRoom },
		// The following commands are not even defined in the game
		// sources, but their numbers are allocated for internal
		// purposes of the old player.
		{ 26, 1, "ShowCheat", 			0, { 0 }, NULL },
		{ 26, 2, "HideCheat", 			0, { 0 }, NULL },
		{ 26, 3, "ClearCheat", 			1, { 1 }, NULL },
		{ 27, 1, "FeedPassword", 		3, { 1, 1, 1 }, NULL }
	};

	/** Operators used by the mathematical evaluator */
	static const GPL2Operator gplOperators[] = {
		{"&", 	&Script::operAnd 			},
		{"|",	&Script::operOr 			},
		{"^", 	&Script::operXor 			},
		{"==",	&Script::operEqual 			},
		{"!=", 	&Script::operNotEqual		},
		{"<", 	&Script::operLess			},
		{">", 	&Script::operGreater		},
		{"<=",	&Script::operLessOrEqual	},
		{">=",	&Script::operGreaterOrEqual	},
		{"*",	&Script::operMul			},
		{"/", 	&Script::operDiv			},
		{"%",	&Script::operMod			},
		{"+", 	&Script::operAdd			},
		{"-",	&Script::operSub			}
	};

	/** Functions used by the mathematical evaluator */
	static const GPL2Function gplFunctions[] = {
		{ "Not", 		&Script::funcNot },
		{ "Random", 	&Script::funcRandom },
		{ "IsIcoOn", 	&Script::funcIsIcoOn },
		{ "IsIcoAct", 	&Script::funcIsIcoAct },
		{ "IcoStat", 	&Script::funcIcoStat },
		{ "ActIco", 	&Script::funcActIco },
		{ "IsObjOn", 	&Script::funcIsObjOn },
		{ "IsObjOff", 	&Script::funcIsObjOff },
		{ "IsObjAway", 	&Script::funcIsObjAway },
		{ "ObjStat", 	&Script::funcObjStat },
		{ "LastBlock", 	&Script::funcLastBlock },
		{ "AtBegin", 	&Script::funcAtBegin },
		{ "BlockVar", 	&Script::funcBlockVar },
		{ "HasBeen", 	&Script::funcHasBeen },
		{ "MaxLine", 	&Script::funcMaxLine },
		{ "ActPhase", 	&Script::funcActPhase },
		{ "Cheat",  	NULL },
	};

	_commandList = gplCommands;
	_operatorList = gplOperators;
	_functionList = gplFunctions;
}

/** Type of mathematical object */
enum mathExpressionObject {
	kMathEnd,
	kMathNumber,
	kMathOperator,
	kMathFunctionCall,
	kMathVariable
};

/* GPL operators */

int Script::operAnd(int op1, int op2) const {
	return op1 & op2;
}

int Script::operOr(int op1, int op2) const {
	return op1 | op2;
}

int Script::operXor(int op1, int op2) const {
	return op1 ^ op2;
}

int Script::operEqual(int op1, int op2) const {
	return op1 == op2;
}

int Script::operNotEqual(int op1, int op2) const {
	return op1 != op2;
}

int Script::operLess(int op1, int op2) const {
	return op1 < op2;
}

int Script::operGreater(int op1, int op2) const {
	return op1 > op2;
}

int Script::operGreaterOrEqual(int op1, int op2) const {
	return op1 >= op2;
}

int Script::operLessOrEqual(int op1, int op2) const {
	return op1 <= op2;
}

int Script::operMul(int op1, int op2) const {
	return op1 * op2;
}

int Script::operAdd(int op1, int op2) const {
	return op1 + op2;
}

int Script::operSub(int op1, int op2) const {
	return op1 - op2;
}

int Script::operDiv(int op1, int op2) const {
	return op1 / op2;
}

int Script::operMod(int op1, int op2) const {
	return op1 % op2;
}

/* GPL functions */

int Script::funcRandom(int n) const {
// The function needs to return numbers in the [0..n-1] range so we need to deduce 1
// (RandomSource::getRandomNumber returns a number in the range [0..n])

	n -= 1;
	return _vm->_rnd.getRandomNumber(n);
}

int Script::funcAtBegin(int yesno) const {
	return _vm->_game->isDialogueBegin() == (bool)yesno;
}

int Script::funcLastBlock(int blockID) const {
	blockID -= 1;

	return _vm->_game->getDialogueLastBlock() == blockID;
}

int Script::funcBlockVar(int blockID) const {
	blockID -= 1;

	const int currentOffset = _vm->_game->getCurrentDialogueOffset();
	return _vm->_game->getDialogueVar(currentOffset + blockID);
}

int Script::funcHasBeen(int blockID) const {
	blockID -= 1;

	const int currentOffset = _vm->_game->getCurrentDialogueOffset();
	return _vm->_game->getDialogueVar(currentOffset + blockID) > 0;
}

int Script::funcMaxLine(int lines) const {
	return _vm->_game->getDialogueLinesNum() < lines;
}

int Script::funcNot(int n) const {
	return !n;
}

int Script::funcIsIcoOn(int itemID) const {
	itemID -= 1;

	return _vm->_game->getItemStatus(itemID) == 1;
}

int Script::funcIcoStat(int itemID) const {
	itemID -= 1;

	int status = _vm->_game->getItemStatus(itemID);
	return (status == 1) ? 1 : 2;
}

int Script::funcIsIcoAct(int itemID) const {
	itemID -= 1;

	return _vm->_game->getCurrentItem() == itemID;
}

int Script::funcActIco(int itemID) const {
	// The parameter seems to be an omission in the original player since it's not
	// used in the implementation of the function. It's possible that the functions were
	// implemented in such a way that they had to have a single parameter so this is only
	// passed as a dummy.

	return _vm->_game->getCurrentItem();
}

int Script::funcIsObjOn(int objID) const {
	objID -= 1;

	const GameObject *obj = _vm->_game->getObject(objID);

	return obj->_visible;
}

int Script::funcIsObjOff(int objID) const {
	objID -= 1;

	const GameObject *obj = _vm->_game->getObject(objID);

	// We index locations from 0 (as opposed to the original player where it was from 1)
	// That's why the "away" location 0 from the data files is converted to -1
	return !obj->_visible && obj->_location != -1;
}

int Script::funcObjStat(int objID) const {
	objID -= 1;

	const GameObject *obj = _vm->_game->getObject(objID);

	if (obj->_location == _vm->_game->getRoomNum()) {
		if (obj->_visible) {
			return 1;   // object is ON (in the room and visible)
		} else {
			return 2;   // object is OFF (in the room, not visible)
		}
	} else {
		return 3;       // object is AWAY (not in the room)
	}
}

int Script::funcIsObjAway(int objID) const {
	objID -= 1;

	const GameObject *obj = _vm->_game->getObject(objID);

	// see Script::funcIsObjOff
	return !obj->_visible && obj->_location == -1;
}

int Script::funcActPhase(int objID) const {
	objID -= 1;

	// Default return value
	int ret = 0;

	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return ret;
	}

	const GameObject *obj = _vm->_game->getObject(objID);

	bool visible = (obj->_location == _vm->_game->getRoomNum() && obj->_visible);

	if (objID == kDragonObject || visible) {
		const int i = _vm->_game->playingObjectAnimation(obj);
		if (i >= 0) {
			int animID = obj->_anim[i];
			Animation *anim = _vm->_anims->getAnimation(animID);
			ret = anim->currentFrameNum();
		}
	}

	return ret;
}

/* GPL commands */

void Script::play(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	_vm->_game->setLoopSubstatus(kSubstatusStrange);
	_vm->_game->setExitLoop(true);
	_vm->_game->loop();
	_vm->_game->setExitLoop(false);
	_vm->_game->setLoopSubstatus(kSubstatusOrdinary);
}

Animation *Script::loadObjectAnimation(GameObject *obj, int animID) {
	_vm->_game->loadAnimation(animID, obj->_z);
	obj->_anim.push_back(animID);
	return _vm->_anims->getAnimation(animID);
}

void Script::load(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int objID = params.pop() - 1;
	int animID = params.pop() - 1;

	uint i;
	GameObject *obj = _vm->_game->getObject(objID);

	// If the animation is already loaded, return
	for (i = 0; i < obj->_anim.size(); ++i) {
		if (obj->_anim[i] == animID) {
			return;
		}
	}

	loadObjectAnimation(obj, animID);
}

void Script::start(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int objID = params.pop() - 1;
	int animID = params.pop() - 1;

	GameObject *obj = _vm->_game->getObject(objID);
	_vm->_game->stopObjectAnimations(obj);

	Animation *anim = _vm->_anims->getAnimation(animID);
	if (!anim) {
		// The original game files seem to contain errors, which I have
		// verified by inspecting their source code.  They try to load
		// each animation before starting it, but fail to anticipate
		// all possible code paths when game loading comes into play.
		//
		// In particular, if I load the game at the stump location,
		// apply a hedgehog on them, and then talk to them, one of the
		// animations is not loaded.  This animation would have been
		// loaded had I talked to them before applying the hedgehog
		// (because a different dialog init code is run before the
		// application).  Talking to the stumps is necessary to be able
		// to apply the hedgehog, so normal game-play is safe.
		// However, if I save the game after talking to them and load
		// it later, then the game variables are set so as to allow me
		// to apply the hedgehog, but there is no way that the game
		// player would load the requested animation by itself.
		// See objekty:5077 and parezy.txt:27.
		anim = loadObjectAnimation(obj, animID);
		debugC(1, kDraciBytecodeDebugLevel, "start(%d=%s) cannot find animation %d.  Loading.",
			objID, obj->_title.c_str(), animID);
	}

	if (objID == kDragonObject)
		_vm->_game->positionAnimAsHero(anim);

	anim->registerCallback(&Animation::stopAnimation);

	bool visible = (obj->_location == _vm->_game->getRoomNum() && obj->_visible);

	if (objID == kDragonObject || visible) {
		_vm->_anims->play(animID);
	}
}

void Script::startPlay(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int objID = params.pop() - 1;
	int animID = params.pop() - 1;

	GameObject *obj = _vm->_game->getObject(objID);
	_vm->_game->stopObjectAnimations(obj);

	Animation *anim = _vm->_anims->getAnimation(animID);
	if (!anim) {
		anim = loadObjectAnimation(obj, animID);
		debugC(1, kDraciBytecodeDebugLevel, "startPlay(%d=%s) cannot find animation %d.  Loading.",
			objID, obj->_title.c_str(), animID);
	}

	if (objID == kDragonObject)
		_vm->_game->positionAnimAsHero(anim);

	anim->registerCallback(&Animation::exitGameLoop);

	_vm->_game->setLoopSubstatus(kSubstatusStrange);

	bool visible = (obj->_location == _vm->_game->getRoomNum() && obj->_visible);

	if (objID == kDragonObject || visible) {
		_vm->_anims->play(animID);
	}

	_vm->_game->loop();
	_vm->_game->setExitLoop(false);
	_vm->_anims->stop(animID);
	_vm->_game->setLoopSubstatus(kSubstatusOrdinary);

	anim->registerCallback(&Animation::doNothing);
}

void Script::justTalk(Common::Queue<int> &params) {
	const GameObject *dragon = _vm->_game->getObject(kDragonObject);
	const int last_anim = static_cast<Movement> (_vm->_game->playingObjectAnimation(dragon));
	int new_anim;
	if (last_anim == kSpeakRight || last_anim == kStopRight) {
		new_anim = kSpeakRight;
	} else {
		new_anim = kSpeakLeft;
	}
	_vm->_game->playHeroAnimation(new_anim);
}

void Script::justStay(Common::Queue<int> &params) {
	const GameObject *dragon = _vm->_game->getObject(kDragonObject);
	const int last_anim = static_cast<Movement> (_vm->_game->playingObjectAnimation(dragon));
	int new_anim;
	if (last_anim == kSpeakRight || last_anim == kStopRight) {
		new_anim = kStopRight;
	} else {
		new_anim = kStopLeft;
	}
	_vm->_game->playHeroAnimation(new_anim);
}

void Script::c_If(Common::Queue<int> &params) {
	int expression = params.pop();
	int jump = params.pop();

	if (expression)
		_jump = jump;
}

void Script::c_Goto(Common::Queue<int> &params) {
	int jump = params.pop();

	_jump = jump;
}

void Script::c_Let(Common::Queue<int> &params) {
	int var = params.pop() - 1;
	int value = params.pop();

	_vm->_game->setVariable(var, value);
}

void Script::mark(Common::Queue<int> &params) {
	_vm->_game->setMarkedAnimationIndex(_vm->_anims->getLastIndex());
}

void Script::release(Common::Queue<int> &params) {
	int markedIndex = _vm->_game->getMarkedAnimationIndex();

	_vm->_game->deleteAnimationsAfterIndex(markedIndex);
}

void Script::icoStat(Common::Queue<int> &params) {
	int status = params.pop();
	int itemID = params.pop() - 1;

	_vm->_game->setItemStatus(itemID, status == 1);

	if (_vm->_game->getItemStatus(itemID) == 0) {
		if (itemID != kNoItem) {
			_vm->_anims->deleteAnimation(kInventoryItemsID - itemID);
		}

		_vm->_game->removeItem(itemID);

		if (_vm->_game->getCurrentItem() == itemID) {
			_vm->_game->setCurrentItem(kNoItem);
		}

		if (_vm->_mouse->getCursorType() == kNormalCursor) {
			if (_vm->_game->getLoopStatus() == kStatusInventory) {
				_vm->_mouse->cursorOff();
			}
		}
	}

	if (_vm->_game->getItemStatus(itemID) == 1) {
		if (itemID != kNoItem) {
			Animation *itemAnim = _vm->_anims->addItem(kInventoryItemsID - itemID);
			const BAFile *f = _vm->_itemImagesArchive->getFile(2 * itemID);
			Sprite *sp = new Sprite(f->_data, f->_length, 0, 0, true);
			itemAnim->addFrame(sp, NULL);
		}

		_vm->_game->setCurrentItem(itemID);

		_vm->_mouse->loadItemCursor(itemID);

		// TODO: This is probably not needed but I'm leaving it to be sure for now
		// The original engine needed to turn off the mouse temporarily when changing
		// the cursor image. I'm just setting it to the final state of that transition.
		if (_vm->_game->getLoopStatus() == kStatusInventory) {
			_vm->_mouse->cursorOn();
		}
	}
}

void Script::objStatOn(Common::Queue<int> &params) {
	int objID = params.pop() - 1;
	int roomID = params.pop() - 1;

	GameObject *obj = _vm->_game->getObject(objID);

	obj->_location = roomID;
	obj->_visible = true;
}

void Script::objStat(Common::Queue<int> &params) {
	int status = params.pop();
	int objID = params.pop() - 1;

	GameObject *obj = _vm->_game->getObject(objID);

	if (status == 1) {
		return;
	} else if (status == 2) {
		obj->_visible = false;
	} else {
		obj->_visible = false;
		obj->_location = -1;
	}

	_vm->_game->stopObjectAnimations(obj);
}

void Script::execInit(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int objID = params.pop() - 1;

	const GameObject *obj = _vm->_game->getObject(objID);
	run(obj->_program, obj->_init);
}

void Script::execLook(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int objID = params.pop() - 1;

	const GameObject *obj = _vm->_game->getObject(objID);
	run(obj->_program, obj->_look);
}

void Script::execUse(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int objID = params.pop() - 1;

	const GameObject *obj = _vm->_game->getObject(objID);
	run(obj->_program, obj->_use);
}

void Script::walkOn(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int x = params.pop();
	int y = params.pop();
	SightDirection dir = static_cast<SightDirection> (params.pop());

	_vm->_game->walkHero(x, y, dir);
}

void Script::walkOnPlay(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int x = params.pop();
	int y = params.pop();
	SightDirection dir = static_cast<SightDirection> (params.pop());

	// HACK: This should be an onDest action when hero walking is properly implemented
	_vm->_game->setExitLoop(true);

	_vm->_game->walkHero(x, y, dir);

	_vm->_game->setLoopSubstatus(kSubstatusStrange);
	_vm->_game->loop();
	_vm->_game->setLoopSubstatus(kSubstatusOrdinary);

	_vm->_game->setExitLoop(false);
}

void Script::newRoom(Common::Queue<int> &params) {
	if (_vm->_game->getLoopStatus() == kStatusInventory) {
		return;
	}

	int room = params.pop() - 1;
	int gate = params.pop() - 1;

	_vm->_game->scheduleEnteringRoomUsingGate(room, gate);
}

void Script::talk(Common::Queue<int> &params) {
	int personID = params.pop() - 1;
	int sentenceID = params.pop() - 1;

	Surface *surface = _vm->_screen->getSurface();

	// Fetch string
	const BAFile *f = _vm->_stringsArchive->getFile(sentenceID);

	// Fetch frame for the speech text
	Animation *speechAnim = _vm->_anims->getAnimation(kSpeechText);
	Text *speechFrame = reinterpret_cast<Text *>(speechAnim->getFrame());

	// Fetch person info
	const Person *person = _vm->_game->getPerson(personID);

	// Fetch the dubbing
	SoundSample *sample = _vm->_sound->isMutedVoice()
		? NULL : _vm->_dubbingArchive->getSample(sentenceID, 0);

	// Set the string and text colour
	surface->markDirtyRect(speechFrame->getRect());
	if (_vm->_sound->showSubtitles() || !sample) {
		speechFrame->setText(Common::String((const char *)f->_data+1, f->_length-1));
	} else {
		speechFrame->setText("");
	}
	speechFrame->setColour(person->_fontColour);

	// HACK: Some strings in the English data files are too long to fit the screen
	// This is a temporary resolution.
	if (speechFrame->getWidth() >= kScreenWidth) {
		speechFrame->setFont(_vm->_smallFont);
	} else {
		speechFrame->setFont(_vm->_bigFont);
	}

	// Set the loop substatus to an appropriate value
	_vm->_game->setLoopSubstatus(kSubstatusTalk);

	// Speak the dubbing if possible
	uint dubbingDuration = 0;
	if (sample) {
		dubbingDuration = (uint) (1000.0 * sample->_length / sample->_frequency + 500.0);
		debugC(3, kDraciSoundDebugLevel, "Playing sentence %d: %d+%d with duration %dms",
			sentenceID, sample->_offset, sample->_length, dubbingDuration);
		_vm->_sound->playVoice(sample);
	}

	// Record time
	uint subtitleDuration = (kBaseSpeechDuration + speechFrame->getLength() * kSpeechTimeUnit)
		/ _vm->_sound->talkSpeed();
	const uint duration = MAX(subtitleDuration, dubbingDuration);
	_vm->_game->setSpeechTiming(_vm->_system->getMillis(), duration);

	// TODO: Implement inventory part

	// Set speech text coordinates

	int x = surface->centerOnX(person->_x, speechFrame->getWidth());
	int y = surface->putAboveY(person->_y, speechFrame->getHeight());

	speechFrame->setX(x);
	speechFrame->setY(y);

	// Prevent the loop from exiting early if other things left the loop in the
	// "exit immediately" state
	_vm->_game->setExitLoop(false);

	// Call the game loop to enable interactivity until the text expires
	_vm->_game->loop();

	// Delete the text
	_vm->_screen->getSurface()->markDirtyRect(speechFrame->getRect());
	speechFrame->setText("");

	// Stop the playing sample and deallocate it.  Stopping should only be
	// necessary if the user interrupts the playback.
	if (sample) {
		_vm->_sound->stopVoice();
		sample->close();
	}

	// Revert to "normal" loop status
	_vm->_game->setLoopSubstatus(kSubstatusOrdinary);
	_vm->_game->setExitLoop(false);
}

void Script::dialogue(Common::Queue<int> &params) {
	int dialogueID = params.pop() - 1;

	_vm->_game->dialogueMenu(dialogueID);
}

void Script::loadMap(Common::Queue<int> &params) {
	int mapID = params.pop() - 1;

	_vm->_game->loadWalkingMap(mapID);
}

void Script::resetDialogue(Common::Queue<int> &params) {
	const int currentOffset = _vm->_game->getCurrentDialogueOffset();

	for (int i = 0; i < _vm->_game->getDialogueBlockNum(); ++i) {
		_vm->_game->setDialogueVar(currentOffset + i, 0);
	}
}

void Script::resetDialogueFrom(Common::Queue<int> &params) {
	const int currentOffset = _vm->_game->getCurrentDialogueOffset();

	for (int i = _vm->_game->getDialogueCurrentBlock(); i < _vm->_game->getDialogueBlockNum(); ++i) {
		_vm->_game->setDialogueVar(currentOffset + i, 0);
	}
}

void Script::resetBlock(Common::Queue<int> &params) {
	int blockID = params.pop() - 1;

	const int currentOffset = _vm->_game->getCurrentDialogueOffset();

	_vm->_game->setDialogueVar(currentOffset + blockID, 0);
}

void Script::exitDialogue(Common::Queue<int> &params) {
	_vm->_game->setDialogueExit(true);
}

void Script::roomMap(Common::Queue<int> &params) {
	// Load the default walking map for the room
	_vm->_game->loadWalkingMap();
}

void Script::loadPalette(Common::Queue<int> &params) {
	int palette = params.pop() - 1;

	_vm->_game->schedulePalette(palette);
}

void Script::blackPalette(Common::Queue<int> &params) {

	_vm->_game->schedulePalette(kBlackPalette);
}

void Script::setPalette(Common::Queue<int> &params) {
	if (_vm->_game->getScheduledPalette() == -1) {
		_vm->_screen->setPaletteEmpty();
	} else {
		const BAFile *f;
		f = _vm->_paletteArchive->getFile(_vm->_game->getScheduledPalette());
		_vm->_screen->setPalette(f->_data, 0, kNumColours);
	}
}

void Script::endCurrentProgram() {
	_endProgram = true;
}

void Script::quitGame(Common::Queue<int> &params) {
	_vm->_game->setQuit(true);
}

void Script::pushNewRoom(Common::Queue<int> &params) {
	_vm->_game->pushNewRoom();
}

void Script::popNewRoom(Common::Queue<int> &params) {
	_vm->_game->popNewRoom();
}

/**
 * @brief Evaluates mathematical expressions
 * @param reader Stream reader set to the beginning of the expression
 */
int Script::handleMathExpression(Common::MemoryReadStream *reader) const {
	Common::Stack<int> stk;
	mathExpressionObject obj;
	GPL2Operator oper;
	GPL2Function func;

	debugC(4, kDraciBytecodeDebugLevel, "\t<MATHEXPR>");

	// Read in initial math object
	obj = (mathExpressionObject)reader->readSint16LE();

	int value;
	int arg1, arg2, res;

	while (1) {
		if (obj == kMathEnd) {
			// Check whether the expression was evaluated correctly
			// The stack should contain only one value after the evaluation
			// i.e. the result of the expression
			assert(stk.size() == 1 && "Mathematical expression error");
			break;
		}

		switch (obj) {

		// If the object type is not known, assume that it's a number
		default:
		case kMathNumber:
			value = reader->readSint16LE();
			stk.push(value);
			debugC(4, kDraciBytecodeDebugLevel, "\t\tnumber: %d", value);
			break;

		case kMathOperator:
			value = reader->readSint16LE();
			arg2 = stk.pop();
			arg1 = stk.pop();

			// Fetch operator
			oper = _operatorList[value-1];

			// Calculate result
			res = (this->*(oper._handler))(arg1, arg2);

			// Push result
			stk.push(res);

			debugC(4, kDraciBytecodeDebugLevel, "\t\t%d %s %d (res: %d)",
				arg1, oper._name, arg2, res);
			break;

		case kMathVariable:
			value = reader->readSint16LE() - 1;

			stk.push(_vm->_game->getVariable(value));

			debugC(4, kDraciBytecodeDebugLevel, "\t\tvariable: %d (%d)", value,
				_vm->_game->getVariable(value));
			break;

		case kMathFunctionCall:
			value = reader->readSint16LE();

			// Fetch function
			func = _functionList[value-1];

			// If not yet implemented
			if (func._handler == NULL) {
				stk.pop();

				// FIXME: Pushing dummy value for now, but should push return value
				stk.push(0);

				debugC(4, kDraciBytecodeDebugLevel, "\t\tcall: %s (not implemented)",
				       func._name);
			} else {
				arg1 = stk.pop();

				// Calculate result
				res = (this->*(func._handler))(arg1);

				// Push the result on the evaluation stack
				stk.push(res);

				debugC(4, kDraciBytecodeDebugLevel, "\t\tcall: %s(%d) (res: %d)",
				       func._name, arg1, res);
			}

			break;
		}

		obj = (mathExpressionObject) reader->readSint16LE();
	}

	return stk.pop();
}

/**
 * @brief Evaluates a GPL mathematical expression on a given offset and returns
 * the result (which is normally a boolean-like value)
 *
 * @param program   A GPL2Program instance of the program containing the expression
 * @param offset    Offset of the expression inside the program (in multiples of 2 bytes)
 *
 * @return The result of the expression converted to a bool.
 *
 * Reference: the function equivalent to this one is called "Can()" in the original engine.
 */
bool Script::testExpression(const GPL2Program &program, uint16 offset) const {
	// Initialize program reader
	Common::MemoryReadStream reader(program._bytecode, program._length);

	// Offset is given as number of 16-bit integers so we need to convert
	// it to a number of bytes
	offset -= 1;
	offset *= 2;

	// Seek to the expression
	reader.seek(offset);

	debugC(4, kDraciBytecodeDebugLevel,
	       "Evaluating (standalone) GPL expression at offset %d:", offset);

	return (bool)handleMathExpression(&reader);
}

/**
 * @brief Find the current command in the internal table
 *
 * @param num       Command number
 * @param subnum    Command subnumer
 *
 * @return NULL if command is not found. Otherwise, a pointer to a GPL2Command
 *         struct representing the command.
 */
const GPL2Command *Script::findCommand(byte num, byte subnum) const {
	uint i = 0;
	while (1) {

		// Command not found
		if (i >= kNumCommands) {
			break;
		}

		// Return found command
		if (_commandList[i]._number == num &&
			_commandList[i]._subNumber == subnum) {
			return &_commandList[i];
		}

		++i;
	}

	return NULL;
}

/**
 * @brief GPL2 bytecode interpreter
 * @param program GPL program in the form of a GPL2Program struct
 *        offset Offset into the program where execution should begin
 *
 * GPL2 is short for Game Programming Language 2 which is the script language
 * used by Draci Historie. This is the interpreter for the language.
 *
 * A compiled GPL2 program consists of a stream of bytes representing commands
 * and their parameters. The syntax is as follows:
 *
 * Syntax of a command:
 *  <name of the command> <number> <sub-number> <list of parameters...>
 *
 * Syntax of a parameter:
 *  - 1: integer number literally passed to the program
 *  - 2-1: string stored in the reservouir of game strings (i.e. something to be
 *    displayed) and stored as an index in this list
 *  - 2-2: string resolved by the compiler (i.e., a path to another file) and
 *    replaced by an integer index of this entity in the appropriate namespace
 *    (e.g., the index of the palette, location, ...)
 *  - 3-0: relative jump to a label defined in this code.  Each label must be
 *    first declared in the beginning of the program.
 *  - 3-1 .. 3-9: index of an entity in several namespaces, defined in file ident
 *  - 4: mathematical expression compiled into a postfix format
 *
 *  In the compiled program, parameters of type 1..3 are represented by a single
 *  16-bit integer.  The called command knows by its definition what namespace the
 *  value comes from.
 */

int Script::run(const GPL2Program &program, uint16 offset) {
	int oldJump = _jump;

	// Mark the last animation index before we do anything so a Release command
	// doesn't unload too many animations if we forget to use a Mark command first
	_vm->_game->setMarkedAnimationIndex(_vm->_anims->getLastIndex());

	// Stream reader for the whole program
	Common::MemoryReadStream reader(program._bytecode, program._length);

	// Parameter queue that is passed to each command
	Common::Queue<int> params;

	// Offset is given as number of 16-bit integers so we need to convert
	// it to a number of bytes
	offset -= 1;
	offset *= 2;

	// Seek to the requested part of the program
	reader.seek(offset);

	debugC(3, kDraciBytecodeDebugLevel,
		"Starting GPL program at offset %d (program length: %d)", offset, program._length);

	const GPL2Command *cmd;
	do {

		// Account for GPL jump that some commands set
		if (_jump != 0) {
			debugC(3, kDraciBytecodeDebugLevel,
				"Jumping from offset %d to %d (%d bytes)",
				reader.pos(), reader.pos() + _jump, _jump);
			reader.seek(_jump, SEEK_CUR);
		}

		// Reset jump
		_jump = 0;

		// Clear any parameters left on the stack from the previous command
		// This likely won't be needed once all commands are implemented
		params.clear();

		// read in command pair
		uint16 cmdpair = reader.readUint16BE();

		// extract high byte, i.e. the command number
		byte num = (cmdpair >> 8) & 0xFF;

		// extract low byte, i.e. the command subnumber
		byte subnum = cmdpair & 0xFF;

		// This might get set by some GPL commands via Script::endCurrentProgram()
		// if they need a program to stop midway
		_endProgram = false;

		if ((cmd = findCommand(num, subnum))) {
			int tmp;

			// Print command name
			debugC(1, kDraciBytecodeDebugLevel, "%s", cmd->_name);

			for (int i = 0; i < cmd->_numParams; ++i) {
				if (cmd->_paramTypes[i] == 4) {
					debugC(3, kDraciBytecodeDebugLevel,
					    "Evaluating (in-script) GPL expression at offset %d: ", offset);
					params.push(handleMathExpression(&reader));
				} else {
					tmp = reader.readSint16LE();
					params.push(tmp);
					debugC(2, kDraciBytecodeDebugLevel, "\t%d", tmp);
				}
			}
		} else {
			debugC(1, kDraciBytecodeDebugLevel, "Unknown opcode %d, %d",
			    num, subnum);
			abort();
		}

		GPLHandler handler = cmd->_handler;

		if (handler != NULL) {
			// Call the handler for the current command
			(this->*(cmd->_handler))(params);
		}

	} while (cmd->_number != 0 && !_endProgram);    // 0 = gplend and exit

	_endProgram = false;
	_jump = oldJump;

	return 0;
}

} // End of namespace Draci