files.c

   1 /* ------------------------------------------------------------------------- */
   2 /*   "files" : File handling for source code, the transcript file and the    */
   3 /*             debugging information file; file handling and splicing of     */
   4 /*             the output file.                                              */
   5 /*                                                                           */
   6 /*             Note that filenaming conventions are left to the top-level    */
   7 /*             routines in "inform.c", since they are tied up with ICL       */
   8 /*             settings and are very host OS-dependent.                      */
   9 /*                                                                           */
  10 /*  Copyright (c) Graham Nelson 1993 - 2016                                  */
  11 /*                                                                           */
  12 /* This file is part of Inform.                                              */
  13 /*                                                                           */
  14 /* Inform is free software: you can redistribute it and/or modify            */
  15 /* it under the terms of the GNU General Public License as published by      */
  16 /* the Free Software Foundation, either version 3 of the License, or         */
  17 /* (at your option) any later version.                                       */
  18 /*                                                                           */
  19 /* Inform is distributed in the hope that it will be useful,                 */
  20 /* but WITHOUT ANY WARRANTY; without even the implied warranty of            */
  21 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the              */
  22 /* GNU General Public License for more details.                              */
  23 /*                                                                           */
  24 /* You should have received a copy of the GNU General Public License         */
  25 /* along with Inform. If not, see https://gnu.org/licenses/                  */
  26 /*                                                                           */
  27 /* ------------------------------------------------------------------------- */
  28
  29 #include "header.h"
  30
  31 int total_files;                        /* Number of files so far, including
  32                                            #include and #origsource files    */
  33 int total_input_files;                  /* Number of source files so far
  34                                            (excludes #origsource)            */
  35 int current_input_file;                 /* Most recently-opened source file  */
  36 static int current_origsource_file;     /* Most recently-used #origsource    */
  37
  38 int32 total_chars_read;                 /* Characters read in (from all
  39                                            source files put together)        */
  40
  41 static int checksum_low_byte,           /* For calculating the Z-machine's   */
  42            checksum_high_byte;          /* "verify" checksum                 */
  43
  44 static int32 checksum_long;             /* For the Glulx checksum,           */
  45 static int checksum_count;              /* similarly                         */
  46
  47 /* ------------------------------------------------------------------------- */
  48 /*   Most of the information about source files is kept by "lexer.c"; this   */
  49 /*   level is only concerned with file names and handles.                    */
  50 /* ------------------------------------------------------------------------- */
  51
  52 FileId *InputFiles=NULL;                /*  Ids for all the source files     */
  53 static char *filename_storage,          /*  Translated filenames             */
  54             *filename_storage_p;
  55 static int filename_storage_left;
  56
  57 /* ------------------------------------------------------------------------- */
  58 /*   When emitting debug information, we won't have addresses of routines,   */
  59 /*   sequence points, Glulx objects (addresses of Z-machine objects aren't   */
  60 /*   needed), globals, arrays, or grammar lines.  We only have their         */
  61 /*   offsets from base addresses, which won't be known until the end of      */
  62 /*   compilation.  Since everything else in the relevant debug records is    */
  63 /*   known much earlier and is less convenient to store up, we emit the      */
  64 /*   debug records with a placeholder value and then backpatch these         */
  65 /*   placeholders.  The following structs each store either an offset or a   */
  66 /*   symbol index and the point in the debug information file where the      */
  67 /*   corresponding address should be written once the base address is known. */
  68 /* ------------------------------------------------------------------------- */
  69
  70 #define INITIAL_DEBUG_INFORMATION_BACKPATCH_ALLOCATION 65536
  71
  72 typedef struct value_and_backpatch_position_struct
  73 {   int32 value;
  74     fpos_t backpatch_position;
  75 } value_and_backpatch_position;
  76
  77 typedef struct debug_backpatch_accumulator_struct
  78 {   int32 number_of_values_to_backpatch;
  79     int32 number_of_available_backpatches;
  80     value_and_backpatch_position *values_and_backpatch_positions;
  81     int32 (* backpatching_function)(int32);
  82 } debug_backpatch_accumulator;
  83
  84 static debug_backpatch_accumulator object_backpatch_accumulator;
  85 static debug_backpatch_accumulator packed_code_backpatch_accumulator;
  86 static debug_backpatch_accumulator code_backpatch_accumulator;
  87 static debug_backpatch_accumulator global_backpatch_accumulator;
  88 static debug_backpatch_accumulator array_backpatch_accumulator;
  89 static debug_backpatch_accumulator grammar_backpatch_accumulator;
  90
  91 /* ------------------------------------------------------------------------- */
  92 /*   File handles and names for temporary files.                             */
  93 /* ------------------------------------------------------------------------- */
  94
  95 FILE *Temp1_fp=NULL, *Temp2_fp=NULL,  *Temp3_fp=NULL;
  96 char Temp1_Name[PATHLEN], Temp2_Name[PATHLEN], Temp3_Name[PATHLEN];
  97
  98 /* ------------------------------------------------------------------------- */
  99 /*   Opening and closing source code files                                   */
 100 /* ------------------------------------------------------------------------- */
 101
 102 #if defined(PC_WIN32) && defined(HAS_REALPATH)
 103 #include <windows.h>
 104 char *realpath(const char *path, char *resolved_path)
 105 {
 106   return GetFullPathNameA(path,PATHLEN,resolved_path,NULL) != 0 ? resolved_path : 0;
 107 }
 108 #endif
 109
 110 extern void load_sourcefile(char *filename_given, int same_directory_flag)
 111 {
 112     /*  Meaning: open a new file of Inform source.  (The lexer picks up on
 113         this by noticing that input_file has increased.)                     */
 114
 115     char name[PATHLEN];
 116 #ifdef HAS_REALPATH
 117     char absolute_name[PATHLEN];
 118 #endif
 119     int x = 0;
 120     FILE *handle;
 121
 122     if (total_files == MAX_SOURCE_FILES)
 123         memoryerror("MAX_SOURCE_FILES", MAX_SOURCE_FILES);
 124
 125     do
 126     {   x = translate_in_filename(x, name, filename_given, same_directory_flag,
 127                 (total_files==0)?1:0);
 128         handle = fopen(name,"r");
 129     } while ((handle == NULL) && (x != 0));
 130
 131     if (filename_storage_left <= (int)strlen(name))
 132         memoryerror("MAX_SOURCE_FILES", MAX_SOURCE_FILES);
 133
 134     filename_storage_left -= strlen(name)+1;
 135     strcpy(filename_storage_p, name);
 136     InputFiles[total_files].filename = filename_storage_p;
 137
 138     filename_storage_p += strlen(name)+1;
 139
 140     if (debugfile_switch)
 141     {   debug_file_printf("<source index=\"%d\">", total_files);
 142         debug_file_printf("<given-path>");
 143         debug_file_print_with_entities(filename_given);
 144         debug_file_printf("</given-path>");
 145 #ifdef HAS_REALPATH
 146         if (realpath(name, absolute_name))
 147         {   debug_file_printf("<resolved-path>");
 148             debug_file_print_with_entities(absolute_name);
 149             debug_file_printf("</resolved-path>");
 150         }
 151 #endif
 152         debug_file_printf("<language>Inform 6</language>");
 153         debug_file_printf("</source>");
 154     }
 155
 156     InputFiles[total_files].handle = handle;
 157     if (InputFiles[total_files].handle==NULL)
 158         fatalerror_named("Couldn't open source file", name);
 159
 160     InputFiles[total_files].is_input = TRUE;
 161
 162     if (line_trace_level > 0) printf("\nOpening file \"%s\"\n",name);
 163
 164     total_files++;
 165     total_input_files++;
 166     current_input_file = total_files;
 167 }
 168
 169 static void close_sourcefile(int file_number)
 170 {
 171     if (InputFiles[file_number-1].handle == NULL) return;
 172
 173     /*  Close this file.  */
 174
 175     if (ferror(InputFiles[file_number-1].handle))
 176         fatalerror_named("I/O failure: couldn't read from source file",
 177             InputFiles[file_number-1].filename);
 178
 179     fclose(InputFiles[file_number-1].handle);
 180
 181     InputFiles[file_number-1].handle = NULL;
 182
 183     if (line_trace_level > 0) printf("\nClosing file\n");
 184 }
 185
 186 extern void close_all_source(void)
 187 {   int i;
 188     for (i=0; i<total_files; i++) close_sourcefile(i+1);
 189 }
 190
 191 /* ------------------------------------------------------------------------- */
 192 /*   Register an #origsource filename. This goes in the InputFiles table,    */
 193 /*   but we do not open the file or advance current_input_file.              */
 194 /* ------------------------------------------------------------------------- */
 195
 196 extern int register_orig_sourcefile(char *filename)
 197 {
 198     int ix;
 199
 200     /* If the filename has already been used as an origsource filename,
 201        return that entry. We check the most-recently-used file first, and
 202        then search the list. */
 203     if (current_origsource_file > 0 && current_origsource_file <= total_files) {
 204         if (!strcmp(filename, InputFiles[current_origsource_file-1].filename))
 205             return current_origsource_file;
 206     }
 207
 208     for (ix=0; ix<total_files; ix++) {
 209         if (InputFiles[ix].is_input)
 210             continue;
 211         if (!strcmp(filename, InputFiles[ix].filename)) {
 212             current_origsource_file = ix+1;
 213             return current_origsource_file;
 214         }
 215     }
 216
 217     /* This filename has never been used before. Allocate a new InputFiles
 218        entry. */
 219
 220     char *name = filename; /* no translation */
 221
 222     if (total_files == MAX_SOURCE_FILES)
 223         memoryerror("MAX_SOURCE_FILES", MAX_SOURCE_FILES);
 224
 225     if (filename_storage_left <= (int)strlen(name))
 226         memoryerror("MAX_SOURCE_FILES", MAX_SOURCE_FILES);
 227
 228     filename_storage_left -= strlen(name)+1;
 229     strcpy(filename_storage_p, name);
 230     InputFiles[total_files].filename = filename_storage_p;
 231
 232     filename_storage_p += strlen(name)+1;
 233
 234     if (debugfile_switch)
 235     {   debug_file_printf("<source index=\"%d\">", total_files);
 236         debug_file_printf("<given-path>");
 237         debug_file_print_with_entities(filename);
 238         debug_file_printf("</given-path>");
 239         debug_file_printf("<language>Inform 7</language>");
 240         debug_file_printf("</source>");
 241     }
 242
 243     InputFiles[total_files].handle = NULL;
 244     InputFiles[total_files].is_input = FALSE;
 245
 246     total_files++;
 247     current_origsource_file = total_files;
 248     return current_origsource_file;
 249 }
 250
 251 /* ------------------------------------------------------------------------- */
 252 /*   Feeding source code up into the lexical analyser's buffer               */
 253 /*   (see "lexer.c" for its specification)                                   */
 254 /* ------------------------------------------------------------------------- */
 255
 256 extern int file_load_chars(int file_number, char *buffer, int length)
 257 {
 258     int read_in; FILE *handle;
 259
 260     if (file_number-1 > total_files)
 261     {   buffer[0] = 0; return 1; }
 262
 263     handle = InputFiles[file_number-1].handle;
 264     if (handle == NULL)
 265     {   buffer[0] = 0; return 1; }
 266
 267     read_in = fread(buffer, 1, length, handle);
 268     total_chars_read += read_in;
 269
 270     if (read_in == length) return length;
 271
 272     close_sourcefile(file_number);
 273
 274     if (file_number == 1)
 275     {   buffer[read_in]   = 0;
 276         buffer[read_in+1] = 0;
 277         buffer[read_in+2] = 0;
 278         buffer[read_in+3] = 0;
 279     }
 280     else
 281     {   buffer[read_in]   = '\n';
 282         buffer[read_in+1] = ' ';
 283         buffer[read_in+2] = ' ';
 284         buffer[read_in+3] = ' ';
 285     }
 286
 287     return(-(read_in+4));
 288 }
 289
 290 /* ------------------------------------------------------------------------- */
 291 /*   Final assembly and output of the story file/module.                     */
 292 /* ------------------------------------------------------------------------- */
 293
 294 FILE *sf_handle;
 295
 296 static void sf_put(int c)
 297 {
 298     if (!glulx_mode) {
 299
 300       /*  The checksum is the unsigned sum mod 65536 of the bytes in the
 301           story file from 0x0040 (first byte after header) to the end.
 302
 303           The link data does not contribute to the checksum of a module.     */
 304
 305       checksum_low_byte += c;
 306       if (checksum_low_byte>=256)
 307       {   checksum_low_byte-=256;
 308           if (++checksum_high_byte==256) checksum_high_byte=0;
 309       }
 310
 311     }
 312     else {
 313
 314       /*  The checksum is the unsigned 32-bit sum of the entire story file,
 315           considered as a list of 32-bit words, with the checksum field
 316           being zero. */
 317
 318       switch (checksum_count) {
 319       case 0:
 320         checksum_long += (((int32)(c & 0xFF)) << 24);
 321         break;
 322       case 1:
 323         checksum_long += (((int32)(c & 0xFF)) << 16);
 324         break;
 325       case 2:
 326         checksum_long += (((int32)(c & 0xFF)) << 8);
 327         break;
 328       case 3:
 329         checksum_long += ((int32)(c & 0xFF));
 330         break;
 331       }
 332
 333       checksum_count = (checksum_count+1) & 3;
 334
 335     }
 336
 337     fputc(c, sf_handle);
 338 }
 339
 340 /* Recursive procedure to generate the Glulx compression table. */
 341
 342 static void output_compression(int entnum, int32 *size, int *count)
 343 {
 344   huffentity_t *ent = &(huff_entities[entnum]);
 345   int32 val;
 346   char *cx;
 347
 348   sf_put(ent->type);
 349   (*size)++;
 350   (*count)++;
 351
 352   switch (ent->type) {
 353   case 0:
 354     val = Write_Strings_At + huff_entities[ent->u.branch[0]].addr;
 355     sf_put((val >> 24) & 0xFF);
 356     sf_put((val >> 16) & 0xFF);
 357     sf_put((val >> 8) & 0xFF);
 358     sf_put((val) & 0xFF);
 359     (*size) += 4;
 360     val = Write_Strings_At + huff_entities[ent->u.branch[1]].addr;
 361     sf_put((val >> 24) & 0xFF);
 362     sf_put((val >> 16) & 0xFF);
 363     sf_put((val >> 8) & 0xFF);
 364     sf_put((val) & 0xFF);
 365     (*size) += 4;
 366     output_compression(ent->u.branch[0], size, count);
 367     output_compression(ent->u.branch[1], size, count);
 368     break;
 369   case 1:
 370     /* no data */
 371     break;
 372   case 2:
 373     sf_put(ent->u.ch);
 374     (*size) += 1;
 375     break;
 376   case 3:
 377     cx = (char *)abbreviations_at + ent->u.val*MAX_ABBREV_LENGTH;
 378     while (*cx) {
 379       sf_put(*cx);
 380       cx++;
 381       (*size) += 1;
 382     }
 383     sf_put('\0');
 384     (*size) += 1;
 385     break;
 386   case 4:
 387     val = unicode_usage_entries[ent->u.val].ch;
 388     sf_put((val >> 24) & 0xFF);
 389     sf_put((val >> 16) & 0xFF);
 390     sf_put((val >> 8) & 0xFF);
 391     sf_put((val) & 0xFF);
 392     (*size) += 4;
 393     break;
 394   case 9:
 395     val = abbreviations_offset + 4 + ent->u.val*4;
 396     sf_put((val >> 24) & 0xFF);
 397     sf_put((val >> 16) & 0xFF);
 398     sf_put((val >> 8) & 0xFF);
 399     sf_put((val) & 0xFF);
 400     (*size) += 4;
 401     break;
 402   }
 403 }
 404
 405 static void output_file_z(void)
 406 {   FILE *fin=NULL; char new_name[PATHLEN];
 407     int32 length, blanks=0, size, i, j, offset;
 408     uint32 code_length, size_before_code, next_cons_check;
 409     int use_function;
 410
 411     ASSERT_ZCODE();
 412
 413     /* At this point, construct_storyfile() has just been called. */
 414
 415     /*  Enter the length information into the header.                        */
 416
 417     length=((int32) Write_Strings_At) + static_strings_extent;
 418     if (module_switch) length += link_data_size +
 419                                  zcode_backpatch_size +
 420                                  zmachine_backpatch_size;
 421
 422     while ((length%length_scale_factor)!=0) { length++; blanks++; }
 423     length=length/length_scale_factor;
 424     zmachine_paged_memory[26]=(length & 0xff00)/0x100;
 425     zmachine_paged_memory[27]=(length & 0xff);
 426
 427     /*  To assist interpreters running a paged virtual memory system, Inform
 428         writes files which are padded with zeros to the next multiple of
 429         0.5K.  This calculates the number of bytes of padding needed:        */
 430
 431     while (((length_scale_factor*length)+blanks-1)%512 != 511) blanks++;
 432
 433     translate_out_filename(new_name, Code_Name);
 434
 435     sf_handle = fopen(new_name,"wb");
 436     if (sf_handle == NULL)
 437         fatalerror_named("Couldn't open output file", new_name);
 438
 439 #ifdef MAC_MPW
 440     /*  Set the type and creator to Andrew Plotkin's MaxZip, a popular
 441         Z-code interpreter on the Macintosh  */
 442
 443     if (!module_switch) fsetfileinfo(new_name, 'mxZR', 'ZCOD');
 444 #endif
 445
 446     /*  (1)  Output the paged memory.                                        */
 447
 448     for (i=0;i<64;i++)
 449         fputc(zmachine_paged_memory[i], sf_handle);
 450     size = 64;
 451     checksum_low_byte = 0;
 452     checksum_high_byte = 0;
 453
 454     for (i=64; i<Write_Code_At; i++)
 455     {   sf_put(zmachine_paged_memory[i]); size++;
 456     }
 457
 458     /*  (2)  Output the compiled code area.                                  */
 459
 460     if (temporary_files_switch)
 461     {   fclose(Temp2_fp);
 462         Temp2_fp = NULL;
 463         fin=fopen(Temp2_Name,"rb");
 464         if (fin==NULL)
 465             fatalerror("I/O failure: couldn't reopen temporary file 2");
 466     }
 467
 468     if (!OMIT_UNUSED_ROUTINES) {
 469         /* This is the old-fashioned case, which is easy. All of zcode_area
 470            (zmachine_pc bytes) will be output. next_cons_check will be
 471            ignored, because j will never reach it. */
 472         code_length = zmachine_pc;
 473         use_function = TRUE;
 474         next_cons_check = code_length+1;
 475     }
 476     else {
 477         /* With dead function stripping, life is more complicated.
 478            j will run from 0 to zmachine_pc, but only code_length of
 479            those should be output. next_cons_check is the location of
 480            the next function break; that's where we check whether
 481            we're in a live function or a dead one.
 482            (This logic is simplified by the assumption that a backpatch
 483            marker will never straddle a function break.) */
 484         if (zmachine_pc != df_total_size_before_stripping)
 485             compiler_error("Code size does not match (zmachine_pc and df_total_size).");
 486         code_length = df_total_size_after_stripping;
 487         use_function = TRUE;
 488         next_cons_check = 0;
 489         df_prepare_function_iterate();
 490     }
 491     size_before_code = size;
 492
 493     j=0;
 494     if (!module_switch)
 495     for (i=0; i<zcode_backpatch_size; i=i+3)
 496     {   int long_flag = TRUE;
 497         offset
 498             = 256*read_byte_from_memory_block(&zcode_backpatch_table, i+1)
 499               + read_byte_from_memory_block(&zcode_backpatch_table, i+2);
 500         backpatch_error_flag = FALSE;
 501         backpatch_marker
 502             = read_byte_from_memory_block(&zcode_backpatch_table, i);
 503         if (backpatch_marker >= 0x80) long_flag = FALSE;
 504         backpatch_marker &= 0x7f;
 505         offset = offset + (backpatch_marker/32)*0x10000;
 506         while (offset+0x30000 < j) {
 507             offset += 0x40000;
 508             long_flag = !long_flag;
 509         }
 510         backpatch_marker &= 0x1f;
 511
 512         /* All code up until the next backpatch marker gets flushed out
 513            as-is. (Unless we're in a stripped-out function.) */
 514         while (j<offset) {
 515             if (!use_function) {
 516                 while (j<offset && j<next_cons_check) {
 517                     /* get dummy value */
 518                     ((temporary_files_switch)?fgetc(fin):
 519                         read_byte_from_memory_block(&zcode_area, j));
 520                     j++;
 521                 }
 522             }
 523             else {
 524                 while (j<offset && j<next_cons_check) {
 525                     size++;
 526                     sf_put((temporary_files_switch)?fgetc(fin):
 527                         read_byte_from_memory_block(&zcode_area, j));
 528                     j++;
 529                 }
 530             }
 531             if (j == next_cons_check)
 532                 next_cons_check = df_next_function_iterate(&use_function);
 533         }
 534
 535         if (long_flag)
 536         {   int32 v = (temporary_files_switch)?fgetc(fin):
 537                 read_byte_from_memory_block(&zcode_area, j);
 538             v = 256*v + ((temporary_files_switch)?fgetc(fin):
 539                 read_byte_from_memory_block(&zcode_area, j+1));
 540             j += 2;
 541             if (use_function) {
 542                 v = backpatch_value(v);
 543                 sf_put(v/256); sf_put(v%256);
 544                 size += 2;
 545             }
 546         }
 547         else
 548         {   int32 v = (temporary_files_switch)?fgetc(fin):
 549                 read_byte_from_memory_block(&zcode_area, j);
 550             j++;
 551             if (use_function) {
 552                 v = backpatch_value(v);
 553                 sf_put(v);
 554                 size++;
 555             }
 556         }
 557
 558         if (j > next_cons_check)
 559             compiler_error("Backpatch appears to straddle function break");
 560
 561         if (backpatch_error_flag)
 562         {   printf("*** %s  zcode offset=%08lx  backpatch offset=%08lx ***\n",
 563                 (long_flag)?"long":"short", (long int) j, (long int) i);
 564         }
 565     }
 566
 567     /* Flush out the last bit of zcode_area, after the last backpatch
 568        marker. */
 569     offset = zmachine_pc;
 570     while (j<offset) {
 571         if (!use_function) {
 572             while (j<offset && j<next_cons_check) {
 573                 /* get dummy value */
 574                 ((temporary_files_switch)?fgetc(fin):
 575                     read_byte_from_memory_block(&zcode_area, j));
 576                 j++;
 577             }
 578         }
 579         else {
 580             while (j<offset && j<next_cons_check) {
 581                 size++;
 582                 sf_put((temporary_files_switch)?fgetc(fin):
 583                     read_byte_from_memory_block(&zcode_area, j));
 584                 j++;
 585             }
 586         }
 587         if (j == next_cons_check)
 588             next_cons_check = df_next_function_iterate(&use_function);
 589     }
 590
 591     if (temporary_files_switch)
 592     {   if (ferror(fin))
 593             fatalerror("I/O failure: couldn't read from temporary file 2");
 594         fclose(fin);
 595         fin = NULL;
 596     }
 597
 598     if (size_before_code + code_length != size)
 599         compiler_error("Code output length did not match");
 600
 601     /*  (3)  Output any null bytes (required to reach a packed address)
 602              before the strings area.                                        */
 603
 604     while (size<Write_Strings_At) { sf_put(0); size++; }
 605
 606     /*  (4)  Output the static strings area.                                 */
 607
 608     if (temporary_files_switch)
 609     {   fclose(Temp1_fp);
 610         Temp1_fp = NULL;
 611         fin=fopen(Temp1_Name,"rb");
 612         if (fin==NULL)
 613             fatalerror("I/O failure: couldn't reopen temporary file 1");
 614         for (i=0; i<static_strings_extent; i++) sf_put(fgetc(fin));
 615         if (ferror(fin))
 616             fatalerror("I/O failure: couldn't read from temporary file 1");
 617         fclose(fin);
 618         fin = NULL;
 619         remove(Temp1_Name); remove(Temp2_Name);
 620     }
 621     else
 622       for (i=0; i<static_strings_extent; i++) {
 623         sf_put(read_byte_from_memory_block(&static_strings_area,i));
 624         size++;
 625       }
 626
 627     /*  (5)  Output the linking data table (in the case of a module).        */
 628
 629     if (temporary_files_switch)
 630     {   if (module_switch)
 631         {   fclose(Temp3_fp);
 632             Temp3_fp = NULL;
 633             fin=fopen(Temp3_Name,"rb");
 634             if (fin==NULL)
 635                 fatalerror("I/O failure: couldn't reopen temporary file 3");
 636             for (j=0; j<link_data_size; j++) sf_put(fgetc(fin));
 637             if (ferror(fin))
 638                 fatalerror("I/O failure: couldn't read from temporary file 3");
 639             fclose(fin);
 640             fin = NULL;
 641             remove(Temp3_Name);
 642         }
 643     }
 644     else
 645         if (module_switch)
 646             for (i=0; i<link_data_size; i++)
 647                 sf_put(read_byte_from_memory_block(&link_data_area,i));
 648
 649     if (module_switch)
 650     {   for (i=0; i<zcode_backpatch_size; i++)
 651             sf_put(read_byte_from_memory_block(&zcode_backpatch_table, i));
 652         for (i=0; i<zmachine_backpatch_size; i++)
 653             sf_put(read_byte_from_memory_block(&zmachine_backpatch_table, i));
 654     }
 655
 656     /*  (6)  Output null bytes to reach a multiple of 0.5K.                  */
 657
 658     while (blanks>0) { sf_put(0); blanks--; }
 659
 660     if (ferror(sf_handle))
 661         fatalerror("I/O failure: couldn't write to story file");
 662
 663     fseek(sf_handle, 28, SEEK_SET);
 664     fputc(checksum_high_byte, sf_handle);
 665     fputc(checksum_low_byte, sf_handle);
 666
 667     if (ferror(sf_handle))
 668       fatalerror("I/O failure: couldn't backtrack on story file for checksum");
 669
 670     fclose(sf_handle);
 671
 672     /*  Write a copy of the header into the debugging information file
 673         (mainly so that it can be used to identify which story file matches
 674         with which debugging info file).                                     */
 675
 676     if (debugfile_switch)
 677     {   debug_file_printf("<story-file-prefix>");
 678         for (i = 0; i < 63; i += 3)
 679         {   if (i == 27)
 680             {   debug_file_print_base_64_triple
 681                     (zmachine_paged_memory[27],
 682                      checksum_high_byte,
 683                      checksum_low_byte);
 684             } else
 685             {   debug_file_print_base_64_triple
 686                     (zmachine_paged_memory[i],
 687                      zmachine_paged_memory[i + 1],
 688                      zmachine_paged_memory[i + 2]);
 689             }
 690         }
 691         debug_file_print_base_64_single(zmachine_paged_memory[63]);
 692         debug_file_printf("</story-file-prefix>");
 693     }
 694
 695 #ifdef ARCHIMEDES
 696     {   char settype_command[PATHLEN];
 697         sprintf(settype_command, "settype %s %s",
 698             new_name, riscos_file_type());
 699         system(settype_command);
 700     }
 701 #endif
 702 #ifdef MAC_FACE
 703      if (module_switch)
 704          InformFiletypes (new_name, INF_MODULE_TYPE);
 705      else
 706          InformFiletypes (new_name, INF_ZCODE_TYPE);
 707 #endif
 708 }
 709
 710 static void output_file_g(void)
 711 {   FILE *fin=NULL; char new_name[PATHLEN];
 712     int32 size, i, j, offset;
 713     int32 VersionNum;
 714     uint32 code_length, size_before_code, next_cons_check;
 715     int use_function;
 716     int first_byte_of_triple, second_byte_of_triple, third_byte_of_triple;
 717
 718     ASSERT_GLULX();
 719
 720     /* At this point, construct_storyfile() has just been called. */
 721
 722     translate_out_filename(new_name, Code_Name);
 723
 724     sf_handle = fopen(new_name,"wb+");
 725     if (sf_handle == NULL)
 726         fatalerror_named("Couldn't open output file", new_name);
 727
 728 #ifdef MAC_MPW
 729     /*  Set the type and creator to Andrew Plotkin's MaxZip, a popular
 730         Z-code interpreter on the Macintosh  */
 731
 732     if (!module_switch) fsetfileinfo(new_name, 'mxZR', 'ZCOD');
 733 #endif
 734
 735     checksum_long = 0;
 736     checksum_count = 0;
 737
 738     /* Determine the version number. */
 739
 740     VersionNum = 0x00020000;
 741
 742     /* Increase for various features the game may have used. */
 743     if (no_unicode_chars != 0 || (uses_unicode_features)) {
 744       VersionNum = 0x00030000;
 745     }
 746     if (uses_memheap_features) {
 747       VersionNum = 0x00030100;
 748     }
 749     if (uses_acceleration_features) {
 750       VersionNum = 0x00030101;
 751     }
 752     if (uses_float_features) {
 753       VersionNum = 0x00030102;
 754     }
 755
 756     /* And check if the user has requested a specific version. */
 757     if (requested_glulx_version) {
 758       if (requested_glulx_version < VersionNum) {
 759         static char error_message_buff[256];
 760         sprintf(error_message_buff, "Version 0x%08lx requested, but \
 761 game features require version 0x%08lx", (long)requested_glulx_version, (long)VersionNum);
 762         warning(error_message_buff);
 763       }
 764       else {
 765         VersionNum = requested_glulx_version;
 766       }
 767     }
 768
 769     /*  (1)  Output the header. We use sf_put here, instead of fputc,
 770         because the header is included in the checksum. */
 771
 772     /* Magic number */
 773     sf_put('G');
 774     sf_put('l');
 775     sf_put('u');
 776     sf_put('l');
 777     /* Version number. */
 778     sf_put((VersionNum >> 24));
 779     sf_put((VersionNum >> 16));
 780     sf_put((VersionNum >> 8));
 781     sf_put((VersionNum));
 782     /* RAMSTART */
 783     sf_put((Write_RAM_At >> 24));
 784     sf_put((Write_RAM_At >> 16));
 785     sf_put((Write_RAM_At >> 8));
 786     sf_put((Write_RAM_At));
 787     /* EXTSTART, or game file size */
 788     sf_put((Out_Size >> 24));
 789     sf_put((Out_Size >> 16));
 790     sf_put((Out_Size >> 8));
 791     sf_put((Out_Size));
 792     /* ENDMEM, which the game file size plus MEMORY_MAP_EXTENSION */
 793     i = Out_Size + MEMORY_MAP_EXTENSION;
 794     sf_put((i >> 24));
 795     sf_put((i >> 16));
 796     sf_put((i >> 8));
 797     sf_put((i));
 798     /* STACKSIZE */
 799     sf_put((MAX_STACK_SIZE >> 24));
 800     sf_put((MAX_STACK_SIZE >> 16));
 801     sf_put((MAX_STACK_SIZE >> 8));
 802     sf_put((MAX_STACK_SIZE));
 803     /* Initial function to call. Inform sets things up so that this
 804        is the start of the executable-code area. */
 805     sf_put((Write_Code_At >> 24));
 806     sf_put((Write_Code_At >> 16));
 807     sf_put((Write_Code_At >> 8));
 808     sf_put((Write_Code_At));
 809     /* String-encoding table. */
 810     sf_put((Write_Strings_At >> 24));
 811     sf_put((Write_Strings_At >> 16));
 812     sf_put((Write_Strings_At >> 8));
 813     sf_put((Write_Strings_At));
 814     /* Checksum -- zero for the moment. */
 815     sf_put(0x00);
 816     sf_put(0x00);
 817     sf_put(0x00);
 818     sf_put(0x00);
 819
 820     size = GLULX_HEADER_SIZE;
 821
 822     /*  (1a) Output the eight-byte memory layout identifier. */
 823
 824     sf_put('I'); sf_put('n'); sf_put('f'); sf_put('o');
 825     sf_put(0); sf_put(1); sf_put(0); sf_put(0);
 826
 827     /*  (1b) Output the rest of the Inform-specific data. */
 828
 829     /* Inform version number */
 830     sf_put('0' + ((RELEASE_NUMBER/100)%10));
 831     sf_put('.');
 832     sf_put('0' + ((RELEASE_NUMBER/10)%10));
 833     sf_put('0' + RELEASE_NUMBER%10);
 834     /* Glulx back-end version number */
 835     sf_put('0' + ((GLULX_RELEASE_NUMBER/100)%10));
 836     sf_put('.');
 837     sf_put('0' + ((GLULX_RELEASE_NUMBER/10)%10));
 838     sf_put('0' + GLULX_RELEASE_NUMBER%10);
 839     /* Game release number */
 840     sf_put((release_number>>8) & 0xFF);
 841     sf_put(release_number & 0xFF);
 842     /* Game serial number */
 843     {
 844       char serialnum[8];
 845       write_serial_number(serialnum);
 846       for (i=0; i<6; i++)
 847         sf_put(serialnum[i]);
 848     }
 849     size += GLULX_STATIC_ROM_SIZE;
 850
 851     /*  (2)  Output the compiled code area. */
 852
 853     if (temporary_files_switch)
 854     {   fclose(Temp2_fp);
 855         Temp2_fp = NULL;
 856         fin=fopen(Temp2_Name,"rb");
 857         if (fin==NULL)
 858             fatalerror("I/O failure: couldn't reopen temporary file 2");
 859     }
 860
 861     if (!OMIT_UNUSED_ROUTINES) {
 862         /* This is the old-fashioned case, which is easy. All of zcode_area
 863            (zmachine_pc bytes) will be output. next_cons_check will be
 864            ignored, because j will never reach it. */
 865         code_length = zmachine_pc;
 866         use_function = TRUE;
 867         next_cons_check = code_length+1;
 868     }
 869     else {
 870         /* With dead function stripping, life is more complicated.
 871            j will run from 0 to zmachine_pc, but only code_length of
 872            those should be output. next_cons_check is the location of
 873            the next function break; that's where we check whether
 874            we're in a live function or a dead one.
 875            (This logic is simplified by the assumption that a backpatch
 876            marker will never straddle a function break.) */
 877         if (zmachine_pc != df_total_size_before_stripping)
 878             compiler_error("Code size does not match (zmachine_pc and df_total_size).");
 879         code_length = df_total_size_after_stripping;
 880         use_function = TRUE;
 881         next_cons_check = 0;
 882         df_prepare_function_iterate();
 883     }
 884     size_before_code = size;
 885
 886     j=0;
 887     if (!module_switch)
 888       for (i=0; i<zcode_backpatch_size; i=i+6) {
 889         int data_len;
 890         int32 v;
 891         offset =
 892           (read_byte_from_memory_block(&zcode_backpatch_table, i+2) << 24)
 893           | (read_byte_from_memory_block(&zcode_backpatch_table, i+3) << 16)
 894           | (read_byte_from_memory_block(&zcode_backpatch_table, i+4) << 8)
 895           | (read_byte_from_memory_block(&zcode_backpatch_table, i+5));
 896         backpatch_error_flag = FALSE;
 897         backpatch_marker =
 898           read_byte_from_memory_block(&zcode_backpatch_table, i);
 899         data_len =
 900           read_byte_from_memory_block(&zcode_backpatch_table, i+1);
 901
 902         /* All code up until the next backpatch marker gets flushed out
 903            as-is. (Unless we're in a stripped-out function.) */
 904         while (j<offset) {
 905             if (!use_function) {
 906                 while (j<offset && j<next_cons_check) {
 907                     /* get dummy value */
 908                     ((temporary_files_switch)?fgetc(fin):
 909                         read_byte_from_memory_block(&zcode_area, j));
 910                     j++;
 911                 }
 912             }
 913             else {
 914                 while (j<offset && j<next_cons_check) {
 915                     size++;
 916                     sf_put((temporary_files_switch)?fgetc(fin):
 917                         read_byte_from_memory_block(&zcode_area, j));
 918                     j++;
 919                 }
 920             }
 921             if (j == next_cons_check)
 922                 next_cons_check = df_next_function_iterate(&use_function);
 923         }
 924
 925         /* Write out the converted value of the backpatch marker.
 926            (Unless we're in a stripped-out function.) */
 927         switch (data_len) {
 928
 929         case 4:
 930           v = ((temporary_files_switch)?fgetc(fin):
 931             read_byte_from_memory_block(&zcode_area, j));
 932           v = (v << 8) | ((temporary_files_switch)?fgetc(fin):
 933             read_byte_from_memory_block(&zcode_area, j+1));
 934           v = (v << 8) | ((temporary_files_switch)?fgetc(fin):
 935             read_byte_from_memory_block(&zcode_area, j+2));
 936           v = (v << 8) | ((temporary_files_switch)?fgetc(fin):
 937             read_byte_from_memory_block(&zcode_area, j+3));
 938           j += 4;
 939           if (!use_function)
 940               break;
 941           v = backpatch_value(v);
 942           sf_put((v >> 24) & 0xFF);
 943           sf_put((v >> 16) & 0xFF);
 944           sf_put((v >> 8) & 0xFF);
 945           sf_put((v) & 0xFF);
 946           size += 4;
 947           break;
 948
 949         case 2:
 950           v = ((temporary_files_switch)?fgetc(fin):
 951             read_byte_from_memory_block(&zcode_area, j));
 952           v = (v << 8) | ((temporary_files_switch)?fgetc(fin):
 953             read_byte_from_memory_block(&zcode_area, j+1));
 954           j += 2;
 955           if (!use_function)
 956               break;
 957           v = backpatch_value(v);
 958           if (v >= 0x10000) {
 959             printf("*** backpatch value does not fit ***\n");
 960             backpatch_error_flag = TRUE;
 961           }
 962           sf_put((v >> 8) & 0xFF);
 963           sf_put((v) & 0xFF);
 964           size += 2;
 965           break;
 966
 967         case 1:
 968           v = ((temporary_files_switch)?fgetc(fin):
 969             read_byte_from_memory_block(&zcode_area, j));
 970           j += 1;
 971           if (!use_function)
 972               break;
 973           v = backpatch_value(v);
 974           if (v >= 0x100) {
 975             printf("*** backpatch value does not fit ***\n");
 976             backpatch_error_flag = TRUE;
 977           }
 978           sf_put((v) & 0xFF);
 979           size += 1;
 980           break;
 981
 982         default:
 983           printf("*** unknown backpatch data len = %d ***\n",
 984             data_len);
 985           backpatch_error_flag = TRUE;
 986         }
 987
 988         if (j > next_cons_check)
 989           compiler_error("Backpatch appears to straddle function break");
 990
 991         if (backpatch_error_flag) {
 992           printf("*** %d bytes  zcode offset=%08lx  backpatch offset=%08lx ***\n",
 993             data_len, (long int) j, (long int) i);
 994         }
 995     }
 996
 997     /* Flush out the last bit of zcode_area, after the last backpatch
 998        marker. */
 999     offset = zmachine_pc;
1000     while (j<offset) {
1001         if (!use_function) {
1002             while (j<offset && j<next_cons_check) {
1003                 /* get dummy value */
1004                 ((temporary_files_switch)?fgetc(fin):
1005                     read_byte_from_memory_block(&zcode_area, j));
1006                 j++;
1007             }
1008         }
1009         else {
1010             while (j<offset && j<next_cons_check) {
1011                 size++;
1012                 sf_put((temporary_files_switch)?fgetc(fin):
1013                     read_byte_from_memory_block(&zcode_area, j));
1014                 j++;
1015             }
1016         }
1017         if (j == next_cons_check)
1018             next_cons_check = df_next_function_iterate(&use_function);
1019     }
1020
1021     if (temporary_files_switch)
1022     {   if (ferror(fin))
1023             fatalerror("I/O failure: couldn't read from temporary file 2");
1024         fclose(fin);
1025         fin = NULL;
1026     }
1027
1028     if (size_before_code + code_length != size)
1029         compiler_error("Code output length did not match");
1030
1031     /*  (4)  Output the static strings area.                                 */
1032
1033     if (temporary_files_switch) {
1034       fseek(Temp1_fp, 0, SEEK_SET);
1035     }
1036     {
1037       int32 ix, lx;
1038       int ch, jx, curbyte, bx;
1039       int depth, checkcount;
1040       huffbitlist_t *bits;
1041       int32 origsize;
1042
1043       origsize = size;
1044
1045       if (compression_switch) {
1046
1047         /* The 12-byte table header. */
1048         lx = compression_table_size;
1049         sf_put((lx >> 24) & 0xFF);
1050         sf_put((lx >> 16) & 0xFF);
1051         sf_put((lx >> 8) & 0xFF);
1052         sf_put((lx) & 0xFF);
1053         size += 4;
1054         sf_put((no_huff_entities >> 24) & 0xFF);
1055         sf_put((no_huff_entities >> 16) & 0xFF);
1056         sf_put((no_huff_entities >> 8) & 0xFF);
1057         sf_put((no_huff_entities) & 0xFF);
1058         size += 4;
1059         lx = Write_Strings_At + 12;
1060         sf_put((lx >> 24) & 0xFF);
1061         sf_put((lx >> 16) & 0xFF);
1062         sf_put((lx >> 8) & 0xFF);
1063         sf_put((lx) & 0xFF);
1064         size += 4;
1065
1066         checkcount = 0;
1067         output_compression(huff_entity_root, &size, &checkcount);
1068         if (checkcount != no_huff_entities)
1069           compiler_error("Compression table count mismatch.");
1070       }
1071
1072       if (size - origsize != compression_table_size)
1073         compiler_error("Compression table size mismatch.");
1074
1075       origsize = size;
1076
1077       for (lx=0, ix=0; lx<no_strings; lx++) {
1078         int escapelen=0, escapetype=0;
1079         int done=FALSE;
1080         int32 escapeval=0;
1081         if (compression_switch)
1082           sf_put(0xE1); /* type byte -- compressed string */
1083         else
1084           sf_put(0xE0); /* type byte -- non-compressed string */
1085         size++;
1086         jx = 0;
1087         curbyte = 0;
1088         while (!done) {
1089           if (temporary_files_switch)
1090             ch = fgetc(Temp1_fp);
1091           else
1092             ch = read_byte_from_memory_block(&static_strings_area, ix);
1093           ix++;
1094           if (ix > static_strings_extent || ch < 0)
1095             compiler_error("Read too much not-yet-compressed text.");
1096
1097           if (escapelen == -1) {
1098             escapelen = 0;
1099             if (ch == '@') {
1100               ch = '@';
1101             }
1102             else if (ch == '0') {
1103               ch = '\0';
1104             }
1105             else if (ch == 'A' || ch == 'D' || ch == 'U') {
1106               escapelen = 4;
1107               escapetype = ch;
1108               escapeval = 0;
1109               continue;
1110             }
1111             else {
1112               compiler_error("Strange @ escape in processed text.");
1113             }
1114           }
1115           else if (escapelen) {
1116             escapeval = (escapeval << 4) | ((ch-'A') & 0x0F);
1117             escapelen--;
1118             if (escapelen == 0) {
1119               if (escapetype == 'A') {
1120                 ch = huff_abbrev_start+escapeval;
1121               }
1122               else if (escapetype == 'D') {
1123                 ch = huff_dynam_start+escapeval;
1124               }
1125               else if (escapetype == 'U') {
1126                 ch = huff_unicode_start+escapeval;
1127               }
1128               else {
1129                 compiler_error("Strange @ escape in processed text.");
1130               }
1131             }
1132             else
1133               continue;
1134           }
1135           else {
1136             if (ch == '@') {
1137               escapelen = -1;
1138               continue;
1139             }
1140             if (ch == 0) {
1141               ch = 256;
1142               done = TRUE;
1143             }
1144           }
1145
1146           if (compression_switch) {
1147             bits = &(huff_entities[ch].bits);
1148             depth = huff_entities[ch].depth;
1149             for (bx=0; bx<depth; bx++) {
1150               if (bits->b[bx / 8] & (1 << (bx % 8)))
1151                 curbyte |= (1 << jx);
1152               jx++;
1153               if (jx == 8) {
1154                 sf_put(curbyte);
1155                 size++;
1156                 curbyte = 0;
1157                 jx = 0;
1158               }
1159             }
1160           }
1161           else {
1162             if (ch >= huff_dynam_start) {
1163               sf_put(' '); sf_put(' '); sf_put(' ');
1164               size += 3;
1165             }
1166             else if (ch >= huff_abbrev_start) {
1167               /* nothing */
1168             }
1169             else {
1170               /* 256, the string terminator, comes out as zero */
1171               sf_put(ch & 0xFF);
1172               size++;
1173             }
1174           }
1175         }
1176         if (compression_switch && jx) {
1177           sf_put(curbyte);
1178           size++;
1179         }
1180       }
1181
1182       if (size - origsize != compression_string_size)
1183         compiler_error("Compression string size mismatch.");
1184
1185     }
1186
1187     /*  (4.5)  Output any null bytes (required to reach a GPAGESIZE address)
1188              before RAMSTART. */
1189
1190     while (size % GPAGESIZE) { sf_put(0); size++; }
1191
1192     /*  (5)  Output RAM. */
1193
1194     for (i=0; i<RAM_Size; i++)
1195     {   sf_put(zmachine_paged_memory[i]); size++;
1196     }
1197
1198     if (ferror(sf_handle))
1199         fatalerror("I/O failure: couldn't write to story file");
1200
1201     fseek(sf_handle, 32, SEEK_SET);
1202     fputc((checksum_long >> 24) & 0xFF, sf_handle);
1203     fputc((checksum_long >> 16) & 0xFF, sf_handle);
1204     fputc((checksum_long >> 8) & 0xFF, sf_handle);
1205     fputc((checksum_long) & 0xFF, sf_handle);
1206
1207     if (ferror(sf_handle))
1208       fatalerror("I/O failure: couldn't backtrack on story file for checksum");
1209
1210     /*  Write a copy of the first 64 bytes into the debugging information file
1211         (mainly so that it can be used to identify which story file matches with
1212         which debugging info file).  */
1213
1214     if (debugfile_switch)
1215     {   fseek(sf_handle, 0L, SEEK_SET);
1216         debug_file_printf("<story-file-prefix>");
1217         for (i = 0; i < 63; i += 3)
1218         {   first_byte_of_triple = fgetc(sf_handle);
1219             second_byte_of_triple = fgetc(sf_handle);
1220             third_byte_of_triple = fgetc(sf_handle);
1221             debug_file_print_base_64_triple
1222                 (first_byte_of_triple,
1223                  second_byte_of_triple,
1224                  third_byte_of_triple);
1225         }
1226         debug_file_print_base_64_single(fgetc(sf_handle));
1227         debug_file_printf("</story-file-prefix>");
1228     }
1229
1230     fclose(sf_handle);
1231
1232 #ifdef ARCHIMEDES
1233     {   char settype_command[PATHLEN];
1234         sprintf(settype_command, "settype %s %s",
1235             new_name, riscos_file_type());
1236         system(settype_command);
1237     }
1238 #endif
1239 #ifdef MAC_FACE
1240      if (module_switch)
1241          InformFiletypes (new_name, INF_MODULE_TYPE);
1242      else
1243          InformFiletypes (new_name, INF_ZCODE_TYPE);
1244 #endif
1245 }
1246
1247 extern void output_file(void)
1248 {
1249   if (!glulx_mode)
1250     output_file_z();
1251   else
1252     output_file_g();
1253 }
1254
1255 /* ------------------------------------------------------------------------- */
1256 /*   Output the text transcript file (only called if there is to be one).    */
1257 /* ------------------------------------------------------------------------- */
1258
1259 FILE *transcript_file_handle; int transcript_open;
1260
1261 extern void write_to_transcript_file(char *text)
1262 {   fputs(text, transcript_file_handle);
1263     fputc('\n', transcript_file_handle);
1264 }
1265
1266 extern void open_transcript_file(char *what_of)
1267 {   char topline_buffer[256];
1268
1269     transcript_file_handle = fopen(Transcript_Name,"w");
1270     if (transcript_file_handle==NULL)
1271         fatalerror_named("Couldn't open transcript file",
1272         Transcript_Name);
1273
1274     transcript_open = TRUE;
1275
1276     sprintf(topline_buffer, "Transcript of the text of \"%s\"\n\
1277 [From %s]\n", what_of, banner_line);
1278     write_to_transcript_file(topline_buffer);
1279 }
1280
1281 extern void abort_transcript_file(void)
1282 {   if (transcript_switch && transcript_open)
1283         fclose(transcript_file_handle);
1284     transcript_open = FALSE;
1285 }
1286
1287 extern void close_transcript_file(void)
1288 {   char botline_buffer[256];
1289     char sn_buffer[7];
1290
1291     write_serial_number(sn_buffer);
1292     sprintf(botline_buffer, "\n[End of transcript: release %d.%s]\n",
1293         release_number, sn_buffer);
1294     write_to_transcript_file(botline_buffer);
1295
1296     if (ferror(transcript_file_handle))
1297         fatalerror("I/O failure: couldn't write to transcript file");
1298     fclose(transcript_file_handle);
1299     transcript_open = FALSE;
1300
1301 #ifdef ARCHIMEDES
1302     {   char settype_command[PATHLEN];
1303         sprintf(settype_command, "settype %s text",
1304             Transcript_Name);
1305         system(settype_command);
1306     }
1307 #endif
1308 #ifdef MAC_FACE
1309     InformFiletypes (Transcript_Name, INF_TEXT_TYPE);
1310 #endif
1311 }
1312
1313 /* ------------------------------------------------------------------------- */
1314 /*   Access to the debugging information file.                               */
1315 /* ------------------------------------------------------------------------- */
1316
1317 static FILE *Debug_fp;                 /* Handle of debugging info file      */
1318
1319 static void open_debug_file(void)
1320 {   Debug_fp=fopen(Debugging_Name,"wb");
1321     if (Debug_fp==NULL)
1322        fatalerror_named("Couldn't open debugging information file",
1323            Debugging_Name);
1324 }
1325
1326 extern void nullify_debug_file_position(maybe_file_position *position) {
1327     position->valid = 0;
1328 }
1329
1330 static void close_debug_file(void)
1331 {   fclose(Debug_fp);
1332 #ifdef MAC_FACE
1333     InformFiletypes (Debugging_Name, INF_DEBUG_TYPE);
1334 #endif
1335 }
1336
1337 extern void begin_debug_file(void)
1338 {   open_debug_file();
1339
1340     debug_file_printf("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
1341     debug_file_printf("<inform-story-file version=\"1.0\" ");
1342     debug_file_printf("content-creator=\"Inform\" ");
1343     debug_file_printf
1344         ("content-creator-version=\"%d.%d%d\">",
1345          (VNUMBER / 100) % 10,
1346          (VNUMBER / 10) % 10,
1347          VNUMBER % 10);
1348 }
1349
1350 extern void debug_file_printf(const char*format, ...)
1351 {   va_list argument_pointer;
1352     va_start(argument_pointer, format);
1353     vfprintf(Debug_fp, format, argument_pointer);
1354     va_end(argument_pointer);
1355     if (ferror(Debug_fp))
1356     {   fatalerror("I/O failure: can't write to debugging information file");
1357     }
1358 }
1359
1360 extern void debug_file_print_with_entities(const char*string)
1361 {   int index = 0;
1362     char character;
1363     for (character = string[index]; character; character = string[++index])
1364     {   switch(character)
1365         {   case '"':
1366                 debug_file_printf("&quot;");
1367                 break;
1368             case '&':
1369                 debug_file_printf("&amp;");
1370                 break;
1371             case '\'':
1372                 debug_file_printf("&apos;");
1373                 break;
1374             case '<':
1375                 debug_file_printf("&lt;");
1376                 break;
1377             case '>':
1378                 debug_file_printf("&gt;");
1379                 break;
1380             default:
1381                 debug_file_printf("%c", character);
1382                 break;
1383         }
1384     }
1385 }
1386
1387 static char base_64_digits[] =
1388   { 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O',
1389     'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd',
1390     'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's',
1391     't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7',
1392     '8', '9', '+', '/' };
1393
1394 extern void debug_file_print_base_64_triple
1395     (uchar first, uchar second, uchar third)
1396 {   debug_file_printf
1397         ("%c%c%c%c",
1398          base_64_digits[first >> 2],
1399          base_64_digits[((first & 3) << 4) | (second >> 4)],
1400          base_64_digits[((second & 15) << 2) | (third >> 6)],
1401          base_64_digits[third & 63]);
1402 }
1403
1404 extern void debug_file_print_base_64_pair(uchar first, uchar second)
1405 {   debug_file_printf
1406         ("%c%c%c=",
1407          base_64_digits[first >> 2],
1408          base_64_digits[((first & 3) << 4) | (second >> 4)],
1409          base_64_digits[(second & 15) << 2]);
1410 }
1411
1412 extern void debug_file_print_base_64_single(uchar first)
1413 {   debug_file_printf
1414         ("%c%c==",
1415          base_64_digits[first >> 2],
1416          base_64_digits[(first & 3) << 4]);
1417 }
1418
1419 static void write_debug_location_internals(debug_location location)
1420 {   debug_file_printf("<file-index>%d</file-index>", location.file_index - 1);
1421     debug_file_printf
1422         ("<file-position>%d</file-position>", location.beginning_byte_index);
1423     debug_file_printf
1424         ("<line>%d</line>", location.beginning_line_number);
1425     debug_file_printf
1426         ("<character>%d</character>", location.beginning_character_number);
1427     if (location.beginning_byte_index != location.end_byte_index ||
1428         location.beginning_line_number != location.end_line_number ||
1429         location.beginning_character_number != location.end_character_number)
1430     {   debug_file_printf
1431             ("<end-file-position>%d</end-file-position>",
1432              location.end_byte_index);
1433         debug_file_printf
1434             ("<end-line>%d</end-line>", location.end_line_number);
1435         debug_file_printf
1436             ("<end-character>%d</end-character>",
1437              location.end_character_number);
1438     }
1439 }
1440
1441 static void write_debug_location_origsource_internals(debug_location location)
1442 {   debug_file_printf
1443         ("<file-index>%d</file-index>", location.orig_file_index - 1);
1444     if (location.orig_beg_line_number)
1445         debug_file_printf
1446             ("<line>%d</line>", location.orig_beg_line_number);
1447     if (location.orig_beg_char_number)
1448         debug_file_printf
1449             ("<character>%d</character>", location.orig_beg_char_number);
1450 }
1451
1452 extern void write_debug_location(debug_location location)
1453 {   if (location.file_index && location.file_index != 255)
1454     {   debug_file_printf("<source-code-location>");
1455         write_debug_location_internals(location);
1456         debug_file_printf("</source-code-location>");
1457     }
1458     if (location.orig_file_index)
1459     {   debug_file_printf("<source-code-location>");
1460         write_debug_location_origsource_internals(location);
1461         debug_file_printf("</source-code-location>");
1462     }
1463 }
1464
1465 extern void write_debug_locations(debug_locations locations)
1466 {   if (locations.next)
1467     {   const debug_locations*current = &locations;
1468         unsigned int index = 0;
1469         for (; current; current = current->next, ++index)
1470         {   debug_file_printf("<source-code-location index=\"%d\">", index);
1471             write_debug_location_internals(current->location);
1472             debug_file_printf("</source-code-location>");
1473         }
1474         if (locations.location.orig_file_index)
1475         {   debug_file_printf("<source-code-location>");
1476             write_debug_location_origsource_internals(locations.location);
1477             debug_file_printf("</source-code-location>");
1478         }
1479     }
1480     else
1481     {   write_debug_location(locations.location);
1482     }
1483 }
1484
1485 extern void write_debug_optional_identifier(int32 symbol_index)
1486 {   if (stypes[symbol_index] != ROUTINE_T)
1487     {   compiler_error
1488             ("Attempt to write a replaceable identifier for a non-routine");
1489     }
1490     if (replacement_debug_backpatch_positions[symbol_index].valid)
1491     {   if (fsetpos
1492                 (Debug_fp,
1493                  &replacement_debug_backpatch_positions[symbol_index].position))
1494         {   fatalerror("I/O failure: can't seek in debugging information file");
1495         }
1496         debug_file_printf
1497             ("<identifier artificial=\"true\">%s "
1498                  "(superseded replacement)</identifier>",
1499              symbs[symbol_index]);
1500         if (fseek(Debug_fp, 0L, SEEK_END))
1501         {   fatalerror("I/O failure: can't seek in debugging information file");
1502         }
1503     }
1504     fgetpos
1505       (Debug_fp, &replacement_debug_backpatch_positions[symbol_index].position);
1506     replacement_debug_backpatch_positions[symbol_index].valid = TRUE;
1507     debug_file_printf("<identifier>%s</identifier>", symbs[symbol_index]);
1508     /* Space for:       artificial="true" (superseded replacement) */
1509     debug_file_printf("                                           ");
1510 }
1511
1512 extern void write_debug_symbol_backpatch(int32 symbol_index)
1513 {   if (symbol_debug_backpatch_positions[symbol_index].valid) {
1514         compiler_error("Symbol entry incorrectly reused in debug information "
1515                        "file backpatching");
1516     }
1517     fgetpos(Debug_fp, &symbol_debug_backpatch_positions[symbol_index].position);
1518     symbol_debug_backpatch_positions[symbol_index].valid = TRUE;
1519     /* Reserve space for up to 10 digits plus a negative sign. */
1520     debug_file_printf("*BACKPATCH*");
1521 }
1522
1523 extern void write_debug_symbol_optional_backpatch(int32 symbol_index)
1524 {   if (symbol_debug_backpatch_positions[symbol_index].valid) {
1525         compiler_error("Symbol entry incorrectly reused in debug information "
1526                        "file backpatching");
1527     }
1528     /* Reserve space for open and close value tags and up to 10 digits plus a
1529        negative sign, but take the backpatch position just inside the element,
1530        so that we'll be in the same case as above if the symbol is eventually
1531        defined. */
1532     debug_file_printf("<value>");
1533     fgetpos(Debug_fp, &symbol_debug_backpatch_positions[symbol_index].position);
1534     symbol_debug_backpatch_positions[symbol_index].valid = TRUE;
1535     debug_file_printf("*BACKPATCH*</value>");
1536 }
1537
1538 static void write_debug_backpatch
1539     (debug_backpatch_accumulator *accumulator, int32 value)
1540 {   if (accumulator->number_of_values_to_backpatch ==
1541         accumulator->number_of_available_backpatches)
1542     {   my_realloc(&accumulator->values_and_backpatch_positions,
1543                    sizeof(value_and_backpatch_position) *
1544                        accumulator->number_of_available_backpatches,
1545                    2 * sizeof(value_and_backpatch_position) *
1546                        accumulator->number_of_available_backpatches,
1547                    "values and debug information backpatch positions");
1548         accumulator->number_of_available_backpatches *= 2;
1549     }
1550     accumulator->values_and_backpatch_positions
1551         [accumulator->number_of_values_to_backpatch].value = value;
1552     fgetpos
1553         (Debug_fp,
1554          &accumulator->values_and_backpatch_positions
1555              [accumulator->number_of_values_to_backpatch].backpatch_position);
1556     ++(accumulator->number_of_values_to_backpatch);
1557     /* Reserve space for up to 10 digits plus a negative sign. */
1558     debug_file_printf("*BACKPATCH*");
1559 }
1560
1561 extern void write_debug_object_backpatch(int32 object_number)
1562 {   if (glulx_mode)
1563     {   write_debug_backpatch(&object_backpatch_accumulator, object_number - 1);
1564     }
1565     else
1566     {   debug_file_printf("%d", object_number);
1567     }
1568 }
1569
1570 static int32 backpatch_object_address(int32 index)
1571 {   return object_tree_offset + OBJECT_BYTE_LENGTH * index;
1572 }
1573
1574 extern void write_debug_packed_code_backpatch(int32 offset)
1575 {   write_debug_backpatch(&packed_code_backpatch_accumulator, offset);
1576 }
1577
1578 static int32 backpatch_packed_code_address(int32 offset)
1579 {
1580     if (OMIT_UNUSED_ROUTINES) {
1581         int stripped;
1582         offset = df_stripped_offset_for_code_offset(offset, &stripped);
1583         if (stripped)
1584             return 0;
1585     }
1586     return (code_offset + offset) / scale_factor;
1587 }
1588
1589 extern void write_debug_code_backpatch(int32 offset)
1590 {   write_debug_backpatch(&code_backpatch_accumulator, offset);
1591 }
1592
1593 static int32 backpatch_code_address(int32 offset)
1594 {
1595     if (OMIT_UNUSED_ROUTINES) {
1596         int stripped;
1597         offset = df_stripped_offset_for_code_offset(offset, &stripped);
1598         if (stripped)
1599             return 0;
1600     }
1601     return code_offset + offset;
1602 }
1603
1604 extern void write_debug_global_backpatch(int32 offset)
1605 {   write_debug_backpatch(&global_backpatch_accumulator, offset);
1606 }
1607
1608 static int32 backpatch_global_address(int32 offset)
1609 {   return variables_offset + WORDSIZE * (offset - MAX_LOCAL_VARIABLES);
1610 }
1611
1612 extern void write_debug_array_backpatch(int32 offset)
1613 {   write_debug_backpatch(&array_backpatch_accumulator, offset);
1614 }
1615
1616 static int32 backpatch_array_address(int32 offset)
1617 {   return (glulx_mode ? arrays_offset : variables_offset) + offset;
1618 }
1619
1620 extern void write_debug_grammar_backpatch(int32 offset)
1621 {   write_debug_backpatch(&grammar_backpatch_accumulator, offset);
1622 }
1623
1624 static int32 backpatch_grammar_address(int32 offset)
1625 {   return grammar_table_offset + offset;
1626 }
1627
1628 extern void begin_writing_debug_sections()
1629 {   debug_file_printf("<story-file-section>");
1630     debug_file_printf("<type>header</type>");
1631     debug_file_printf("<address>0</address>");
1632 }
1633
1634 extern void write_debug_section(const char*name, int32 beginning_address)
1635 {   debug_file_printf("<end-address>%d</end-address>", beginning_address);
1636     debug_file_printf("</story-file-section>");
1637     debug_file_printf("<story-file-section>");
1638     debug_file_printf("<type>");
1639     debug_file_print_with_entities(name);
1640     debug_file_printf("</type>");
1641     debug_file_printf("<address>%d</address>", beginning_address);
1642 }
1643
1644 extern void end_writing_debug_sections(int32 end_address)
1645 {   debug_file_printf("<end-address>%d</end-address>", end_address);
1646     debug_file_printf("</story-file-section>");
1647 }
1648
1649 extern void write_debug_undef(int32 symbol_index)
1650 {   if (!symbol_debug_backpatch_positions[symbol_index].valid)
1651     {   compiler_error
1652             ("Attempt to erase debugging information never written or since "
1653                 "erased");
1654     }
1655     if (stypes[symbol_index] != CONSTANT_T)
1656     {   compiler_error
1657             ("Attempt to erase debugging information for a non-constant "
1658              "because of an #undef");
1659     }
1660     if (fsetpos
1661          (Debug_fp, &symbol_debug_backpatch_positions[symbol_index].position))
1662     {   fatalerror("I/O failure: can't seek in debugging information file");
1663     }
1664     /* There are 7 characters in ``<value>''. */
1665     if (fseek(Debug_fp, -7L, SEEK_CUR))
1666     {   fatalerror("I/O failure: can't seek in debugging information file");
1667     }
1668     /* Overwrite:      <value>*BACKPATCH*</value> */
1669     debug_file_printf("                          ");
1670     nullify_debug_file_position
1671         (&symbol_debug_backpatch_positions[symbol_index]);
1672     if (fseek(Debug_fp, 0L, SEEK_END))
1673     {   fatalerror("I/O failure: can't seek in debugging information file");
1674     }
1675 }
1676
1677 static void apply_debug_information_backpatches
1678     (debug_backpatch_accumulator *accumulator)
1679 {   int32 backpatch_index, backpatch_value;
1680     for (backpatch_index = accumulator->number_of_values_to_backpatch;
1681          backpatch_index--;)
1682     {   if (fsetpos
1683                 (Debug_fp,
1684                  &accumulator->values_and_backpatch_positions
1685                      [backpatch_index].backpatch_position))
1686         {   fatalerror
1687                 ("I/O failure: can't seek in debugging information file");
1688         }
1689         backpatch_value =
1690             (*accumulator->backpatching_function)
1691                 (accumulator->values_and_backpatch_positions
1692                     [backpatch_index].value);
1693         debug_file_printf
1694             ("%11d", /* Space for up to 10 digits plus a negative sign. */
1695              backpatch_value);
1696     }
1697 }
1698
1699 static void apply_debug_information_symbol_backpatches()
1700 {   int backpatch_symbol;
1701     for (backpatch_symbol = no_symbols; backpatch_symbol--;)
1702     {   if (symbol_debug_backpatch_positions[backpatch_symbol].valid)
1703         {   if (fsetpos(Debug_fp,
1704                         &symbol_debug_backpatch_positions
1705                             [backpatch_symbol].position))
1706             {   fatalerror
1707                     ("I/O failure: can't seek in debugging information file");
1708             }
1709             debug_file_printf("%11d", svals[backpatch_symbol]);
1710         }
1711     }
1712 }
1713
1714 static void write_debug_system_constants()
1715 {   int *system_constant_list =
1716         glulx_mode ? glulx_system_constant_list : z_system_constant_list;
1717     int system_constant_index = 0;
1718
1719     /* Store system constants. */
1720     for (; system_constant_list[system_constant_index] != -1;
1721          ++system_constant_index)
1722     {   int system_constant = system_constant_list[system_constant_index];
1723         debug_file_printf("<constant>");
1724         debug_file_printf
1725             ("<identifier>#%s</identifier>",
1726              system_constants.keywords[system_constant]);
1727         debug_file_printf
1728             ("<value>%d</value>",
1729              value_of_system_constant(system_constant));
1730         debug_file_printf("</constant>");
1731     }
1732 }
1733
1734 extern void end_debug_file()
1735 {   write_debug_system_constants();
1736     debug_file_printf("</inform-story-file>\n");
1737
1738     if (glulx_mode)
1739     {   apply_debug_information_backpatches(&object_backpatch_accumulator);
1740     } else
1741     {   apply_debug_information_backpatches(&packed_code_backpatch_accumulator);
1742     }
1743     apply_debug_information_backpatches(&code_backpatch_accumulator);
1744     apply_debug_information_backpatches(&global_backpatch_accumulator);
1745     apply_debug_information_backpatches(&array_backpatch_accumulator);
1746     apply_debug_information_backpatches(&grammar_backpatch_accumulator);
1747
1748     apply_debug_information_symbol_backpatches();
1749
1750     close_debug_file();
1751 }
1752
1753 /* ------------------------------------------------------------------------- */
1754 /*  Temporary storage files:                                                 */
1755 /*                                                                           */
1756 /*      Temp file 1 is used to hold the static strings area, as compiled     */
1757 /*                2 to hold compiled routines of Z-code                      */
1758 /*                3 to hold the link data table (but only for modules)       */
1759 /*                                                                           */
1760 /*  (Though annoying, this procedure typically saves about 200K of memory,   */
1761 /*  an important point for Amiga and sub-386 PC users of Inform)             */
1762 /* ------------------------------------------------------------------------- */
1763
1764 extern void open_temporary_files(void)
1765 {   translate_temp_filename(1);
1766     Temp1_fp=fopen(Temp1_Name,"wb");
1767     if (Temp1_fp==NULL) fatalerror_named("Couldn't open temporary file 1",
1768         Temp1_Name);
1769     translate_temp_filename(2);
1770     Temp2_fp=fopen(Temp2_Name,"wb");
1771     if (Temp2_fp==NULL) fatalerror_named("Couldn't open temporary file 2",
1772         Temp2_Name);
1773
1774     if (!module_switch) return;
1775     translate_temp_filename(3);
1776     Temp3_fp=fopen(Temp3_Name,"wb");
1777     if (Temp3_fp==NULL) fatalerror_named("Couldn't open temporary file 3",
1778         Temp3_Name);
1779 }
1780
1781 extern void check_temp_files(void)
1782 {
1783     if (ferror(Temp1_fp))
1784         fatalerror("I/O failure: couldn't write to temporary file 1");
1785     if (ferror(Temp2_fp))
1786         fatalerror("I/O failure: couldn't write to temporary file 2");
1787     if (module_switch && ferror(Temp3_fp))
1788         fatalerror("I/O failure: couldn't write to temporary file 3");
1789 }
1790
1791 extern void remove_temp_files(void)
1792 {   if (Temp1_fp != NULL) fclose(Temp1_fp);
1793     Temp1_fp = NULL;
1794     if (Temp2_fp != NULL) fclose(Temp2_fp);
1795     Temp2_fp = NULL;
1796     remove(Temp1_Name); remove(Temp2_Name);
1797     if (module_switch)
1798     {   if (Temp3_fp != NULL) fclose(Temp3_fp);
1799         Temp3_fp = NULL;
1800         remove(Temp3_Name);
1801     }
1802 }
1803
1804 /* ========================================================================= */
1805 /*   Data structure management routines                                      */
1806 /* ------------------------------------------------------------------------- */
1807
1808 extern void init_files_vars(void)
1809 {   malloced_bytes = 0;
1810     checksum_low_byte = 0; /* Z-code */
1811     checksum_high_byte = 0;
1812     checksum_long = 0; /* Glulx */
1813     checksum_count = 0;
1814     transcript_open = FALSE;
1815 }
1816
1817 extern void files_begin_prepass(void)
1818 {
1819     total_files = 0;
1820     total_input_files = 0;
1821     current_input_file = 0;
1822     current_origsource_file = 0;
1823 }
1824
1825 extern void files_begin_pass(void)
1826 {   total_chars_read=0;
1827     if (temporary_files_switch)
1828         open_temporary_files();
1829 }
1830
1831 static void initialise_accumulator
1832     (debug_backpatch_accumulator *accumulator,
1833      int32 (* backpatching_function)(int32))
1834 {   accumulator->number_of_values_to_backpatch = 0;
1835     accumulator->number_of_available_backpatches =
1836         INITIAL_DEBUG_INFORMATION_BACKPATCH_ALLOCATION;
1837     accumulator->values_and_backpatch_positions =
1838         my_malloc
1839             (sizeof(value_and_backpatch_position) *
1840                  accumulator->number_of_available_backpatches,
1841              "values and debug information backpatch positions");
1842     accumulator->backpatching_function = backpatching_function;
1843 }
1844
1845 extern void files_allocate_arrays(void)
1846 {   filename_storage = my_malloc(MAX_SOURCE_FILES*64, "filename storage");
1847     filename_storage_p = filename_storage;
1848     filename_storage_left = MAX_SOURCE_FILES*64;
1849     InputFiles = my_malloc(MAX_SOURCE_FILES*sizeof(FileId),
1850         "input file storage");
1851     if (debugfile_switch)
1852     {   if (glulx_mode)
1853         {   initialise_accumulator
1854                 (&object_backpatch_accumulator, &backpatch_object_address);
1855         } else
1856         {   initialise_accumulator
1857                 (&packed_code_backpatch_accumulator,
1858                  &backpatch_packed_code_address);
1859         }
1860         initialise_accumulator
1861             (&code_backpatch_accumulator, &backpatch_code_address);
1862         initialise_accumulator
1863             (&global_backpatch_accumulator, &backpatch_global_address);
1864         initialise_accumulator
1865             (&array_backpatch_accumulator, &backpatch_array_address);
1866         initialise_accumulator
1867             (&grammar_backpatch_accumulator, &backpatch_grammar_address);
1868     }
1869 }
1870
1871 static void tear_down_accumulator(debug_backpatch_accumulator *accumulator)
1872 {   my_free
1873         (&(accumulator->values_and_backpatch_positions),
1874          "values and debug information backpatch positions");
1875 }
1876
1877 extern void files_free_arrays(void)
1878 {   my_free(&filename_storage, "filename storage");
1879     my_free(&InputFiles, "input file storage");
1880     if (debugfile_switch)
1881     {   if (!glulx_mode)
1882         {   tear_down_accumulator(&object_backpatch_accumulator);
1883         } else
1884         {   tear_down_accumulator(&packed_code_backpatch_accumulator);
1885         }
1886         tear_down_accumulator(&code_backpatch_accumulator);
1887         tear_down_accumulator(&global_backpatch_accumulator);
1888         tear_down_accumulator(&array_backpatch_accumulator);
1889         tear_down_accumulator(&grammar_backpatch_accumulator);
1890     }
1891 }
1892
1893 /* ========================================================================= */