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