File: fileio.c

package info (click to toggle)
xzip 1:1.8.2-4
  • links: PTS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 656 kB
  • ctags: 1,556
  • sloc: ansic: 11,942; makefile: 171; sh: 11
file content (1332 lines) | stat: -rw-r--r-- 28,619 bytes parent folder | download | duplicates (2)
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
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
/*
 * fileio.c
 *
 * File manipulation routines. Should be generic.
 *
 */

#include "ztypes.h"
#include "pickle.h"

/* A couple of definitions for constants used to access PICKLE files.
	Both are Mac-style four-byte constants. You can read each as 
	four characters, MSB first. (Don't worry about whether your
	system is big- or little-endian; the PICKLE library takes care 
	of that stuff.) */
/* The "use" of executable chunks */ 
#define PICKLETYPE_exec (0x65786563)
/* The "format" of executable chunks containing Z-code */
#define PICKLETYPE_zcod (0x7a636f64)

/* All of the following variables are set in open_story(). */

/* is_pickle is a boolean flag; it will be TRUE if the open zcode is
	contained in a PICKLE file. It is not static because other modules
	may wish to check its value. */
int is_pickle;

/* pickle_map is the opaque handle to the PICKLE file map in memory.
	It is not static because other modules will need it in order
	to load PICKLE chunks. */
pikMapPtr pickle_map;

/* zcode_length is the length of the zcode. If is_pickle is FALSE,
	this is the actual file length. */
static unsigned long zcode_length;

/* zcode_offset is the starting position of the zcode in its file. If
	is_pickle is FALSE, this is just 0. */
static unsigned long zcode_offset;

/* Static data */

static FILE *gfp = NULL; /* Game file pointer */
static FILE *sfp = NULL; /* Script file pointer */
static FILE *rfp = NULL; /* Record file pointer */
static char save_name[FILENAME_MAX + 1] = "";
static char savedata_name[FILENAME_MAX + 1] = "";
static char script_name[FILENAME_MAX + 1] = "";
static char record_name[FILENAME_MAX + 1] = "";

static int undo_valid = FALSE;
static zword_t undo_stack[STACK_SIZE];

static int script_file_valid = FALSE;

#ifdef __STDC__
static int save_restore (const char *, int);
static int save_restore_data (const char *, int, int, zword_t *);
static void set_names (const char *);
static void swap_bytes (zword_t *, int);
#else
static int save_restore ();
static int save_restore_data ();
static void set_names ();
static void swap_bytes ();
#endif

/*
 * set_names
 *
 * Set up the story names intelligently.
 * Taken from JZip, John Holder, 28 Sept 1995
 */
#ifdef __STDC__
static void set_names (const char *storyname)
#else
static void set_names (storyname)
const char *storyname;
#endif
{
    char *dot_pos ;
    char *slash_pos ;
    char *home ;
    char basename[FILENAME_MAX+1] ;

    /* Find base name */
    if( slash_pos = strrchr( storyname, '/' ) )
      strcpy( basename, ++slash_pos ) ;
    else
      strcpy( basename, storyname ) ;

    if( dot_pos = strrchr( basename, '.' ) )
      *dot_pos = '\0' ;

    /* Find correct directory */
    if( home = getenv( "HOME" ) )
      {
	strcpy( save_name, home ) ;
	strcat( save_name, "/.infocom/" ) ;
	mkdir( save_name, 0777 ) ;
      }

    /* Home directory + basename */
    strcat( save_name, basename ) ;

    /* Copy to other three strings */
    strcpy( script_name, save_name ) ;
    strcpy( record_name, save_name ) ;
    strcpy( savedata_name, save_name ) ;

    /* Add extensions */
    strcat(save_name,".sav");
    strcat(script_name,".scr");
    strcat(record_name,".rec");
    strcat(savedata_name,".dat");
} /* set_names */

/*
 * open_story
 *
 * Open game file for read.
 *
 */

#ifdef __STDC__
void open_story (const char *storyname)
#else
void open_story (storyname)
const char *storyname;
#endif
{
    /* Most of this function is new. --Z */
    int ix;
    char firstfour[4];
    pikErr err;
    pikChunkID chunkid;
    pikChunk chunk;
    
    /* This is the list of formats that the PICKLE library will check for.
        You can extend it in the obvious way. */
#define NUMPICKLEFORMATS (4)
    static pikFormat formatlist[NUMPICKLEFORMATS] = {
        {PICKLETYPE_zcod, 3}, 
        {PICKLETYPE_zcod, 4}, 
        {PICKLETYPE_zcod, 5}, 
        {PICKLETYPE_zcod, 8}
    };
    
    /* The following three lines are what used to here. --Z */
    gfp = fopen (storyname, "rb");
    if (gfp == NULL && storyname[0] != '/') {
        /* Try the magic path variable. */
        char *classpath = getenv("INFOCOM_PATH");
	if (classpath && strlen(classpath) > 0) {
	    char *p;
	    p = strtok(classpath, ":");
	    while (p && !gfp) {
	        char classfile[FILENAME_MAX+1];
		sprintf(classfile, "%s/%s", p, storyname);
		gfp = fopen (classfile, "rb");
		p = strtok(NULL, ":");
	    }
	}
    }
    if (gfp == NULL)
        fatal ("Game file not found");

    set_names(storyname);

    /* Now the new code... --Z */
    
    for (ix = 0; ix < 4; ix++) {
        firstfour[ix] = fgetc (gfp);
        if (firstfour[ix] == EOF)
            break;
    }
    
    /* The PICKLE library doesn't require the file to be rewound here, 
    and standard ZIP doesn't either, but it doesn't hurt to be sure. */
    rewind(gfp);   
    
    is_pickle = FALSE;
    zcode_length = 0;
    zcode_offset = 0;
    
    if (ix == 4) {
        if (pikIsPickleHeader(firstfour)) {
            /* Yes! It is indeed a PICKLE file! */
            is_pickle = TRUE;
            /* Open the PICKLE file and load the map into memory. */
            err = pikCreateMap(gfp, &pickle_map);
            if (err) 
                fatal ("Unable to open PICKLE file");
            /* Find and load the Z-code chunk. */
            err = pikFindChunk(pickle_map, PICKLETYPE_exec, 0, NUMPICKLEFORMATS, 
                formatlist, &chunkid);
            if (err == pikerr_NotFound) 
                fatal ("There is no Z-code chunk in this PICKLE file");
            if (err) 
                fatal ("Unable to search PICKLE file");
            err = pikLoadChunk(pickle_map, chunkid, pikmethod_FilePos, &chunk);
            if (err) 
                fatal ("Unable to read Z-code chunk from PICKLE file");
            zcode_offset = chunk.data.startpos;
            zcode_length = chunk.length;
        }
    }
}/* open_story */

/*
 * close_story
 *
 * Close game file if open.
 *
 */

#ifdef __STDC__
void close_story (void)
#else
void close_story ()
#endif
{
    if (is_pickle) { /* --Z */
        pikDestroyMap(pickle_map);
    } /* --Z */
    
    /* The rest of this function is not changed. --Z */

    if (gfp != NULL)
        fclose (gfp);

}/* close_story */

/*
 * get_story_size
 *
 * Calculate the size of the game file. Only used for very old games that do not
 * have the game file size in the header.
 *
 */

#ifdef __STDC__
unsigned int get_story_size (void)
#else
unsigned int get_story_size ()
#endif
{
    unsigned long file_length;

    if (!is_pickle) { /* --Z */
        /* Read whole file to calculate file size */
    
        rewind (gfp);
        for (file_length = 0; fgetc (gfp) != EOF; file_length++)
            ;
        rewind (gfp);
    }
    else {
        /* Use the length loaded from the PICKLE file */
        file_length = zcode_length;
    } /* --Z */

    /* The rest of this function is not changed. --Z */

    /* Calculate length of file in game allocation units */

    file_length = (file_length + (unsigned long) (story_scaler - 1)) / (unsigned long) story_scaler;

    return ((unsigned int) file_length);

}/* get_story_size */

/*
 * read_page
 *
 * Read one game file page.
 *
 */

#ifdef __STDC__
void read_page (int page, void *buffer)
#else
void read_page (page, buffer)
int page;
void *buffer;
#endif
{
    unsigned long file_size;
    unsigned int pages, offset;

    /* Seek to start of page */

    fseek (gfp, zcode_offset + (long) page * PAGE_SIZE, SEEK_SET);

    /* Read the page */

    if (fread (buffer, PAGE_SIZE, 1, gfp) != 1) {

        /* Read failed. Are we in the last page? */

        file_size = (unsigned long) h_file_size * story_scaler;
        pages = (unsigned int) ((unsigned long) file_size / PAGE_SIZE);
        offset = (unsigned int) ((unsigned long) file_size & PAGE_MASK);
        if ((unsigned int) page == pages) {

            /* Read partial page if this is the last page in the game file */

            fseek (gfp, zcode_offset + (long) page * PAGE_SIZE, SEEK_SET);
            if (fread (buffer, offset, 1, gfp) == 1)
                return;
        }
        fatal ("Game file read error");
    }

}/* read_page */

/*
 * verify
 *
 * Verify game ($verify verb). Add all bytes in game file except for bytes in
 * the game file header.
 *
 */

#ifdef __STDC__
void verify (void)
#else
void verify ()
#endif
{
    unsigned long file_size;
    unsigned int pages, offset;
    unsigned int start, end, i, j;
    zword_t checksum = 0;
    zbyte_t buffer[PAGE_SIZE];

    /* Print version banner */

    if (h_type < V4) {
        write_string ("ZIP Interpreter ");
        print_number (get_byte (H_INTERPRETER));
        write_string (", Version ");
        write_char (get_byte (H_INTERPRETER_VERSION));
        write_string (".");
        new_line ();
    }

    /* Calculate game file dimensions */

    file_size = (unsigned long) h_file_size * story_scaler;
    pages = (unsigned int) ((unsigned long) file_size / PAGE_SIZE);
    offset = (unsigned int) file_size & PAGE_MASK;

    /* Sum all bytes in game file, except header bytes */

    for (i = 0; i <= pages; i++) {
        read_page (i, buffer);
        start = (i == 0) ? 64 : 0;
        end = (i == pages) ? offset : PAGE_SIZE;
        for (j = start; j < end; j++)
            checksum += buffer[j];
    }

    /* Make a conditional jump based on whether the checksum is equal */

    conditional_jump (checksum == h_checksum);

}/* verify */

/*
 * save
 *
 * Save game state to disk. Returns:
 *     0 = save failed
 *     1 = save succeeded
 *
 */

#ifdef __STDC__
int save (int argc, zword_t *argv)
#else
int save (argc, argv)
int argc;
zword_t *argv;
#endif
{
    int status = 1; /* assume failure */
    int storestatus = 0;

    if (argc == 0) {

        char new_save_name[FILENAME_MAX + 1];

	/* Get the file name */
	if (get_file_name (new_save_name, save_name, GAME_SAVE) == 0) {

	    /* Do a save operation */
	    if (save_restore (new_save_name, GAME_SAVE) == 0) {

	        /* Cleanup file */
	        file_cleanup (new_save_name, GAME_SAVE);

		/* Save the new name as the default file name */
		strcpy (save_name, new_save_name);

		/* Indicate success */
		status = 0;
	    }
        }
	storestatus = ((status == 0) ? 1 : 0);
    }
    else {

        char new_savedata_name[FILENAME_MAX + 1];  
        char defname[FILENAME_MAX + 1];  
	char *defnameptr = NULL;

	if (argc >= 3) {
	    unsigned char *cx = datap + argv[2];
	    int cxlen = cx[0];
	    memcpy(defname, cx+1, cxlen);
	    defname[cxlen] = '\0';
	    defnameptr = defname;
	}

	/* Get the file name ### defname */
	if (get_file_name (new_savedata_name, savedata_name, 
			   GAME_SAVEDATA) == 0) {
	    
  	    /* Do a save operation */
	    storestatus = save_restore_data (new_savedata_name, 
		GAME_SAVEDATA, argc, argv);
	    if (storestatus != 0) {

	        /* Cleanup file */
	        file_cleanup (new_savedata_name, GAME_SAVEDATA);
	    
		/* Save the new name as the default file name */
		strcpy (savedata_name, new_savedata_name);
	    
		/* Indicate success */
		status = 0;
	    }
	}
    }

    /* Return result of save to Z-code */

    if (h_type < V4)
        conditional_jump (status == 0);
    else
        store_operand (storestatus);

    return (status);

}/* save */

/*
 * restore
 *
 * Restore game state from disk. Returns:
 *     0 = restore failed
 *     2 = restore succeeded
 *
 */

#ifdef __STDC__
int restore (int argc, zword_t *argv)
#else
int restore (argc, argv)
int argc;
zword_t *argv;
#endif
{
    int status = 1; /* assume failure */
    int storestatus = 0;

    if (argc == 0) {
        char new_save_name[FILENAME_MAX + 1];

	/* Get the file name */
	if (get_file_name (new_save_name, save_name, GAME_RESTORE) == 0) {

	    /* Do the restore operation */
	    if (save_restore (new_save_name, GAME_RESTORE) == 0) {

	        /* Cleanup file */
	        file_cleanup (new_save_name, GAME_SAVE);

		/* Save the new name as the default file name */
		strcpy (save_name, new_save_name);

		/* Indicate success */
		status = 0;

	    }
	}
	storestatus = ((status == 0) ? 2 : 0);
    }
    else {
        char new_savedata_name[FILENAME_MAX + 1];  
        char defname[FILENAME_MAX + 1];  
	char *defnameptr = NULL;

	if (argc >= 3) {
	    unsigned char *cx = datap + argv[2];
	    int cxlen = cx[0];
	    memcpy(defname, cx+1, cxlen);
	    defname[cxlen] = '\0';
	    defnameptr = defname;
	}

	/* Get the file name ### defname */
	if (get_file_name (new_savedata_name, savedata_name, 
			   GAME_RESTOREDATA) == 0) {

	    /* Do the restore operation */
	    storestatus = save_restore_data (new_savedata_name, 
	        GAME_RESTOREDATA, argc, argv);
	    if (storestatus != 0) {

  	        /* Cleanup file */
	        file_cleanup (new_savedata_name, GAME_RESTOREDATA);

		/* Save the new name as the default file name */
		strcpy (savedata_name, new_savedata_name);
		
		/* Indicate success */
		status = 0;
	    }
	}
    }

    /* Return result of save to Z-code */

    if (h_type < V4)
        conditional_jump (status == 0);
    else
        store_operand (storestatus);

    return (status);

}/* restore */

/*
 * undo_save
 *
 * Save the current Z machine state in memory for a future undo. Returns:
 *    -1 = feature unavailable
 *     0 = save failed
 *     1 = save succeeded
 *
 */

#ifdef __STDC__
void undo_save (void)
#else
void undo_save ()
#endif
{

    /* Check if undo is available first */

    if (undo_datap != NULL) {

        /* Save the undo data and return success */

        save_restore (NULL, UNDO_SAVE);

        undo_valid = TRUE;

        store_operand (1);

    } else 

        /* If no memory for data area then say undo is not available */

        store_operand ((zword_t) -1);

}/* undo_save */

/*
 * undo_restore
 *
 * Restore the current Z machine state from memory. Returns:
 *    -1 = feature unavailable
 *     0 = restore failed
 *     2 = restore succeeded
 *
 */

#ifdef __STDC__
void undo_restore (void)
#else
void undo_restore ()
#endif
{

    /* Check if undo is available first */

    if (undo_datap != NULL) {

        /* If no undo save done then return an error */

        if (undo_valid == TRUE) {

            /* Restore the undo data and return success */

            save_restore (NULL, UNDO_RESTORE);

            store_operand (2);

        } else

            store_operand (0);

    } else 

        /* If no memory for data area then say undo is not available */

        store_operand ((zword_t) -1);

}/* undo_restore */

/*
 * swap_bytes
 *
 * Swap the low and high bytes in every word of the specified array.
 * The length is specified in BYTES!
 *
 * This routine added by Mark Phillips(msp@bnr.co.uk), Thanks Mark!
 */

#ifdef __STDC__
static void swap_bytes(zword_t *ptr, int len)
#else
static void swap_bytes(ptr, len)
zword_t *ptr;
int len;
#endif
{
  unsigned char *pbyte;
  unsigned char tmp;

  len/=2; /* convert len into number of 2 byte words */

  pbyte=(unsigned char*)ptr;

  while (len)
  {
    tmp=pbyte[0];
    pbyte[0]=pbyte[1];
    pbyte[1]=tmp;
    pbyte+=2;
    len--;
  }
  return;
}

/*
 * save_restore
 *
 * Common save and restore code. Just save or restore the game stack and the
 * writeable data area.
 *
 */

#ifdef __STDC__
static int save_restore (const char *file_name, int flag)
#else
static int save_restore (file_name, flag)
const char *file_name;
int flag;
#endif
{
    FILE *tfp = NULL;
    int scripting_flag = 0, status = 0;
#ifdef BIG_END_MODE
    int little_endian=0;
#else
    int little_endian=1;
#endif

    /* Open the save file and disable scripting */

    if (flag == GAME_SAVE || flag == GAME_RESTORE) {
        if ((tfp = fopen (file_name, (flag == GAME_SAVE) ? "wb" : "rb")) == NULL) {
            output_line ("Cannot open SAVE file");
            return (1);
        }
        scripting_flag = get_word (H_FLAGS) & SCRIPTING_FLAG;
        set_word (H_FLAGS, get_word (H_FLAGS) & (~SCRIPTING_FLAG));
    }

#if defined(USE_QUETZAL)
    if (flag == GAME_SAVE)
        status = !save_quetzal (tfp, gfp, zcode_offset);
    else if (flag == GAME_RESTORE)
        status = !restore_quetzal (tfp, gfp, zcode_offset);
    else {
#endif  /* defined(USE_QUETZAL) */

    /* Push PC, FP, version and store SP in special location */

    stack[--sp] = (zword_t) (pc / PAGE_SIZE);
    stack[--sp] = (zword_t) (pc % PAGE_SIZE);
    stack[--sp] = fp;
    stack[--sp] = h_version;
    stack[0] = sp;

    /* Save or restore stack */

#if !defined(USE_QUETZAL)
    if (flag == GAME_SAVE) {
	if (little_endian) swap_bytes(stack, sizeof(stack));  
        if (status == 0 && fwrite (stack, sizeof (stack), 1, tfp) != 1)
            status = 1;
	if (little_endian) swap_bytes(stack, sizeof(stack));  
    } else if (flag == GAME_RESTORE) {
	if (little_endian) swap_bytes(stack, sizeof(stack));  
        if (status == 0 && fread (stack, sizeof (stack), 1, tfp) != 1)
            status = 1;
	if (little_endian) swap_bytes(stack, sizeof(stack));  
    } else 
#endif/* !defined(USE_QUETZAL) */
    if (flag == UNDO_SAVE) {
        memmove (undo_stack, stack, sizeof (stack));
    } else /* if (flag == UNDO_RESTORE) */
        memmove (stack, undo_stack, sizeof (stack));

    /* Restore SP, check version, restore FP and PC */

    sp = stack[0];
    if (stack[sp++] != h_version)
        fatal ("Wrong game or version");
    fp = stack[sp++];
    pc = stack[sp++];
    pc += (unsigned long) stack[sp++] * PAGE_SIZE;

    /* Save or restore writeable game data area */

#if !defined(USE_QUETZAL)
    if (flag == GAME_SAVE) {
        if (status == 0 && fwrite (datap, h_restart_size, 1, tfp) != 1)
            status = 1;
    } else if (flag == GAME_RESTORE) {
        if (status == 0 && fread (datap, h_restart_size, 1, tfp) != 1)
            status = 1;
    } else 
#endif  /* !defined(USE_QUETZAL) */
    if (flag == UNDO_SAVE) {
        memmove (undo_datap, datap, h_restart_size);
    } else /* if (flag == UNDO_RESTORE) */
        memmove (datap, undo_datap, h_restart_size);

#if defined(USE_QUETZAL)
    }
#endif  /* defined(USE_QUETZAL) */

    /* Close the save file and restore scripting */

    if (flag == GAME_SAVE) {
        fclose (tfp);
        if (scripting_flag)
            set_word (H_FLAGS, get_word (H_FLAGS) | SCRIPTING_FLAG);
    }
    else if (flag == GAME_RESTORE) {
        fclose (tfp);
        restart_screen();
        restart_interp(scripting_flag);
    }

    /* Handle read or write errors */

    if (status) {
        if (flag == GAME_SAVE) {
            output_line ("Write to SAVE file failed");
            remove (file_name);
        } else {
            output_line ("Read from SAVE file failed");
        }
    }

    return (status);

}/* save_restore */

/*
 * open_script
 *
 * Open the scripting file.
 *
 */

#ifdef __STDC__
void open_script (void)
#else
void open_script ()
#endif
{
    char new_script_name[FILENAME_MAX + 1];

    /* Open scripting file if closed */

    if (scripting == OFF) {

        if (script_file_valid == TRUE) {

            sfp = fopen (script_name, "a");

            /* Turn on scripting if open succeeded */

            if (sfp != NULL)
                scripting = ON;
            else
                output_line ("Script file open failed");

        } else {

            /* Get scripting file name and record it */

            if (get_file_name (new_script_name, script_name, GAME_SCRIPT) == 0) {

                /* Open scripting file */

                sfp = fopen (new_script_name, "w");

                /* Turn on scripting if open succeeded */

                if (sfp != NULL) {

                    script_file_valid = TRUE;

                    /* Make file name the default name */

                    strcpy (script_name, new_script_name);

                    /* Turn on scripting */

                    scripting = ON;
            
                } else

                    output_line ("Script file create failed");

            }

        }

    }

    /* Set the scripting flag in the game file flags */

    if (datap) {
        if (scripting == ON)
            set_word (H_FLAGS, get_word (H_FLAGS) | SCRIPTING_FLAG);
	else
            set_word (H_FLAGS, get_word (H_FLAGS) & (~SCRIPTING_FLAG));
    }

}/* open_script */

/*
 * close_script
 *
 * Close the scripting file.
 *
 */

#ifdef __STDC__
void close_script (void)
#else
void close_script ()
#endif
{

    /* Close scripting file if open */

    if (scripting == ON) {

        fclose (sfp);
#if 0
        /* Cleanup */

        file_cleanup (script_name, GAME_SCRIPT);
#endif
        /* Turn off scripting */

        scripting = OFF;

    }

    /* Set the scripting flag in the game file flags */

    if (datap) {
        if (scripting == OFF)
            set_word (H_FLAGS, get_word (H_FLAGS) & (~SCRIPTING_FLAG));
        else
            set_word (H_FLAGS, get_word (H_FLAGS) | SCRIPTING_FLAG);
    }

}/* close_script */

/*
 * script_char
 *
 * Write one character to scripting file.
 *
 * Check the state of the scripting flag first. Older games only set the
 * scripting flag in the game flags instead of calling the set_print_modes
 * function. This is because they expect a physically attached printer that
 * doesn't need opening like a file.
 */

#ifdef __STDC__
void script_char (int c)
#else
void script_char (c)
int c;
#endif
{

    /* Check the state of the scripting flag in the game flags. If it is on
       then check to see if the scripting file is open as well */

    if ((get_word (H_FLAGS) & SCRIPTING_FLAG) != 0 && scripting == OFF)
        open_script ();

    /* Check the state of the scripting flag in the game flags. If it is off
       then check to see if the scripting file is closed as well */

    if ((get_word (H_FLAGS) & SCRIPTING_FLAG) == 0 && scripting == ON)
        close_script ();

    /* If scripting file is open, we are in the text window and the character is
       printable then write the character */

    if (scripting == ON && scripting_disable == OFF && (c == '\n' || (isprint (c))))
        putc (c, sfp);

}/* script_char */

/*
 * script_string
 *
 * Write a string to the scripting file.
 *
 */

#ifdef __STDC__
void script_string (const char *s)
#else
void script_string (s)
const char *s;
#endif
{

    /* Write string */

    while (*s)
        script_char (*s++);

}/* script_string */

/*
 * script_line
 *
 * Write a string followed by a new line to the scripting file.
 *
 */

#ifdef __STDC__
void script_line (const char *s, int len)
#else
void script_line (s, len)
const char *s;
int len;
#endif
{
    int ix;

    /* Write string */

    for (ix=0; ix<len; ix++)
        script_char(s[ix]);

    /* Write new line */

    script_new_line ();

}/* script_line */

/*
 * script_new_line
 *
 * Write a new line to the scripting file.
 *
 */

#ifdef __STDC__
void script_new_line (void)
#else
void script_new_line ()
#endif
{

    script_char ('\n');

}/* script_new_line */

/*
 * open_record
 *
 * Turn on recording of all input to an output file.
 *
 */

#ifdef __STDC__
void open_record (void)
#else
void open_record ()
#endif
{
    char new_record_name[FILENAME_MAX + 1];

    /* If recording or playback is already on then complain */

    if (recording == ON || replaying == ON) {

        output_line ("Recording or playback are already active.");

    } else {

        /* Get recording file name */

        if (get_file_name (new_record_name, record_name, GAME_RECORD) == 0) {

            /* Open recording file */

            rfp = fopen (new_record_name, "w");

            /* Turn on recording if open succeeded */

            if (rfp != NULL) {

                /* Make file name the default name */

                strcpy (record_name, new_record_name);

                /* Set recording on */

                recording = ON;

            } else

                output_line ("Record file create failed");

        }

    }

}/* open_record */

/*
 * record_line
 *
 * Write a string followed by a new line to the recording file.
 *
 */

#ifdef __STDC__
void record_line (const char *s, int len)
#else
void record_line (s, len)
const char *s;
int len;
#endif
{
    int ix;

    if (recording == ON && replaying == OFF) {

        /* Write string */
        for (ix=0; ix<len; ix++)
	    putc(s[ix], rfp);

	putc('\n', rfp);

    }

}/* record_line */

/*
 * record_key
 *
 * Write a key followed by a new line to the recording file.
 *
 */

#ifdef __STDC__
void record_key (int c)
#else
void record_key (c)
int c;
#endif
{

    if (recording == ON && replaying == OFF) {

        /* Write the key */

        fprintf (rfp, "<%0o>\n", c);

    }

}/* record_key */

/*
 * close_record
 *
 * Turn off recording of all input to an output file.
 *
 */

#ifdef __STDC__
void close_record (void)
#else
void close_record ()
#endif
{

    /* Close recording file */

    if (rfp != NULL) {
        fclose (rfp);
        rfp = NULL;

        /* Cleanup */

        if (recording == ON)
            file_cleanup (record_name, GAME_RECORD);
        else /* (replaying == ON) */
            file_cleanup (record_name, GAME_PLAYBACK);
    }

    /* Set recording and replaying off */

    recording = OFF;
    replaying = OFF;

}/* close_record */

/*
 * open_playback
 *
 * Take input from command file instead of keyboard.
 *
 */

#ifdef __STDC__
void open_playback (int arg)
#else
void open_playback (arg)
int arg;
#endif
{
    char new_record_name[FILENAME_MAX + 1];

    /* If recording or replaying is already on then complain */

    if (recording == ON || replaying == ON) {

        output_line ("Recording or replaying is already active.");

    } else {

        /* Get recording file name */

        if (get_file_name (new_record_name, record_name, GAME_PLAYBACK) == 0) {

            /* Open recording file */

            rfp = fopen (new_record_name, "r");

            /* Turn on recording if open succeeded */

            if (rfp != NULL) {

                /* Make file name the default name */

                strcpy (record_name, new_record_name);

                /* Set replaying on */

                replaying = ON;

            } else

                output_line ("Record file open failed");

        }

    }

}/* open_playback */

/*
 * playback_line
 *
 * Get a line of input from the command file.
 *
 */

#ifdef __STDC__
int playback_line (int buflen, char *buffer, int *read_size)
#else
int playback_line (buflen, buffer, read_size)
int buflen;
char *buffer;
int *read_size;
#endif
{
    char *cp;

    if (recording == ON || replaying == OFF)
        return (-1);

    if (fgets (buffer, buflen, rfp) == NULL) {
        close_record ();
        return (-1);
    } else {
        cp = strrchr (buffer, '\n');
        if (cp != NULL)
            *cp = '\0';
        *read_size = strlen (buffer);
        output_line (buffer);
    }

    return ('\n');

}/* playback_line */

/*
 * playback_key
 *
 * Get a key from the command file.
 *
 */

#ifdef __STDC__
int playback_key (void)
#else
int playback_key ()
#endif
{
    int c;

    if (recording == ON || replaying == OFF)
        return (-1);

    if (fscanf (rfp, "<%o>\n", &c) == EOF) {
        close_record ();
        c = -1;
    }

    return (c);

}/* playback_key */

/*
 * save_restore_data. This returns the actual z-machine status: number of bytes
 * loaded for a restore; 0 for failure / 1 for success, for a save.
 *
 */

#ifdef __STDC__
static int save_restore_data (const char *file_name, int flag, int argc, zword_t *argv)
#else
static int save_restore_data (file_name, flag, argc, argv)
const char *file_name;
int flag;
int argc;
zword_t *argv;
#endif
{
    FILE *tfp;
    long dat_begin, dat_len;
    int status, val;
    long lx;
    char *cx;

    if (argc < 2)
        return (1);

    dat_begin = argv[0];
    dat_len = argv[1];

    /* Open the save file */

    if (flag == GAME_SAVEDATA)
        tfp = fopen (file_name, "wb");
    else
        tfp = fopen (file_name, "rb");

    if (tfp == NULL) {
        output_line ("Cannot open DATA file");
        return (1);
    }

    /* Save or restore writeable game data area */
    if (flag == GAME_SAVEDATA) {
        lx = fwrite (datap+dat_begin, 1, dat_len, tfp);
	if (lx != dat_len) {
            output_line ("Write to DATA file failed");
            status = 0;
	}
	else {
	    status = 1;
	}
    }
    else if (flag == GAME_RESTOREDATA) {
        lx = fread (datap+dat_begin, 1, dat_len, tfp);
	status = lx; /* number of bytes read */
    }

    /* Close the save file */

    fclose (tfp);

    return (status);

} /* save_restore_data */