Specials excised from adventure.yaml
[open-adventure.git] / make_dungeon.py
index a02fd1e1a54d39acc15b04c6c52cf0f5c37432c1..03b5b04229fc60023a378208cc8525fb8873bb97 100755 (executable)
@@ -1,48 +1,11 @@
-#!/usr/bin/python3
+#!/usr/bin/env python
 
-# This is the new open-adventure dungeon generator. It'll eventually
-# replace the existing dungeon.c It currently outputs a .h and .c pair
-# for C code.
+# This is the open-adventure dungeon generator. It consumes a YAML description of
+# the dungeon and outputs a dungeon.h and dungeon.c pair of C code files.
 #
 # The nontrivial part of this is the compilation of the YAML for
 # movement rules to the travel array that's actually used by
-# playermove().  This program first compiles the YAML to a form
-# identical to the data in section 3 of the old adventure.text file,
-# then a second stage unpacks that data into the travel array.
-#
-# Here are the rules of the intermediate form:
-#
-# Each row of data contains a location number (X), a second
-# location number (Y), and a list of motion numbers (see section 4).
-# each motion represents a verb which will go to Y if currently at X.
-# Y, in turn, is interpreted as follows.  Let M=Y/1000, N=Y mod 1000.
-#              If N<=300       it is the location to go to.
-#              If 300<N<=500   N-300 is used in a computed goto to
-#                                      a section of special code.
-#              If N>500        message N-500 from section 6 is printed,
-#                                      and he stays wherever he is.
-# Meanwhile, M specifies the conditions on the motion.
-#              If M=0          it's unconditional.
-#              If 0<M<100      it is done with M% probability.
-#              If M=100        unconditional, but forbidden to dwarves.
-#              If 100<M<=200   he must be carrying object M-100.
-#              If 200<M<=300   must be carrying or in same room as M-200.
-#              If 300<M<=400   game.prop(M % 100) must *not* be 0.
-#              If 400<M<=500   game.prop(M % 100) must *not* be 1.
-#              If 500<M<=600   game.prop(M % 100) must *not* be 2, etc.
-# If the condition (if any) is not met, then the next *different*
-# "destination" value is used (unless it fails to meet *its* conditions,
-# in which case the next is found, etc.).  Typically, the next dest will
-# be for one of the same verbs, so that its only use is as the alternate
-# destination for those verbs.  For instance:
-#              15      110022  29      31      34      35      23      43
-#              15      14      29
-# This says that, from loc 15, any of the verbs 29, 31, etc., will take
-# him to 22 if he's carrying object 10, and otherwise will go to 14.
-#              11      303008  49
-#              11      9       50
-# This says that, from 11, 49 takes him to 8 unless game.prop(3)=0, in which
-# case he goes to 9.  Verb 50 takes him to 9 regardless of game.prop(3).
+# playermove().
 
 import sys, yaml
 
@@ -142,17 +105,19 @@ typedef struct {{
 typedef struct {{
   const string_group_t words;
   const char* message;
+  const bool noaction;
 }} action_t;
 
-typedef struct {{
-  const string_group_t words;
-  const char* message;
-}} special_t;
+enum condtype_t {{cond_goto, cond_pct, cond_carry, cond_with, cond_not}};
+enum desttype_t {{dest_goto, dest_special, dest_speak}};
 
 typedef struct {{
   const long motion;
-  const long cond;
-  const long dest;
+  const long condtype;
+  const long condarg1;
+  const long condarg2;
+  const enum desttype_t desttype;
+  const long destval;
   const bool nodwarves;
   const bool stop;
 }} travelop_t;
@@ -163,7 +128,6 @@ typedef struct {{
  * encoding description for travel.
  */
 #define T_TERMINATE(entry)     ((entry).motion == 1)
-#define L_SPEAK(loc)           ((loc) - 500)
 
 extern const location_t locations[];
 extern const object_t objects[];
@@ -175,7 +139,6 @@ extern const hint_t hints[];
 extern long conditions[];
 extern const motion_t motions[];
 extern const action_t actions[];
-extern const special_t specials[];
 extern const travelop_t travel[];
 extern const long tkey[];
 extern const char *ignore;
@@ -186,9 +149,8 @@ extern const char *ignore;
 #define NCLASSES       {}
 #define NDEATHS                {}
 #define NTHRESHOLDS    {}
-#define NMOTIONS        {}
+#define NMOTIONS    {}
 #define NACTIONS       {}
-#define NSPECIALS       {}
 #define NTRAVEL                {}
 #define NKEYS          {}
 
@@ -214,10 +176,6 @@ enum action_refs {{
 {}
 }};
 
-enum special_refs {{
-{}
-}};
-
 /* State definitions */
 
 {}
@@ -268,10 +226,6 @@ const action_t actions[] = {{
 {}
 }};
 
-const special_t specials[] = {{
-{}
-}};
-
 const long tkey[] = {{{}}};
 
 const travelop_t travel[] = {{
@@ -416,8 +370,8 @@ def get_objects(obj):
             if labels:
                 global statedefines
                 statedefines += "/* States for %s */\n" % item[0]
-                for (i, label) in enumerate(labels):
-                    statedefines += "#define %s\t%d\n" % (label, i)
+                for (j, label) in enumerate(labels):
+                    statedefines += "#define %s\t%d\n" % (label, j)
                 statedefines += "\n"
         sounds_str = ""
         if attr.get("sounds") == None:
@@ -533,40 +487,12 @@ def get_actions(actions):
     template = """    {{
         .words = {},
         .message = {},
+        .noaction = {},
     }},
 """
     act_str = ""
     for action in actions:
         contents = action[1]
-        
-        if contents["words"] == None:
-            words_str = get_string_group([])
-        else:
-            words_str = get_string_group(contents["words"])
-
-        if contents["message"] == None:
-            message = "NO_MESSAGE"
-        else:
-            message = contents["message"]
-            
-        act_str += template.format(words_str, message)
-        global ignore
-        if contents.get("oldstyle", True) == False:
-            for word in contents["words"]:
-                if len(word) == 1:
-                    ignore += word.upper()
-    act_str = act_str[:-1] # trim trailing newline
-    return act_str
-
-def get_specials(specials):
-    template = """    {{
-        .words = {},
-        .message = {},
-    }},
-"""
-    spc_str = ""
-    for special in specials:
-        contents = special[1]
 
         if contents["words"] == None:
             words_str = get_string_group([])
@@ -578,14 +504,19 @@ def get_specials(specials):
         else:
             message = make_c_string(contents["message"])
 
-        spc_str += template.format(words_str, message)
+        if contents.get("noaction") == None:
+            noaction = "false"
+        else:
+            noaction = "true"
+
+        act_str += template.format(words_str, message, noaction)
         global ignore
         if contents.get("oldstyle", True) == False:
             for word in contents["words"]:
                 if len(word) == 1:
                     ignore += word.upper()
-    spc_str = spc_str[:-1] # trim trailing newline
-    return spc_str
+    act_str = act_str[:-1] # trim trailing newline
+    return act_str
 
 def bigdump(arr):
     out = ""
@@ -599,6 +530,51 @@ def bigdump(arr):
     return out
 
 def buildtravel(locs, objs):
+    assert len(locs) <= 300
+    assert len(objs) <= 100
+    # THIS CODE IS WAAAY MORE COMPLEX THAN IT NEEDS TO BE.  It's the
+    # result of a massive refactoring exercise that concentrated all
+    # the old nastiness in one spot. It hasn't been finally simplified
+    # because there's no need to do it until one of the asserions
+    # fails. Hint: if you try cleaning this up, the acceptance test is
+    # simple - the output dungeon.c must not change.
+    #
+    # This function first compiles the YAML to a form identical to the
+    # data in section 3 of the old adventure.text file, then a second
+    # stage unpacks that data into the travel array.  Here are the
+    # rules of that intermediate form:
+    #
+    # Each row of data contains a location number (X), a second
+    # location number (Y), and a list of motion numbers (see section 4).
+    # each motion represents a verb which will go to Y if currently at X.
+    # Y, in turn, is interpreted as follows.  Let M=Y/1000, N=Y mod 1000.
+    #          If N<=300       it is the location to go to.
+    #          If 300<N<=500   N-300 is used in a computed goto to
+    #                                  a section of special code.
+    #          If N>500        message N-500 from section 6 is printed,
+    #                                  and he stays wherever he is.
+    # Meanwhile, M specifies the conditions on the motion.
+    #          If M=0          it's unconditional.
+    #          If 0<M<100      it is done with M% probability.
+    #          If M=100        unconditional, but forbidden to dwarves.
+    #          If 100<M<=200   he must be carrying object M-100.
+    #          If 200<M<=300   must be carrying or in same room as M-200.
+    #          If 300<M<=400   game.prop(M % 100) must *not* be 0.
+    #          If 400<M<=500   game.prop(M % 100) must *not* be 1.
+    #          If 500<M<=600   game.prop(M % 100) must *not* be 2, etc.
+    # If the condition (if any) is not met, then the next *different*
+    # "destination" value is used (unless it fails to meet *its* conditions,
+    # in which case the next is found, etc.).  Typically, the next dest will
+    # be for one of the same verbs, so that its only use is as the alternate
+    # destination for those verbs.  For instance:
+    #          15      110022  29      31      34      35      23      43
+    #          15      14      29
+    # This says that, from loc 15, any of the verbs 29, 31, etc., will take
+    # him to 22 if he's carrying object 10, and otherwise will go to 14.
+    #          11      303008  49
+    #          11      9       50
+    # This says that, from 11, 49 takes him to 8 unless game.prop[3]=0, in which
+    # case he goes to 9.  Verb 50 takes him to 9 regardless of game.prop[3].
     ltravel = []
     verbmap = {}
     for i, motion in enumerate(db["motions"]):
@@ -613,7 +589,7 @@ def buildtravel(locs, objs):
             try:
                 return locnames.index(action[1])
             except ValueError:
-                sys.stderr.write("dungeon: unknown location %s in goto clause of %s\n" % (cond[1], name))
+                sys.stderr.write("dungeon: unknown location %s in goto clause of %s\n" % (action[1], name))
         elif action[0] == "special":
             return 300 + action[1]
         elif action[0] == "speak":
@@ -675,34 +651,14 @@ def buildtravel(locs, objs):
                 tt.append(dest)
                 tt += [motionnames[verbmap[e]].upper() for e in rule["verbs"]]
                 if not rule["verbs"]:
-                    tt.append(1)
+                    tt.append(1)       # Magic dummy entry for null rules
                 ltravel.append(tuple(tt))
 
     # At this point the ltravel data is in the Section 3
     # representation from the FORTRAN version.  Next we perform the
-    # same mapping into the runtime format.  This was the C translation
-    # of the FORTRAN code:
-    # long loc;
-    # while ((loc = GETNUM(database)) != -1) {
-    #     long newloc = GETNUM(NULL);
-    #     long L;
-    #     if (TKEY[loc] == 0) {
-    #         TKEY[loc] = TRVS;
-    #     } else {
-    #         TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
-    #     }
-    #     while ((L = GETNUM(NULL)) != 0) {
-    #         TRAVEL[TRVS] = newloc * 1000 + L;
-    #         TRVS = TRVS + 1;
-    #         if (TRVS == TRVSIZ)
-    #             BUG(TOO_MANY_TRAVEL_OPTIONS);
-    #     }
-    #     TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
-    # }
-    #
-    # In order to de-crypticize the runtime code, we're going to break these
-    # magic numbers up into a struct.
-    travel = [[0, 0, 0, "false", "false"]]
+    # same mapping into wgat used to be the runtime format.
+
+    travel = [[0, "LOC_NOWHERE", 0, 0, 0, 0, 0, 0, "false", "false"]]
     tkey = [0]
     oldloc = 0
     while ltravel:
@@ -716,19 +672,61 @@ def buildtravel(locs, objs):
             travel[-1][-1] = "false" if travel[-1][-1] == "true" else "true" 
         while rule:
             cond = newloc // 1000
-            travel.append([rule.pop(0),
-                           cond,
-                           newloc % 1000,
-                           "true" if cond==100 else "false",
+            nodwarves = (cond == 100)
+            if cond == 0:
+                condtype = "cond_goto"
+                condarg1 = condarg2 = 0
+            elif cond < 100:
+                condtype = "cond_pct"
+                condarg1 = cond
+                condarg2 = 0
+            elif cond == 100:
+                condtype = "cond_goto"
+                condarg1 = 100
+                condarg2 = 0
+            elif cond <= 200:
+                condtype = "cond_carry"
+                condarg1 = objnames[cond - 100]
+                condarg2 = 0
+            elif cond <= 300:
+                condtype = "cond_with"
+                condarg1 = objnames[cond - 200]
+                condarg2 = 0
+            else:
+                condtype = "cond_not"
+                condarg1 = cond % 100
+                condarg2 = (cond - 300) // 100.
+            dest = newloc % 1000
+            if dest <= 300:
+                desttype = "dest_goto";
+                destval = locnames[dest]
+            elif dest > 500:
+                desttype = "dest_speak";
+                destval = msgnames[dest - 500]
+            else:
+                desttype = "dest_special";
+                destval = locnames[dest - 300]
+            travel.append([len(tkey)-1,
+                           locnames[len(tkey)-1],
+                           rule.pop(0),
+                           condtype,
+                           condarg1,
+                           condarg2,
+                           desttype,
+                           destval,
+                           "true" if nodwarves else "false",
                            "false"])
         travel[-1][-1] = "true"
     return (travel, tkey)
 
 def get_travel(travel):
-    template = """    {{
+    template = """    {{ // from {}: {}
         .motion = {},
-        .cond = {},
-        .dest = {},
+        .condtype = {},
+        .condarg1 = {},
+        .condarg2 = {},
+        .desttype = {},
+        .destval = {},
         .nodwarves = {},
         .stop = {},
     }},
@@ -762,8 +760,7 @@ if __name__ == "__main__":
         get_hints(db["hints"], db["arbitrary_messages"]),
         get_condbits(db["locations"]),
         get_motions(db["motions"]),
-        get_specials(db["actions"]),
-        get_specials(db["specials"]),
+        get_actions(db["actions"]),
         bigdump(tkey),
         get_travel(travel), 
         ignore,
@@ -782,7 +779,6 @@ if __name__ == "__main__":
         len(db["turn_thresholds"]),
         len(db["motions"]),
         len(db["actions"]),
-        len(db["specials"]),
         len(travel),
         len(tkey),
         deathbird,
@@ -791,7 +787,6 @@ if __name__ == "__main__":
         get_refs(db["objects"]),
         get_refs(db["motions"]),
         get_refs(db["actions"]),
-        get_refs(db["specials"]),
         statedefines,
     )