dungeon.c

   1 /*
   2  * The dungeon compiler. Turns adventure.text into a set of C initializers
   3  * defining invariant state.
   4  */
   5
   6 /*  Current limits:
   7  *     12600 words of message text (LINES, LINSIZ).
   8  *      885 travel options (TRAVEL, TRVSIZ).
   9  *      330 vocabulary words (KTAB, ATAB, TABSIZ).
  10  *       35 "action" verbs (ACTSPK, VRBSIZ).
  11  *  There are also limits which cannot be exceeded due to the structure of
  12  *  the database.  (E.G., The vocabulary uses n/1000 to determine word type,
  13  *  so there can't be more than 1000 words.)  These upper limits are:
  14  *      1000 non-synonymous vocabulary words
  15  *      300 locations
  16  *      100 objects
  17  */
  18
  19 /*  Description of the database format
  20  *
  21  *
  22  *  The data file contains several sections.  Each begins with a line containing
  23  *  a number identifying the section, and ends with a line containing "-1".
  24  *
  25  *  Section 3: Travel table.  Each line contains a location number (X), a second
  26  *      location number (Y), and a list of motion numbers (see section 4).
  27  *      each motion represents a verb which will go to Y if currently at X.
  28  *      Y, in turn, is interpreted as follows.  Let M=Y/1000, N=Y mod 1000.
  29  *              If N<=300       it is the location to go to.
  30  *              If 300<N<=500   N-300 is used in a computed goto to
  31  *                                      a section of special code.
  32  *              If N>500        message N-500 from section 6 is printed,
  33  *                                      and he stays wherever he is.
  34  *      Meanwhile, M specifies the conditions on the motion.
  35  *              If M=0          it's unconditional.
  36  *              If 0<M<100      it is done with M% probability.
  37  *              If M=100        unconditional, but forbidden to dwarves.
  38  *              If 100<M<=200   he must be carrying object M-100.
  39  *              If 200<M<=300   must be carrying or in same room as M-200.
  40  *              If 300<M<=400   game.prop(M % 100) must *not* be 0.
  41  *              If 400<M<=500   game.prop(M % 100) must *not* be 1.
  42  *              If 500<M<=600   game.prop(M % 100) must *not* be 2, etc.
  43  *      If the condition (if any) is not met, then the next *different*
  44  *      "destination" value is used (unless it fails to meet *its* conditions,
  45  *      in which case the next is found, etc.).  Typically, the next dest will
  46  *      be for one of the same verbs, so that its only use is as the alternate
  47  *      destination for those verbs.  For instance:
  48  *              15      110022  29      31      34      35      23      43
  49  *              15      14      29
  50  *      This says that, from loc 15, any of the verbs 29, 31, etc., will take
  51  *      him to 22 if he's carrying object 10, and otherwise will go to 14.
  52  *              11      303008  49
  53  *              11      9       50
  54  *      This says that, from 11, 49 takes him to 8 unless game.prop(3)=0, in which
  55  *      case he goes to 9.  Verb 50 takes him to 9 regardless of game.prop(3).
  56  *  Section 4: Vocabulary.  Each line contains a number (n), a tab, and a
  57  *      five-letter word.  Call M=N/1000.  If M=0, then the word is a motion
  58  *      verb for use in travelling (see section 3).  Else, if M=1, the word is
  59  *      an object.  Else, if M=2, the word is an action verb (such as "carry"
  60  *      or "attack").  Else, if M=3, the word is a special case verb (such as
  61  *      "dig") and N % 1000 is an index into section 6.  Objects from 50 to
  62  *      (currently, anyway) 79 are considered treasures (for pirate, closeout).
  63  *  Section 7: Object locations.  Each line contains an object number and its
  64  *      initial location (zero (or omitted) if none).  If the object is
  65  *      immovable, the location is followed by a "-1".  If it has two locations
  66  *      (e.g. the grate) the first location is followed with the second, and
  67  *      the object is assumed to be immovable.
  68  *  Section 8: Action defaults.  Each line contains an "action-verb" number and
  69  *      the index (in section 6) of the default message for the verb.
  70  *  Section 0: End of database.
  71  *
  72  * Other sections are obsolete and ignored */
  73
  74 #define LINESIZE 100
  75 #define CLSMAX 12
  76 #define LINSIZ 12600
  77 #define TRNSIZ 5
  78 #define TABSIZ 330
  79 #define VRBSIZ 35
  80 #define TRVSIZ 885
  81 #define TOKLEN 5
  82
  83 #include <stdio.h>
  84 #include <stdlib.h>
  85 #include <stdbool.h>
  86 #include <unistd.h>
  87 #include <string.h>
  88 #include "newdb.h"
  89 #include "common.h"
  90
  91 // Global variables for use in functions below that can gradually disappear as code is cleaned up
  92 static long LNLENG;
  93 static long LNPOSN;
  94 static char INLINE[LINESIZE + 1];
  95 static long OLDLOC;
  96 static long LINUSE;
  97
  98 // Storage for what comes out of the database
  99 long TRVS;
 100 long TRNVLS;
 101 long TABNDX;
 102 long KEY[NLOCATIONS + 1];
 103 long LINES[LINSIZ + 1];
 104 long TRAVEL[TRVSIZ + 1];
 105 long KTAB[TABSIZ + 1];
 106 long ATAB[TABSIZ + 1];
 107 long PLAC[NOBJECTS + 1];
 108 long FIXD[NOBJECTS + 1];
 109 long ACTSPK[VRBSIZ + 1];
 110
 111 static long GETTXT(long SKIP, long ONEWRD, long UPPER)
 112 {
 113     /*  Take characters from an input line and pack them into 30-bit words.
 114      *  Skip says to skip leading blanks.  ONEWRD says stop if we come to a
 115      *  blank.  UPPER says to map all letters to uppercase.  If we reach the
 116      *  end of the line, the word is filled up with blanks (which encode as 0's).
 117      *  If we're already at end of line when GETTXT is called, we return -1. */
 118
 119     long TEXT;
 120     static long SPLITTING = -1;
 121
 122     if (LNPOSN != SPLITTING)
 123         SPLITTING = -1;
 124     TEXT = -1;
 125     while (true) {
 126         if (LNPOSN > LNLENG)
 127             return (TEXT);
 128         if ((!SKIP) || INLINE[LNPOSN] != 0)
 129             break;
 130         LNPOSN = LNPOSN + 1;
 131     }
 132
 133     TEXT = 0;
 134     for (int I = 1; I <= TOKLEN; I++) {
 135         TEXT = TEXT * 64;
 136         if (LNPOSN > LNLENG || (ONEWRD && INLINE[LNPOSN] == 0))
 137             continue;
 138         char current = INLINE[LNPOSN];
 139         if (current < 63) {
 140             SPLITTING = -1;
 141             if (UPPER && current >= 37)
 142                 current = current - 26;
 143             TEXT = TEXT + current;
 144             LNPOSN = LNPOSN + 1;
 145             continue;
 146         }
 147         if (SPLITTING != LNPOSN) {
 148             TEXT = TEXT + 63;
 149             SPLITTING = LNPOSN;
 150             continue;
 151         }
 152
 153         TEXT = TEXT + current - 63;
 154         SPLITTING = -1;
 155         LNPOSN = LNPOSN + 1;
 156     }
 157
 158     return (TEXT);
 159 }
 160
 161 static void MAPLIN(FILE *OPENED)
 162 {
 163     /*  Read a line of input, from the specified input source,
 164      *  translate the chars to integers in the range 0-126 and store
 165      *  them in the common array "INLINE".  Integer values are as follows:
 166      *     0   = space [ASCII CODE 40 octal, 32 decimal]
 167      *    1-2  = !" [ASCII 41-42 octal, 33-34 decimal]
 168      *    3-10 = '()*+,-. [ASCII 47-56 octal, 39-46 decimal]
 169      *   11-36 = upper-case letters
 170      *   37-62 = lower-case letters
 171      *    63   = percent (%) [ASCII 45 octal, 37 decimal]
 172      *   64-73 = digits, 0 through 9
 173      *  Remaining characters can be translated any way that is convenient;
 174      *  The "TYPE" routine below is used to map them back to characters when
 175      *  necessary.  The above mappings are required so that certain special
 176      *  characters are known to fit in 6 bits and/or can be easily spotted.
 177      *  Array elements beyond the end of the line should be filled with 0,
 178      *  and LNLENG should be set to the index of the last character.
 179      *
 180      *  If the data file uses a character other than space (e.g., tab) to
 181      *  separate numbers, that character should also translate to 0.
 182      *
 183      *  This procedure may use the map1,map2 arrays to maintain static data for
 184      *  the mapping.  MAP2(1) is set to 0 when the program starts
 185      *  and is not changed thereafter unless the routines on this page choose
 186      *  to do so. */
 187
 188     do {
 189         if (NULL == fgets(INLINE + 1, sizeof(INLINE) - 1, OPENED)) {
 190             printf("Failed fgets()\n");
 191         }
 192     } while (!feof(OPENED) && INLINE[1] == '#');
 193
 194     LNLENG = 0;
 195     for (size_t i = 1; i < sizeof(INLINE) && INLINE[i] != 0; ++i) {
 196         char val = INLINE[i];
 197         INLINE[i] = ascii_to_advent[(unsigned)val];
 198         if (INLINE[i] != 0)
 199             LNLENG = i;
 200     }
 201     LNPOSN = 1;
 202 }
 203
 204 static long GETNUM(FILE *source)
 205 {
 206     /*  Obtain the next integer from an input line.  If K>0, we first read a
 207      *  new input line from a file; if K<0, we read a line from the keyboard;
 208      *  if K=0 we use a line that has already been read (and perhaps partially
 209      *  scanned).  If we're at the end of the line or encounter an illegal
 210      *  character (not a digit, hyphen, or blank), we return 0. */
 211
 212     long DIGIT, GETNUM, SIGN;
 213
 214     if (source != NULL) MAPLIN(source);
 215     GETNUM = 0;
 216
 217     while (INLINE[LNPOSN] == 0) {
 218         if (LNPOSN > LNLENG) return (GETNUM);
 219         ++LNPOSN;
 220     }
 221
 222     if (INLINE[LNPOSN] != 9) {
 223         SIGN = 1;
 224     } else {
 225         SIGN = -1;
 226         LNPOSN = LNPOSN + 1;
 227     }
 228     while (!(LNPOSN > LNLENG || INLINE[LNPOSN] == 0)) {
 229         DIGIT = INLINE[LNPOSN] - 64;
 230         if (DIGIT < 0 || DIGIT > 9) {
 231             GETNUM = 0;
 232             break;
 233         }
 234         GETNUM = GETNUM * 10 + DIGIT;
 235         LNPOSN = LNPOSN + 1;
 236     }
 237
 238     GETNUM = GETNUM * SIGN;
 239     LNPOSN = LNPOSN + 1;
 240     return (GETNUM);
 241 }
 242
 243 /*  Sections 1, 2, 5, 6, 10, 14.  Skip these, they're all in YAML now. */
 244 static void read_messages(FILE* database, long sect)
 245 {
 246     long KK = LINUSE;
 247     while (true) {
 248         do {
 249             if (NULL == fgets(INLINE + 1, sizeof(INLINE) - 1, database)) {
 250                 printf("Failed fgets()\n");
 251             }
 252         } while (!feof(database) && INLINE[1] == '#');
 253         if (strncmp(INLINE + 1, "-1\n", 3) == 0)
 254             break;
 255     }
 256 }
 257
 258 /*  The stuff for section 3 is encoded here.  Each "from-location" gets a
 259  *  contiguous section of the "TRAVEL" array.  Each entry in travel is
 260  *  newloc*1000 + KEYWORD (from section 4, motion verbs), and is negated if
 261  *  this is the last entry for this location.  KEY(N) is the index in travel
 262  *  of the first option at location N. */
 263 static void read_section3_stuff(FILE* database)
 264 {
 265     long loc;
 266     while ((loc = GETNUM(database)) != -1) {
 267         long newloc = GETNUM(NULL);
 268         long L;
 269         if (KEY[loc] == 0) {
 270             KEY[loc] = TRVS;
 271         } else {
 272             TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
 273         }
 274         while ((L = GETNUM(NULL)) != 0) {
 275             TRAVEL[TRVS] = newloc * 1000 + L;
 276             TRVS = TRVS + 1;
 277             if (TRVS == TRVSIZ)
 278                 BUG(TOO_MANY_TRAVEL_OPTIONS);
 279         }
 280         TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
 281     }
 282 }
 283
 284 /*  Here we read in the vocabulary.  KTAB(N) is the word number, ATAB(N) is
 285  *  the corresponding word.  The -1 at the end of section 4 is left in KTAB
 286  *  as an end-marker. */
 287 static void read_vocabulary(FILE* database)
 288 {
 289     for (TABNDX = 1; TABNDX <= TABSIZ; TABNDX++) {
 290         KTAB[TABNDX] = GETNUM(database);
 291         if (KTAB[TABNDX] == -1) return;
 292         ATAB[TABNDX] = GETTXT(true, true, true);
 293     } /* end loop */
 294     BUG(TOO_MANY_VOCABULARY_WORDS);
 295 }
 296
 297 /*  Read in the initial locations for each object.  Also the immovability info.
 298  *  plac contains initial locations of objects.  FIXD is -1 for immovable
 299  *  objects (including the snake), or = second loc for two-placed objects. */
 300 static void read_initial_locations(FILE* database)
 301 {
 302     long OBJ;
 303     while ((OBJ = GETNUM(database)) != -1) {
 304         PLAC[OBJ] = GETNUM(NULL);
 305         FIXD[OBJ] = GETNUM(NULL);
 306     }
 307 }
 308
 309 /*  Read default message numbers for action verbs, store in ACTSPK. */
 310 static void read_action_verb_message_nr(FILE* database)
 311 {
 312     long verb;
 313     while ((verb = GETNUM(database)) != -1) {
 314         ACTSPK[verb] = GETNUM(NULL);
 315     }
 316 }
 317
 318 /*  Read info about available liquids and other conditions. */
 319 static void read_conditions(FILE* database)
 320 {
 321     long K;
 322     while ((K = GETNUM(database)) != -1) {
 323         long loc;
 324         while ((loc = GETNUM(NULL)) != 0) {
 325             continue;   /* COND is no longer used */
 326         }
 327     }
 328 }
 329
 330
 331 /*  Read data for hints. */
 332 static void read_hints(FILE* database)
 333 {
 334     long K;
 335     while ((K = GETNUM(database)) != -1) {
 336         for (int I = 1; I <= 4; I++) {
 337             /* consume - actual array-building now done in YAML. */
 338             GETNUM(NULL);
 339         } /* end loop */
 340     }
 341 }
 342
 343 /*  Read the sound/text info */
 344 static void read_sound_text(FILE* database)
 345 {
 346     long K;
 347     while ((K = GETNUM(database)) != -1) {
 348         long KK = GETNUM(NULL);
 349         long I = GETNUM(NULL);
 350         /* this stuff is in YAML now */
 351     }
 352 }
 353
 354
 355 static int read_database(FILE* database)
 356 {
 357     /*  Clear out the various text-pointer arrays.  All text is stored
 358      *  in array lines; each line is preceded by a word pointing to
 359      *  the next pointer (i.e.  the word following the end of the
 360      *  line).  The pointer is negative if this is first line of a
 361      *  message.  The text-pointer arrays contain indices of
 362      *  pointer-words in lines. PTEXT(N) points to
 363      *  message for game.prop(N)=0.  Successive prop messages are
 364      *  found by chasing pointers. */
 365     for (int I = 1; I <= NLOCATIONS; I++) {
 366         KEY[I] = 0;
 367     }
 368
 369     LINUSE = 1;
 370     TRVS = 1;
 371     TRNVLS = 0;
 372
 373     /*  Start new data section.  Sect is the section number. */
 374
 375     while (true) {
 376         long sect = GETNUM(database);
 377         OLDLOC = -1;
 378         switch (sect) {
 379         case 0:
 380             return (0);
 381         case 1:
 382             read_messages(database, sect);
 383             break;
 384         case 2:
 385             read_messages(database, sect);
 386             break;
 387         case 3:
 388             read_section3_stuff(database);
 389             break;
 390         case 4:
 391             read_vocabulary(database);
 392             break;
 393         case 5:
 394             read_messages(database, sect);
 395             break;
 396         case 6:
 397             read_messages(database, sect);
 398             break;
 399         case 7:
 400             read_initial_locations(database);
 401             break;
 402         case 8:
 403             read_action_verb_message_nr(database);
 404             break;
 405         case 9:
 406             read_conditions(database);
 407             break;
 408         case 10:
 409             read_messages(database, sect);
 410             break;
 411         case 11:
 412             read_hints(database);
 413             break;
 414         case 12:
 415             break;
 416         case 13:
 417             read_sound_text(database);
 418             break;
 419         case 14:
 420             read_messages(database, sect);
 421             break;
 422         default:
 423             BUG(INVALID_SECTION_NUMBER_IN_DATABASE);
 424         }
 425     }
 426 }
 427
 428 /*  Finish constructing internal data format */
 429
 430 /*  Having read in the database, certain things are now constructed.
 431  *  game.propS are set to zero.    The PLAC and FIXD arrays are used
 432  *  to set up game.atloc(N) as the first object at location N, and
 433  *  game.link(OBJ) as the next object at the same location as OBJ.
 434  *  (OBJ>NOBJECTS indicates that game.fixed(OBJ-NOBJECTS)=LOC; game.link(OBJ) is
 435  *  still the correct link to use.)  game.abbrev is zeroed; it controls
 436  *  whether the abbreviated description is printed.  Counts modulo 5
 437  *  unless "LOOK" is used. */
 438
 439 static void write_1d(FILE* header_file, long array[], long dim, const char* varname)
 440 {
 441     fprintf(header_file, "LOCATION long %s[] INITIALIZE(= {\n", varname);
 442     for (int i = 0; i < dim; ++i) {
 443         if (i % 10 == 0) {
 444             if (i > 0)
 445                 fprintf(header_file, "\n");
 446             fprintf(header_file, "  ");
 447         }
 448         fprintf(header_file, "%ld, ", array[i]);
 449     }
 450     fprintf(header_file, "\n});\n");
 451 }
 452
 453 static void write_file(FILE* header_file)
 454 {
 455     fprintf(header_file, "#ifndef DATABASE_H\n");
 456     fprintf(header_file, "#define DATABASE_H\n");
 457     fprintf(header_file, "\n");
 458
 459     fprintf(header_file, "#include \"common.h\"\n");
 460     fprintf(header_file, "#define TABSIZ 330\n");
 461     fprintf(header_file, "#define TOKLEN %d\n", TOKLEN);
 462     fprintf(header_file, "\n");
 463
 464     fprintf(header_file, "\n");
 465     fprintf(header_file, "#ifdef DEFINE_GLOBALS_FROM_INCLUDES\n");
 466     fprintf(header_file, "#define LOCATION\n");
 467     fprintf(header_file, "#define INITIALIZE(...) __VA_ARGS__\n");
 468     fprintf(header_file, "#else\n");
 469     fprintf(header_file, "#define LOCATION extern\n");
 470     fprintf(header_file, "#define INITIALIZE(...)\n");
 471     fprintf(header_file, "#endif\n");
 472     fprintf(header_file, "\n");
 473
 474     // content variables
 475     write_1d(header_file, KEY, NLOCATIONS + 1, "KEY");
 476     write_1d(header_file, TRAVEL, TRVSIZ + 1, "TRAVEL");
 477     write_1d(header_file, KTAB, TABSIZ + 1, "KTAB");
 478     write_1d(header_file, ATAB, TABSIZ + 1, "ATAB");
 479     write_1d(header_file, PLAC, NOBJECTS + 1, "PLAC");
 480     write_1d(header_file, FIXD, NOBJECTS + 1, "FIXD");
 481     write_1d(header_file, ACTSPK, VRBSIZ + 1, "ACTSPK");
 482
 483     fprintf(header_file, "#undef LOCATION\n");
 484     fprintf(header_file, "#undef INITIALIZE\n");
 485     fprintf(header_file, "#endif\n");
 486 }
 487
 488 void bug(enum bugtype num, const char *error_string)
 489 {
 490     fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
 491     exit(EXIT_FAILURE);
 492 }
 493
 494 int main(void)
 495 {
 496     FILE* database = fopen("adventure.text", "r");
 497     read_database(database);
 498     fclose(database);
 499
 500     FILE* header_file = fopen("database.h", "w");
 501     write_file(header_file);
 502     fclose(header_file);
 503
 504     return (EXIT_SUCCESS);
 505 }