Purge magic numbers from C side of destination handling.
[open-adventure.git] / main.c
1 /*
2  * There used to be a note that said this:
3  *
4  * The author - Don Woods - apologises for the style of the code; it
5  * is a result of running the original Fortran IV source through a
6  * home-brew Fortran-to-C converter.
7  *
8  * Now that the code has been restructured into something much closer
9  * to idiomatic C, the following is more appropriate:
10  *
11  * ESR apologizes for the remaing gotos (now confined to one function
12  * in this file - there used to be over 350 of them, *everywhere*),
13  * and for the offensive globals.  Applying the Structured Program
14  * Theorem can be hard.
15  */
16
17 #include <stdlib.h>
18 #include <stdio.h>
19 #include <stdbool.h>
20 #include <getopt.h>
21 #include <signal.h>
22 #include <string.h>
23 #include <ctype.h>
24 #include "advent.h"
25 #include "dungeon.h"
26
27 #define DIM(a) (sizeof(a)/sizeof(a[0]))
28
29 // LCOV_EXCL_START
30 // exclude from coverage analysis because it requires interactivity to test
31 static void sig_handler(int signo)
32 {
33     if (signo == SIGINT) {
34         if (settings.logfp != NULL)
35             fflush(settings.logfp);
36     }
37     exit(EXIT_FAILURE);
38 }
39 // LCOV_EXCL_STOP
40
41 /*
42  * MAIN PROGRAM
43  *
44  *  Adventure (rev 2: 20 treasures)
45  *  History: Original idea & 5-treasure version (adventures) by Willie Crowther
46  *           15-treasure version (adventure) by Don Woods, April-June 1977
47  *           20-treasure version (rev 2) by Don Woods, August 1978
48  *              Errata fixed: 78/12/25
49  *           Revived 2017 as Open Adventure.
50  */
51
52 static bool do_command(void);
53
54 int main(int argc, char *argv[])
55 {
56     int ch;
57
58     /*  Options. */
59
60 #ifndef ADVENT_NOSAVE
61     const char* opts = "l:or:";
62     const char* usage = "Usage: %s [-l logfilename] [-o] [-r restorefilename]\n";
63     FILE *rfp = NULL;
64 #else
65     const char* opts = "l:o";
66     const char* usage = "Usage: %s [-l logfilename] [-o]\n";
67 #endif
68     while ((ch = getopt(argc, argv, opts)) != EOF) {
69         switch (ch) {
70         case 'l':
71             settings.logfp = fopen(optarg, "w");
72             if (settings.logfp == NULL)
73                 fprintf(stderr,
74                         "advent: can't open logfile %s for write\n",
75                         optarg);
76             signal(SIGINT, sig_handler);
77             break;
78         case 'o':
79             settings.oldstyle = true;
80             settings.prompt = false;
81             break;
82 #ifndef ADVENT_NOSAVE
83         case 'r':
84             rfp = fopen(optarg, "r");
85             if (rfp == NULL)
86                 fprintf(stderr,
87                         "advent: can't open save file %s for read\n",
88                         optarg);
89             signal(SIGINT, sig_handler);
90             break;
91 #endif
92         default:
93             fprintf(stderr,
94                     usage, argv[0]);
95             fprintf(stderr,
96                     "        -l create a log file of your game named as specified'\n");
97             fprintf(stderr,
98                     "        -o 'oldstyle' (no prompt, no command editing, displays 'Initialising...')\n");
99 #ifndef ADVENT_NOSAVE
100             fprintf(stderr,
101                     "        -r restore from specified saved game file\n");
102 #endif
103             exit(EXIT_FAILURE);
104             break;
105         }
106     }
107
108     /*  Initialize game variables */
109     long seedval = initialise();
110
111 #ifndef ADVENT_NOSAVE
112     if (!rfp) {
113         game.novice = yes(arbitrary_messages[WELCOME_YOU], arbitrary_messages[CAVE_NEARBY], arbitrary_messages[NO_MESSAGE]);
114         if (game.novice)
115             game.limit = NOVICELIMIT;
116     } else {
117         restore(rfp);
118     }
119 #else
120     game.novice = yes(arbitrary_messages[WELCOME_YOU], arbitrary_messages[CAVE_NEARBY], arbitrary_messages[NO_MESSAGE]);
121     if (game.novice)
122         game.limit = NOVICELIMIT;
123 #endif
124
125     if (settings.logfp)
126         fprintf(settings.logfp, "seed %ld\n", seedval);
127
128     /* interpret commands until EOF or interrupt */
129     for (;;) {
130         if (!do_command())
131             break;
132     }
133     /* show score and exit */
134     terminate(quitgame);
135 }
136
137 static bool fallback_handler(char *buf)
138 /* fallback handler for commands not handled by FORTRANish parser */
139 {
140     long sv;
141     if (sscanf(buf, "seed %ld", &sv) == 1) {
142         set_seed(sv);
143         printf("Seed set to %ld\n", sv);
144         // autogenerated, so don't charge user time for it.
145         --game.turns;
146         return true;
147     }
148     return false;
149 }
150
151 /*  Check if this loc is eligible for any hints.  If been here long
152  *  enough, display.  Ignore "HINTS" < 4 (special stuff, see database
153  *  notes). */
154 static void checkhints(void)
155 {
156     if (conditions[game.loc] >= game.conds) {
157         for (int hint = 0; hint < NHINTS; hint++) {
158             if (game.hinted[hint])
159                 continue;
160             if (!CNDBIT(game.loc, hint + 1 + COND_HBASE))
161                 game.hintlc[hint] = -1;
162             ++game.hintlc[hint];
163             /*  Come here if he's been long enough at required loc(s) for some
164              *  unused hint. */
165             if (game.hintlc[hint] >= hints[hint].turns) {
166                 int i;
167
168                 switch (hint) {
169                 case 0:
170                     /* cave */
171                     if (game.prop[GRATE] == GRATE_CLOSED && !HERE(KEYS))
172                         break;
173                     game.hintlc[hint] = 0;
174                     return;
175                 case 1: /* bird */
176                     if (game.place[BIRD] == game.loc && TOTING(ROD) && game.oldobj == BIRD)
177                         break;
178                     return;
179                 case 2: /* snake */
180                     if (HERE(SNAKE) && !HERE(BIRD))
181                         break;
182                     game.hintlc[hint] = 0;
183                     return;
184                 case 3: /* maze */
185                     if (game.atloc[game.loc] == NO_OBJECT &&
186                         game.atloc[game.oldloc] == NO_OBJECT &&
187                         game.atloc[game.oldlc2] == NO_OBJECT &&
188                         game.holdng > 1)
189                         break;
190                     game.hintlc[hint] = 0;
191                     return;
192                 case 4: /* dark */
193                     if (game.prop[EMERALD] != STATE_NOTFOUND && game.prop[PYRAMID] == STATE_NOTFOUND)
194                         break;
195                     game.hintlc[hint] = 0;
196                     return;
197                 case 5: /* witt */
198                     break;
199                 case 6: /* urn */
200                     if (game.dflag == 0)
201                         break;
202                     game.hintlc[hint] = 0;
203                     return;
204                 case 7: /* woods */
205                     if (game.atloc[game.loc] == NO_OBJECT &&
206                         game.atloc[game.oldloc] == NO_OBJECT &&
207                         game.atloc[game.oldlc2] == NO_OBJECT)
208                         break;
209                     return;
210                 case 8: /* ogre */
211                     i = atdwrf(game.loc);
212                     if (i < 0) {
213                         game.hintlc[hint] = 0;
214                         return;
215                     }
216                     if (HERE(OGRE) && i == 0)
217                         break;
218                     return;
219                 case 9: /* jade */
220                     if (game.tally == 1 && game.prop[JADE] < 0)
221                         break;
222                     game.hintlc[hint] = 0;
223                     return;
224                 default:
225                     BUG(HINT_NUMBER_EXCEEDS_GOTO_LIST); // LCOV_EXCL_LINE
226                     break;
227                 }
228
229                 /* Fall through to hint display */
230                 game.hintlc[hint] = 0;
231                 if (!yes(hints[hint].question, arbitrary_messages[NO_MESSAGE], arbitrary_messages[OK_MAN]))
232                     return;
233                 rspeak(HINT_COST, hints[hint].penalty, hints[hint].penalty);
234                 game.hinted[hint] = yes(arbitrary_messages[WANT_HINT], hints[hint].hint, arbitrary_messages[OK_MAN]);
235                 if (game.hinted[hint] && game.limit > WARNTIME)
236                     game.limit += WARNTIME * hints[hint].penalty;
237             }
238         }
239     }
240 }
241
242 static bool spotted_by_pirate(int i)
243 {
244     if (i != PIRATE)
245         return false;
246
247     /*  The pirate's spotted him.  He leaves him alone once we've
248      *  found chest.  K counts if a treasure is here.  If not, and
249      *  tally=1 for an unseen chest, let the pirate be spotted.  Note
250      *  that game.place[CHEST] = LOC_NOWHERE might mean that he's thrown
251      *  it to the troll, but in that case he's seen the chest
252      *  (game.prop=0). */
253     if (game.loc == game.chloc ||
254         game.prop[CHEST] != STATE_NOTFOUND)
255         return true;
256     int snarfed = 0;
257     bool movechest = false, robplayer = false;
258     for (int treasure = 1; treasure <= NOBJECTS; treasure++) {
259         if (!objects[treasure].is_treasure)
260             continue;
261         /*  Pirate won't take pyramid from plover room or dark
262          *  room (too easy!). */
263         if (treasure == PYRAMID && (game.loc == objects[PYRAMID].plac ||
264                                     game.loc == objects[EMERALD].plac)) {
265             continue;
266         }
267         if (TOTING(treasure) ||
268             HERE(treasure))
269             ++snarfed;
270         if (TOTING(treasure)) {
271             movechest = true;
272             robplayer = true;
273         }
274     }
275     /* Force chest placement before player finds last treasure */
276     if (game.tally == 1 && snarfed == 0 && game.place[CHEST] == LOC_NOWHERE && HERE(LAMP) && game.prop[LAMP] == LAMP_BRIGHT) {
277         rspeak(PIRATE_SPOTTED);
278         movechest = true;
279     }
280     /* Do things in this order (chest move before robbery) so chest is listed
281      * last at the maze location. */
282     if (movechest) {
283         move(CHEST, game.chloc);
284         move(MESSAG, game.chloc2);
285         game.dloc[PIRATE] = game.chloc;
286         game.odloc[PIRATE] = game.chloc;
287         game.dseen[PIRATE] = false;
288     } else {
289         /* You might get a hint of the pirate's presence even if the
290          * chest doesn't move... */
291         if (game.odloc[PIRATE] != game.dloc[PIRATE] && PCT(20))
292             rspeak(PIRATE_RUSTLES);
293     }
294     if (robplayer) {
295         rspeak(PIRATE_POUNCES);
296         for (int treasure = 1; treasure <= NOBJECTS; treasure++) {
297             if (!objects[treasure].is_treasure)
298                 continue;
299             if (!(treasure == PYRAMID && (game.loc == objects[PYRAMID].plac ||
300                                           game.loc == objects[EMERALD].plac))) {
301                 if (AT(treasure) && game.fixed[treasure] == IS_FREE)
302                     carry(treasure, game.loc);
303                 if (TOTING(treasure))
304                     drop(treasure, game.chloc);
305             }
306         }
307     }
308
309     return true;
310 }
311
312 static bool dwarfmove(void)
313 /* Dwarves move.  Return true if player survives, false if he dies. */
314 {
315     int kk, stick, attack;
316     long tk[21];
317
318     /*  Dwarf stuff.  See earlier comments for description of
319      *  variables.  Remember sixth dwarf is pirate and is thus
320      *  very different except for motion rules. */
321
322     /*  First off, don't let the dwarves follow him into a pit or
323      *  a wall.  Activate the whole mess the first time he gets as
324      *  far as the hall of mists (loc 15).  If game.newloc is
325      *  forbidden to pirate (in particular, if it's beyond the
326      *  troll bridge), bypass dwarf stuff.  That way pirate can't
327      *  steal return toll, and dwarves can't meet the bear.  Also
328      *  means dwarves won't follow him into dead end in maze, but
329      *  c'est la vie.  They'll wait for him outside the dead
330      *  end. */
331     if (game.loc == LOC_NOWHERE ||
332         FORCED(game.loc) ||
333         CNDBIT(game.newloc, COND_NOARRR))
334         return true;
335
336     /* Dwarf activity level ratchets up */
337     if (game.dflag == 0) {
338         if (INDEEP(game.loc))
339             game.dflag = 1;
340         return true;
341     }
342
343     /*  When we encounter the first dwarf, we kill 0, 1, or 2 of
344      *  the 5 dwarves.  If any of the survivors is at loc,
345      *  replace him with the alternate. */
346     if (game.dflag == 1) {
347         if (!INDEEP(game.loc) ||
348             (PCT(95) && (!CNDBIT(game.loc, COND_NOBACK) ||
349                          PCT(85))))
350             return true;
351         game.dflag = 2;
352         for (int i = 1; i <= 2; i++) {
353             int j = 1 + randrange(NDWARVES - 1);
354             if (PCT(50))
355                 game.dloc[j] = 0;
356         }
357
358         /* Alternate initial loc for dwarf, in case one of them
359         *  starts out on top of the adventurer. */
360         for (int i = 1; i <= NDWARVES - 1; i++) {
361             if (game.dloc[i] == game.loc)
362                 game.dloc[i] = DALTLC; //
363             game.odloc[i] = game.dloc[i];
364         }
365         rspeak(DWARF_RAN);
366         drop(AXE, game.loc);
367         return true;
368     }
369
370     /*  Things are in full swing.  Move each dwarf at random,
371      *  except if he's seen us he sticks with us.  Dwarves stay
372      *  deep inside.  If wandering at random, they don't back up
373      *  unless there's no alternative.  If they don't have to
374      *  move, they attack.  And, of course, dead dwarves don't do
375      *  much of anything. */
376     game.dtotal = 0;
377     attack = 0;
378     stick = 0;
379     for (int i = 1; i <= NDWARVES; i++) {
380         if (game.dloc[i] == 0)
381             continue;
382         /*  Fill tk array with all the places this dwarf might go. */
383         unsigned int j = 1;
384         kk = tkey[game.dloc[i]];
385         if (kk != 0)
386             do {
387                 enum desttype_t desttype = travel[kk].desttype;
388                 game.newloc = travel[kk].destval;
389                 /* Have we avoided a dwarf encounter? */
390                 if (desttype != dest_goto)
391                     continue;
392                 else if (!INDEEP(game.newloc))
393                     continue;
394                 else if (game.newloc == game.odloc[i])
395                     continue;
396                 else if (j > 1 && game.newloc == tk[j - 1])
397                     continue;
398                 else if (j >= DIM(tk) - 1)
399                     continue;
400                 else if (game.newloc == game.dloc[i])
401                     continue;
402                 else if (FORCED(game.newloc))
403                     continue;
404                 else if (i == PIRATE && CNDBIT(game.newloc, COND_NOARRR))
405                     continue;
406                 else if (travel[kk].nodwarves)
407                     continue;
408                 tk[j++] = game.newloc;
409             } while
410             (!travel[kk++].stop);
411         tk[j] = game.odloc[i];
412         if (j >= 2)
413             --j;
414         j = 1 + randrange(j);
415         game.odloc[i] = game.dloc[i];
416         game.dloc[i] = tk[j];
417         game.dseen[i] = (game.dseen[i] && INDEEP(game.loc)) ||
418                         (game.dloc[i] == game.loc ||
419                          game.odloc[i] == game.loc);
420         if (!game.dseen[i])
421             continue;
422         game.dloc[i] = game.loc;
423         if (spotted_by_pirate(i))
424             continue;
425         /* This threatening little dwarf is in the room with him! */
426         ++game.dtotal;
427         if (game.odloc[i] == game.dloc[i]) {
428             ++attack;
429             if (game.knfloc >= 0)
430                 game.knfloc = game.loc;
431             if (randrange(1000) < 95 * (game.dflag - 2))
432                 ++stick;
433         }
434     }
435
436     /*  Now we know what's happening.  Let's tell the poor sucker about it.
437      *  Note that various of the "knife" messages must have specific relative
438      *  positions in the rspeak database. */
439     if (game.dtotal == 0)
440         return true;
441     rspeak(game.dtotal == 1 ? DWARF_SINGLE : DWARF_PACK, game.dtotal);
442     if (attack == 0)
443         return true;
444     if (game.dflag == 2)
445         game.dflag = 3;
446     if (attack > 1) {
447         rspeak(THROWN_KNIVES, attack);
448         rspeak(stick > 1 ? MULTIPLE_HITS : (stick == 1 ? ONE_HIT : NONE_HIT), stick);
449     } else {
450         rspeak(KNIFE_THROWN);
451         rspeak(MISSES_YOU);
452     }
453     if (stick == 0)
454         return true;
455     game.oldlc2 = game.loc;
456     return false;
457 }
458
459 /*  "You're dead, Jim."
460  *
461  *  If the current loc is zero, it means the clown got himself killed.
462  *  We'll allow this maxdie times.  NDEATHS is automatically set based
463  *  on the number of snide messages available.  Each death results in
464  *  a message (obituaries[n]) which offers reincarnation; if accepted,
465  *  this results in message obituaries[0], obituaries[2], etc.  The
466  *  last time, if he wants another chance, he gets a snide remark as
467  *  we exit.  When reincarnated, all objects being carried get dropped
468  *  at game.oldlc2 (presumably the last place prior to being killed)
469  *  without change of props.  The loop runs backwards to assure that
470  *  the bird is dropped before the cage.  (This kluge could be changed
471  *  once we're sure all references to bird and cage are done by
472  *  keywords.)  The lamp is a special case (it wouldn't do to leave it
473  *  in the cave). It is turned off and left outside the building (only
474  *  if he was carrying it, of course).  He himself is left inside the
475  *  building (and heaven help him if he tries to xyzzy back into the
476  *  cave without the lamp!).  game.oldloc is zapped so he can't just
477  *  "retreat". */
478
479 static void croak(void)
480 /*  Okay, he's dead.  Let's get on with it. */
481 {
482     const char* query = obituaries[game.numdie].query;
483     const char* yes_response = obituaries[game.numdie].yes_response;
484     ++game.numdie;
485     if (game.closng) {
486         /*  He died during closing time.  No resurrection.  Tally up a
487          *  death and exit. */
488         rspeak(DEATH_CLOSING);
489         terminate(endgame);
490     } else if (game.numdie == NDEATHS ||
491                !yes(query, yes_response, arbitrary_messages[OK_MAN]))
492         terminate(endgame);
493     else {
494         game.place[WATER] = game.place[OIL] = LOC_NOWHERE;
495         if (TOTING(LAMP))
496             game.prop[LAMP] = LAMP_DARK;
497         for (int j = 1; j <= NOBJECTS; j++) {
498             int i = NOBJECTS + 1 - j;
499             if (TOTING(i)) {
500                 /* Always leave lamp where it's accessible aboveground */
501                 drop(i, (i == LAMP) ? LOC_START : game.oldlc2);
502             }
503         }
504         game.loc = LOC_BUILDING;
505         game.oldloc = game.loc;
506     }
507 }
508
509 static bool traveleq(long a, long b)
510 /* Are two travel entries equal for purposes of skip after failed condition? */
511 {
512     return (travel[a].cond == travel[b].cond)
513            && (travel[a].desttype == travel[b].desttype)
514            && (travel[a].destval == travel[b].destval);
515 }
516
517 /*  Given the current location in "game.loc", and a motion verb number in
518  *  "motion", put the new location in "game.newloc".  The current loc is saved
519  *  in "game.oldloc" in case he wants to retreat.  The current
520  *  game.oldloc is saved in game.oldlc2, in case he dies.  (if he
521  *  does, game.newloc will be limbo, and game.oldloc will be what killed
522  *  him, so we need game.oldlc2, which is the last place he was
523  *  safe.) */
524
525 static void playermove( int motion)
526 {
527     int scratchloc, travel_entry = tkey[game.loc];
528     game.newloc = game.loc;
529     if (travel_entry == 0)
530         BUG(LOCATION_HAS_NO_TRAVEL_ENTRIES); // LCOV_EXCL_LINE
531     if (motion == NUL)
532         return;
533     else if (motion == BACK) {
534         /*  Handle "go back".  Look for verb which goes from game.loc to
535          *  game.oldloc, or to game.oldlc2 If game.oldloc has forced-motion.
536          *  te_tmp saves entry -> forced loc -> previous loc. */
537         motion = game.oldloc;
538         if (FORCED(motion))
539             motion = game.oldlc2;
540         game.oldlc2 = game.oldloc;
541         game.oldloc = game.loc;
542         int spk = 0;
543         if (motion == game.loc)
544             spk = FORGOT_PATH;
545         if (CNDBIT(game.loc, COND_NOBACK))
546             spk = TWIST_TURN;
547         if (spk == 0) {
548             int te_tmp = 0;
549             for (;;) {
550                 enum desttype_t desttype = travel[travel_entry].desttype;
551                 scratchloc = travel[travel_entry].destval;
552                 if (desttype != dest_goto || scratchloc != motion) {
553                     if (desttype == dest_goto) {
554                         if (FORCED(scratchloc) && travel[tkey[scratchloc]].destval == motion)
555                             te_tmp = travel_entry;
556                     }
557                     if (!travel[travel_entry].stop) {
558                         ++travel_entry; /* go to next travel entry for this location */
559                         continue;
560                     }
561                     /* we've reached the end of travel entries for game.loc */
562                     travel_entry = te_tmp;
563                     if (travel_entry == 0) {
564                         rspeak(NOT_CONNECTED);
565                         return;
566                     }
567                 }
568
569                 motion = travel[travel_entry].motion;
570                 travel_entry = tkey[game.loc];
571                 break; /* fall through to ordinary travel */
572             }
573         } else {
574             rspeak(spk);
575             return;
576         }
577     } else if (motion == LOOK) {
578         /*  Look.  Can't give more detail.  Pretend it wasn't dark
579          *  (though it may now be dark) so he won't fall into a
580          *  pit while staring into the gloom. */
581         if (game.detail < 3)
582             rspeak(NO_MORE_DETAIL);
583         ++game.detail;
584         game.wzdark = false;
585         game.abbrev[game.loc] = 0;
586         return;
587     } else if (motion == CAVE) {
588         /*  Cave.  Different messages depending on whether above ground. */
589         rspeak((OUTSID(game.loc) && game.loc != LOC_GRATE) ? FOLLOW_STREAM : NEED_DETAIL);
590         return;
591     } else {
592         /* none of the specials */
593         game.oldlc2 = game.oldloc;
594         game.oldloc = game.loc;
595     }
596
597     /* Look for a way to fulfil the motion verb passed in - travel_entry indexes
598      * the beginning of the motion entries for here (game.loc). */
599     for (;;) {
600         if (T_TERMINATE(travel[travel_entry]) ||
601             travel[travel_entry].motion == motion)
602             break;
603         if (travel[travel_entry].stop) {
604             /*  Couldn't find an entry matching the motion word passed
605              *  in.  Various messages depending on word given. */
606             int spk = CANT_APPLY;
607             if (motion >= EAST && motion <= NW)
608                 spk = BAD_DIRECTION;
609             if (motion == UP ||
610                 motion == DOWN)
611                 spk = BAD_DIRECTION;
612             if (motion == FORWARD ||
613                 motion == LEFT ||
614                 motion == RIGHT)
615                 spk = UNSURE_FACING;
616             if (motion == OUTSIDE ||
617                 motion == INSIDE)
618                 spk = NO_INOUT_HERE;
619             if (motion == XYZZY ||
620                 motion == PLUGH)
621                 spk = NOTHING_HAPPENS;
622             if (motion == CRAWL)
623                 spk = WHICH_WAY;
624             rspeak(spk);
625             return;
626         }
627         ++travel_entry;
628     }
629
630     /* (ESR) We've found a destination that goes with the motion verb.
631      * Next we need to check any conditional(s) on this destination, and
632      * possibly on following entries. */
633     /* FIXME: Magic numbers related to move opcodes */
634     do {
635         for (;;) { /* L12 loop */
636             for (;;) {
637                 long cond = travel[travel_entry].cond;
638                 long arg = MOD(cond, 100);
639                 if (!SPECIAL(cond)) {
640                     /* YAML N and [pct N] conditionals */
641                     if (cond <= 100) {
642                         if (cond == 0 ||
643                             PCT(cond))
644                             break;
645                         /* else fall through */
646                     }
647                     /* YAML [with OBJ] clause */
648                     if (TOTING(arg) ||
649                         (cond > 200 && AT(arg)))
650                         break;
651                     /* else fall through to check [not OBJ STATE] */
652                 } else if (game.prop[arg] != cond / 100 - 3)
653                     break;
654
655                 /* We arrive here on conditional failure.
656                  * Skip to next non-matching destination */
657                 long te_tmp = travel_entry;
658                 do {
659                     if (travel[te_tmp].stop)
660                         BUG(CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION); // LCOV_EXCL_LINE
661                     ++te_tmp;
662                 } while
663                 (traveleq(travel_entry, te_tmp));
664                 travel_entry = te_tmp;
665             }
666
667             /* Found an eligible rule, now execute it */
668             enum desttype_t desttype = travel[travel_entry].desttype;
669             game.newloc = travel[travel_entry].destval;
670             if (desttype == dest_goto)
671                 return;
672
673             if (desttype == dest_speak) {
674                 /* Execute a speak rule */
675                 rspeak(game.newloc);
676                 game.newloc = game.loc;
677                 return;
678             } else {
679                 switch (game.newloc) {
680                 case 1:
681                     /* Special travel 1.  Plover-alcove passage.  Can carry only
682                      * emerald.  Note: travel table must include "useless"
683                      * entries going through passage, which can never be used
684                      * for actual motion, but can be spotted by "go back". */
685                     game.newloc = (game.loc == LOC_PLOVER)
686                                   ? LOC_ALCOVE
687                                   : LOC_PLOVER;
688                     if (game.holdng > 1 ||
689                         (game.holdng == 1 && !TOTING(EMERALD))) {
690                         game.newloc = game.loc;
691                         rspeak(MUST_DROP);
692                     }
693                     return;
694                 case 2:
695                     /* Special travel 2.  Plover transport.  Drop the
696                      * emerald (only use special travel if toting
697                      * it), so he's forced to use the plover-passage
698                      * to get it out.  Having dropped it, go back and
699                      * pretend he wasn't carrying it after all. */
700                     drop(EMERALD, game.loc);
701                     int te_tmp = travel_entry;
702                     do {
703                         if (travel[te_tmp].stop)
704                             BUG(CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION); // LCOV_EXCL_LINE
705                         ++te_tmp;
706                     } while
707                     (traveleq(travel_entry, te_tmp));
708                     travel_entry = te_tmp;
709                     continue; /* goto L12 */
710                 case 3:
711                     /* Special travel 3.  Troll bridge.  Must be done
712                      * only as special motion so that dwarves won't
713                      * wander across and encounter the bear.  (They
714                      * won't follow the player there because that
715                      * region is forbidden to the pirate.)  If
716                      * game.prop(TROLL)=1, he's crossed since paying,
717                      * so step out and block him.  (standard travel
718                      * entries check for game.prop(TROLL)=0.)  Special
719                      * stuff for bear. */
720                     if (game.prop[TROLL] == TROLL_PAIDONCE) {
721                         pspeak(TROLL, look, TROLL_PAIDONCE, true);
722                         game.prop[TROLL] = TROLL_UNPAID;
723                         move(TROLL2, LOC_NOWHERE);
724                         move(TROLL2 + NOBJECTS, IS_FREE);
725                         move(TROLL, objects[TROLL].plac);
726                         move(TROLL + NOBJECTS, objects[TROLL].fixd);
727                         juggle(CHASM);
728                         game.newloc = game.loc;
729                         return;
730                     } else {
731                         game.newloc = objects[TROLL].plac + objects[TROLL].fixd - game.loc;
732                         if (game.prop[TROLL] == TROLL_UNPAID)
733                             game.prop[TROLL] = TROLL_PAIDONCE;
734                         if (!TOTING(BEAR))
735                             return;
736                         state_change(CHASM, BRIDGE_WRECKED);
737                         game.prop[TROLL] = TROLL_GONE;
738                         drop(BEAR, game.newloc);
739                         game.fixed[BEAR] = IS_FIXED;
740                         game.prop[BEAR] = BEAR_DEAD;
741                         game.oldlc2 = game.newloc;
742                         croak();
743                         return;
744                     }
745                 default:
746                     BUG(SPECIAL_TRAVEL_500_GT_L_GT_300_EXCEEDS_GOTO_LIST); // LCOV_EXCL_LINE
747                 }
748             }
749             break; /* Leave L12 loop */
750         }
751     } while
752     (false);
753 }
754
755 static bool closecheck(void)
756 /*  Handle the closing of the cave.  The cave closes "clock1" turns
757  *  after the last treasure has been located (including the pirate's
758  *  chest, which may of course never show up).  Note that the
759  *  treasures need not have been taken yet, just located.  Hence
760  *  clock1 must be large enough to get out of the cave (it only ticks
761  *  while inside the cave).  When it hits zero, we branch to 10000 to
762  *  start closing the cave, and then sit back and wait for him to try
763  *  to get out.  If he doesn't within clock2 turns, we close the cave;
764  *  if he does try, we assume he panics, and give him a few additional
765  *  turns to get frantic before we close.  When clock2 hits zero, we
766  *  transport him into the final puzzle.  Note that the puzzle depends
767  *  upon all sorts of random things.  For instance, there must be no
768  *  water or oil, since there are beanstalks which we don't want to be
769  *  able to water, since the code can't handle it.  Also, we can have
770  *  no keys, since there is a grate (having moved the fixed object!)
771  *  there separating him from all the treasures.  Most of these
772  *  problems arise from the use of negative prop numbers to suppress
773  *  the object descriptions until he's actually moved the objects. */
774 {
775     /*  Don't tick game.clock1 unless well into cave (and not at Y2). */
776     if (game.tally == 0 && INDEEP(game.loc) && game.loc != LOC_Y2)
777         --game.clock1;
778
779     /*  When the first warning comes, we lock the grate, destroy
780      *  the bridge, kill all the dwarves (and the pirate), remove
781      *  the troll and bear (unless dead), and set "closng" to
782      *  true.  Leave the dragon; too much trouble to move it.
783      *  from now until clock2 runs out, he cannot unlock the
784      *  grate, move to any location outside the cave, or create
785      *  the bridge.  Nor can he be resurrected if he dies.  Note
786      *  that the snake is already gone, since he got to the
787      *  treasure accessible only via the hall of the mountain
788      *  king. Also, he's been in giant room (to get eggs), so we
789      *  can refer to it.  Also also, he's gotten the pearl, so we
790      *  know the bivalve is an oyster.  *And*, the dwarves must
791      *  have been activated, since we've found chest. */
792     if (game.clock1 == 0) {
793         game.prop[GRATE] = GRATE_CLOSED;
794         game.prop[FISSURE] = UNBRIDGED;
795         for (int i = 1; i <= NDWARVES; i++) {
796             game.dseen[i] = false;
797             game.dloc[i] = LOC_NOWHERE;
798         }
799         move(TROLL, LOC_NOWHERE);
800         move(TROLL + NOBJECTS, IS_FREE);
801         move(TROLL2, objects[TROLL].plac);
802         move(TROLL2 + NOBJECTS, objects[TROLL].fixd);
803         juggle(CHASM);
804         if (game.prop[BEAR] != BEAR_DEAD)
805             DESTROY(BEAR);
806         game.prop[CHAIN] = CHAIN_HEAP;
807         game.fixed[CHAIN] = IS_FREE;
808         game.prop[AXE] = AXE_HERE;
809         game.fixed[AXE] = IS_FREE;
810         rspeak(CAVE_CLOSING);
811         game.clock1 = -1;
812         game.closng = true;
813         return true;
814     } else if (game.clock1 < 0)
815         --game.clock2;
816     if (game.clock2 == 0) {
817         /*  Once he's panicked, and clock2 has run out, we come here
818          *  to set up the storage room.  The room has two locs,
819          *  hardwired as LOC_NE and LOC_SW.  At the ne end, we
820          *  place empty bottles, a nursery of plants, a bed of
821          *  oysters, a pile of lamps, rods with stars, sleeping
822          *  dwarves, and him.  At the sw end we place grate over
823          *  treasures, snake pit, covey of caged birds, more rods, and
824          *  pillows.  A mirror stretches across one wall.  Many of the
825          *  objects come from known locations and/or states (e.g. the
826          *  snake is known to have been destroyed and needn't be
827          *  carried away from its old "place"), making the various
828          *  objects be handled differently.  We also drop all other
829          *  objects he might be carrying (lest he have some which
830          *  could cause trouble, such as the keys).  We describe the
831          *  flash of light and trundle back. */
832         game.prop[BOTTLE] = put(BOTTLE, LOC_NE, EMPTY_BOTTLE);
833         game.prop[PLANT] = put(PLANT, LOC_NE, PLANT_THIRSTY);
834         game.prop[OYSTER] = put(OYSTER, LOC_NE, STATE_FOUND);
835         game.prop[LAMP] = put(LAMP, LOC_NE, LAMP_DARK);
836         game.prop[ROD] = put(ROD, LOC_NE, STATE_FOUND);
837         game.prop[DWARF] = put(DWARF, LOC_NE, 0);
838         game.loc = LOC_NE;
839         game.oldloc = LOC_NE;
840         game.newloc = LOC_NE;
841         /*  Leave the grate with normal (non-negative) property.
842          *  Reuse sign. */
843         put(GRATE, LOC_SW, 0);
844         put(SIGN, LOC_SW, 0);
845         game.prop[SIGN] = ENDGAME_SIGN;
846         game.prop[SNAKE] = put(SNAKE, LOC_SW, SNAKE_CHASED);
847         game.prop[BIRD] = put(BIRD, LOC_SW, BIRD_CAGED);
848         game.prop[CAGE] = put(CAGE, LOC_SW, STATE_FOUND);
849         game.prop[ROD2] = put(ROD2, LOC_SW, STATE_FOUND);
850         game.prop[PILLOW] = put(PILLOW, LOC_SW, STATE_FOUND);
851
852         game.prop[MIRROR] = put(MIRROR, LOC_NE, STATE_FOUND);
853         game.fixed[MIRROR] = LOC_SW;
854
855         for (int i = 1; i <= NOBJECTS; i++) {
856             if (TOTING(i))
857                 DESTROY(i);
858         }
859
860         rspeak(CAVE_CLOSED);
861         game.closed = true;
862         return true;
863     }
864
865     return false;
866 }
867
868 static void lampcheck(void)
869 /* Check game limit and lamp timers */
870 {
871     if (game.prop[LAMP] == LAMP_BRIGHT)
872         --game.limit;
873
874     /*  Another way we can force an end to things is by having the
875      *  lamp give out.  When it gets close, we come here to warn him.
876      *  First following arm checks if the lamp and fresh batteries are
877      *  here, in which case we replace the batteries and continue.
878      *  Second is for other cases of lamp dying.  Eve after it goes
879      *  out, he can explore outside for a while if desired. */
880     if (game.limit <= WARNTIME && HERE(BATTERY) && game.prop[BATTERY] == FRESH_BATTERIES && HERE(LAMP)) {
881         rspeak(REPLACE_BATTERIES);
882         game.prop[BATTERY] = DEAD_BATTERIES;
883         if (TOTING(BATTERY))
884             drop(BATTERY, game.loc);
885         game.limit += BATTERYLIFE;
886         game.lmwarn = false;
887     } else if (game.limit == 0) {
888         game.limit = -1;
889         game.prop[LAMP] = LAMP_DARK;
890         if (HERE(LAMP))
891             rspeak(LAMP_OUT);
892     } else if (game.limit <= WARNTIME) {
893         if (!game.lmwarn && HERE(LAMP)) {
894             game.lmwarn = true;
895             int spk = GET_BATTERIES;
896             if (game.place[BATTERY] == LOC_NOWHERE)
897                 spk = LAMP_DIM;
898             if (game.prop[BATTERY] == DEAD_BATTERIES)
899                 spk = MISSING_BATTERIES;
900             rspeak(spk);
901         }
902     }
903 }
904
905 static void listobjects(void)
906 /*  Print out descriptions of objects at this location.  If
907  *  not closing and property value is negative, tally off
908  *  another treasure.  Rug is special case; once seen, its
909  *  game.prop is RUG_DRAGON (dragon on it) till dragon is killed.
910  *  Similarly for chain; game.prop is initially CHAINING_BEAR (locked to
911  *  bear).  These hacks are because game.prop=0 is needed to
912  *  get full score. */
913 {
914     if (!DARK(game.loc)) {
915         ++game.abbrev[game.loc];
916         for (int i = game.atloc[game.loc]; i != 0; i = game.link[i]) {
917             long obj = i;
918             if (obj > NOBJECTS)
919                 obj = obj - NOBJECTS;
920             if (obj == STEPS && TOTING(NUGGET))
921                 continue;
922             if (game.prop[obj] < 0) {
923                 if (game.closed)
924                     continue;
925                 game.prop[obj] = STATE_FOUND;
926                 if (obj == RUG)
927                     game.prop[RUG] = RUG_DRAGON;
928                 if (obj == CHAIN)
929                     game.prop[CHAIN] = CHAINING_BEAR;
930                 --game.tally;
931                 /*  Note: There used to be a test here to see whether the
932                  *  player had blown it so badly that he could never ever see
933                  *  the remaining treasures, and if so the lamp was zapped to
934                  *  35 turns.  But the tests were too simple-minded; things
935                  *  like killing the bird before the snake was gone (can never
936                  *  see jewelry), and doing it "right" was hopeless.  E.G.,
937                  *  could cross troll bridge several times, using up all
938                  *  available treasures, breaking vase, using coins to buy
939                  *  batteries, etc., and eventually never be able to get
940                  *  across again.  If bottle were left on far side, could then
941                  *  never get eggs or trident, and the effects propagate.  So
942                  *  the whole thing was flushed.  anyone who makes such a
943                  *  gross blunder isn't likely to find everything else anyway
944                  *  (so goes the rationalisation). */
945             }
946             int kk = game.prop[obj];
947             if (obj == STEPS)
948                 kk = (game.loc == game.fixed[STEPS])
949                      ? STEPS_UP
950                      : STEPS_DOWN;
951             pspeak(obj, look, kk, true);
952         }
953     }
954 }
955
956 static bool do_command()
957 /* Get and execute a command */
958 {
959     long kmod, defn;
960     static long igo = 0;
961     static struct command_t command;
962     command.verb = 0;
963
964     /*  Can't leave cave once it's closing (except by main office). */
965     if (OUTSID(game.newloc) && game.newloc != 0 && game.closng) {
966         rspeak(EXIT_CLOSED);
967         game.newloc = game.loc;
968         if (!game.panic)
969             game.clock2 = PANICTIME;
970         game.panic = true;
971     }
972
973     /*  See if a dwarf has seen him and has come from where he
974      *  wants to go.  If so, the dwarf's blocking his way.  If
975      *  coming from place forbidden to pirate (dwarves rooted in
976      *  place) let him get out (and attacked). */
977     if (game.newloc != game.loc && !FORCED(game.loc) && !CNDBIT(game.loc, COND_NOARRR)) {
978         for (size_t i = 1; i <= NDWARVES - 1; i++) {
979             if (game.odloc[i] == game.newloc && game.dseen[i]) {
980                 game.newloc = game.loc;
981                 rspeak(DWARF_BLOCK);
982                 break;
983             }
984         }
985     }
986     game.loc = game.newloc;
987
988     if (!dwarfmove())
989         croak();
990
991     /*  Describe the current location and (maybe) get next command. */
992
993     for (;;) {
994         if (game.loc == 0)
995             croak();
996         const char* msg = locations[game.loc].description.small;
997         if (MOD(game.abbrev[game.loc], game.abbnum) == 0 ||
998             msg == 0)
999             msg = locations[game.loc].description.big;
1000         if (!FORCED(game.loc) && DARK(game.loc)) {
1001             /*  The easiest way to get killed is to fall into a pit in
1002              *  pitch darkness. */
1003             if (game.wzdark && PCT(35)) {
1004                 rspeak(PIT_FALL);
1005                 game.oldlc2 = game.loc;
1006                 croak();
1007                 continue;       /* back to top of main interpreter loop */
1008             }
1009             msg = arbitrary_messages[PITCH_DARK];
1010         }
1011         if (TOTING(BEAR))
1012             rspeak(TAME_BEAR);
1013         speak(msg);
1014         if (FORCED(game.loc)) {
1015             playermove(HERE);
1016             return true;
1017         }
1018         if (game.loc == LOC_Y2 && PCT(25) && !game.closng)
1019             rspeak(SAYS_PLUGH);
1020
1021         listobjects();
1022
1023 L2012:
1024         game.oldobj = command.obj;
1025
1026 L2600:
1027         checkhints();
1028
1029         /*  If closing time, check for any objects being toted with
1030          *  game.prop < 0 and stash them.  This way objects won't be
1031          *  described until they've been picked up and put down
1032          *  separate from their respective piles. */
1033         if (game.closed) {
1034             if (game.prop[OYSTER] < 0 && TOTING(OYSTER))
1035                 pspeak(OYSTER, look, 1, true);
1036             for (size_t i = 1; i <= NOBJECTS; i++) {
1037                 if (TOTING(i) && game.prop[i] < 0)
1038                     game.prop[i] = STASHED(i);
1039             }
1040         }
1041         game.wzdark = DARK(game.loc);
1042         if (game.knfloc > 0 && game.knfloc != game.loc)
1043             game.knfloc = 0;
1044
1045         /* This is where we get a new command from the user */
1046         char* input;
1047         char inputbuf[LINESIZE];
1048
1049         for (;;) {
1050             input = get_input();
1051             if (input == NULL)
1052                 return (false);
1053             if (word_count(input) > 2) {
1054                 rspeak(TWO_WORDS);
1055                 free(input);
1056                 continue;
1057             }
1058             if (strcmp(input, "") != 0)
1059                 break;
1060             free(input);
1061         }
1062
1063         strncpy(inputbuf, input, LINESIZE - 1);
1064         free(input);
1065
1066         tokenize(inputbuf, &command);
1067
1068         char word1[TOKLEN + 1];
1069         char word2[TOKLEN + 1];
1070         packed_to_token(command.wd1, word1);
1071         packed_to_token(command.wd2, word2);
1072         command.id1 = get_vocab_id(word1);
1073         command.id2 = get_vocab_id(word2);
1074
1075 L2607:
1076         ++game.turns;
1077
1078         /* If a turn threshold has been met, apply penalties and tell
1079          * the player about it. */
1080         for (int i = 0; i < NTHRESHOLDS; ++i) {
1081             if (game.turns == turn_thresholds[i].threshold + 1) {
1082                 game.trnluz += turn_thresholds[i].point_loss;
1083                 speak(turn_thresholds[i].message);
1084             }
1085         }
1086
1087         if (command.verb == SAY && command.id2 != WORD_NOT_FOUND && command.id2 != WORD_EMPTY)
1088             command.verb = 0;
1089         if (command.verb == SAY) {
1090             command.part = transitive;
1091             goto Laction;
1092         }
1093         if (closecheck()) {
1094             if (game.closed)
1095                 return true;
1096         } else
1097             lampcheck();
1098
1099         if (command.id1 == ENTER && (command.id2 == STREAM ||
1100                                      command.id2 == PROMOTE_WORD(WATER))) {
1101             if (LIQLOC(game.loc) == WATER) {
1102                 rspeak(FEET_WET);
1103             } else {
1104                 rspeak(WHERE_QUERY);
1105             }
1106             goto L2012;
1107         }
1108         if (command.id1 == ENTER && command.id2 != WORD_NOT_FOUND && command.id2 != WORD_EMPTY) {
1109             /* command.wd1 = command.wd2; */
1110             /* wordclear(&command.wd2); */
1111             command.id1 = command.id2;
1112             command.id2 = WORD_EMPTY;
1113         } else {
1114             /* FIXME: Magic numbers related to vocabulary */
1115             if (!((command.id1 != PROMOTE_WORD(WATER) && command.id1 != PROMOTE_WORD(OIL)) ||
1116                   (command.id2 != PROMOTE_WORD(PLANT) && command.id2 != PROMOTE_WORD(DOOR)))) {
1117                 if (AT(DEMOTE_WORD(command.id2)))
1118                     command.wd2 = token_to_packed("POUR");
1119             }
1120             if (command.id1 == PROMOTE_WORD(CAGE) && command.id2 == PROMOTE_WORD(BIRD) && HERE(CAGE) && HERE(BIRD))
1121                 command.wd1 = token_to_packed("CATCH");
1122         }
1123 L2620:
1124         if (wordeq(command.wd1, token_to_packed("WEST"))) {
1125             ++game.iwest;
1126             if (game.iwest == 10)
1127                 rspeak(W_IS_WEST);
1128         }
1129         if (wordeq(command.wd1, token_to_packed("GO")) && !wordempty(command.wd2)) {
1130             if (++igo == 10)
1131                 rspeak(GO_UNNEEDED);
1132         }
1133 Lookup:
1134         packed_to_token(command.wd1, word1);
1135         defn = get_vocab_id(word1);
1136         if (defn == WORD_NOT_FOUND) {
1137             /* Gee, I don't understand. */
1138             if (fallback_handler(inputbuf))
1139                 continue;
1140             sspeak(DONT_KNOW, command.raw1);
1141             goto L2600;
1142         }
1143         /* FIXME: magic numbers related to vocabulary */
1144         kmod = MOD(defn, 1000);
1145         switch (defn / 1000) {
1146         case 0:
1147             playermove(kmod);
1148             return true;
1149         case 1:
1150             command.part = unknown;
1151             command.obj = kmod;
1152             break;
1153         case 2:
1154             command.part = intransitive;
1155             command.verb = kmod;
1156             break;
1157         case 3:
1158             speak(specials[kmod].message);
1159             goto L2012;
1160         default:
1161             BUG(VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3); // LCOV_EXCL_LINE
1162         }
1163
1164 Laction:
1165         switch (action(&command)) {
1166         case GO_TERMINATE:
1167             return true;
1168         case GO_MOVE:
1169             playermove(NUL);
1170             return true;
1171         case GO_TOP:
1172             continue;   /* back to top of main interpreter loop */
1173         case GO_CLEAROBJ:
1174             goto L2012;
1175         case GO_CHECKHINT:
1176             goto L2600;
1177         case GO_CHECKFOO:
1178             goto L2607;
1179         case GO_LOOKUP:
1180             goto Lookup;
1181         case GO_WORD2:
1182             /* Get second word for analysis. */
1183             command.wd1 = command.wd2;
1184             strcpy(command.raw1, command.raw2);
1185             wordclear(&command.wd2);
1186             command.raw2[0] = '\0';
1187             goto L2620;
1188         case GO_UNKNOWN:
1189             /*  Random intransitive verbs come here.  Clear obj just in case
1190              *  (see attack()). */
1191             command.raw1[0] = toupper(command.raw1[0]);
1192             sspeak(DO_WHAT, command.raw1);
1193             command.obj = 0;
1194             goto L2600;
1195         case GO_DWARFWAKE:
1196             /*  Oh dear, he's disturbed the dwarves. */
1197             rspeak(DWARVES_AWAKEN);
1198             terminate(endgame);
1199         default:
1200             BUG(ACTION_RETURNED_PHASE_CODE_BEYOND_END_OF_SWITCH); // LCOV_EXCL_LINE
1201         }
1202     }
1203 }
1204
1205 /* end */