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];
62 bool is_set(long, long);
63 long GETTXT(long, long, long);
67 int read_database(FILE*);
68 void read_messages(FILE*, long);
69 void read_section3_stuff(FILE*);
70 void read_vocabulary(FILE*);
71 void read_initial_locations(FILE*);
72 void read_action_verb_message_nr(FILE*);
73 void read_conditions(FILE*);
74 void read_hints(FILE*);
75 void read_sound_text(FILE*);
76 void write_0d(FILE*, FILE*, long, char*);
77 void write_1d(FILE*, FILE*, long[], long, char*);
78 void write_hints(FILE*, FILE*, long[][HINTLEN], long, long, char*);
79 void write_files(FILE*, FILE*);
81 bool is_set(long var, long position)
83 long mask = 1l << position;
84 bool result = (var & mask) == mask;
88 long GETTXT(long SKIP,long ONEWRD, long UPPER) {
89 /* Take characters from an input line and pack them into 30-bit words.
90 * Skip says to skip leading blanks. ONEWRD says stop if we come to a
91 * blank. UPPER says to map all letters to uppercase. If we reach the
92 * end of the line, the word is filled up with blanks (which encode as 0's).
93 * If we're already at end of line when GETTXT is called, we return -1. */
96 static long SPLITTING = -1;
98 if(LNPOSN != SPLITTING)
104 if((!SKIP) || INLINE[LNPOSN] != 0)
110 for (int I=1; I<=TOKLEN; I++) {
112 if(LNPOSN > LNLENG || (ONEWRD && INLINE[LNPOSN] == 0))
114 char current=INLINE[LNPOSN];
117 if(UPPER && current >= 37)
123 if(SPLITTING != LNPOSN) {
129 TEXT=TEXT+current-63;
139 /* The following conditions are currently considered fatal bugs. Numbers < 20
140 * are detected while reading the database; the others occur at "run time".
141 * 0 Message line > 70 characters
142 * 1 Null line in message
143 * 2 Too many words of messages
144 * 3 Too many travel options
145 * 4 Too many vocabulary words
146 * 5 Required vocabulary word not found
147 * 6 Too many RTEXT messages
149 * 8 Location has cond bit being set twice
150 * 9 Invalid section number in database
151 * 10 Too many locations
152 * 11 Too many class or turn messages
153 * 20 Special travel (500>L>300) exceeds goto list
154 * 21 Ran off end of vocabulary table
155 * 22 Vocabulary type (N/1000) not between 0 and 3
156 * 23 Intransitive action verb exceeds goto list
157 * 24 Transitive action verb exceeds goto list
158 * 25 Conditional travel entry with no alternative
159 * 26 Location has no travel entries
160 * 27 Hint number exceeds goto list
161 * 28 Invalid month returned by date function
162 * 29 Too many parameters given to SETPRM */
164 fprintf(stderr, "Fatal error %ld. See source code for interpretation.\n", NUM);
168 void MAPLIN(FILE *OPENED) {
169 /* Read a line of input, from the specified input source,
170 * translate the chars to integers in the range 0-126 and store
171 * them in the common array "INLINE". Integer values are as follows:
172 * 0 = space [ASCII CODE 40 octal, 32 decimal]
173 * 1-2 = !" [ASCII 41-42 octal, 33-34 decimal]
174 * 3-10 = '()*+,-. [ASCII 47-56 octal, 39-46 decimal]
175 * 11-36 = upper-case letters
176 * 37-62 = lower-case letters
177 * 63 = percent (%) [ASCII 45 octal, 37 decimal]
178 * 64-73 = digits, 0 through 9
179 * Remaining characters can be translated any way that is convenient;
180 * The "TYPE" routine below is used to map them back to characters when
181 * necessary. The above mappings are required so that certain special
182 * characters are known to fit in 6 bits and/or can be easily spotted.
183 * Array elements beyond the end of the line should be filled with 0,
184 * and LNLENG should be set to the index of the last character.
186 * If the data file uses a character other than space (e.g., tab) to
187 * separate numbers, that character should also translate to 0.
189 * This procedure may use the map1,map2 arrays to maintain static data for
190 * the mapping. MAP2(1) is set to 0 when the program starts
191 * and is not changed thereafter unless the routines on this page choose
195 fgets(INLINE + 1, sizeof(INLINE) - 1, OPENED);
197 while (!feof(OPENED) && INLINE[1] == '#');
200 for (size_t i = 1; i < sizeof(INLINE) && INLINE[i] != 0; ++i)
202 char val = INLINE[i];
203 INLINE[i] = ascii_to_advent[(unsigned)val];
210 long GETNUM(FILE *source) {
211 /* Obtain the next integer from an input line. If K>0, we first read a
212 * new input line from a file; if K<0, we read a line from the keyboard;
213 * if K=0 we use a line that has already been read (and perhaps partially
214 * scanned). If we're at the end of the line or encounter an illegal
215 * character (not a digit, hyphen, or blank), we return 0. */
219 if(source != NULL) MAPLIN(source);
222 while (INLINE[LNPOSN] == 0) {
223 if (LNPOSN > LNLENG) return(GETNUM);
227 if(INLINE[LNPOSN] != 9)
236 while (!(LNPOSN > LNLENG || INLINE[LNPOSN] == 0))
238 long DIGIT=INLINE[LNPOSN]-64;
239 if(DIGIT < 0 || DIGIT > 9)
244 GETNUM=GETNUM*10+DIGIT;
253 int read_database(FILE* database) {
255 /* Clear out the various text-pointer arrays. All text is stored in array
256 * lines; each line is preceded by a word pointing to the next pointer (i.e.
257 * the word following the end of the line). The pointer is negative if this is
258 * first line of a message. The text-pointer arrays contain indices of
259 * pointer-words in lines. STEXT(N) is short description of location N.
260 * LTEXT(N) is long description. PTEXT(N) points to message for game.prop(N)=0.
261 * Successive prop messages are found by chasing pointers. RTEXT contains
262 * section 6's stuff. CTEXT(N) points to a player-class message. TTEXT is for
263 * section 14. We also clear COND (see description of section 9 for details). */
265 for (int I=1; I<=NOBJECTS; I++) {
270 for (int I=1; I<=RTXSIZ; I++) {
273 for (int I=1; I<=CLSMAX; I++) {
276 for (int I=1; I<=LOCSIZ; I++) {
289 /* Start new data section. Sect is the section number. */
293 long sect=GETNUM(database);
298 case 1: read_messages(database, sect); break;
299 case 2: read_messages(database, sect); break;
300 case 3: read_section3_stuff(database); break;
301 case 4: read_vocabulary(database); break;
302 case 5: read_messages(database, sect); break;
303 case 6: read_messages(database, sect); break;
304 case 7: read_initial_locations(database); break;
305 case 8: read_action_verb_message_nr(database); break;
306 case 9: read_conditions(database); break;
307 case 10: read_messages(database, sect); break;
308 case 11: read_hints(database); break;
310 case 13: read_sound_text(database); break;
311 case 14: read_messages(database, sect); break;
318 /* Sections 1, 2, 5, 6, 10, 14. Read messages and set up pointers. */
319 void read_messages(FILE* database, long sect)
326 loc=GETNUM(database);
327 if(LNLENG >= LNPOSN+70)BUG(0);
328 if(loc == -1) return;
329 if(LNLENG < LNPOSN)BUG(1);
332 if(KK >= LINSIZ)BUG(2);
333 LINES[KK]=GETTXT(false,false,false);
335 while(LINES[KK] != -1);
337 if(loc == OLDLOC) continue;
343 if(TRNVLS > TRNSIZ)BUG(11);
344 TTEXT[TRNVLS]=LINUSE;
351 if(CLSSES > CLSMAX)BUG(11);
352 CTEXT[CLSSES]=LINUSE;
358 if(loc > RTXSIZ)BUG(6);
364 if(loc > 0 && loc <= NOBJECTS)PTEXT[loc]=LINUSE;
367 if(loc > LOCSIZ)BUG(10);
379 /* The stuff for section 3 is encoded here. Each "from-location" gets a
380 * contiguous section of the "TRAVEL" array. Each entry in travel is
381 * newloc*1000 + KEYWORD (from section 4, motion verbs), and is negated if
382 * this is the last entry for this location. KEY(N) is the index in travel
383 * of the first option at location N. */
384 void read_section3_stuff(FILE* database)
387 while((loc=GETNUM(database)) != -1)
389 long newloc=GETNUM(NULL);
397 TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
399 while((L=GETNUM(NULL)) != 0)
401 TRAVEL[TRVS]=newloc*1000+L;
403 if(TRVS == TRVSIZ)BUG(3);
405 TRAVEL[TRVS-1]= -TRAVEL[TRVS-1];
410 /* Here we read in the vocabulary. KTAB(N) is the word number, ATAB(N) is
411 * the corresponding word. The -1 at the end of section 4 is left in KTAB
412 * as an end-marker. */
413 void read_vocabulary(FILE* database)
415 for (TABNDX=1; TABNDX<=TABSIZ; TABNDX++)
417 KTAB[TABNDX]=GETNUM(database);
418 if(KTAB[TABNDX] == -1) return;
419 ATAB[TABNDX]=GETTXT(true,true,true);
425 /* Read in the initial locations for each object. Also the immovability info.
426 * plac contains initial locations of objects. FIXD is -1 for immovable
427 * objects (including the snake), or = second loc for two-placed objects. */
428 void read_initial_locations(FILE* database)
431 while((OBJ=GETNUM(database)) != -1)
433 PLAC[OBJ]=GETNUM(NULL);
434 FIXD[OBJ]=GETNUM(NULL);
439 /* Read default message numbers for action verbs, store in ACTSPK. */
440 void read_action_verb_message_nr(FILE* database)
443 while((verb=GETNUM(database)) != -1)
445 ACTSPK[verb]=GETNUM(NULL);
450 /* Read info about available liquids and other conditions, store in COND. */
451 void read_conditions(FILE* database)
454 while((K=GETNUM(database)) != -1)
457 while((loc=GETNUM(NULL)) != 0)
459 if(is_set(COND[loc],K)) BUG(8);
460 COND[loc]=COND[loc] + (1l << K);
466 /* Read data for hints. */
467 void read_hints(FILE* database)
471 while((K=GETNUM(database)) != -1)
473 if(K <= 0 || K > HNTSIZ)BUG(7);
474 for (int I=1; I<=4; I++)
476 HINTS[K][I] =GETNUM(NULL);
478 HNTMAX=(HNTMAX>K ? HNTMAX : K);
483 /* Read the sound/text info, store in OBJSND, OBJTXT, LOCSND. */
484 void read_sound_text(FILE* database)
487 while((K=GETNUM(database)) != -1)
489 long KK=GETNUM(NULL);
493 OBJSND[K]=(KK>0 ? KK : 0);
494 OBJTXT[K]=(I>0 ? I : 0);
502 /* Finish constructing internal data format */
504 /* Having read in the database, certain things are now constructed.
505 * game.propS are set to zero. We finish setting up COND by checking for
506 * forced-motion travel entries. The PLAC and FIXD arrays are used
507 * to set up game.atloc(N) as the first object at location N, and
508 * game.link(OBJ) as the next object at the same location as OBJ.
509 * (OBJ>NOBJECTS indicates that game.fixed(OBJ-NOBJECTS)=LOC; game.link(OBJ) is
510 * still the correct link to use.) game.abbrev is zeroed; it controls
511 * whether the abbreviated description is printed. Counts modulo 5
512 * unless "LOOK" is used. */
514 void write_0d(FILE* c_file, FILE* header_file, long single, char* varname)
516 fprintf(c_file, "long %s = %ld;\n", varname, single);
517 fprintf(header_file, "extern long %s;\n", varname);
520 void write_1d(FILE* c_file, FILE* header_file, long array[], long dim, char* varname)
522 fprintf(c_file, "long %s[] = {\n", varname);
523 for (int i = 0; i < dim; ++i)
528 fprintf(c_file, "\n");
529 fprintf(c_file, " ");
531 fprintf(c_file, "%ld, ", array[i]);
533 fprintf(c_file, "\n};\n");
534 fprintf(header_file, "extern long %s[%ld];\n", varname, dim);
537 void write_hints(FILE* c_file, FILE* header_file, long matrix[][HINTLEN], long dim1, long dim2, char* varname)
539 fprintf(c_file, "long %s[][%ld] = {\n", varname, dim2);
540 for (int i = 0; i < dim1; ++i)
542 fprintf(c_file, " {");
543 for (int j = 0; j < dim2; ++j)
545 fprintf(c_file, "%ld, ", matrix[i][j]);
547 fprintf(c_file, "},\n");
549 fprintf(c_file, "};\n");
550 fprintf(header_file, "extern long %s[%ld][%ld];\n", varname, dim1, dim2);
553 void write_files(FILE* c_file, FILE* header_file)
556 for (i=0; i<=4; i++) {
562 // preprocessor defines for the header
563 fprintf(header_file, "#include \"common.h\"\n");
564 fprintf(header_file, "#define TABSIZ 330\n");
565 fprintf(header_file, "#define HNTSIZ 20\n");
566 fprintf(header_file, "#define TOKLEN %d\n", TOKLEN);
567 fprintf(header_file, "#define MAXDIE %d\n", MAXDIE);
568 fprintf(header_file, "\n");
570 // include the header in the C file
571 fprintf(c_file, "#include \"database.h\"\n");
572 fprintf(c_file, "\n");
575 write_0d(c_file, header_file, TRNVLS, "TRNVLS");
576 write_0d(c_file, header_file, HNTMAX, "HNTMAX");
577 write_1d(c_file, header_file, OBJSND, NOBJECTS + 1, "OBJSND");
578 write_1d(c_file, header_file, OBJTXT, NOBJECTS + 1, "OBJTXT");
579 write_1d(c_file, header_file, COND, LOCSIZ + 1, "COND");
580 write_1d(c_file, header_file, KEY, LOCSIZ + 1, "KEY");
581 write_1d(c_file, header_file, LOCSND, LOCSIZ + 1, "LOCSND");
582 write_1d(c_file, header_file, CVAL, CLSMAX + 1, "CVAL");
583 write_1d(c_file, header_file, TRNVAL, TRNSIZ + 1, "TRNVAL");
584 write_1d(c_file, header_file, TRAVEL, TRVSIZ + 1, "TRAVEL");
585 write_1d(c_file, header_file, KTAB, TABSIZ + 1, "KTAB");
586 write_1d(c_file, header_file, ATAB, TABSIZ + 1, "ATAB");
587 write_1d(c_file, header_file, PLAC, NOBJECTS + 1, "PLAC");
588 write_1d(c_file, header_file, FIXD, NOBJECTS + 1, "FIXD");
589 write_1d(c_file, header_file, ACTSPK, VRBSIZ + 1, "ACTSPK");
590 write_hints(c_file, header_file, HINTS, HNTSIZ + 1, 5, "HINTS");
595 FILE* database = fopen("adventure.text", "r");
596 read_database(database);
599 FILE* c_file = fopen("database.c", "w");
600 FILE* header_file = fopen("database.h", "w");
601 write_files(c_file, header_file);
605 return(EXIT_SUCCESS);