dungeon.c

   1 /*
   2  * The dungeon compiler. Turns adventure.text into a set of C initializers
   3  * defining (mostly) invariant state.  A couple of slots are messed with
   4  * at runtime.
   5  */
   6 #include "common.h"
   7
   8 #define LINESIZE 100
   9 #define RTXSIZ 277
  10 #define CLSMAX 12
  11 #define LINSIZ 12600
  12 #define TRNSIZ 5
  13 #define TABSIZ 330
  14 #define VRBSIZ 35
  15 #define TRVSIZ 885
  16 #define TOKLEN 5
  17 #define HINTLEN 5
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <stdbool.h>
  22 #include <unistd.h>
  23
  24 /* hard limit, will be propagated to database.h */
  25 #define NOBJECTS        100
  26
  27 // Global variables for use in functions below that can gradually disappear as code is cleaned up
  28 static long LNLENG;
  29 static long LNPOSN;
  30 static char INLINE[LINESIZE+1];
  31 static long OLDLOC;
  32 static long MAXDIE;
  33
  34 // Storage for what comes out of the database
  35 long LINUSE;
  36 long TRVS;
  37 long CLSSES;
  38 long TRNVLS;
  39 long TABNDX;
  40 long HNTMAX;
  41 long PTEXT[NOBJECTS+1];
  42 long RTEXT[RTXSIZ + 1];
  43 long CTEXT[CLSMAX + 1];
  44 long OBJSND[NOBJECTS+1];
  45 long OBJTXT[NOBJECTS+1];
  46 long STEXT[LOCSIZ + 1];
  47 long LTEXT[LOCSIZ + 1];
  48 long COND[LOCSIZ + 1];
  49 long KEY[LOCSIZ + 1];
  50 long LOCSND[LOCSIZ + 1];
  51 long LINES[LINSIZ + 1];
  52 long CVAL[CLSMAX + 1];
  53 long TTEXT[TRNSIZ + 1];
  54 long TRNVAL[TRNSIZ + 1];
  55 long TRAVEL[TRVSIZ + 1];
  56 long KTAB[TABSIZ + 1];
  57 long ATAB[TABSIZ + 1];
  58 long PLAC[NOBJECTS+1];
  59 long FIXD[NOBJECTS+1];
  60 long ACTSPK[VRBSIZ + 1];
  61 long HINTS[HNTSIZ + 1][HINTLEN];
  62
  63 bool is_set(long, long);
  64 long GETTXT(long, long, long);
  65 void BUG(long);
  66 void MAPLIN(FILE*);
  67 long GETNUM(FILE*);
  68 int read_database(FILE*);
  69 void read_messages(FILE*, long);
  70 void read_section3_stuff(FILE*);
  71 void read_vocabulary(FILE*);
  72 void read_initial_locations(FILE*);
  73 void read_action_verb_message_nr(FILE*);
  74 void read_conditions(FILE*);
  75 void read_hints(FILE*);
  76 void read_sound_text(FILE*);
  77 void write_0d(FILE*, FILE*, long, char*);
  78 void write_1d(FILE*, FILE*, long[], long, char*);
  79 void write_hints(FILE*, FILE*, long[][HINTLEN], long, long, char*);
  80 void write_files(FILE*, FILE*);
  81
  82 bool is_set(long var, long position)
  83 {
  84   long mask = 1l << position;
  85   bool result = (var & mask) == mask;
  86   return(result);
  87 }
  88
  89 long GETTXT(long SKIP,long ONEWRD, long UPPER) {
  90 /*  Take characters from an input line and pack them into 30-bit words.
  91  *  Skip says to skip leading blanks.  ONEWRD says stop if we come to a
  92  *  blank.  UPPER says to map all letters to uppercase.  If we reach the
  93  *  end of the line, the word is filled up with blanks (which encode as 0's).
  94  *  If we're already at end of line when GETTXT is called, we return -1. */
  95
  96   long TEXT;
  97   static long SPLITTING = -1;
  98
  99   if(LNPOSN != SPLITTING)
 100     SPLITTING = -1;
 101   TEXT= -1;
 102   while (true) {
 103     if(LNPOSN > LNLENG)
 104       return(TEXT);
 105     if((!SKIP) || INLINE[LNPOSN] != 0)
 106       break;
 107     LNPOSN=LNPOSN+1;
 108   }
 109
 110   TEXT=0;
 111   for (int I=1; I<=TOKLEN; I++) {
 112     TEXT=TEXT*64;
 113     if(LNPOSN > LNLENG || (ONEWRD && INLINE[LNPOSN] == 0))
 114       continue;
 115     char current=INLINE[LNPOSN];
 116     if(current < 63) {
 117       SPLITTING = -1;
 118       if(UPPER && current >= 37)
 119         current=current-26;
 120       TEXT=TEXT+current;
 121       LNPOSN=LNPOSN+1;
 122       continue;
 123     }
 124     if(SPLITTING != LNPOSN) {
 125       TEXT=TEXT+63;
 126       SPLITTING = LNPOSN;
 127       continue;
 128     }
 129
 130     TEXT=TEXT+current-63;
 131     SPLITTING = -1;
 132     LNPOSN=LNPOSN+1;
 133   }
 134
 135   return(TEXT);
 136 }
 137
 138 void BUG(long NUM) {
 139
 140 /*  The following conditions are currently considered fatal bugs.  Numbers < 20
 141  *  are detected while reading the database; the others occur at "run time".
 142  *      0       Message line > 70 characters
 143  *      1       Null line in message
 144  *      2       Too many words of messages
 145  *      3       Too many travel options
 146  *      4       Too many vocabulary words
 147  *      5       Required vocabulary word not found
 148  *      6       Too many RTEXT messages
 149  *      7       Too many hints
 150  *      8       Location has cond bit being set twice
 151  *      9       Invalid section number in database
 152  *      10      Too many locations
 153  *      11      Too many class or turn messages
 154  *      20      Special travel (500>L>300) exceeds goto list
 155  *      21      Ran off end of vocabulary table
 156  *      22      Vocabulary type (N/1000) not between 0 and 3
 157  *      23      Intransitive action verb exceeds goto list
 158  *      24      Transitive action verb exceeds goto list
 159  *      25      Conditional travel entry with no alternative
 160  *      26      Location has no travel entries
 161  *      27      Hint number exceeds goto list
 162  *      28      Invalid month returned by date function
 163  *      29      Too many parameters given to SETPRM */
 164
 165   fprintf(stderr, "Fatal error %ld.  See source code for interpretation.\n", NUM);
 166   exit(EXIT_FAILURE);
 167 }
 168
 169 void MAPLIN(FILE *OPENED) {
 170 /*  Read a line of input, from the specified input source,
 171  *  translate the chars to integers in the range 0-126 and store
 172  *  them in the common array "INLINE".  Integer values are as follows:
 173  *     0   = space [ASCII CODE 40 octal, 32 decimal]
 174  *    1-2  = !" [ASCII 41-42 octal, 33-34 decimal]
 175  *    3-10 = '()*+,-. [ASCII 47-56 octal, 39-46 decimal]
 176  *   11-36 = upper-case letters
 177  *   37-62 = lower-case letters
 178  *    63   = percent (%) [ASCII 45 octal, 37 decimal]
 179  *   64-73 = digits, 0 through 9
 180  *  Remaining characters can be translated any way that is convenient;
 181  *  The "TYPE" routine below is used to map them back to characters when
 182  *  necessary.  The above mappings are required so that certain special
 183  *  characters are known to fit in 6 bits and/or can be easily spotted.
 184  *  Array elements beyond the end of the line should be filled with 0,
 185  *  and LNLENG should be set to the index of the last character.
 186  *
 187  *  If the data file uses a character other than space (e.g., tab) to
 188  *  separate numbers, that character should also translate to 0.
 189  *
 190  *  This procedure may use the map1,map2 arrays to maintain static data for
 191  *  the mapping.  MAP2(1) is set to 0 when the program starts
 192  *  and is not changed thereafter unless the routines on this page choose
 193  *  to do so. */
 194
 195   do {
 196     fgets(INLINE + 1, sizeof(INLINE) - 1, OPENED);
 197   }
 198   while (!feof(OPENED) && INLINE[1] == '#');
 199
 200   LNLENG = 0;
 201   for (size_t i = 1; i <= sizeof(INLINE) && INLINE[i] != 0; ++i)
 202     {
 203       char val = INLINE[i];
 204       INLINE[i] = ascii_to_advent[(unsigned)val];
 205       if (INLINE[i] != 0)
 206         LNLENG = i;
 207     }
 208   LNPOSN = 1;
 209 }
 210
 211 long GETNUM(FILE *source) {
 212 /*  Obtain the next integer from an input line.  If K>0, we first read a
 213  *  new input line from a file; if K<0, we read a line from the keyboard;
 214  *  if K=0 we use a line that has already been read (and perhaps partially
 215  *  scanned).  If we're at the end of the line or encounter an illegal
 216  *  character (not a digit, hyphen, or blank), we return 0. */
 217
 218   long DIGIT, GETNUM, SIGN;
 219
 220   if(source != NULL) MAPLIN(source);
 221   GETNUM = 0;
 222
 223   while (INLINE[LNPOSN] == 0) {
 224     if (LNPOSN > LNLENG) return(GETNUM);
 225     ++LNPOSN;
 226   }
 227
 228   if(INLINE[LNPOSN] != 9)
 229     {
 230       SIGN=1;
 231     }
 232   else
 233     {
 234       SIGN= -1;
 235       LNPOSN=LNPOSN+1;
 236     }
 237   while (!(LNPOSN > LNLENG || INLINE[LNPOSN] == 0))
 238     {
 239       DIGIT=INLINE[LNPOSN]-64;
 240       if(DIGIT < 0 || DIGIT > 9)
 241         {
 242           GETNUM=0;
 243           break;
 244         }
 245       GETNUM=GETNUM*10+DIGIT;
 246       LNPOSN=LNPOSN+1;
 247     }
 248
 249   GETNUM=GETNUM*SIGN;
 250   LNPOSN=LNPOSN+1;
 251   return(GETNUM);
 252 }
 253
 254 int read_database(FILE* database) {
 255
 256 /*  Clear out the various text-pointer arrays.  All text is stored in array
 257  *  lines; each line is preceded by a word pointing to the next pointer (i.e.
 258  *  the word following the end of the line).  The pointer is negative if this is
 259  *  first line of a message.  The text-pointer arrays contain indices of
 260  *  pointer-words in lines.  STEXT(N) is short description of location N.
 261  *  LTEXT(N) is long description.  PTEXT(N) points to message for game.prop(N)=0.
 262  *  Successive prop messages are found by chasing pointers.  RTEXT contains
 263  *  section 6's stuff.  CTEXT(N) points to a player-class message.  TTEXT is for
 264  *  section 14.  We also clear COND (see description of section 9 for details). */
 265
 266   for (int I=1; I<=NOBJECTS; I++) {
 267     PTEXT[I] = 0;
 268     OBJSND[I] = 0;
 269     OBJTXT[I] = 0;
 270   }
 271   for (int I=1; I<=RTXSIZ; I++) {
 272     RTEXT[I] = 0;
 273   }
 274   for (int I=1; I<=CLSMAX; I++) {
 275     CTEXT[I] = 0;
 276   }
 277   for (int I=1; I<=LOCSIZ; I++) {
 278     STEXT[I] = 0;
 279     LTEXT[I] = 0;
 280     COND[I] = 0;
 281     KEY[I] = 0;
 282     LOCSND[I] = 0;
 283   }
 284
 285   LINUSE = 1;
 286   TRVS = 1;
 287   CLSSES = 0;
 288   TRNVLS = 0;
 289
 290 /*  Start new data section.  Sect is the section number. */
 291
 292   while(true)
 293     {
 294       long sect=GETNUM(database);
 295       OLDLOC= -1;
 296       switch (sect)
 297         {
 298           case 0: return(0);
 299           case 1: read_messages(database, sect); break;
 300           case 2: read_messages(database, sect); break;
 301           case 3: read_section3_stuff(database); break;
 302           case 4: read_vocabulary(database); break;
 303           case 5: read_messages(database, sect); break;
 304           case 6: read_messages(database, sect); break;
 305           case 7: read_initial_locations(database); break;
 306           case 8: read_action_verb_message_nr(database); break;
 307           case 9: read_conditions(database); break;
 308           case 10: read_messages(database, sect); break;
 309           case 11: read_hints(database); break;
 310           case 12: break;
 311           case 13: read_sound_text(database); break;
 312           case 14: read_messages(database, sect); break;
 313           default: BUG(9);
 314         }
 315     }
 316 }
 317
 318
 319 /*  Sections 1, 2, 5, 6, 10, 14.  Read messages and set up pointers. */
 320 void read_messages(FILE* database, long sect)
 321   {
 322     long KK=LINUSE;
 323     while(true)
 324       {
 325         long loc;
 326         LINUSE=KK;
 327         loc=GETNUM(database);
 328         if(LNLENG >= LNPOSN+70)BUG(0);
 329         if(loc == -1) return;
 330         if(LNLENG < LNPOSN)BUG(1);
 331         do {
 332             KK=KK+1;
 333             if(KK >= LINSIZ)BUG(2);
 334             LINES[KK]=GETTXT(false,false,false);
 335           }
 336         while(LINES[KK] != -1);
 337         LINES[LINUSE]=KK;
 338         if(loc == OLDLOC) continue;
 339         OLDLOC=loc;
 340         LINES[LINUSE]= -KK;
 341         if(sect == 14)
 342           {
 343             TRNVLS=TRNVLS+1;
 344             if(TRNVLS > TRNSIZ)BUG(11);
 345             TTEXT[TRNVLS]=LINUSE;
 346             TRNVAL[TRNVLS]=loc;
 347             continue;
 348           }
 349         if(sect == 10)
 350           {
 351             CLSSES=CLSSES+1;
 352             if(CLSSES > CLSMAX)BUG(11);
 353             CTEXT[CLSSES]=LINUSE;
 354             CVAL[CLSSES]=loc;
 355             continue;
 356           }
 357         if(sect == 6)
 358           {
 359             if(loc > RTXSIZ)BUG(6);
 360             RTEXT[loc]=LINUSE;
 361             continue;
 362           }
 363         if(sect == 5)
 364           {
 365             if(loc > 0 && loc <= NOBJECTS)PTEXT[loc]=LINUSE;
 366             continue;
 367           }
 368         if(loc > LOCSIZ)BUG(10);
 369         if(sect == 1)
 370           {
 371             LTEXT[loc]=LINUSE;
 372             continue;
 373           }
 374
 375         STEXT[loc]=LINUSE;
 376       }
 377   }
 378
 379
 380 /*  The stuff for section 3 is encoded here.  Each "from-location" gets a
 381  *  contiguous section of the "TRAVEL" array.  Each entry in travel is
 382  *  newloc*1000 + KEYWORD (from section 4, motion verbs), and is negated if
 383  *  this is the last entry for this location.  KEY(N) is the index in travel
 384  *  of the first option at location N. */
 385 void read_section3_stuff(FILE* database)
 386   {
 387     long loc;
 388     while((loc=GETNUM(database)) != -1)
 389       {
 390         long newloc=GETNUM(NULL);
 391         long L;
 392         if(KEY[loc] == 0)
 393           {
 394             KEY[loc]=TRVS;
 395           }
 396         else
 397           {
 398             TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
 399           }
 400         while((L=GETNUM(NULL)) != 0)
 401           {
 402             TRAVEL[TRVS]=newloc*1000+L;
 403             TRVS=TRVS+1;
 404             if(TRVS == TRVSIZ)BUG(3);
 405           }
 406         TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
 407       }
 408   }
 409
 410
 411 /*  Here we read in the vocabulary.  KTAB(N) is the word number, ATAB(N) is
 412  *  the corresponding word.  The -1 at the end of section 4 is left in KTAB
 413  *  as an end-marker. */
 414 void read_vocabulary(FILE* database)
 415   {
 416     for (TABNDX=1; TABNDX<=TABSIZ; TABNDX++)
 417       {
 418         KTAB[TABNDX]=GETNUM(database);
 419         if(KTAB[TABNDX] == -1) return;
 420         ATAB[TABNDX]=GETTXT(true,true,true);
 421       } /* end loop */
 422     BUG(4);
 423   }
 424
 425
 426 /*  Read in the initial locations for each object.  Also the immovability info.
 427  *  plac contains initial locations of objects.  FIXD is -1 for immovable
 428  *  objects (including the snake), or = second loc for two-placed objects. */
 429 void read_initial_locations(FILE* database)
 430   {
 431     long OBJ;
 432     while((OBJ=GETNUM(database)) != -1)
 433       {
 434         PLAC[OBJ]=GETNUM(NULL);
 435         FIXD[OBJ]=GETNUM(NULL);
 436       }
 437   }
 438
 439
 440 /*  Read default message numbers for action verbs, store in ACTSPK. */
 441 void read_action_verb_message_nr(FILE* database)
 442   {
 443     long verb;
 444     while((verb=GETNUM(database)) != -1)
 445       {
 446         ACTSPK[verb]=GETNUM(NULL);
 447       }
 448   }
 449
 450
 451 /*  Read info about available liquids and other conditions, store in COND. */
 452 void read_conditions(FILE* database)
 453   {
 454     long K;
 455     while((K=GETNUM(database)) != -1)
 456       {
 457         long loc;
 458         while((loc=GETNUM(NULL)) != 0)
 459           {
 460             if(is_set(COND[loc],K)) BUG(8);
 461             COND[loc]=COND[loc] + (1l << K);
 462           }
 463       }
 464   }
 465
 466
 467 /*  Read data for hints. */
 468 void read_hints(FILE* database)
 469   {
 470     long K;
 471     HNTMAX=0;
 472     while((K=GETNUM(database)) != -1)
 473       {
 474         if(K <= 0 || K > HNTSIZ)BUG(7);
 475         for (int I=1; I<=4; I++)
 476           {
 477             HINTS[K][I] =GETNUM(NULL);
 478           } /* end loop */
 479         HNTMAX=(HNTMAX>K ? HNTMAX : K);
 480       }
 481   }
 482
 483
 484 /*  Read the sound/text info, store in OBJSND, OBJTXT, LOCSND. */
 485 void read_sound_text(FILE* database)
 486   {
 487     long K;
 488     while((K=GETNUM(database)) != -1)
 489       {
 490         long KK=GETNUM(NULL);
 491         long I=GETNUM(NULL);
 492         if(I != 0)
 493           {
 494             OBJSND[K]=(KK>0 ? KK : 0);
 495             OBJTXT[K]=(I>0 ? I : 0);
 496             continue;
 497           }
 498
 499         LOCSND[K]=KK;
 500       }
 501   }
 502
 503 /*  Finish constructing internal data format */
 504
 505 /*  Having read in the database, certain things are now constructed.
 506  *  game.propS are set to zero.  We finish setting up COND by checking for
 507  *  forced-motion travel entries.  The PLAC and FIXD arrays are used
 508  *  to set up game.atloc(N) as the first object at location N, and
 509  *  game.link(OBJ) as the next object at the same location as OBJ.
 510  *  (OBJ>NOBJECTS indicates that game.fixed(OBJ-NOBJECTS)=LOC; game.link(OBJ) is
 511  *  still the correct link to use.)  game.abbrev is zeroed; it controls
 512  *  whether the abbreviated description is printed.  Counts modulo 5
 513  *  unless "LOOK" is used. */
 514
 515 void write_0d(FILE* c_file, FILE* header_file, long single, char* varname)
 516 {
 517   fprintf(c_file, "long %s = %ld;\n", varname, single);
 518   fprintf(header_file, "extern long %s;\n", varname);
 519 }
 520
 521 void write_1d(FILE* c_file, FILE* header_file, long array[], long dim, char* varname)
 522 {
 523   fprintf(c_file, "long %s[] = {\n", varname);
 524   for (int i = 0; i < dim; ++i)
 525     {
 526       if (i % 10 == 0)
 527         {
 528           if (i > 0)
 529             fprintf(c_file, "\n");
 530           fprintf(c_file, "  ");
 531         }
 532       fprintf(c_file, "%ld, ", array[i]);
 533     }
 534   fprintf(c_file, "\n};\n");
 535   fprintf(header_file, "extern long %s[%ld];\n", varname, dim);
 536 }
 537
 538 void write_hints(FILE* c_file, FILE* header_file, long matrix[][HINTLEN], long dim1, long dim2, char* varname)
 539 {
 540   fprintf(c_file, "long %s[][%ld] = {\n", varname, dim2);
 541   for (int i = 0; i < dim1; ++i)
 542     {
 543       fprintf(c_file, "  {");
 544       for (int j = 0; j < dim2; ++j)
 545         {
 546           fprintf(c_file, "%ld, ", matrix[i][j]);
 547         }
 548       fprintf(c_file, "},\n");
 549     }
 550   fprintf(c_file, "};\n");
 551   fprintf(header_file, "extern long %s[%ld][%ld];\n", varname, dim1, dim2);
 552 }
 553
 554 void write_files(FILE* c_file, FILE* header_file)
 555 {
 556   int i, MAXDIE;
 557   for (i=0; i<=4; i++) {
 558       long x = 2*i+81;
 559       if(RTEXT[x] != 0)
 560           MAXDIE=i+1;
 561   }
 562
 563   // preprocessor defines for the header
 564   fprintf(header_file, "#include \"common.h\"\n");
 565   fprintf(header_file, "#define TABSIZ 330\n");
 566   fprintf(header_file, "#define HNTSIZ 20\n");
 567   fprintf(header_file, "#define TOKLEN %d\n", TOKLEN);
 568   fprintf(header_file, "#define MAXDIE %d\n", MAXDIE);
 569   fprintf(header_file, "\n");
 570
 571   // include the header in the C file
 572   fprintf(c_file, "#include \"database.h\"\n");
 573   fprintf(c_file, "\n");
 574
 575   // content variables
 576   write_0d(c_file, header_file, TRNVLS, "TRNVLS");
 577   write_0d(c_file, header_file, HNTMAX, "HNTMAX");
 578   write_1d(c_file, header_file, OBJSND, NOBJECTS + 1, "OBJSND");
 579   write_1d(c_file, header_file, OBJTXT, NOBJECTS + 1, "OBJTXT");
 580   write_1d(c_file, header_file, COND, LOCSIZ + 1, "COND");
 581   write_1d(c_file, header_file, KEY, LOCSIZ + 1, "KEY");
 582   write_1d(c_file, header_file, LOCSND, LOCSIZ + 1, "LOCSND");
 583   write_1d(c_file, header_file, CVAL, CLSMAX + 1, "CVAL");
 584   write_1d(c_file, header_file, TRNVAL, TRNSIZ + 1, "TRNVAL");
 585   write_1d(c_file, header_file, TRAVEL, TRVSIZ + 1, "TRAVEL");
 586   write_1d(c_file, header_file, KTAB, TABSIZ + 1, "KTAB");
 587   write_1d(c_file, header_file, ATAB, TABSIZ + 1, "ATAB");
 588   write_1d(c_file, header_file, PLAC, NOBJECTS + 1, "PLAC");
 589   write_1d(c_file, header_file, FIXD, NOBJECTS + 1, "FIXD");
 590   write_1d(c_file, header_file, ACTSPK, VRBSIZ + 1, "ACTSPK");
 591   write_hints(c_file, header_file, HINTS, HNTSIZ + 1, 5, "HINTS");
 592 }
 593
 594 int main()
 595 {
 596   FILE* database = fopen("adventure.text", "r");
 597   read_database(database);
 598   fclose(database);
 599
 600   FILE* c_file = fopen("database.c", "w");
 601   FILE* header_file = fopen("database.h", "w");
 602   write_files(c_file, header_file);
 603   fclose(c_file);
 604   fclose(header_file);
 605
 606   return(EXIT_SUCCESS);
 607 }