-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathglkapi.js
6528 lines (5844 loc) · 210 KB
/
glkapi.js
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
'use strict';
/* GlkAPI -- a Javascript Glk API for IF interfaces
* GlkOte Library: version 2.3.6.
* Glk API which this implements: version 0.7.4.
* Designed by Andrew Plotkin <[email protected]>
* <http://eblong.com/zarf/glk/glkote.html>
*
* This Javascript library is copyright 2010-2024 by Andrew Plotkin.
* It is distributed under the MIT license; see the "LICENSE" file.
*
* This file is a Glk API compatibility layer for glkote.js. It offers a
* set of Javascript calls which closely match the original C Glk API;
* these work by means of glkote.js operations.
*
* This API was built for Quixe, which is a pure-Javascript Glulx
* interpreter. Therefore, the API is a little strange. Notably, it
* accepts text buffers in the form of arrays of integers, not
* Javascript strings. Only the Glk calls that explicitly use strings
* (glk_put_string, etc) accept Javascript native strings.
*
* If you are writing an application in pure Javascript, you can use
* this layer (along with glkote.js). If you are writing a web app which
* is the front face of a server-side Glk app, ignore this file -- use
* glkote.js directly.
*/
/* Known problems:
Some places in the library get confused about Unicode characters
beyond 0xFFFF. They are handled correctly by streams, but grid windows
will think they occupy two characters rather than one, which will
throw off the grid spacing.
Also, the glk_put_jstring() function can't handle them at all. Quixe
printing operations that funnel through glk_put_jstring() -- meaning,
most native string printing -- will break up three-byte characters
into a UTF-16-encoded pair of two-byte characters. This will come
out okay in a buffer window, but it will again mess up grid windows,
and will also double the write-count in a stream.
*/
/* All state is contained in GlkClass. */
var GlkClass = function() {
var GlkOte = null; /* imported API object */
var VM = null; /* imported API object (the VM interface) */
var GiDispa = null; /* imported API object (the dispatch layer) */
var Blorb = null; /* imported API object (the resource layer) */
/* Environment capabilities. (Checked at init time.) */
var has_canvas;
/* Options from the vm_options object. */
var option_exit_warning;
var option_do_vm_autosave;
var option_before_select_hook;
var option_extevent_hook;
var option_glk_gestalt_hook;
/* Library display state. */
var has_exited = false;
var ui_disabled = false;
var ui_specialinput = null;
var ui_specialcallback = null;
var event_generation = 0;
var current_partial_inputs = null;
var current_partial_outputs = null;
/* Initialize the library, initialize the VM, and set it running. (It will
run until the first glk_select() or glk_exit() call.)
The vm_options argument must have a vm_options.vm field, which must be an
appropriate VM interface object. (For example, Quixe.) This must have
init() and resume() methods.
The vm_options argument is also passed through to GlkOte as the game
interface object. It can be used to affect some GlkOte display options,
such as window spacing.
(You do not need to provide a vm_options.accept() function. The Glk
library sets that up for you.)
*/
function init(vm_options) {
/* Either GlkOte was passed in or we must create one. */
if (vm_options.GlkOte) {
GlkOte = vm_options.GlkOte;
}
else if (window.GlkOteClass) {
GlkOte = new window.GlkOteClass();
}
/* Either Blorb was passed in or we don't have one. */
if (vm_options.Blorb) {
Blorb = vm_options.Blorb;
}
/* Check for canvas support. We don't rely on jquery here. */
has_canvas = (document.createElement('canvas').getContext != undefined);
VM = vm_options.vm;
GiDispa = vm_options.GiDispa; /* may be null/undefined */
vm_options.accept = accept_ui_event;
option_exit_warning = vm_options.exit_warning;
option_do_vm_autosave = vm_options.do_vm_autosave;
option_before_select_hook = vm_options.before_select_hook;
option_extevent_hook = vm_options.extevent_hook;
option_glk_gestalt_hook = vm_options.glk_gestalt_hook;
if (option_before_select_hook) {
option_before_select_hook();
}
/* Initialize the lower levels. */
if (GiDispa)
GiDispa.init({ io:vm_options.io, vm:vm_options.vm });
GlkOte.init(vm_options);
}
function is_inited() {
return (VM != null && GlkOte != null);
}
function accept_ui_event(obj) {
var box;
//qlog("### accept_ui_event: " + obj.type + ", gen " + obj.gen);
if (ui_disabled) {
/* We've hit glk_exit() or a VM fatal error, or just blocked the UI for
some modal dialog. */
qlog("### ui is disabled, ignoring event");
return;
}
if (obj.gen != event_generation) {
GlkOte.log('Input event had wrong generation number: got ' + obj.gen + ', currently at ' + event_generation);
return;
}
event_generation += 1;
/* Note any partial inputs; we'll need them if the game cancels a line
input. This may be undef. */
current_partial_inputs = obj.partial;
switch (obj.type) {
case 'init':
content_metrics = complete_metrics(obj.metrics);
/* We ignore the support array. This library is updated in sync
with GlkOte, so we know what it supports. */
VM.start();
break;
case 'external':
var res = null;
if (option_extevent_hook) {
res = option_extevent_hook(obj.value);
}
if (!res && obj.value == 'timer') {
/* Timer events no longer come in this way, but we'll still
accept them. */
gli_timer_started = Date.now();
res = { type: Const.evtype_Timer };
}
if (res && res.type) {
handle_external_input(res);
}
break;
case 'timer':
gli_timer_started = Date.now();
var res = { type: Const.evtype_Timer };
handle_external_input(res);
break;
case 'hyperlink':
handle_hyperlink_input(obj.window, obj.value);
break;
case 'mouse':
handle_mouse_input(obj.window, obj.x, obj.y);
break;
case 'char':
handle_char_input(obj.window, obj.value);
break;
case 'line':
handle_line_input(obj.window, obj.value, obj.terminator);
break;
case 'arrange':
content_metrics = complete_metrics(obj.metrics);
box = {
left: content_metrics.outspacingx,
top: content_metrics.outspacingy,
right: content_metrics.width-content_metrics.outspacingx,
bottom: content_metrics.height-content_metrics.outspacingy
};
if (gli_rootwin)
gli_window_rearrange(gli_rootwin, box);
handle_arrange_input();
break;
case 'redraw':
handle_redraw_input();
break;
case 'specialresponse':
if (obj.response == 'fileref_prompt') {
gli_fileref_create_by_prompt_callback(obj);
}
break;
}
}
/* Given a partial metrics object, return one with all the required
values. Missing values will default to 0 or the standard inherited
terms. (E.g., if "inspacingx" is missing it will default to
"inspacing", then "spacing", then 0. See measure_window() in
glkote.js or data_metrics_parse() in RemGlk.)
All values in the given object will be copied over; defaulting only
applies to missing values from the required set.
*/
function complete_metrics(metrics) {
// Default values if absolutely nothing is specified.
var res = {
width: 80,
height: 50,
gridcharwidth: 1,
gridcharheight: 1,
buffercharwidth: 1,
buffercharheight: 1,
gridmarginx: 0,
gridmarginy: 0,
buffermarginx: 0,
buffermarginy: 0,
graphicsmarginx: 0,
graphicsmarginy: 0,
outspacingx: 0,
outspacingy: 0,
inspacingx: 0,
inspacingy: 0,
};
// Various ways of specifying defaults.
var val;
val = metrics.charwidth;
if (val !== undefined) {
res.gridcharwidth = val;
res.buffercharwidth = val;
}
val = metrics.charheight;
if (val !== undefined) {
res.gridcharheight = val;
res.buffercharheight = val;
}
val = metrics.margin;
if (val !== undefined) {
res.gridmarginx = val;
res.gridmarginy = val;
res.buffermarginx = val;
res.buffermarginy = val;
res.graphicsmarginx = val;
res.graphicsmarginy = val;
}
val = metrics.gridmargin;
if (val !== undefined) {
res.gridmarginx = val;
res.gridmarginy = val;
}
val = metrics.buffermargin;
if (val !== undefined) {
res.buffermarginx = val;
res.buffermarginy = val;
}
val = metrics.graphicsmargin;
if (val !== undefined) {
res.graphicsmarginx = val;
res.graphicsmarginy = val;
}
val = metrics.marginx;
if (val !== undefined) {
res.gridmarginx = val;
res.buffermarginx = val;
res.graphicsmarginx = val;
}
val = metrics.marginy;
if (val !== undefined) {
res.gridmarginy = val;
res.buffermarginy = val;
res.graphicsmarginy = val;
}
val = metrics.spacing;
if (val !== undefined) {
res.inspacingx = val;
res.inspacingy = val;
res.outspacingx = val;
res.outspacingy = val;
}
val = metrics.inspacing;
if (val !== undefined) {
res.inspacingx = val;
res.inspacingy = val;
}
val = metrics.outspacing;
if (val !== undefined) {
res.outspacingx = val;
res.outspacingy = val;
}
val = metrics.spacingx;
if (val !== undefined) {
res.inspacingx = val;
res.outspacingx = val;
}
val = metrics.spacingy;
if (val !== undefined) {
res.inspacingy = val;
res.outspacingy = val;
}
// Copy over all the supplied fields. These override the defaults above.
res = Object.assign(res, metrics);
return res;
}
function handle_arrange_input() {
if (!gli_selectref)
return;
gli_selectref.set_field(0, Const.evtype_Arrange);
gli_selectref.set_field(1, null);
gli_selectref.set_field(2, 0);
gli_selectref.set_field(3, 0);
if (GiDispa)
GiDispa.prepare_resume(gli_selectref);
gli_selectref = null;
VM.resume();
}
function handle_redraw_input() {
if (!gli_selectref)
return;
gli_selectref.set_field(0, Const.evtype_Redraw);
gli_selectref.set_field(1, null);
gli_selectref.set_field(2, 0);
gli_selectref.set_field(3, 0);
if (GiDispa)
GiDispa.prepare_resume(gli_selectref);
gli_selectref = null;
VM.resume();
}
function handle_external_input(res) {
if (!gli_selectref)
return;
/* This also handles timer input. */
var val1 = 0;
var val2 = 0;
if (res.val1)
val1 = res.val1;
if (res.val2)
val2 = res.val2;
gli_selectref.set_field(0, res.type);
gli_selectref.set_field(1, null);
gli_selectref.set_field(2, val1);
gli_selectref.set_field(3, val2);
if (GiDispa)
GiDispa.prepare_resume(gli_selectref);
gli_selectref = null;
VM.resume();
}
function handle_hyperlink_input(disprock, val) {
if (!gli_selectref)
return;
var win = null;
for (win=gli_windowlist; win; win=win.next) {
if (win.disprock == disprock)
break;
}
if (!win || !win.hyperlink_request)
return;
gli_selectref.set_field(0, Const.evtype_Hyperlink);
gli_selectref.set_field(1, win);
gli_selectref.set_field(2, val);
gli_selectref.set_field(3, 0);
win.hyperlink_request = false;
if (GiDispa)
GiDispa.prepare_resume(gli_selectref);
gli_selectref = null;
VM.resume();
}
function handle_mouse_input(disprock, xpos, ypos) {
if (!gli_selectref)
return;
var win = null;
for (win=gli_windowlist; win; win=win.next) {
if (win.disprock == disprock)
break;
}
if (!win || !win.mouse_request)
return;
gli_selectref.set_field(0, Const.evtype_MouseInput);
gli_selectref.set_field(1, win);
gli_selectref.set_field(2, xpos);
gli_selectref.set_field(3, ypos);
win.mouse_request = false;
if (GiDispa)
GiDispa.prepare_resume(gli_selectref);
gli_selectref = null;
VM.resume();
}
function handle_char_input(disprock, input) {
var charval;
if (!gli_selectref)
return;
var win = null;
for (win=gli_windowlist; win; win=win.next) {
if (win.disprock == disprock)
break;
}
if (!win || !win.char_request)
return;
if (input.length == 1) {
charval = input.charCodeAt(0);
if (!win.char_request_uni)
charval = charval & 0xFF;
}
else {
charval = KeystrokeNameMap[input];
if (!charval)
charval = Const.keycode_Unknown;
}
gli_selectref.set_field(0, Const.evtype_CharInput);
gli_selectref.set_field(1, win);
gli_selectref.set_field(2, charval);
gli_selectref.set_field(3, 0);
win.char_request = false;
win.char_request_uni = false;
win.input_generation = null;
if (GiDispa)
GiDispa.prepare_resume(gli_selectref);
gli_selectref = null;
VM.resume();
}
function handle_line_input(disprock, input, termkey) {
var ix;
if (!gli_selectref)
return;
var win = null;
for (win=gli_windowlist; win; win=win.next) {
if (win.disprock == disprock)
break;
}
if (!win || !win.line_request)
return;
if (input.length > win.linebuf.length)
input = input.slice(0, win.linebuf.length);
if (win.request_echo_line_input) {
ix = win.style;
gli_set_style(win.str, Const.style_Input);
gli_window_put_string(win, input);
if (win.echostr)
glk_put_jstring_stream(win.echostr, input);
gli_set_style(win.str, ix);
gli_window_put_string(win, "\n");
if (win.echostr)
glk_put_jstring_stream(win.echostr, "\n");
}
for (ix=0; ix<input.length; ix++)
win.linebuf[ix] = input.charCodeAt(ix);
var termcode = 0;
if (termkey && KeystrokeNameMap[termkey])
termcode = KeystrokeNameMap[termkey];
gli_selectref.set_field(0, Const.evtype_LineInput);
gli_selectref.set_field(1, win);
gli_selectref.set_field(2, input.length);
gli_selectref.set_field(3, termcode);
if (GiDispa)
GiDispa.unretain_array(win.linebuf);
win.line_request = false;
win.line_request_uni = false;
win.request_echo_line_input = null;
win.input_generation = null;
win.linebuf = null;
if (GiDispa)
GiDispa.prepare_resume(gli_selectref);
gli_selectref = null;
VM.resume();
}
function update() {
var dataobj = { type: 'update', gen: event_generation };
var winarray = null;
var contentarray = null;
var inputarray = null;
var win, obj, robj, useobj, lineobj, ls, val, ix, cx;
var initial, lastpos, laststyle, lasthyperlink;
if (geometry_changed) {
geometry_changed = false;
winarray = [];
for (win=gli_windowlist; win; win=win.next) {
if (win.type == Const.wintype_Pair)
continue;
obj = { id: win.disprock, rock: win.rock };
winarray.push(obj);
switch (win.type) {
case Const.wintype_TextBuffer:
obj.type = 'buffer';
break;
case Const.wintype_TextGrid:
obj.type = 'grid';
obj.gridwidth = win.gridwidth;
obj.gridheight = win.gridheight;
break;
case Const.wintype_Graphics:
obj.type = 'graphics';
obj.graphwidth = win.graphwidth;
obj.graphheight = win.graphheight;
break;
}
obj.left = win.bbox.left;
obj.top = win.bbox.top;
obj.width = win.bbox.right - win.bbox.left;
obj.height = win.bbox.bottom - win.bbox.top;
}
}
for (win=gli_windowlist; win; win=win.next) {
useobj = false;
obj = { id: win.disprock };
if (contentarray == null)
contentarray = [];
switch (win.type) {
case Const.wintype_TextBuffer:
gli_window_buffer_deaccumulate(win);
if (win.content.length) {
obj.text = win.content.slice(0);
win.content.length = 0;
useobj = true;
}
if (win.clearcontent) {
obj.clear = true;
win.clearcontent = false;
useobj = true;
if (!obj.text) {
obj.text = [];
}
win.reserve.length = 0;
}
if (obj.text && obj.text.length) {
for (ix=0; ix<obj.text.length; ix++) {
win.reserve.push(obj.text[ix]);
}
}
if (win.reserve.length > 100) {
win.reserve.splice(0, win.reserve.length-100);
}
break;
case Const.wintype_TextGrid:
if (win.gridwidth == 0 || win.gridheight == 0)
break;
obj.lines = [];
for (ix=0; ix<win.gridheight; ix++) {
lineobj = win.lines[ix];
if (!lineobj.dirty)
continue;
lineobj.dirty = false;
ls = [];
lastpos = 0;
for (cx=0; cx<win.gridwidth; ) {
laststyle = lineobj.styles[cx];
lasthyperlink = lineobj.hyperlinks[cx];
for (; cx<win.gridwidth
&& lineobj.styles[cx] == laststyle
&& lineobj.hyperlinks[cx] == lasthyperlink;
cx++) { }
if (lastpos < cx) {
if (!lasthyperlink) {
ls.push(StyleNameMap[laststyle]);
ls.push(lineobj.chars.slice(lastpos, cx).join(''));
}
else {
robj = { style:StyleNameMap[laststyle], text:lineobj.chars.slice(lastpos, cx).join(''), hyperlink:lasthyperlink };
ls.push(robj);
}
lastpos = cx;
}
}
obj.lines.push({ line:ix, content:ls });
}
useobj = obj.lines.length;
break;
case Const.wintype_Graphics:
if (win.content.length) {
obj.draw = win.content.slice(0);
win.content.length = 0;
useobj = true;
}
/* Copy new drawing commands over to the reserve. Keep track
of the last (whole-window) fill command. */
var clearedat = -1;
if (obj.draw && obj.draw.length) {
for (ix=0; ix<obj.draw.length; ix++) {
var drawel = obj.draw[ix];
if (drawel.special == 'fill'
&& drawel.x === undefined && drawel.y === undefined
&& drawel.width === undefined && drawel.height === undefined) {
clearedat = win.reserve.length;
}
win.reserve.push(drawel);
}
}
if (clearedat >= 0) {
/* We're going to delete every command before the
fill, except that we save the last setcolor. */
var setcol = null;
for (ix=0; ix<win.reserve.length && ix<clearedat; ix++) {
var drawel = win.reserve[ix];
if (drawel.special == 'setcolor')
setcol = drawel;
}
win.reserve.splice(0, clearedat);
if (setcol)
win.reserve.unshift(setcol);
}
break;
}
if (useobj)
contentarray.push(obj);
}
inputarray = [];
for (win=gli_windowlist; win; win=win.next) {
obj = null;
if (win.char_request) {
obj = { id: win.disprock, type: 'char', gen: win.input_generation };
if (win.type == Const.wintype_TextGrid) {
if (gli_window_grid_canonicalize(win)) {
obj.xpos = win.gridwidth;
obj.ypos = win.gridheight-1;
}
else {
obj.xpos = win.cursorx;
obj.ypos = win.cursory;
}
}
}
if (win.line_request) {
initial = '';
if (current_partial_outputs) {
val = current_partial_outputs[win.disprock];
if (val)
initial = val;
}
/* Note that the initial and terminators fields will be ignored
if this is a continued (old) input request. So it doesn't
matter if they're wrong. */
obj = { id: win.disprock, type: 'line', gen: win.input_generation,
maxlen: win.linebuf.length, initial: initial };
if (win.line_input_terminators.length) {
obj.terminators = win.line_input_terminators;
}
if (win.type == Const.wintype_TextGrid) {
if (gli_window_grid_canonicalize(win)) {
obj.xpos = win.gridwidth;
obj.ypos = win.gridheight-1;
}
else {
obj.xpos = win.cursorx;
obj.ypos = win.cursory;
}
}
}
if (win.hyperlink_request) {
if (!obj)
obj = { id: win.disprock };
obj.hyperlink = true;
}
if (win.mouse_request) {
if (!obj)
obj = { id: win.disprock };
obj.mouse = true;
}
if (obj)
inputarray.push(obj);
}
dataobj.windows = winarray;
dataobj.content = contentarray;
dataobj.input = inputarray;
if (gli_timer_lastsent != gli_timer_interval) {
//qlog("### timer update: " + gli_timer_interval);
dataobj.timer = gli_timer_interval;
gli_timer_lastsent = gli_timer_interval;
}
if (ui_specialinput) {
//qlog("### special input: " + ui_specialinput.type);
dataobj.specialinput = ui_specialinput;
}
if (ui_disabled) {
//qlog("### disabling ui");
dataobj.disable = true;
}
/* Clean this up; it's only meaningful within one run/update cycle. */
current_partial_outputs = null;
/* If we're doing an autorestore, gli_autorestore_glkstate will
contain additional setup information for the first update()
call only. */
if (gli_autorestore_glkstate)
dataobj.autorestore = gli_autorestore_glkstate;
gli_autorestore_glkstate = null;
GlkOte.update(dataobj, gli_autorestore_glkstate);
if (option_before_select_hook) {
option_before_select_hook();
}
if (option_do_vm_autosave) {
if (has_exited) {
/* On quit or fatal error, delete the autosave. */
VM.do_autosave(-1);
}
else {
/* If this is a good time, autosave. */
var eventarg = GiDispa.check_autosave();
if (eventarg)
VM.do_autosave(eventarg);
}
}
}
/* Return the library interface object that we were passed or created.
Call this if you want to use, e.g., the same Dialog object that GlkOte
is using.
*/
function get_library(val) {
switch (val) {
case 'VM': return VM;
case 'GlkOte': return GlkOte;
case 'GiDispa': return GiDispa;
case 'Blorb': return Blorb;
case 'Dialog': return GlkOte.getlibrary('Dialog');
}
/* Unrecognized library name. */
return null;
}
/* Wrap up the current display state as a (JSONable) object. This is
called from Quixe.vm_autosave.
*/
function save_allstate() {
var Dialog = GlkOte.getlibrary('Dialog');
var res = {};
if (gli_rootwin)
res.rootwin = gli_rootwin.disprock;
if (gli_currentstr)
res.currentstr = gli_currentstr.disprock;
if (gli_timer_interval)
res.timer_interval = gli_timer_interval;
res.windows = [];
for (var win = gli_windowlist; win; win = win.next) {
var obj = {
type: win.type, rock: win.rock, disprock: win.disprock,
style: win.style, hyperlink: win.hyperlink
};
if (win.parent)
obj.parent = win.parent.disprock;
obj.str = win.str.disprock;
if (win.echostr)
obj.echostr = win.echostr.disprock;
obj.bbox = {
left: win.bbox.left, right: win.bbox.right,
top: win.bbox.top, bottom: win.bbox.bottom
};
if (win.linebuf !== null) {
var info = GiDispa.get_retained_array(win.linebuf);
obj.linebuf = {
addr: info.addr,
len: info.len,
arr: info.arr.slice(0),
arg: info.arg.serialize()
};
}
obj.char_request = win.char_request;
obj.line_request = win.line_request;
obj.char_request_uni = win.char_request_uni;
obj.line_request_uni = win.line_request_uni;
obj.hyperlink_request = win.hyperlink_request;
obj.mouse_request = win.mouse_request;
obj.echo_line_input = win.echo_line_input;
obj.request_echo_line_input = win.request_echo_line_input;
obj.line_input_terminators = win.line_input_terminators.slice(0);
//### should have a request_line_input_terminators as well
switch (win.type) {
case Const.wintype_TextBuffer:
obj.reserve = win.reserve.slice(0);
break;
case Const.wintype_TextGrid:
obj.gridwidth = win.gridwidth;
obj.gridheight = win.gridheight;
obj.lines = [];
for (var ix=0; ix<win.lines.length; ix++) {
var ln = win.lines[ix];
obj.lines.push({
chars: ln.chars.slice(0),
styles: ln.styles.slice(0),
hyperlinks: ln.hyperlinks.slice(0)
});
}
obj.cursorx = win.cursorx;
obj.cursory = win.cursory;
break;
case Const.wintype_Graphics:
obj.graphwidth = win.graphwidth;
obj.graphheight = win.graphheight;
obj.reserve = win.reserve.slice(0);
break;
case Const.wintype_Pair:
obj.pair_dir = win.pair_dir;
obj.pair_division = win.pair_division;
obj.pair_key = win.pair_key.disprock;
obj.pair_keydamage = false;
obj.pair_size = win.pair_size;
obj.pair_hasborder = win.pair_hasborder;
obj.pair_vertical = win.pair_vertical;
obj.pair_backward = win.pair_backward;
obj.child1 = win.child1.disprock;
obj.child2 = win.child2.disprock;
break;
}
res.windows.push(obj);
}
res.streams = [];
for (var str = gli_streamlist; str; str = str.next) {
var obj = {
type: str.type, rock: str.rock, disprock: str.disprock,
unicode: str.unicode, isbinary: str.isbinary,
readcount: str.readcount, writecount: str.writecount,
readable: str.readable, writable: str.writable,
streaming: str.streaming
};
switch (str.type) {
case strtype_Window:
if (str.win)
obj.win = str.win.disprock;
break;
case strtype_Memory:
if (str.buf !== null) {
var info = GiDispa.get_retained_array(str.buf);
obj.buf = {
addr: info.addr,
len: info.len,
arr: info.arr.slice(0),
arg: info.arg.serialize()
};
}
obj.buflen = str.buflen;
obj.bufpos = str.bufpos;
obj.bufeof = str.bufeof;
break;
case strtype_Resource:
obj.resfilenum = str.resfilenum;
// Don't need str.buf
obj.buflen = str.buflen;
obj.bufpos = str.bufpos;
obj.bufeof = str.bufeof;
break;
case strtype_File:
obj.origfmode = str.origfmode;
if (!Dialog.streaming) {
obj.ref = str.ref;
gli_stream_flush_file(str);
// Don't need str.buf
obj.buflen = str.buflen;
obj.bufpos = str.bufpos;
obj.bufeof = str.bufeof;
}
else {
str.fstream.fflush();
obj.ref = str.ref;
obj.filepos = str.fstream.ftell();
}
break;
}
res.streams.push(obj);
}
res.filerefs = [];
for (var fref = gli_filereflist; fref; fref = fref.next) {
var obj = {
type: fref.type, rock: fref.rock, disprock: fref.disprock,
filename: fref.filename, textmode: fref.textmode,
filetype: fref.filetype, filetypename: fref.filetypename
};
obj.ref = fref.ref;
res.filerefs.push(obj);
}
// Ignore gli_schannellist, as it's currently always empty.
/* Save GlkOte-level information. This includes the overall metrics. */
res.glkote = GlkOte.save_allstate();
return res;
}
/* Take display information (created by save_allstate) and set up our
state to match it. Called from vm_autorestore.
*/
function restore_allstate(res)
{
var Dialog = GlkOte.getlibrary('Dialog');
if (gli_windowlist || gli_streamlist || gli_filereflist)
throw('restore_allstate: glkapi module has already been launched');
/* We build and register all the bare objects first. (In reverse