Test Coverage -- lots of new pieces of actions.c
[open-adventure.git] / dungeon.c
index 1ca28326f224c65592abb8f9c1c68574bb4c89a8..a39e41394560b1d8f24916173a22a4e04b6a7166 100644 (file)
--- a/dungeon.c
+++ b/dungeon.c
@@ -3,7 +3,6 @@
  * defining (mostly) invariant state.  A couple of slots are messed with
  * at runtime.
  */
-#include "common.h"
 
 #define LINESIZE 100
 #define RTXSIZ 277
@@ -20,6 +19,7 @@
 #include <stdlib.h>
 #include <stdbool.h>
 #include <unistd.h>
+#include "common.h"
 
 // Global variables for use in functions below that can gradually disappear as code is cleaned up
 static long LNLENG;
@@ -30,13 +30,11 @@ static long OLDLOC;
 // Storage for what comes out of the database
 long LINUSE;
 long TRVS;
-long CLSSES;
 long TRNVLS;
 long TABNDX;
 long HNTMAX;
 long PTEXT[NOBJECTS + 1];
 long RTEXT[RTXSIZ + 1];
-long CTEXT[CLSMAX + 1];
 long OBJSND[NOBJECTS + 1];
 long OBJTXT[NOBJECTS + 1];
 long STEXT[LOCSIZ + 1];
@@ -45,7 +43,6 @@ long COND[LOCSIZ + 1];
 long KEY[LOCSIZ + 1];
 long LOCSND[LOCSIZ + 1];
 long LINES[LINSIZ + 1];
-long CVAL[CLSMAX + 1];
 long TTEXT[TRNSIZ + 1];
 long TRNVAL[TRNSIZ + 1];
 long TRAVEL[TRVSIZ + 1];
@@ -54,8 +51,6 @@ long ATAB[TABSIZ + 1];
 long PLAC[NOBJECTS + 1];
 long FIXD[NOBJECTS + 1];
 long ACTSPK[VRBSIZ + 1];
-long HINTS[HNTSIZ + 1][HINTLEN];
-
 
 static bool is_set(long var, long position)
 {
@@ -114,38 +109,6 @@ static long GETTXT(long SKIP, long ONEWRD, long UPPER)
     return (TEXT);
 }
 
-static void BUG(long NUM)
-{
-
-    /*  The following conditions are currently considered fatal bugs.  Numbers < 20
-     *  are detected while reading the database; the others occur at "run time".
-     * 0       Message line > 70 characters
-     * 1       Null line in message
-     * 2       Too many words of messages
-     * 3       Too many travel options
-     * 4       Too many vocabulary words
-     * 5       Required vocabulary word not found
-     * 6       Too many RTEXT messages
-     * 7       Too many hints
-     * 8       Location has cond bit being set twice
-     * 9       Invalid section number in database
-     * 10      Too many locations
-     * 11      Too many class or turn messages
-     * 20      Special travel (500>L>300) exceeds goto list
-     * 21      Ran off end of vocabulary table
-     * 22      Vocabulary type (N/1000) not between 0 and 3
-     * 23      Intransitive action verb exceeds goto list
-     * 24      Transitive action verb exceeds goto list
-     * 25      Conditional travel entry with no alternative
-     * 26      Location has no travel entries
-     * 27      Hint number exceeds goto list
-     * 28      Invalid month returned by date function
-     * 29      Too many parameters given to SETPRM */
-
-    fprintf(stderr, "Fatal error %ld.  See source code for interpretation.\n", NUM);
-    exit(EXIT_FAILURE);
-}
-
 static void MAPLIN(FILE *OPENED)
 {
     /*  Read a line of input, from the specified input source,
@@ -236,34 +199,28 @@ static void read_messages(FILE* database, long sect)
         long loc;
         LINUSE = KK;
         loc = GETNUM(database);
-        if (LNLENG >= LNPOSN + 70)BUG(0);
+        if (LNLENG >= LNPOSN + 70)
+            BUG(MESSAGE_LINE_GT_70_CHARACTERS);
         if (loc == -1) return;
-        if (LNLENG < LNPOSN)BUG(1);
+        if (LNLENG < LNPOSN)
+            BUG(NULL_LINE_IN_MESSAGE);
         do {
             KK = KK + 1;
-            if (KK >= LINSIZ)BUG(2);
+            if (KK >= LINSIZ)
+                BUG(TOO_MANY_WORDS_OF_MESSAGES);
             LINES[KK] = GETTXT(false, false, false);
         } while (LINES[KK] != -1);
         LINES[LINUSE] = KK;
         if (loc == OLDLOC) continue;
         OLDLOC = loc;
         LINES[LINUSE] = -KK;
-        if (sect == 14) {
-            TRNVLS = TRNVLS + 1;
-            if (TRNVLS > TRNSIZ)BUG(11);
-            TTEXT[TRNVLS] = LINUSE;
-            TRNVAL[TRNVLS] = loc;
-            continue;
-        }
-        if (sect == 10) {
-            CLSSES = CLSSES + 1;
-            if (CLSSES > CLSMAX)BUG(11);
-            CTEXT[CLSSES] = LINUSE;
-            CVAL[CLSSES] = loc;
+        if (sect == 10 || sect == 14) {
+           /* now parsed from YAML */
             continue;
         }
         if (sect == 6) {
-            if (loc > RTXSIZ)BUG(6);
+            if (loc > RTXSIZ)
+                BUG(TOO_MANY_RTEXT_MESSAGES);
             RTEXT[loc] = LINUSE;
             continue;
         }
@@ -271,7 +228,8 @@ static void read_messages(FILE* database, long sect)
             if (loc > 0 && loc <= NOBJECTS)PTEXT[loc] = LINUSE;
             continue;
         }
-        if (loc > LOCSIZ)BUG(10);
+        if (loc > LOCSIZ)
+            BUG(TOO_MANY_LOCATIONS);
         if (sect == 1) {
             LTEXT[loc] = LINUSE;
             continue;
@@ -300,7 +258,8 @@ static void read_section3_stuff(FILE* database)
         while ((L = GETNUM(NULL)) != 0) {
             TRAVEL[TRVS] = newloc * 1000 + L;
             TRVS = TRVS + 1;
-            if (TRVS == TRVSIZ)BUG(3);
+            if (TRVS == TRVSIZ)
+                BUG(TOO_MANY_TRAVEL_OPTIONS);
         }
         TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
     }
@@ -316,7 +275,7 @@ static void read_vocabulary(FILE* database)
         if (KTAB[TABNDX] == -1) return;
         ATAB[TABNDX] = GETTXT(true, true, true);
     } /* end loop */
-    BUG(4);
+    BUG(TOO_MANY_VOCABULARY_WORDS);
 }
 
 /*  Read in the initial locations for each object.  Also the immovability info.
@@ -347,7 +306,8 @@ static void read_conditions(FILE* database)
     while ((K = GETNUM(database)) != -1) {
         long loc;
         while ((loc = GETNUM(NULL)) != 0) {
-            if (is_set(COND[loc], K)) BUG(8);
+            if (is_set(COND[loc], K))
+                BUG(LOCATION_HAS_CONDITION_BIT_BEING_SET_TWICE);
             COND[loc] = COND[loc] + (1l << K);
         }
     }
@@ -360,9 +320,11 @@ static void read_hints(FILE* database)
     long K;
     HNTMAX = 0;
     while ((K = GETNUM(database)) != -1) {
-        if (K <= 0 || K > HNTSIZ)BUG(7);
+        if (K <= 0 || K > HNTSIZ)
+            BUG(TOO_MANY_HINTS);
         for (int I = 1; I <= 4; I++) {
-            HINTS[K][I] = GETNUM(NULL);
+           /* consume - actual arrqy-building now done in YAML. */
+            GETNUM(NULL);
         } /* end loop */
         HNTMAX = (HNTMAX > K ? HNTMAX : K);
     }
@@ -388,17 +350,17 @@ static void read_sound_text(FILE* database)
 
 static int read_database(FILE* database)
 {
-
-    /*  Clear out the various text-pointer arrays.  All text is stored in array
-     *  lines; each line is preceded by a word pointing to the next pointer (i.e.
-     *  the word following the end of the line).  The pointer is negative if this is
-     *  first line of a message.  The text-pointer arrays contain indices of
-     *  pointer-words in lines.  STEXT(N) is short description of location N.
-     *  LTEXT(N) is long description.  PTEXT(N) points to message for game.prop(N)=0.
-     *  Successive prop messages are found by chasing pointers.  RTEXT contains
-     *  section 6's stuff.  CTEXT(N) points to a player-class message.  TTEXT is for
-     *  section 14.  We also clear COND (see description of section 9 for details). */
-
+    /*  Clear out the various text-pointer arrays.  All text is stored
+     *  in array lines; each line is preceded by a word pointing to
+     *  the next pointer (i.e.  the word following the end of the
+     *  line).  The pointer is negative if this is first line of a
+     *  message.  The text-pointer arrays contain indices of
+     *  pointer-words in lines.  STEXT(N) is short description of
+     *  location N.  LTEXT(N) is long description.  PTEXT(N) points to
+     *  message for game.prop(N)=0.  Successive prop messages are
+     *  found by chasing pointers.  RTEXT contains section 6's stuff.
+     *  TTEXT is for section 14.  We also clear COND (see description
+     *  of section 9 for details). */
     for (int I = 1; I <= NOBJECTS; I++) {
         PTEXT[I] = 0;
         OBJSND[I] = 0;
@@ -407,9 +369,6 @@ static int read_database(FILE* database)
     for (int I = 1; I <= RTXSIZ; I++) {
         RTEXT[I] = 0;
     }
-    for (int I = 1; I <= CLSMAX; I++) {
-        CTEXT[I] = 0;
-    }
     for (int I = 1; I <= LOCSIZ; I++) {
         STEXT[I] = 0;
         LTEXT[I] = 0;
@@ -420,7 +379,6 @@ static int read_database(FILE* database)
 
     LINUSE = 1;
     TRVS = 1;
-    CLSSES = 0;
     TRNVLS = 0;
 
     /*  Start new data section.  Sect is the section number. */
@@ -473,7 +431,7 @@ static int read_database(FILE* database)
             read_messages(database, sect);
             break;
         default:
-            BUG(9);
+            BUG(INVALID_SECTION_NUMBER_IN_DATABASE);
         }
     }
 }
@@ -509,29 +467,8 @@ static void write_1d(FILE* header_file, long array[], long dim, const char* varn
     fprintf(header_file, "\n});\n");
 }
 
-static void write_hints(FILE* header_file, long matrix[][HINTLEN], long dim1, long dim2, const char* varname)
-{
-    fprintf(header_file, "LOCATION long %s[][%ld] INITIALIZE(= {\n", varname, dim2);
-    for (int i = 0; i < dim1; ++i) {
-        fprintf(header_file, "  {");
-        for (int j = 0; j < dim2; ++j) {
-            fprintf(header_file, "%ld, ", matrix[i][j]);
-        }
-        fprintf(header_file, "},\n");
-    }
-    fprintf(header_file, "});\n");
-}
-
 static void write_file(FILE* header_file)
 {
-    int MAXDIE;
-    for (int i = 0; i <= 4; i++) {
-        long x = 2 * i + 81;
-        if (RTEXT[x] != 0)
-            MAXDIE = i + 1;
-    }
-
-
     fprintf(header_file, "#ifndef DATABASE_H\n");
     fprintf(header_file, "#define DATABASE_H\n");
     fprintf(header_file, "\n");
@@ -540,7 +477,6 @@ static void write_file(FILE* header_file)
     fprintf(header_file, "#define TABSIZ 330\n");
     fprintf(header_file, "#define HNTSIZ 20\n");
     fprintf(header_file, "#define TOKLEN %d\n", TOKLEN);
-    fprintf(header_file, "#define MAXDIE %d\n", MAXDIE);
     fprintf(header_file, "\n");
 
     fprintf(header_file, "\n");
@@ -554,28 +490,30 @@ static void write_file(FILE* header_file)
     fprintf(header_file, "\n");
 
     // content variables
-    write_0d(header_file, TRNVLS, "TRNVLS");
     write_0d(header_file, HNTMAX, "HNTMAX");
     write_1d(header_file, OBJSND, NOBJECTS + 1, "OBJSND");
     write_1d(header_file, OBJTXT, NOBJECTS + 1, "OBJTXT");
     write_1d(header_file, COND, LOCSIZ + 1, "COND");
     write_1d(header_file, KEY, LOCSIZ + 1, "KEY");
     write_1d(header_file, LOCSND, LOCSIZ + 1, "LOCSND");
-    write_1d(header_file, CVAL, CLSMAX + 1, "CVAL");
-    write_1d(header_file, TRNVAL, TRNSIZ + 1, "TRNVAL");
     write_1d(header_file, TRAVEL, TRVSIZ + 1, "TRAVEL");
     write_1d(header_file, KTAB, TABSIZ + 1, "KTAB");
     write_1d(header_file, ATAB, TABSIZ + 1, "ATAB");
     write_1d(header_file, PLAC, NOBJECTS + 1, "PLAC");
     write_1d(header_file, FIXD, NOBJECTS + 1, "FIXD");
     write_1d(header_file, ACTSPK, VRBSIZ + 1, "ACTSPK");
-    write_hints(header_file, HINTS, HNTSIZ + 1, 5, "HINTS");
 
     fprintf(header_file, "#undef LOCATION\n");
     fprintf(header_file, "#undef INITIALIZE\n");
     fprintf(header_file, "#endif\n");
 }
 
+void bug(enum bugtype num, const char *error_string)
+{
+    fprintf(stderr, "Fatal error %d, %s.\n", num, error_string);
+    exit(EXIT_FAILURE);
+}
+
 int main(void)
 {
     FILE* database = fopen("adventure.text", "r");