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
24 /* hard limit, will be propagated to database.h */
27 // Global variables for use in functions below that can gradually disappear as code is cleaned up
30 static char INLINE[LINESIZE+1];
33 // Storage for what comes out of the database
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];
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];
63 static bool is_set(long var, long position)
65 long mask = 1l << position;
66 bool result = (var & mask) == mask;
70 static long GETTXT(long SKIP,long ONEWRD, long UPPER)
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. */
79 static long SPLITTING = -1;
81 if(LNPOSN != SPLITTING)
87 if((!SKIP) || INLINE[LNPOSN] != 0)
93 for (int I=1; I<=TOKLEN; I++) {
95 if(LNPOSN > LNLENG || (ONEWRD && INLINE[LNPOSN] == 0))
97 char current=INLINE[LNPOSN];
100 if(UPPER && current >= 37)
106 if(SPLITTING != LNPOSN) {
112 TEXT=TEXT+current-63;
120 static void BUG(long NUM) {
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
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 */
147 fprintf(stderr, "Fatal error %ld. See source code for interpretation.\n", NUM);
151 static void MAPLIN(FILE *OPENED) {
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.
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.
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
179 if (NULL == fgets(INLINE + 1, sizeof(INLINE) - 1, OPENED)) {
180 printf("Failed fgets()\n");
183 while (!feof(OPENED) && INLINE[1] == '#');
186 for (i = 1; i < sizeof(INLINE) && INLINE[i] != 0; ++i)
188 char val = INLINE[i];
189 INLINE[i] = ascii_to_advent[(unsigned)val];
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. */
203 long DIGIT, GETNUM, SIGN;
205 if(source != NULL) MAPLIN(source);
208 while (INLINE[LNPOSN] == 0) {
209 if (LNPOSN > LNLENG) return(GETNUM);
213 if(INLINE[LNPOSN] != 9)
222 while (!(LNPOSN > LNLENG || INLINE[LNPOSN] == 0))
224 DIGIT=INLINE[LNPOSN]-64;
225 if(DIGIT < 0 || DIGIT > 9)
230 GETNUM=GETNUM*10+DIGIT;
239 /* Sections 1, 2, 5, 6, 10, 14. Read messages and set up pointers. */
240 static void read_messages(FILE* database, long sect)
247 loc=GETNUM(database);
248 if(LNLENG >= LNPOSN+70)BUG(0);
249 if(loc == -1) return;
250 if(LNLENG < LNPOSN)BUG(1);
253 if(KK >= LINSIZ)BUG(2);
254 LINES[KK]=GETTXT(false,false,false);
256 while(LINES[KK] != -1);
258 if(loc == OLDLOC) continue;
264 if(TRNVLS > TRNSIZ)BUG(11);
265 TTEXT[TRNVLS]=LINUSE;
272 if(CLSSES > CLSMAX)BUG(11);
273 CTEXT[CLSSES]=LINUSE;
279 if(loc > RTXSIZ)BUG(6);
285 if(loc > 0 && loc <= NOBJECTS)PTEXT[loc]=LINUSE;
288 if(loc > LOCSIZ)BUG(10);
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)
307 while((loc=GETNUM(database)) != -1)
309 long newloc=GETNUM(NULL);
317 TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
319 while((L=GETNUM(NULL)) != 0)
321 TRAVEL[TRVS]=newloc*1000+L;
323 if(TRVS == TRVSIZ)BUG(3);
325 TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
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)
334 for (TABNDX=1; TABNDX<=TABSIZ; TABNDX++)
336 KTAB[TABNDX]=GETNUM(database);
337 if(KTAB[TABNDX] == -1) return;
338 ATAB[TABNDX]=GETTXT(true,true,true);
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)
349 while((OBJ=GETNUM(database)) != -1)
351 PLAC[OBJ]=GETNUM(NULL);
352 FIXD[OBJ]=GETNUM(NULL);
356 /* Read default message numbers for action verbs, store in ACTSPK. */
357 static void read_action_verb_message_nr(FILE* database)
360 while((verb=GETNUM(database)) != -1)
362 ACTSPK[verb]=GETNUM(NULL);
366 /* Read info about available liquids and other conditions, store in COND. */
367 static void read_conditions(FILE* database)
370 while((K=GETNUM(database)) != -1)
373 while((loc=GETNUM(NULL)) != 0)
375 if(is_set(COND[loc],K)) BUG(8);
376 COND[loc]=COND[loc] + (1l << K);
382 /* Read data for hints. */
383 static void read_hints(FILE* database)
387 while((K=GETNUM(database)) != -1)
389 if(K <= 0 || K > HNTSIZ)BUG(7);
390 for (int I=1; I<=4; I++)
392 HINTS[K][I] =GETNUM(NULL);
394 HNTMAX=(HNTMAX>K ? HNTMAX : K);
398 /* Read the sound/text info, store in OBJSND, OBJTXT, LOCSND. */
399 static void read_sound_text(FILE* database)
402 while((K=GETNUM(database)) != -1)
404 long KK=GETNUM(NULL);
408 OBJSND[K]=(KK>0 ? KK : 0);
409 OBJTXT[K]=(I>0 ? I : 0);
418 static int read_database(FILE* database) {
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). */
430 for (int I=1; I<=NOBJECTS; I++) {
435 for (int I=1; I<=RTXSIZ; I++) {
438 for (int I=1; I<=CLSMAX; I++) {
441 for (int I=1; I<=LOCSIZ; I++) {
454 /* Start new data section. Sect is the section number. */
458 long sect=GETNUM(database);
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;
475 case 13: read_sound_text(database); break;
476 case 14: read_messages(database, sect); break;
482 /* Finish constructing internal data format */
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. */
494 static void write_0d(FILE* header_file, long single, char* varname)
496 fprintf(header_file, "LOCATION long %s INITIALIZE(= %ld);\n", varname, single);
499 static void write_1d(FILE* header_file, long array[], long dim, char* varname)
501 fprintf(header_file, "LOCATION long %s[] INITIALIZE(= {\n", varname);
502 for (int i = 0; i < dim; ++i)
507 fprintf(header_file, "\n");
508 fprintf(header_file, " ");
510 fprintf(header_file, "%ld, ", array[i]);
512 fprintf(header_file, "\n});\n");
515 static void write_hints(FILE* header_file, long matrix[][HINTLEN], long dim1, long dim2, char* varname)
517 fprintf(header_file, "LOCATION long %s[][%ld] INITIALIZE(= {\n", varname, dim2);
518 for (int i = 0; i < dim1; ++i)
520 fprintf(header_file, " {");
521 for (int j = 0; j < dim2; ++j)
523 fprintf(header_file, "%ld, ", matrix[i][j]);
525 fprintf(header_file, "},\n");
527 fprintf(header_file, "});\n");
530 static void write_file(FILE* header_file)
533 for (i=0; i<=4; i++) {
540 fprintf(header_file, "#ifndef DATABASE_H\n");
541 fprintf(header_file, "#define DATABASE_H\n");
542 fprintf(header_file, "\n");
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");
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");
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");
579 fprintf(header_file, "#undef LOCATION\n");
580 fprintf(header_file, "#undef INITIALIZE\n");
581 fprintf(header_file, "#endif\n");
586 FILE* database = fopen("adventure.text", "r");
587 read_database(database);
590 FILE* header_file = fopen("database.h", "w");
591 write_file(header_file);
594 return(EXIT_SUCCESS);