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 // Global variables for use in functions below that can gradually disappear as code is cleaned up
27 static char INLINE[LINESIZE+1];
30 // Storage for what comes out of the database
37 long PTEXT[NOBJECTS+1];
38 long RTEXT[RTXSIZ + 1];
39 long CTEXT[CLSMAX + 1];
40 long OBJSND[NOBJECTS+1];
41 long OBJTXT[NOBJECTS+1];
42 long STEXT[LOCSIZ + 1];
43 long LTEXT[LOCSIZ + 1];
44 long COND[LOCSIZ + 1];
46 long LOCSND[LOCSIZ + 1];
47 long LINES[LINSIZ + 1];
48 long CVAL[CLSMAX + 1];
49 long TTEXT[TRNSIZ + 1];
50 long TRNVAL[TRNSIZ + 1];
51 long TRAVEL[TRVSIZ + 1];
52 long KTAB[TABSIZ + 1];
53 long ATAB[TABSIZ + 1];
54 long PLAC[NOBJECTS+1];
55 long FIXD[NOBJECTS+1];
56 long ACTSPK[VRBSIZ + 1];
57 long HINTS[HNTSIZ + 1][HINTLEN];
60 static bool is_set(long var, long position)
62 long mask = 1l << position;
63 bool result = (var & mask) == mask;
67 static long GETTXT(long SKIP,long ONEWRD, long UPPER)
69 /* Take characters from an input line and pack them into 30-bit words.
70 * Skip says to skip leading blanks. ONEWRD says stop if we come to a
71 * blank. UPPER says to map all letters to uppercase. If we reach the
72 * end of the line, the word is filled up with blanks (which encode as 0's).
73 * If we're already at end of line when GETTXT is called, we return -1. */
76 static long SPLITTING = -1;
78 if(LNPOSN != SPLITTING)
84 if((!SKIP) || INLINE[LNPOSN] != 0)
90 for (int I=1; I<=TOKLEN; I++) {
92 if(LNPOSN > LNLENG || (ONEWRD && INLINE[LNPOSN] == 0))
94 char current=INLINE[LNPOSN];
97 if(UPPER && current >= 37)
103 if(SPLITTING != LNPOSN) {
109 TEXT=TEXT+current-63;
117 static void BUG(long NUM) {
119 /* The following conditions are currently considered fatal bugs. Numbers < 20
120 * are detected while reading the database; the others occur at "run time".
121 * 0 Message line > 70 characters
122 * 1 Null line in message
123 * 2 Too many words of messages
124 * 3 Too many travel options
125 * 4 Too many vocabulary words
126 * 5 Required vocabulary word not found
127 * 6 Too many RTEXT messages
129 * 8 Location has cond bit being set twice
130 * 9 Invalid section number in database
131 * 10 Too many locations
132 * 11 Too many class or turn messages
133 * 20 Special travel (500>L>300) exceeds goto list
134 * 21 Ran off end of vocabulary table
135 * 22 Vocabulary type (N/1000) not between 0 and 3
136 * 23 Intransitive action verb exceeds goto list
137 * 24 Transitive action verb exceeds goto list
138 * 25 Conditional travel entry with no alternative
139 * 26 Location has no travel entries
140 * 27 Hint number exceeds goto list
141 * 28 Invalid month returned by date function
142 * 29 Too many parameters given to SETPRM */
144 fprintf(stderr, "Fatal error %ld. See source code for interpretation.\n", NUM);
148 static void MAPLIN(FILE *OPENED) {
149 /* Read a line of input, from the specified input source,
150 * translate the chars to integers in the range 0-126 and store
151 * them in the common array "INLINE". Integer values are as follows:
152 * 0 = space [ASCII CODE 40 octal, 32 decimal]
153 * 1-2 = !" [ASCII 41-42 octal, 33-34 decimal]
154 * 3-10 = '()*+,-. [ASCII 47-56 octal, 39-46 decimal]
155 * 11-36 = upper-case letters
156 * 37-62 = lower-case letters
157 * 63 = percent (%) [ASCII 45 octal, 37 decimal]
158 * 64-73 = digits, 0 through 9
159 * Remaining characters can be translated any way that is convenient;
160 * The "TYPE" routine below is used to map them back to characters when
161 * necessary. The above mappings are required so that certain special
162 * characters are known to fit in 6 bits and/or can be easily spotted.
163 * Array elements beyond the end of the line should be filled with 0,
164 * and LNLENG should be set to the index of the last character.
166 * If the data file uses a character other than space (e.g., tab) to
167 * separate numbers, that character should also translate to 0.
169 * This procedure may use the map1,map2 arrays to maintain static data for
170 * the mapping. MAP2(1) is set to 0 when the program starts
171 * and is not changed thereafter unless the routines on this page choose
175 if (NULL == fgets(INLINE + 1, sizeof(INLINE) - 1, OPENED)) {
176 printf("Failed fgets()\n");
179 while (!feof(OPENED) && INLINE[1] == '#');
182 for (size_t i = 1; i < sizeof(INLINE) && INLINE[i] != 0; ++i)
184 char val = INLINE[i];
185 INLINE[i] = ascii_to_advent[(unsigned)val];
192 static long GETNUM(FILE *source) {
193 /* Obtain the next integer from an input line. If K>0, we first read a
194 * new input line from a file; if K<0, we read a line from the keyboard;
195 * if K=0 we use a line that has already been read (and perhaps partially
196 * scanned). If we're at the end of the line or encounter an illegal
197 * character (not a digit, hyphen, or blank), we return 0. */
199 long DIGIT, GETNUM, SIGN;
201 if(source != NULL) MAPLIN(source);
204 while (INLINE[LNPOSN] == 0) {
205 if (LNPOSN > LNLENG) return(GETNUM);
209 if(INLINE[LNPOSN] != 9)
218 while (!(LNPOSN > LNLENG || INLINE[LNPOSN] == 0))
220 DIGIT=INLINE[LNPOSN]-64;
221 if(DIGIT < 0 || DIGIT > 9)
226 GETNUM=GETNUM*10+DIGIT;
235 /* Sections 1, 2, 5, 6, 10, 14. Read messages and set up pointers. */
236 static void read_messages(FILE* database, long sect)
243 loc=GETNUM(database);
244 if(LNLENG >= LNPOSN+70)BUG(0);
245 if(loc == -1) return;
246 if(LNLENG < LNPOSN)BUG(1);
249 if(KK >= LINSIZ)BUG(2);
250 LINES[KK]=GETTXT(false,false,false);
252 while(LINES[KK] != -1);
254 if(loc == OLDLOC) continue;
260 if(TRNVLS > TRNSIZ)BUG(11);
261 TTEXT[TRNVLS]=LINUSE;
268 if(CLSSES > CLSMAX)BUG(11);
269 CTEXT[CLSSES]=LINUSE;
275 if(loc > RTXSIZ)BUG(6);
281 if(loc > 0 && loc <= NOBJECTS)PTEXT[loc]=LINUSE;
284 if(loc > LOCSIZ)BUG(10);
295 /* The stuff for section 3 is encoded here. Each "from-location" gets a
296 * contiguous section of the "TRAVEL" array. Each entry in travel is
297 * newloc*1000 + KEYWORD (from section 4, motion verbs), and is negated if
298 * this is the last entry for this location. KEY(N) is the index in travel
299 * of the first option at location N. */
300 static void read_section3_stuff(FILE* database)
303 while((loc=GETNUM(database)) != -1)
305 long newloc=GETNUM(NULL);
313 TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
315 while((L=GETNUM(NULL)) != 0)
317 TRAVEL[TRVS]=newloc*1000+L;
319 if(TRVS == TRVSIZ)BUG(3);
321 TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
325 /* Here we read in the vocabulary. KTAB(N) is the word number, ATAB(N) is
326 * the corresponding word. The -1 at the end of section 4 is left in KTAB
327 * as an end-marker. */
328 static void read_vocabulary(FILE* database)
330 for (TABNDX=1; TABNDX<=TABSIZ; TABNDX++)
332 KTAB[TABNDX]=GETNUM(database);
333 if(KTAB[TABNDX] == -1) return;
334 ATAB[TABNDX]=GETTXT(true,true,true);
339 /* Read in the initial locations for each object. Also the immovability info.
340 * plac contains initial locations of objects. FIXD is -1 for immovable
341 * objects (including the snake), or = second loc for two-placed objects. */
342 static void read_initial_locations(FILE* database)
345 while((OBJ=GETNUM(database)) != -1)
347 PLAC[OBJ]=GETNUM(NULL);
348 FIXD[OBJ]=GETNUM(NULL);
352 /* Read default message numbers for action verbs, store in ACTSPK. */
353 static void read_action_verb_message_nr(FILE* database)
356 while((verb=GETNUM(database)) != -1)
358 ACTSPK[verb]=GETNUM(NULL);
362 /* Read info about available liquids and other conditions, store in COND. */
363 static void read_conditions(FILE* database)
366 while((K=GETNUM(database)) != -1)
369 while((loc=GETNUM(NULL)) != 0)
371 if(is_set(COND[loc],K)) BUG(8);
372 COND[loc]=COND[loc] + (1l << K);
378 /* Read data for hints. */
379 static void read_hints(FILE* database)
383 while((K=GETNUM(database)) != -1)
385 if(K <= 0 || K > HNTSIZ)BUG(7);
386 for (int I=1; I<=4; I++)
388 HINTS[K][I] =GETNUM(NULL);
390 HNTMAX=(HNTMAX>K ? HNTMAX : K);
394 /* Read the sound/text info, store in OBJSND, OBJTXT, LOCSND. */
395 static void read_sound_text(FILE* database)
398 while((K=GETNUM(database)) != -1)
400 long KK=GETNUM(NULL);
404 OBJSND[K]=(KK>0 ? KK : 0);
405 OBJTXT[K]=(I>0 ? I : 0);
414 static int read_database(FILE* database) {
416 /* Clear out the various text-pointer arrays. All text is stored in array
417 * lines; each line is preceded by a word pointing to the next pointer (i.e.
418 * the word following the end of the line). The pointer is negative if this is
419 * first line of a message. The text-pointer arrays contain indices of
420 * pointer-words in lines. STEXT(N) is short description of location N.
421 * LTEXT(N) is long description. PTEXT(N) points to message for game.prop(N)=0.
422 * Successive prop messages are found by chasing pointers. RTEXT contains
423 * section 6's stuff. CTEXT(N) points to a player-class message. TTEXT is for
424 * section 14. We also clear COND (see description of section 9 for details). */
426 for (int I=1; I<=NOBJECTS; I++) {
431 for (int I=1; I<=RTXSIZ; I++) {
434 for (int I=1; I<=CLSMAX; I++) {
437 for (int I=1; I<=LOCSIZ; I++) {
450 /* Start new data section. Sect is the section number. */
454 long sect=GETNUM(database);
459 case 1: read_messages(database, sect); break;
460 case 2: read_messages(database, sect); break;
461 case 3: read_section3_stuff(database); break;
462 case 4: read_vocabulary(database); break;
463 case 5: read_messages(database, sect); break;
464 case 6: read_messages(database, sect); break;
465 case 7: read_initial_locations(database); break;
466 case 8: read_action_verb_message_nr(database); break;
467 case 9: read_conditions(database); break;
468 case 10: read_messages(database, sect); break;
469 case 11: read_hints(database); break;
471 case 13: read_sound_text(database); break;
472 case 14: read_messages(database, sect); break;
478 /* Finish constructing internal data format */
480 /* Having read in the database, certain things are now constructed.
481 * game.propS are set to zero. We finish setting up COND by checking for
482 * forced-motion travel entries. The PLAC and FIXD arrays are used
483 * to set up game.atloc(N) as the first object at location N, and
484 * game.link(OBJ) as the next object at the same location as OBJ.
485 * (OBJ>NOBJECTS indicates that game.fixed(OBJ-NOBJECTS)=LOC; game.link(OBJ) is
486 * still the correct link to use.) game.abbrev is zeroed; it controls
487 * whether the abbreviated description is printed. Counts modulo 5
488 * unless "LOOK" is used. */
490 static void write_0d(FILE* header_file, long single, char* varname)
492 fprintf(header_file, "LOCATION long %s INITIALIZE(= %ld);\n", varname, single);
495 static void write_1d(FILE* header_file, long array[], long dim, char* varname)
497 fprintf(header_file, "LOCATION long %s[] INITIALIZE(= {\n", varname);
498 for (int i = 0; i < dim; ++i)
503 fprintf(header_file, "\n");
504 fprintf(header_file, " ");
506 fprintf(header_file, "%ld, ", array[i]);
508 fprintf(header_file, "\n});\n");
511 static void write_hints(FILE* header_file, long matrix[][HINTLEN], long dim1, long dim2, char* varname)
513 fprintf(header_file, "LOCATION long %s[][%ld] INITIALIZE(= {\n", varname, dim2);
514 for (int i = 0; i < dim1; ++i)
516 fprintf(header_file, " {");
517 for (int j = 0; j < dim2; ++j)
519 fprintf(header_file, "%ld, ", matrix[i][j]);
521 fprintf(header_file, "},\n");
523 fprintf(header_file, "});\n");
526 static void write_file(FILE* header_file)
529 for (int i=0; i<=4; i++) {
536 fprintf(header_file, "#ifndef DATABASE_H\n");
537 fprintf(header_file, "#define DATABASE_H\n");
538 fprintf(header_file, "\n");
540 fprintf(header_file, "#include \"common.h\"\n");
541 fprintf(header_file, "#define TABSIZ 330\n");
542 fprintf(header_file, "#define HNTSIZ 20\n");
543 fprintf(header_file, "#define TOKLEN %d\n", TOKLEN);
544 fprintf(header_file, "#define MAXDIE %d\n", MAXDIE);
545 fprintf(header_file, "\n");
547 fprintf(header_file, "\n");
548 fprintf(header_file, "#ifdef DEFINE_GLOBALS_FROM_INCLUDES\n");
549 fprintf(header_file, "#define LOCATION\n");
550 fprintf(header_file, "#define INITIALIZE(...) __VA_ARGS__\n");
551 fprintf(header_file, "#else\n");
552 fprintf(header_file, "#define LOCATION extern\n");
553 fprintf(header_file, "#define INITIALIZE(...)\n");
554 fprintf(header_file, "#endif\n");
555 fprintf(header_file, "\n");
558 write_0d(header_file, TRNVLS, "TRNVLS");
559 write_0d(header_file, HNTMAX, "HNTMAX");
560 write_1d(header_file, OBJSND, NOBJECTS + 1, "OBJSND");
561 write_1d(header_file, OBJTXT, NOBJECTS + 1, "OBJTXT");
562 write_1d(header_file, COND, LOCSIZ + 1, "COND");
563 write_1d(header_file, KEY, LOCSIZ + 1, "KEY");
564 write_1d(header_file, LOCSND, LOCSIZ + 1, "LOCSND");
565 write_1d(header_file, CVAL, CLSMAX + 1, "CVAL");
566 write_1d(header_file, TRNVAL, TRNSIZ + 1, "TRNVAL");
567 write_1d(header_file, TRAVEL, TRVSIZ + 1, "TRAVEL");
568 write_1d(header_file, KTAB, TABSIZ + 1, "KTAB");
569 write_1d(header_file, ATAB, TABSIZ + 1, "ATAB");
570 write_1d(header_file, PLAC, NOBJECTS + 1, "PLAC");
571 write_1d(header_file, FIXD, NOBJECTS + 1, "FIXD");
572 write_1d(header_file, ACTSPK, VRBSIZ + 1, "ACTSPK");
573 write_hints(header_file, HINTS, HNTSIZ + 1, 5, "HINTS");
575 fprintf(header_file, "#undef LOCATION\n");
576 fprintf(header_file, "#undef INITIALIZE\n");
577 fprintf(header_file, "#endif\n");
582 FILE* database = fopen("adventure.text", "r");
583 read_database(database);
586 FILE* header_file = fopen("database.h", "w");
587 write_file(header_file);
590 return(EXIT_SUCCESS);