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