/
finaleinterpreter.c
2128 lines (1849 loc) · 56.5 KB
/
finaleinterpreter.c
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
/**\file finaleinterpreter.c
*\section License
* License: GPL
* Online License Link: http://www.gnu.org/licenses/gpl.html
*
*\author Copyright © 2003-2011 Jaakko Keränen <jaakko.keranen@iki.fi>
*\author Copyright © 2005-2011 Daniel Swanson <danij@dengine.net>
*
* 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 St, Fifth Floor,
* Boston, MA 02110-1301 USA
*/
/**
* InFine: "Finale" script interpreter.
*/
// HEADER FILES ------------------------------------------------------------
#include <ctype.h>
#include <stdio.h>
#include <string.h>
#include "de_base.h"
#include "de_console.h"
#include "de_play.h"
#include "de_defs.h"
#include "de_graphics.h"
#include "de_refresh.h"
#include "de_render.h"
#include "de_network.h"
#include "de_audio.h"
#include "de_infine.h"
#include "de_misc.h"
#include "de_infine.h"
#include "de_ui.h"
#include "de_filesys.h"
// MACROS ------------------------------------------------------------------
#define FRACSECS_TO_TICKS(sec) ((int)(sec * TICSPERSEC + 0.5))
// Helper macro for defining infine command functions.
#define DEFFC(name) void FIC_##name(const struct command_s* cmd, const fi_operand_t* ops, finaleinterpreter_t* fi)
// Helper macro for accessing the value of an operand.
#define OP_INT(n) (ops[n].data.integer)
#define OP_FLOAT(n) (ops[n].data.flt)
#define OP_CSTRING(n) (ops[n].data.cstring)
#define OP_OBJECT(n) (ops[n].data.obj)
// TYPES -------------------------------------------------------------------
typedef enum {
FVT_INT,
FVT_FLOAT,
FVT_SCRIPT_STRING, // ptr points to a char*, which points to the string.
FVT_OBJECT
} fi_operand_type_t;
typedef struct {
fi_operand_type_t type;
union {
int integer;
float flt;
const char* cstring;
fi_object_t* obj;
} data;
} fi_operand_t;
typedef struct command_s {
char* token;
const char* operands;
void (*func) (const struct command_s* cmd, const fi_operand_t* ops, finaleinterpreter_t* fi);
struct command_flags_s {
char when_skipping:1;
char when_condition_skipping:1; // Skipping because condition failed.
} flags;
/// Command execution directives NOT supported by this command.
/// @see finaleInterpreterCommandDirective
int excludeDirectives;
} command_t;
typedef struct fi_namespace_record_s {
fi_objectname_t name; // Unique among objects of the same type and spawned by the same script.
fi_objectid_t objectId;
} fi_namespace_record_t;
// EXTERNAL FUNCTION PROTOTYPES --------------------------------------------
// PUBLIC FUNCTION PROTOTYPES ----------------------------------------------
// Command functions.
DEFFC(Do);
DEFFC(End);
DEFFC(BGFlat);
DEFFC(BGTexture);
DEFFC(NoBGMaterial);
DEFFC(Wait);
DEFFC(WaitText);
DEFFC(WaitAnim);
DEFFC(Tic);
DEFFC(InTime);
DEFFC(Color);
DEFFC(ColorAlpha);
DEFFC(Pause);
DEFFC(CanSkip);
DEFFC(NoSkip);
DEFFC(SkipHere);
DEFFC(Events);
DEFFC(NoEvents);
DEFFC(OnKey);
DEFFC(UnsetKey);
DEFFC(If);
DEFFC(IfNot);
DEFFC(Else);
DEFFC(GoTo);
DEFFC(Marker);
DEFFC(Image);
DEFFC(ImageAt);
DEFFC(XImage);
DEFFC(Delete);
DEFFC(Patch);
DEFFC(SetPatch);
DEFFC(Anim);
DEFFC(AnimImage);
DEFFC(StateAnim);
DEFFC(Repeat);
DEFFC(ClearAnim);
DEFFC(PicSound);
DEFFC(ObjectOffX);
DEFFC(ObjectOffY);
DEFFC(ObjectOffZ);
DEFFC(ObjectScaleX);
DEFFC(ObjectScaleY);
DEFFC(ObjectScaleZ);
DEFFC(ObjectScale);
DEFFC(ObjectScaleXY);
DEFFC(ObjectScaleXYZ);
DEFFC(ObjectRGB);
DEFFC(ObjectAlpha);
DEFFC(ObjectAngle);
DEFFC(Rect);
DEFFC(FillColor);
DEFFC(EdgeColor);
DEFFC(OffsetX);
DEFFC(OffsetY);
DEFFC(Sound);
DEFFC(SoundAt);
DEFFC(SeeSound);
DEFFC(DieSound);
DEFFC(Music);
DEFFC(MusicOnce);
DEFFC(Filter);
DEFFC(Text);
DEFFC(TextFromDef);
DEFFC(TextFromLump);
DEFFC(SetText);
DEFFC(SetTextDef);
DEFFC(DeleteText);
DEFFC(Font);
DEFFC(FontA);
DEFFC(FontB);
DEFFC(PredefinedColor);
DEFFC(PredefinedFont);
DEFFC(TextRGB);
DEFFC(TextAlpha);
DEFFC(TextOffX);
DEFFC(TextOffY);
DEFFC(TextCenter);
DEFFC(TextNoCenter);
DEFFC(TextScroll);
DEFFC(TextPos);
DEFFC(TextRate);
DEFFC(TextLineHeight);
DEFFC(NoMusic);
DEFFC(TextScaleX);
DEFFC(TextScaleY);
DEFFC(TextScale);
DEFFC(PlayDemo);
DEFFC(Command);
DEFFC(ShowMenu);
DEFFC(NoShowMenu);
// PRIVATE FUNCTION PROTOTYPES ---------------------------------------------
static fi_objectid_t toObjectId(fi_namespace_t* names, const char* name, fi_obtype_e type);
// EXTERNAL DATA DECLARATIONS ----------------------------------------------
// PUBLIC DATA DEFINITIONS -------------------------------------------------
// PRIVATE DATA DEFINITIONS ------------------------------------------------
/// Time is measured in seconds.
/// Colors are floating point and [0,1].
static const command_t commands[] = {
// Run Control
{ "DO", "", FIC_Do, true, true },
{ "END", "", FIC_End },
{ "IF", "s", FIC_If }, // if (value-id)
{ "IFNOT", "s", FIC_IfNot }, // ifnot (value-id)
{ "ELSE", "", FIC_Else },
{ "GOTO", "s", FIC_GoTo }, // goto (marker)
{ "MARKER", "s", FIC_Marker, true },
{ "in", "f", FIC_InTime }, // in (time)
{ "pause", "", FIC_Pause },
{ "tic", "", FIC_Tic },
{ "wait", "f", FIC_Wait }, // wait (time)
{ "waittext", "s", FIC_WaitText }, // waittext (id)
{ "waitanim", "s", FIC_WaitAnim }, // waitanim (id)
{ "canskip", "", FIC_CanSkip },
{ "noskip", "", FIC_NoSkip },
{ "skiphere", "", FIC_SkipHere, true },
{ "events", "", FIC_Events },
{ "noevents", "", FIC_NoEvents },
{ "onkey", "ss", FIC_OnKey }, // onkey (keyname) (marker)
{ "unsetkey", "s", FIC_UnsetKey }, // unsetkey (keyname)
// Screen Control
{ "color", "fff", FIC_Color }, // color (red) (green) (blue)
{ "coloralpha", "ffff", FIC_ColorAlpha }, // coloralpha (r) (g) (b) (a)
{ "flat", "s", FIC_BGFlat }, // flat (flat-id)
{ "texture", "s", FIC_BGTexture }, // texture (texture-id)
{ "noflat", "", FIC_NoBGMaterial },
{ "notexture", "", FIC_NoBGMaterial },
{ "offx", "f", FIC_OffsetX }, // offx (x)
{ "offy", "f", FIC_OffsetY }, // offy (y)
{ "filter", "ffff", FIC_Filter }, // filter (r) (g) (b) (a)
// Audio
{ "sound", "s", FIC_Sound }, // sound (snd)
{ "soundat", "sf", FIC_SoundAt }, // soundat (snd) (vol:0-1)
{ "seesound", "s", FIC_SeeSound }, // seesound (mobjtype)
{ "diesound", "s", FIC_DieSound }, // diesound (mobjtype)
{ "music", "s", FIC_Music }, // music (musicname)
{ "musiconce", "s", FIC_MusicOnce }, // musiconce (musicname)
{ "nomusic", "", FIC_NoMusic },
// Objects
{ "del", "o", FIC_Delete }, // del (obj)
{ "x", "of", FIC_ObjectOffX }, // x (obj) (x)
{ "y", "of", FIC_ObjectOffY }, // y (obj) (y)
{ "z", "of", FIC_ObjectOffZ }, // z (obj) (z)
{ "sx", "of", FIC_ObjectScaleX }, // sx (obj) (x)
{ "sy", "of", FIC_ObjectScaleY }, // sy (obj) (y)
{ "sz", "of", FIC_ObjectScaleZ }, // sz (obj) (z)
{ "scale", "of", FIC_ObjectScale }, // scale (obj) (factor)
{ "scalexy", "off", FIC_ObjectScaleXY }, // scalexy (obj) (x) (y)
{ "scalexyz", "offf", FIC_ObjectScaleXYZ }, // scalexyz (obj) (x) (y) (z)
{ "rgb", "offf", FIC_ObjectRGB }, // rgb (obj) (r) (g) (b)
{ "alpha", "of", FIC_ObjectAlpha }, // alpha (obj) (alpha)
{ "angle", "of", FIC_ObjectAngle }, // angle (obj) (degrees)
// Rects
{ "rect", "sffff", FIC_Rect }, // rect (hndl) (x) (y) (w) (h)
{ "fillcolor", "osffff", FIC_FillColor }, // fillcolor (obj) (top/bottom/both) (r) (g) (b) (a)
{ "edgecolor", "osffff", FIC_EdgeColor }, // edgecolor (obj) (top/bottom/both) (r) (g) (b) (a)
// Pics
{ "image", "ss", FIC_Image }, // image (id) (raw-image-lump)
{ "imageat", "sffs", FIC_ImageAt }, // imageat (id) (x) (y) (raw)
{ "ximage", "ss", FIC_XImage }, // ximage (id) (ext-gfx-filename)
{ "patch", "sffs", FIC_Patch }, // patch (id) (x) (y) (patch)
{ "set", "ss", FIC_SetPatch }, // set (id) (lump)
{ "clranim", "o", FIC_ClearAnim }, // clranim (obj)
{ "anim", "ssf", FIC_Anim }, // anim (id) (patch) (time)
{ "imageanim", "ssf", FIC_AnimImage }, // imageanim (id) (raw-img) (time)
{ "picsound", "ss", FIC_PicSound }, // picsound (id) (sound)
{ "repeat", "s", FIC_Repeat }, // repeat (id)
{ "states", "ssi", FIC_StateAnim }, // states (id) (state) (count)
// Text
{ "text", "sffs", FIC_Text }, // text (hndl) (x) (y) (string)
{ "textdef", "sffs", FIC_TextFromDef }, // textdef (hndl) (x) (y) (txt-id)
{ "textlump", "sffs", FIC_TextFromLump }, // textlump (hndl) (x) (y) (lump)
{ "settext", "ss", FIC_SetText }, // settext (id) (newtext)
{ "settextdef", "ss", FIC_SetTextDef }, // settextdef (id) (txt-id)
{ "center", "s", FIC_TextCenter }, // center (id)
{ "nocenter", "s", FIC_TextNoCenter }, // nocenter (id)
{ "scroll", "sf", FIC_TextScroll }, // scroll (id) (speed)
{ "pos", "si", FIC_TextPos }, // pos (id) (pos)
{ "rate", "si", FIC_TextRate }, // rate (id) (rate)
{ "font", "ss", FIC_Font }, // font (id) (font)
{ "linehgt", "sf", FIC_TextLineHeight }, // linehgt (hndl) (hgt)
// Game Control
{ "playdemo", "s", FIC_PlayDemo }, // playdemo (filename)
{ "cmd", "s", FIC_Command }, // cmd (console command)
{ "trigger", "", FIC_ShowMenu },
{ "notrigger", "", FIC_NoShowMenu },
// Misc.
{ "precolor", "ifff", FIC_PredefinedColor }, // precolor (num) (r) (g) (b)
{ "prefont", "is", FIC_PredefinedFont }, // prefont (num) (font)
// Deprecated Font commands
{ "fonta", "s", FIC_FontA }, // fonta (id)
{ "fontb", "s", FIC_FontB }, // fontb (id)
// Deprecated Pic commands
{ "delpic", "o", FIC_Delete }, // delpic (obj)
// Deprecated Text commands
{ "deltext", "o", FIC_DeleteText }, // deltext (obj)
{ "textrgb", "sfff", FIC_TextRGB }, // textrgb (id) (r) (g) (b)
{ "textalpha", "sf", FIC_TextAlpha }, // textalpha (id) (alpha)
{ "tx", "sf", FIC_TextOffX }, // tx (id) (x)
{ "ty", "sf", FIC_TextOffY }, // ty (id) (y)
{ "tsx", "sf", FIC_TextScaleX }, // tsx (id) (x)
{ "tsy", "sf", FIC_TextScaleY }, // tsy (id) (y)
{ "textscale", "sf", FIC_TextScale }, // textscale (id) (x) (y)
{ NULL, 0, NULL } // Terminate.
};
// CODE --------------------------------------------------------------------
static fi_objectid_t findIdForName(fi_namespace_t* names, const char* name)
{
fi_objectid_t id;
// First check all pics.
id = toObjectId(names, name, FI_PIC);
// Then check text objects.
if(!id)
id = toObjectId(names, name, FI_TEXT);
return id;
}
static fi_objectid_t toObjectId(fi_namespace_t* names, const char* name, fi_obtype_e type)
{
assert(name && name[0]);
if(type == FI_NONE)
{ // Use a priority-based search.
return findIdForName(names, name);
}
{uint i;
for(i = 0; i < names->num; ++i)
{
fi_namespace_record_t* rec = &names->vector[i];
if(!stricmp(rec->name, name) && FI_Object(rec->objectId)->type == type)
return rec->objectId;
}}
return 0;
}
static void destroyObjectsInScope(fi_namespace_t* names)
{
// Delete external images, text strings etc.
if(names->vector)
{
uint i;
for(i = 0; i < names->num; ++i)
{
fi_namespace_record_t* rec = &names->vector[i];
FI_DeleteObject(FI_Object(rec->objectId));
}
Z_Free(names->vector);
}
names->vector = NULL;
names->num = 0;
}
static uint objectIndexInNamespace(fi_namespace_t* names, fi_object_t* obj)
{
if(obj)
{
uint i;
for(i = 0; i < names->num; ++i)
{
fi_namespace_record_t* rec = &names->vector[i];
if(rec->objectId == obj->id)
return i+1;
}
}
return 0;
}
static __inline boolean objectInNamespace(fi_namespace_t* names, fi_object_t* obj)
{
return objectIndexInNamespace(names, obj) != 0;
}
/**
* \note Does not check if the object already exists in this scope.
*/
static fi_object_t* addObjectToNamespace(fi_namespace_t* names, const char* name, fi_object_t* obj)
{
fi_namespace_record_t* rec;
names->vector = Z_Realloc(names->vector, sizeof(*names->vector) * ++names->num, PU_APPSTATIC);
rec = &names->vector[names->num-1];
rec->objectId = obj->id;
memset(rec->name, 0, sizeof(rec->name));
dd_snprintf(rec->name, FI_NAME_MAX_LENGTH, "%s", name);
return obj;
}
/**
* \assume There is at most one reference to the object in this scope.
*/
static fi_object_t* removeObjectInNamespace(fi_namespace_t* names, fi_object_t* obj)
{
uint idx;
if((idx = objectIndexInNamespace(names, obj)))
{
idx -= 1; // Indices are 1-based.
if(idx != names->num-1)
memmove(&names->vector[idx], &names->vector[idx+1], sizeof(*names->vector) * (names->num-idx));
if(names->num > 1)
{
names->vector = Z_Realloc(names->vector, sizeof(*names->vector) * --names->num, PU_APPSTATIC);
}
else
{
Z_Free(names->vector);
names->vector = NULL;
names->num = 0;
}
}
return obj;
}
static fi_objectid_t findObjectIdForName(fi_namespace_t* names, const char* name, fi_obtype_e type)
{
if(!name || !name[0])
return 0;
return toObjectId(names, name, type);
}
static const command_t* findCommand(const char* name)
{
size_t i;
for(i = 0; commands[i].token; ++i)
{
const command_t* cmd = &commands[i];
if(!stricmp(cmd->token, name))
return cmd;
}
return 0; // Not found.
}
static void releaseScript(finaleinterpreter_t* fi)
{
if(fi->_script)
Z_Free(fi->_script);
fi->_script = 0;
fi->_scriptBegin = 0;
fi->_cp = 0;
}
static const char* nextToken(finaleinterpreter_t* fi)
{
char* out;
// Skip whitespace.
while(*fi->_cp && isspace(*fi->_cp))
fi->_cp++;
if(!*fi->_cp)
return NULL; // The end has been reached.
out = fi->_token;
if(*fi->_cp == '"') // A string?
{
for(fi->_cp++; *fi->_cp; fi->_cp++)
{
if(*fi->_cp == '"')
{
fi->_cp++;
// Convert double quotes to single ones.
if(*fi->_cp != '"')
break;
}
*out++ = *fi->_cp;
}
}
else
{
while(!isspace(*fi->_cp) && *fi->_cp)
*out++ = *fi->_cp++;
}
*out++ = 0;
return fi->_token;
}
/**
* Parse the command operands from the script. If successfull, a ptr to a new
* vector of @c fi_operand_t objects is returned. Ownership of the vector is
* given to the caller.
*
* @return Ptr to a new vector of @c fi_operand_t or @c 0.
*/
static fi_operand_t* parseCommandArguments(finaleinterpreter_t* fi,
const command_t* cmd, uint* count)
{
const char* origCursorPos;
uint numOperands;
fi_operand_t* ops = 0;
if(!cmd->operands || !cmd->operands[0])
return 0;
origCursorPos = fi->_cp;
numOperands = (uint)strlen(cmd->operands);
// Operands are read sequentially.
{uint i = 0;
do
{
char typeSymbol = cmd->operands[i];
fi_operand_t* op;
fi_operand_type_t type;
if(!nextToken(fi))
{
fi->_cp = origCursorPos;
if(ops)
free(ops);
if(count)
*count = 0;
Con_Error("parseCommandArguments: Too few operands for command '%s'.\n", cmd->token);
return 0; // Unreachable.
}
switch(typeSymbol)
{
// Supported operand type symbols:
case 'i': type = FVT_INT; break;
case 'f': type = FVT_FLOAT; break;
case 's': type = FVT_SCRIPT_STRING; break;
case 'o': type = FVT_OBJECT; break;
default:
Con_Error("parseCommandArguments: Invalid symbol '%c' in operand list for command '%s'.", typeSymbol, cmd->token);
return 0; // Unreachable.
}
if(!ops)
ops = malloc(sizeof(*ops));
else
ops = realloc(ops, sizeof(*ops) * (i+1));
op = &ops[i];
op->type = type;
switch(type)
{
case FVT_INT:
op->data.integer = strtol(fi->_token, NULL, 0);
break;
case FVT_FLOAT:
op->data.flt = strtod(fi->_token, NULL);
break;
case FVT_SCRIPT_STRING:
{
size_t len = strlen(fi->_token)+1;
char* str = malloc(len);
dd_snprintf(str, len, "%s", fi->_token);
op->data.cstring = str;
break;
}
case FVT_OBJECT:
op->data.obj = FI_Object(findObjectIdForName(&fi->_namespace, fi->_token, FI_NONE));
break;
}
} while(++i < numOperands);}
if(count)
*count = numOperands;
return ops;
}
static boolean skippingCommand(finaleinterpreter_t* fi, const command_t* cmd)
{
if((fi->_skipNext && !cmd->flags.when_condition_skipping) ||
((fi->_skipping || fi->_gotoSkip) && !cmd->flags.when_skipping))
{
// While not DO-skipping, the condskip has now been done.
if(!fi->_doLevel)
{
if(fi->_skipNext)
fi->_lastSkipped = true;
fi->_skipNext = false;
}
return true;
}
return false;
}
/**
* Execute one (the next) command, advance script cursor.
*/
static boolean executeCommand(finaleinterpreter_t* fi, const char* commandString,
int directive)
{
boolean didSkip = false;
// Semicolon terminates DO-blocks.
if(!strcmp(commandString, ";"))
{
if(fi->_doLevel > 0)
{
if(--fi->_doLevel == 0)
{
// The DO-skip has been completed.
fi->_skipNext = false;
fi->_lastSkipped = true;
}
}
return true; // Success!
}
// We're now going to execute a command.
fi->_cmdExecuted = true;
// Is this a command we know how to execute?
{const command_t* cmd;
if((cmd = findCommand(commandString)))
{
boolean requiredOperands;
fi_operand_t* ops = NULL;
uint numOps = 0;
// Is this command supported for this directive?
if(directive != 0 && cmd->excludeDirectives != 0 &&
(cmd->excludeDirectives & directive) == 0)
Con_Error("executeCommand: Command \"%s\" is not supported for directive %i.",
cmd->token, directive);
// Check that there are enough operands.
requiredOperands = (cmd->operands && cmd->operands[0]);
if(0 == requiredOperands || NULL != (ops = parseCommandArguments(fi, cmd, &numOps)))
{
// Should we skip this command?
if(!(didSkip = skippingCommand(fi, cmd)))
{
// Execute forthwith!
cmd->func(cmd, ops, fi);
}
}
if(!didSkip)
{
if(fi->_gotoEnd)
{
fi->_wait = 1;
}
else
{ // Now we've executed the latest command.
fi->_lastSkipped = false;
}
}
if(ops)
{
uint i;
for(i = 0; i < numOps; ++i)
{
fi_operand_t* op = &ops[i];
if(op->type == FVT_SCRIPT_STRING)
free((char*)op->data.cstring);
}
free(ops);
}
}}
return !didSkip;
}
static boolean executeNextCommand(finaleinterpreter_t* fi)
{
const char* token;
if((token = nextToken(fi)))
{
executeCommand(fi, token, FID_NORMAL);
// Time to unhide the object page(s)?
if(fi->_cmdExecuted)
{
FIPage_MakeVisible(fi->_pages[PAGE_PICS], true);
FIPage_MakeVisible(fi->_pages[PAGE_TEXT], true);
}
return true;
}
return false;
}
static __inline uint pageForObjectType(fi_obtype_e type)
{
return (type == FI_TEXT? PAGE_TEXT : PAGE_PICS);
}
/**
* Find an object of the specified type with the type-unique name.
* @param name Unique name of the object we are looking for.
* @return Ptr to @c fi_object_t Either:
* a) Existing object associated with unique @a name.
* b) New object with unique @a name.
*/
static fi_object_t* getObject(finaleinterpreter_t* fi, fi_obtype_e type, const char* name)
{
fi_objectid_t id;
fi_object_t* obj;
uint pageIdx;
assert(name && name);
// An existing object?
if((id = findObjectIdForName(&fi->_namespace, name, type)))
{
return FI_Object(id);
}
// A new object.
obj = FI_NewObject(type, name);
pageIdx = pageForObjectType(type);
switch(type)
{
case FI_TEXT:
FIData_TextSetFont(obj, FIPage_PredefinedFont(fi->_pages[pageIdx], 0));
FIData_TextSetPreColor(obj, 1);
break;
default:
// No additional pre-configuration.
break;
}
return FIPage_AddObject(fi->_pages[pageIdx], addObjectToNamespace(&fi->_namespace, name, obj));
}
static void clearEventHandlers(finaleinterpreter_t* fi)
{
if(fi->_numEventHandlers)
Z_Free(fi->_eventHandlers);
fi->_eventHandlers = 0;
fi->_numEventHandlers = 0;
}
static fi_handler_t* findEventHandler(finaleinterpreter_t* fi, const ddevent_t* ev)
{
uint i;
for(i = 0; i < fi->_numEventHandlers; ++i)
{
fi_handler_t* h = &fi->_eventHandlers[i];
if(h->ev.device != ev->device && h->ev.type != ev->type)
continue;
switch(h->ev.type)
{
case E_TOGGLE:
if(h->ev.toggle.id != ev->toggle.id)
continue;
break;
case E_AXIS:
if(h->ev.axis.id != ev->axis.id)
continue;
break;
case E_ANGLE:
if(h->ev.angle.id != ev->angle.id)
continue;
break;
default:
Con_Error("Internal error: Invalid event template (type=%i) in finale event handler.", (int) h->ev.type);
}
return h;
}
return 0;
}
static fi_handler_t* createEventHandler(finaleinterpreter_t* fi, const ddevent_t* ev, const char* marker)
{
fi_handler_t* h;
fi->_eventHandlers = Z_Realloc(fi->_eventHandlers, sizeof(*h) * ++fi->_numEventHandlers, PU_APPSTATIC);
h = &fi->_eventHandlers[fi->_numEventHandlers-1];
memset(h, 0, sizeof(*h));
memcpy(&h->ev, ev, sizeof(h->ev));
dd_snprintf(h->marker, FI_NAME_MAX_LENGTH, "%s", marker);
return h;
}
static void destroyEventHandler(finaleinterpreter_t* fi, fi_handler_t* h)
{
assert(fi && h);
{uint i;
for(i = 0; i < fi->_numEventHandlers; ++i)
{
fi_handler_t* other = &fi->_eventHandlers[i];
if(h != other)
continue;
if(i != fi->_numEventHandlers-1)
memmove(&fi->_eventHandlers[i], &fi->_eventHandlers[i+1], sizeof(*fi->_eventHandlers) * (fi->_numEventHandlers-i));
// Resize storage?
if(fi->_numEventHandlers > 1)
{
fi->_eventHandlers = Z_Realloc(fi->_eventHandlers, sizeof(*fi->_eventHandlers) * --fi->_numEventHandlers, PU_APPSTATIC);
}
else
{
Z_Free(fi->_eventHandlers);
fi->_eventHandlers = NULL;
fi->_numEventHandlers = 0;
}
return;
}}
}
/**
* Find a @c fi_handler_t for the specified ddkey code.
* @param ev Input event to find a handler for.
* @return Ptr to @c fi_handler_t object. Either:
* a) Existing handler associated with unique @a code.
* b) New object with unique @a code.
*/
static boolean getEventHandler(finaleinterpreter_t* fi, const ddevent_t* ev, const char* marker)
{
// First, try to find an existing handler.
if(findEventHandler(fi, ev))
return true;
// Allocate and attach another.
createEventHandler(fi, ev, marker);
return true;
}
static void stopScript(finaleinterpreter_t* fi)
{
#ifdef _DEBUG
Con_Printf("Finale End - id:%i '%.30s'\n", fi->_id, fi->_scriptBegin);
#endif
fi->flags.stopped = true;
if(isServer && !(FI_ScriptFlags(fi->_id) & FF_LOCAL))
{ // Tell clients to stop the finale.
Sv_Finale(FINF_END, 0);
}
// Any hooks?
DD_CallHooks(HOOK_FINALE_SCRIPT_STOP, fi->_id, 0);
}
static void changePageBackground(fi_page_t* p, material_t* mat)
{
// If the page does not yet have a background set we must setup the color+alpha.
if(mat && !FIPage_BackgroundMaterial(p))
{
FIPage_SetBackgroundTopColorAndAlpha(p, 1, 1, 1, 1, 0);
FIPage_SetBackgroundBottomColorAndAlpha(p, 1, 1, 1, 1, 0);
}
FIPage_SetBackgroundMaterial(p, mat);
}
finaleinterpreter_t* P_CreateFinaleInterpreter(void)
{
return Z_Calloc(sizeof(finaleinterpreter_t), PU_APPSTATIC, 0);
}
void P_DestroyFinaleInterpreter(finaleinterpreter_t* fi)
{
assert(fi);
stopScript(fi);
clearEventHandlers(fi);
releaseScript(fi);
destroyObjectsInScope(&fi->_namespace);
FI_DeletePage(fi->_pages[PAGE_PICS]);
FI_DeletePage(fi->_pages[PAGE_TEXT]);
Z_Free(fi);
}
static __inline void findBegin(finaleinterpreter_t* fi)
{
const char* token;
while(!fi->_gotoEnd && 0 != (token = nextToken(fi)) && stricmp(token, "{")) {}
}
static __inline void findEnd(finaleinterpreter_t* fi)
{
const char* token;
while(!fi->_gotoEnd && 0 != (token = nextToken(fi)) && stricmp(token, "}")) {}
}
static void initDefaultState(finaleinterpreter_t* fi)
{
assert(fi);
fi->flags.suspended = false;
fi->flags.paused = false;
fi->flags.show_menu = true; // Enabled by default.
fi->flags.can_skip = true; // By default skipping is enabled.
fi->_cmdExecuted = false; // Nothing is drawn until a cmd has been executed.
fi->_skipping = false;
fi->_wait = 0; // Not waiting for anything.
fi->_inTime = 0; // Interpolation is off.
fi->_timer = 0;
fi->_gotoSkip = false;
fi->_gotoEnd = false;
fi->_skipNext = false;
fi->_waitingText = 0;
fi->_waitingPic = 0;
memset(fi->_gotoTarget, 0, sizeof(fi->_gotoTarget));
clearEventHandlers(fi);
}
void FinaleInterpreter_LoadScript(finaleinterpreter_t* fi, const char* script)
{
assert(fi && script && script[0]);
{
size_t size = strlen(script);
/**
* InFine imposes a strict object drawing order:
*
* 1: Background flat (or a single-color background).
* 2: Picture objects (globally offseted with OffX and OffY), in the order in which they were created.
* 3: Text objects, in the order in which they were created.
* 4: Filter.
*
* For this we'll need two pages; one for it's background and for Pics and another for Text and it's filter.
*/
fi->_pages[PAGE_PICS] = FI_NewPage(0);
fi->_pages[PAGE_TEXT] = FI_NewPage(0);
// Hide our pages until command interpretation begins.
FIPage_MakeVisible(fi->_pages[PAGE_PICS], false);
FIPage_MakeVisible(fi->_pages[PAGE_TEXT], false);
// Take a copy of the script.
fi->_script = Z_Realloc(fi->_script, size + 1, PU_APPSTATIC);
memcpy(fi->_script, script, size);
fi->_script[size] = '\0';
fi->_scriptBegin = fi->_script;
fi->_cp = fi->_script; // Init cursor.
initDefaultState(fi);
// Locate the start of the script.
if(0 != nextToken(fi))
{
// The start of the script may include blocks of event directive
// commands. These commands are automatically executed in response
// to their associated events.
if(!stricmp(fi->_token, "OnLoad"))
{
findBegin(fi);
for(;;)
{
nextToken(fi);
if(!stricmp(fi->_token, "}"))
goto end_read;
if(!executeCommand(fi, fi->_token, FID_ONLOAD))
Con_Error("FinaleInterpreter::LoadScript: Unknown error"
"occured executing directive \"OnLoad\".");
}
findEnd(fi);
end_read:
// Skip over any trailing whitespace to position the read cursor
// on the first token.
while(*fi->_cp && isspace(*fi->_cp))
fi->_cp++;
// Calculate the new script entry point and restore default state.
fi->_scriptBegin = fi->_script + (fi->_cp - fi->_script);
fi->_cp = fi->_scriptBegin;
initDefaultState(fi);
}
}
// Any hooks?
DD_CallHooks(HOOK_FINALE_SCRIPT_BEGIN, fi->_id, 0);
}
}
void FinaleInterpreter_ReleaseScript(finaleinterpreter_t* fi)
{
assert(fi);
if(!fi->flags.stopped)
{
stopScript(fi);
}
clearEventHandlers(fi);
releaseScript(fi);
}
void FinaleInterpreter_Resume(finaleinterpreter_t* fi)