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