-
Notifications
You must be signed in to change notification settings - Fork 20
/
glkop.c
1526 lines (1360 loc) · 40.4 KB
/
glkop.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
/* glkop.c: Glulxe code for Glk API dispatching.
Designed by Andrew Plotkin <[email protected]>
http://eblong.com/zarf/glulx/index.html
*/
/* This code is actually very general; it could work for almost any
32-bit VM which remotely resembles Glulxe or the Z-machine in design.
To be precise, we make the following assumptions:
- An argument list is an array of 32-bit values, which can represent
either integers or addresses.
- We can read or write to a 32-bit integer in VM memory using the macros
ReadMemory(addr) and WriteMemory(addr), where addr is an address
taken from the argument list.
- A character array is a sequence of bytes somewhere in VM memory.
The array can be turned into a C char array by the macro
CaptureCArray(addr, len), and released by ReleaseCArray().
The passin, passout hints may be used to avoid unnecessary copying.
- An integer array is a sequence of integers somewhere in VM memory.
The array can be turned into a C integer array by the macro
CaptureIArray(addr, len), and released by ReleaseIArray().
These macros are responsible for fixing byte-order and alignment
(if the C ABI does not match the VM's). The passin, passout hints
may be used to avoid unnecessary copying.
- A Glk object array is a sequence of integers in VM memory. It is
turned into a C pointer array (remember that C pointers may be more
than 4 bytes!) The pointer array is allocated by
CapturePtrArray(addr, len, objclass) and released by ReleasePtrArray().
Again, the macros handle the conversion.
- A Glk structure (such as event_t) is a set of integers somewhere
in VM memory, which can be read and written with the macros
ReadStructField(addr, fieldnum) and WriteStructField(addr, fieldnum).
The fieldnum is an integer (from 0 to 3, for event_t.)
- A VM string can be turned into a C-style string with the macro
ptr = DecodeVMString(addr). After the string is used, this code
calls ReleaseVMString(ptr), which should free any memory that
DecodeVMString allocates.
- A VM Unicode string can be turned into a zero-terminated array
of 32-bit integers, in the same way, with DecodeVMUstring
and ReleaseVMUstring.
To work this code over for a new VM, just diddle the macros.
*/
#define ReadMemory(addr) \
(((addr) == 0xffffffff) \
? (stackptr -= 4, Stk4(stackptr)) \
: (Mem4(addr)))
#define WriteMemory(addr, val) \
(((addr) == 0xffffffff) \
? (StkW4(stackptr, (val)), stackptr += 4) \
: (MemW4((addr), (val))))
#define CaptureCArray(addr, len, passin) \
(grab_temp_c_array(addr, len, passin))
#define ReleaseCArray(ptr, addr, len, passout) \
(release_temp_c_array(ptr, addr, len, passout))
#define CaptureIArray(addr, len, passin) \
(grab_temp_i_array(addr, len, passin))
#define ReleaseIArray(ptr, addr, len, passout) \
(release_temp_i_array(ptr, addr, len, passout))
#define CapturePtrArray(addr, len, objclass, passin) \
(grab_temp_ptr_array(addr, len, objclass, passin))
#define ReleasePtrArray(ptr, addr, len, objclass, passout) \
(release_temp_ptr_array(ptr, addr, len, objclass, passout))
#define ReadStructField(addr, fieldnum) \
(((addr) == 0xffffffff) \
? (stackptr -= 4, Stk4(stackptr)) \
: (Mem4((addr)+(fieldnum)*4)))
#define WriteStructField(addr, fieldnum, val) \
(((addr) == 0xffffffff) \
? (StkW4(stackptr, (val)), stackptr += 4) \
: (MemW4((addr)+(fieldnum)*4, (val))))
#define DecodeVMString(addr) \
(make_temp_string(addr))
#define ReleaseVMString(ptr) \
(free_temp_string(ptr))
#define DecodeVMUstring(addr) \
(make_temp_ustring(addr))
#define ReleaseVMUstring(ptr) \
(free_temp_ustring(ptr))
#include <time.h>
#include "glk.h"
#include "glulxe.h"
#include "gi_dispa.h"
typedef struct dispatch_splot_struct {
int numwanted;
int maxargs;
gluniversal_t *garglist;
glui32 *varglist;
int numvargs;
glui32 *retval;
} dispatch_splot_t;
/* We maintain a linked list of arrays being used for Glk calls. It is
only used for integer (glui32) arrays -- char arrays are handled in
place. It's not worth bothering with a hash table, since most
arrays appear here only momentarily. */
typedef struct arrayref_struct arrayref_t;
struct arrayref_struct {
void *array;
glui32 addr;
glui32 elemsize;
glui32 len; /* elements */
int retained;
arrayref_t *next;
};
static arrayref_t *arrays = NULL;
/* We maintain a hash table for each opaque Glk class. classref_t are the
nodes of the table, and classtable_t are the tables themselves. */
typedef struct classref_struct classref_t;
struct classref_struct {
void *obj;
glui32 id;
int bucknum;
classref_t *next;
};
#define CLASSHASH_SIZE (31)
typedef struct classtable_struct {
glui32 lastid;
classref_t *bucket[CLASSHASH_SIZE];
} classtable_t;
/* The list of hash tables, for the classes. */
static int num_classes = 0;
classtable_t **classes = NULL;
static classtable_t *new_classtable(glui32 firstid);
static void *classes_get(int classid, glui32 objid);
static classref_t *classes_put(int classid, void *obj, glui32 origid);
static void classes_remove(int classid, void *obj);
static gidispatch_rock_t glulxe_classtable_register(void *obj,
glui32 objclass);
static void glulxe_classtable_unregister(void *obj, glui32 objclass,
gidispatch_rock_t objrock);
static gidispatch_rock_t glulxe_retained_register(void *array,
glui32 len, char *typecode);
static void glulxe_retained_unregister(void *array, glui32 len,
char *typecode, gidispatch_rock_t objrock);
static long glulxe_array_locate(void *array, glui32 len,
char *typecode, gidispatch_rock_t objrock, int *elemsizeref);
static gidispatch_rock_t glulxe_array_restore(long bufkey,
glui32 len, char *typecode, void **arrayref);
/* This is only needed for autorestore. */
extern gidispatch_rock_t glulxe_classtable_register_existing(void *obj,
glui32 objclass, glui32 dispid);
/* The library_select_hook is called every time the VM blocks for input.
The app might take this opportunity to autosave, for example. */
static void (*library_select_hook)(glui32, glui32, glui32, glui32) = NULL;
static char *grab_temp_c_array(glui32 addr, glui32 len, int passin);
static void release_temp_c_array(char *arr, glui32 addr, glui32 len, int passout);
static glui32 *grab_temp_i_array(glui32 addr, glui32 len, int passin);
static void release_temp_i_array(glui32 *arr, glui32 addr, glui32 len, int passout);
static void **grab_temp_ptr_array(glui32 addr, glui32 len, int objclass, int passin);
static void release_temp_ptr_array(void **arr, glui32 addr, glui32 len, int objclass, int passout);
static void prepare_glk_args(char *proto, dispatch_splot_t *splot);
static void parse_glk_args(dispatch_splot_t *splot, char **proto, int depth,
int *argnumptr, glui32 subaddress, int subpassin);
static void unparse_glk_args(dispatch_splot_t *splot, char **proto, int depth,
int *argnumptr, glui32 subaddress, int subpassout);
static char *get_game_id(void);
/* init_dispatch():
Set up the class hash tables and other startup-time stuff.
*/
int init_dispatch()
{
int ix;
int randish;
/* What with one thing and another, this *could* be called more than
once. We only need to allocate the tables once. */
if (classes)
return TRUE;
/* Set up the game-ID hook. (This is ifdeffed because not all Glk
libraries have this call.) */
#ifdef GI_DISPA_GAME_ID_AVAILABLE
gidispatch_set_game_id_hook(&get_game_id);
#endif /* GI_DISPA_GAME_ID_AVAILABLE */
/* Allocate the class hash tables. */
num_classes = gidispatch_count_classes();
classes = (classtable_t **)glulx_malloc(num_classes
* sizeof(classtable_t *));
if (!classes)
return FALSE;
randish = time(NULL) % 101;
for (ix=0; ix<num_classes; ix++) {
classes[ix] = new_classtable(1+120*ix+randish);
if (!classes[ix])
return FALSE;
}
/* Set up the two callbacks. */
gidispatch_set_object_registry(&glulxe_classtable_register,
&glulxe_classtable_unregister);
gidispatch_set_retained_registry(&glulxe_retained_register,
&glulxe_retained_unregister);
/* If the library supports autorestore callbacks, set those up too.
(These are only used in iosglk and remglk, currently.) */
#ifdef GIDISPATCH_AUTORESTORE_REGISTRY
gidispatch_set_autorestore_registry(&glulxe_array_locate,
&glulxe_array_restore);
#endif /* GIDISPATCH_AUTORESTORE_REGISTRY */
return TRUE;
}
/* perform_glk():
Turn a list of Glulx arguments into a list of Glk arguments,
dispatch the function call, and return the result.
*/
glui32 perform_glk(glui32 funcnum, glui32 numargs, glui32 *arglist)
{
glui32 retval = 0;
switch (funcnum) {
/* To speed life up, we implement commonly-used Glk functions
directly -- instead of bothering with the whole prototype
mess. */
case 0x0047: /* stream_set_current */
if (numargs != 1)
goto WrongArgNum;
glk_stream_set_current(find_stream_by_id(arglist[0]));
break;
case 0x0048: /* stream_get_current */
if (numargs != 0)
goto WrongArgNum;
retval = find_id_for_stream(glk_stream_get_current());
break;
case 0x0062: /* fileref_create_by_prompt */
/* call a library hook on every glk_fileref_create_by_prompt(),
because it blocks and waits like glk_select() */
if (library_select_hook)
library_select_hook(0x0062, arglist[0], arglist[1], arglist[2]);
/* but then fall through to full dispatcher, because there's no real
need for speed here */
goto FullDispatcher;
case 0x0080: /* put_char */
if (numargs != 1)
goto WrongArgNum;
glk_put_char(arglist[0] & 0xFF);
break;
case 0x0081: /* put_char_stream */
if (numargs != 2)
goto WrongArgNum;
glk_put_char_stream(find_stream_by_id(arglist[0]), arglist[1] & 0xFF);
break;
case 0x00C0: /* select */
/* call a library hook on every glk_select() */
if (library_select_hook)
library_select_hook(0x00C0, arglist[0], 0, 0);
/* but then fall through to full dispatcher, because there's no real
need for speed here */
goto FullDispatcher;
case 0x00A0: /* char_to_lower */
if (numargs != 1)
goto WrongArgNum;
retval = glk_char_to_lower(arglist[0] & 0xFF);
break;
case 0x00A1: /* char_to_upper */
if (numargs != 1)
goto WrongArgNum;
retval = glk_char_to_upper(arglist[0] & 0xFF);
break;
case 0x0128: /* put_char_uni */
if (numargs != 1)
goto WrongArgNum;
glk_put_char_uni(arglist[0]);
break;
case 0x012B: /* put_char_stream_uni */
if (numargs != 2)
goto WrongArgNum;
glk_put_char_stream_uni(find_stream_by_id(arglist[0]), arglist[1]);
break;
WrongArgNum:
fatal_error("Wrong number of arguments to Glk function.");
break;
FullDispatcher:
default: {
/* Go through the full dispatcher prototype foo. */
char *proto, *cx;
dispatch_splot_t splot;
int argnum, argnum2;
/* Grab the string. */
proto = gidispatch_prototype(funcnum);
if (!proto)
fatal_error("Unknown Glk function.");
splot.varglist = arglist;
splot.numvargs = numargs;
splot.retval = &retval;
/* The work goes in four phases. First, we figure out how many
arguments we want, and allocate space for the Glk argument
list. Then we go through the Glulxe arguments and load them
into the Glk list. Then we call. Then we go through the
arguments again, unloading the data back into Glulx memory. */
/* Phase 0. */
prepare_glk_args(proto, &splot);
/* Phase 1. */
argnum = 0;
cx = proto;
parse_glk_args(&splot, &cx, 0, &argnum, 0, 0);
/* Phase 2. */
gidispatch_call(funcnum, argnum, splot.garglist);
/* Phase 3. */
argnum2 = 0;
cx = proto;
unparse_glk_args(&splot, &cx, 0, &argnum2, 0, 0);
if (argnum != argnum2)
fatal_error("Argument counts did not match.");
break;
}
}
return retval;
}
/* read_prefix():
Read the prefixes of an argument string -- the "<>&+:#!" chars.
*/
static char *read_prefix(char *cx, int *isref, int *isarray,
int *passin, int *passout, int *nullok, int *isretained,
int *isreturn)
{
*isref = FALSE;
*passin = FALSE;
*passout = FALSE;
*nullok = TRUE;
*isarray = FALSE;
*isretained = FALSE;
*isreturn = FALSE;
while (1) {
if (*cx == '<') {
*isref = TRUE;
*passout = TRUE;
}
else if (*cx == '>') {
*isref = TRUE;
*passin = TRUE;
}
else if (*cx == '&') {
*isref = TRUE;
*passout = TRUE;
*passin = TRUE;
}
else if (*cx == '+') {
*nullok = FALSE;
}
else if (*cx == ':') {
*isref = TRUE;
*passout = TRUE;
*nullok = FALSE;
*isreturn = TRUE;
}
else if (*cx == '#') {
*isarray = TRUE;
}
else if (*cx == '!') {
*isretained = TRUE;
}
else {
break;
}
cx++;
}
return cx;
}
/* prepare_glk_args():
This reads through the prototype string, and pulls Floo objects off the
stack. It also works out the maximal number of gluniversal_t objects
which could be used by the Glk call in question. It then allocates
space for them.
*/
static void prepare_glk_args(char *proto, dispatch_splot_t *splot)
{
static gluniversal_t *garglist = NULL;
static int garglist_size = 0;
int ix;
int numwanted, numvargswanted, maxargs;
char *cx;
cx = proto;
numwanted = 0;
while (*cx >= '0' && *cx <= '9') {
numwanted = 10 * numwanted + (*cx - '0');
cx++;
}
splot->numwanted = numwanted;
maxargs = 0;
numvargswanted = 0;
for (ix = 0; ix < numwanted; ix++) {
int isref, passin, passout, nullok, isarray, isretained, isreturn;
cx = read_prefix(cx, &isref, &isarray, &passin, &passout, &nullok,
&isretained, &isreturn);
if (isref) {
maxargs += 2;
}
else {
maxargs += 1;
}
if (!isreturn) {
if (isarray) {
numvargswanted += 2;
}
else {
numvargswanted += 1;
}
}
if (*cx == 'I' || *cx == 'C') {
cx += 2;
}
else if (*cx == 'Q') {
cx += 2;
}
else if (*cx == 'S' || *cx == 'U') {
cx += 1;
}
else if (*cx == '[') {
int refdepth, nwx;
cx++;
nwx = 0;
while (*cx >= '0' && *cx <= '9') {
nwx = 10 * nwx + (*cx - '0');
cx++;
}
maxargs += nwx; /* This is *only* correct because all structs contain
plain values. */
refdepth = 1;
while (refdepth > 0) {
if (*cx == '[')
refdepth++;
else if (*cx == ']')
refdepth--;
cx++;
}
}
else {
fatal_error("Illegal format string.");
}
}
if (*cx != ':' && *cx != '\0')
fatal_error("Illegal format string.");
splot->maxargs = maxargs;
if (splot->numvargs != numvargswanted)
fatal_error("Wrong number of arguments to Glk function.");
if (garglist && garglist_size < maxargs) {
glulx_free(garglist);
garglist = NULL;
garglist_size = 0;
}
if (!garglist) {
garglist_size = maxargs + 16;
garglist = (gluniversal_t *)glulx_malloc(garglist_size
* sizeof(gluniversal_t));
}
if (!garglist)
fatal_error("Unable to allocate storage for Glk arguments.");
splot->garglist = garglist;
}
/* parse_glk_args():
This long and unpleasant function translates a set of Floo objects into
a gluniversal_t array. It's recursive, too, to deal with structures.
*/
static void parse_glk_args(dispatch_splot_t *splot, char **proto, int depth,
int *argnumptr, glui32 subaddress, int subpassin)
{
char *cx;
int ix, argx;
int gargnum, numwanted;
void *opref;
gluniversal_t *garglist;
glui32 *varglist;
garglist = splot->garglist;
varglist = splot->varglist;
gargnum = *argnumptr;
cx = *proto;
numwanted = 0;
while (*cx >= '0' && *cx <= '9') {
numwanted = 10 * numwanted + (*cx - '0');
cx++;
}
for (argx = 0, ix = 0; argx < numwanted; argx++, ix++) {
char typeclass;
int skipval;
int isref, passin, passout, nullok, isarray, isretained, isreturn;
cx = read_prefix(cx, &isref, &isarray, &passin, &passout, &nullok,
&isretained, &isreturn);
typeclass = *cx;
cx++;
skipval = FALSE;
if (isref) {
if (!isreturn && varglist[ix] == 0) {
if (!nullok)
fatal_error("Zero passed invalidly to Glk function.");
garglist[gargnum].ptrflag = FALSE;
gargnum++;
skipval = TRUE;
}
else {
garglist[gargnum].ptrflag = TRUE;
gargnum++;
}
}
if (!skipval) {
glui32 thisval;
if (typeclass == '[') {
parse_glk_args(splot, &cx, depth+1, &gargnum, varglist[ix], passin);
}
else if (isarray) {
/* definitely isref */
switch (typeclass) {
case 'C':
/* This test checks for a giant array length, which is
deprecated. It displays a warning and cuts it down to
something reasonable. Future releases of this interpreter
may remove this test and go on to verify_array_addresses(),
which treats this case as a fatal error. */
if (varglist[ix+1] > endmem
|| varglist[ix]+varglist[ix+1] > endmem) {
nonfatal_warning_i("Memory access was much too long -- perhaps a print_to_array call with only one argument", varglist[ix+1]);
varglist[ix+1] = endmem - varglist[ix];
}
verify_array_addresses(varglist[ix], varglist[ix+1], 1);
garglist[gargnum].array = CaptureCArray(varglist[ix], varglist[ix+1], passin);
gargnum++;
ix++;
garglist[gargnum].uint = varglist[ix];
gargnum++;
cx++;
break;
case 'I':
/* See comment above. */
if (varglist[ix+1] > endmem/4
|| varglist[ix+1] > (endmem-varglist[ix])/4) {
nonfatal_warning_i("Memory access was much too long -- perhaps a print_to_array call with only one argument", varglist[ix+1]);
varglist[ix+1] = (endmem - varglist[ix]) / 4;
}
verify_array_addresses(varglist[ix], varglist[ix+1], 4);
garglist[gargnum].array = CaptureIArray(varglist[ix], varglist[ix+1], passin);
gargnum++;
ix++;
garglist[gargnum].uint = varglist[ix];
gargnum++;
cx++;
break;
case 'Q':
/* This case was added after the giant arrays were deprecated,
so we don't bother to allow for that case. We just verify
the length. */
verify_array_addresses(varglist[ix], varglist[ix+1], 4);
garglist[gargnum].array = CapturePtrArray(varglist[ix], varglist[ix+1], (*cx-'a'), passin);
gargnum++;
ix++;
garglist[gargnum].uint = varglist[ix];
gargnum++;
cx++;
break;
default:
fatal_error("Illegal format string.");
break;
}
}
else {
/* a plain value or a reference to one. */
if (isreturn) {
thisval = 0;
}
else if (depth > 0) {
/* Definitely not isref or isarray. */
if (subpassin)
thisval = ReadStructField(subaddress, ix);
else
thisval = 0;
}
else if (isref) {
if (passin)
thisval = ReadMemory(varglist[ix]);
else
thisval = 0;
}
else {
thisval = varglist[ix];
}
switch (typeclass) {
case 'I':
if (*cx == 'u')
garglist[gargnum].uint = (glui32)(thisval);
else if (*cx == 's')
garglist[gargnum].sint = (glsi32)(thisval);
else
fatal_error("Illegal format string.");
gargnum++;
cx++;
break;
case 'Q':
if (thisval) {
opref = classes_get(*cx-'a', thisval);
if (!opref) {
fatal_error("Reference to nonexistent Glk object.");
}
}
else {
opref = NULL;
}
garglist[gargnum].opaqueref = opref;
gargnum++;
cx++;
break;
case 'C':
if (*cx == 'u')
garglist[gargnum].uch = (unsigned char)(thisval);
else if (*cx == 's')
garglist[gargnum].sch = (signed char)(thisval);
else if (*cx == 'n')
garglist[gargnum].ch = (char)(thisval);
else
fatal_error("Illegal format string.");
gargnum++;
cx++;
break;
case 'S':
garglist[gargnum].charstr = DecodeVMString(thisval);
gargnum++;
break;
#ifdef GLK_MODULE_UNICODE
case 'U':
garglist[gargnum].unicharstr = DecodeVMUstring(thisval);
gargnum++;
break;
#endif /* GLK_MODULE_UNICODE */
default:
fatal_error("Illegal format string.");
break;
}
}
}
else {
/* We got a null reference, so we have to skip the format element. */
if (typeclass == '[') {
int numsubwanted, refdepth;
numsubwanted = 0;
while (*cx >= '0' && *cx <= '9') {
numsubwanted = 10 * numsubwanted + (*cx - '0');
cx++;
}
refdepth = 1;
while (refdepth > 0) {
if (*cx == '[')
refdepth++;
else if (*cx == ']')
refdepth--;
cx++;
}
}
else if (typeclass == 'S' || typeclass == 'U') {
/* leave it */
}
else {
cx++;
if (isarray)
ix++;
}
}
}
if (depth > 0) {
if (*cx != ']')
fatal_error("Illegal format string.");
cx++;
}
else {
if (*cx != ':' && *cx != '\0')
fatal_error("Illegal format string.");
}
*proto = cx;
*argnumptr = gargnum;
}
/* unparse_glk_args():
This is about the reverse of parse_glk_args().
*/
static void unparse_glk_args(dispatch_splot_t *splot, char **proto, int depth,
int *argnumptr, glui32 subaddress, int subpassout)
{
char *cx;
int ix, argx;
int gargnum, numwanted;
void *opref;
gluniversal_t *garglist;
glui32 *varglist;
garglist = splot->garglist;
varglist = splot->varglist;
gargnum = *argnumptr;
cx = *proto;
numwanted = 0;
while (*cx >= '0' && *cx <= '9') {
numwanted = 10 * numwanted + (*cx - '0');
cx++;
}
for (argx = 0, ix = 0; argx < numwanted; argx++, ix++) {
char typeclass;
int skipval;
int isref, passin, passout, nullok, isarray, isretained, isreturn;
cx = read_prefix(cx, &isref, &isarray, &passin, &passout, &nullok,
&isretained, &isreturn);
typeclass = *cx;
cx++;
skipval = FALSE;
if (isref) {
if (!isreturn && varglist[ix] == 0) {
if (!nullok)
fatal_error("Zero passed invalidly to Glk function.");
garglist[gargnum].ptrflag = FALSE;
gargnum++;
skipval = TRUE;
}
else {
garglist[gargnum].ptrflag = TRUE;
gargnum++;
}
}
if (!skipval) {
glui32 thisval = 0;
if (typeclass == '[') {
unparse_glk_args(splot, &cx, depth+1, &gargnum, varglist[ix], passout);
}
else if (isarray) {
/* definitely isref */
switch (typeclass) {
case 'C':
ReleaseCArray(garglist[gargnum].array, varglist[ix], varglist[ix+1], passout);
gargnum++;
ix++;
gargnum++;
cx++;
break;
case 'I':
ReleaseIArray(garglist[gargnum].array, varglist[ix], varglist[ix+1], passout);
gargnum++;
ix++;
gargnum++;
cx++;
break;
case 'Q':
ReleasePtrArray(garglist[gargnum].array, varglist[ix], varglist[ix+1], (*cx-'a'), passout);
gargnum++;
ix++;
gargnum++;
cx++;
break;
default:
fatal_error("Illegal format string.");
break;
}
}
else {
/* a plain value or a reference to one. */
if (isreturn || (depth > 0 && subpassout) || (isref && passout)) {
skipval = FALSE;
}
else {
skipval = TRUE;
}
switch (typeclass) {
case 'I':
if (!skipval) {
if (*cx == 'u')
thisval = (glui32)garglist[gargnum].uint;
else if (*cx == 's')
thisval = (glui32)garglist[gargnum].sint;
else
fatal_error("Illegal format string.");
}
gargnum++;
cx++;
break;
case 'Q':
if (!skipval) {
opref = garglist[gargnum].opaqueref;
if (opref) {
gidispatch_rock_t objrock =
gidispatch_get_objrock(opref, *cx-'a');
thisval = ((classref_t *)objrock.ptr)->id;
}
else {
thisval = 0;
}
}
gargnum++;
cx++;
break;
case 'C':
if (!skipval) {
if (*cx == 'u')
thisval = (glui32)garglist[gargnum].uch;
else if (*cx == 's')
thisval = (glui32)garglist[gargnum].sch;
else if (*cx == 'n')
thisval = (glui32)garglist[gargnum].ch;
else
fatal_error("Illegal format string.");
}
gargnum++;
cx++;
break;
case 'S':
if (garglist[gargnum].charstr)
ReleaseVMString(garglist[gargnum].charstr);
gargnum++;
break;
#ifdef GLK_MODULE_UNICODE
case 'U':
if (garglist[gargnum].unicharstr)
ReleaseVMUstring(garglist[gargnum].unicharstr);
gargnum++;
break;
#endif /* GLK_MODULE_UNICODE */
default:
fatal_error("Illegal format string.");
break;
}
if (isreturn) {
*(splot->retval) = thisval;
}
else if (depth > 0) {
/* Definitely not isref or isarray. */
if (subpassout)
WriteStructField(subaddress, ix, thisval);
}
else if (isref) {
if (passout)
WriteMemory(varglist[ix], thisval);
}
}
}
else {
/* We got a null reference, so we have to skip the format element. */
if (typeclass == '[') {
int numsubwanted, refdepth;
numsubwanted = 0;
while (*cx >= '0' && *cx <= '9') {
numsubwanted = 10 * numsubwanted + (*cx - '0');
cx++;
}
refdepth = 1;
while (refdepth > 0) {
if (*cx == '[')
refdepth++;
else if (*cx == ']')
refdepth--;
cx++;
}
}
else if (typeclass == 'S' || typeclass == 'U') {
/* leave it */
}
else {
cx++;
if (isarray)
ix++;
}
}
}
if (depth > 0) {
if (*cx != ']')
fatal_error("Illegal format string.");
cx++;
}
else {
if (*cx != ':' && *cx != '\0')
fatal_error("Illegal format string.");
}
*proto = cx;
*argnumptr = gargnum;
}
/* find_stream_by_id():
This is used by some interpreter code which has to, well, find a Glk
stream given its ID.
*/
strid_t find_stream_by_id(glui32 objid)
{
if (!objid)
return NULL;
/* Recall that class 1 ("b") is streams. */
return classes_get(gidisp_Class_Stream, objid);
}
/* find_id_for_window():
Return the ID of a given Glk window.
*/
glui32 find_id_for_window(winid_t win)
{
gidispatch_rock_t objrock;
if (!win)
return 0;
objrock = gidispatch_get_objrock(win, gidisp_Class_Window);
if (!objrock.ptr)
return 0;
return ((classref_t *)objrock.ptr)->id;
}
/* find_id_for_stream():
Return the ID of a given Glk stream.
*/
glui32 find_id_for_stream(strid_t str)
{
gidispatch_rock_t objrock;
if (!str)
return 0;
objrock = gidispatch_get_objrock(str, gidisp_Class_Stream);
if (!objrock.ptr)
return 0;
return ((classref_t *)objrock.ptr)->id;
}
/* find_id_for_fileref():
Return the ID of a given Glk fileref.
*/
glui32 find_id_for_fileref(frefid_t fref)
{
gidispatch_rock_t objrock;
if (!fref)
return 0;
objrock = gidispatch_get_objrock(fref, gidisp_Class_Fileref);
if (!objrock.ptr)
return 0;
return ((classref_t *)objrock.ptr)->id;
}