Implement and document state-changes messages in YAML.

[open-adventure.git] / newdungeon.py

diff --git a/newdungeon.py b/newdungeon.py
index 6f95bb4232277da9b650112c761fa31184dd8529..f2e801f587d91e7735d50ecfa8061cb92663e062 100755 (executable)
--- a/newdungeon.py
+++ b/newdungeon.py
@@ -8,7 +8,7 @@
 # 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 packs that data into the travel array.
+# then a second stage unpacks that data into the travel array.
 #
 # Here are the rules of the intermediate form:
 #
@@ -88,9 +88,10 @@ typedef struct {{
   const char* inventory;
   int plac, fixd;
   bool is_treasure;
-  const char** longs;
+  const char** descriptions;
   const char** sounds;
   const char** texts;
+  const char** changes;
 }} object_t;
 
 typedef struct {{
@@ -137,6 +138,23 @@ typedef struct {{
   const long message;
 }} action_t;
 
+typedef struct {{
+  const long motion;
+  const long dest;
+  const bool stop;
+}} travelop_t;
+
+/* Abstract out the encoding of words in the travel array.  Gives us
+ * some hope of getting to a less cryptic representation than we
+ * inherited from FORTRAN, someday. To understand these, read the
+ * encoding description for travel.
+ */
+#define T_DESTINATION(entry)   MOD((entry).dest, 1000)
+#define T_NODWARVES(entry)     ((entry).dest / 1000 == 100)
+#define T_HIGH(entry)          ((entry).dest)
+#define T_TERMINATE(entry)     ((entry).motion == 1)
+#define L_SPEAK(loc)           ((loc) - 500)
+
 extern const location_t locations[];
 extern const object_t objects[];
 extern const char* arbitrary_messages[];
@@ -147,7 +165,7 @@ extern const hint_t hints[];
 extern long conditions[];
 extern const motion_t motions[];
 extern const action_t actions[];
-extern const long travel[];
+extern const travelop_t travel[];
 extern const long tkey[];
 
 #define NLOCATIONS     {}
@@ -233,7 +251,9 @@ const action_t actions[] = {{
 
 {}
 
+const travelop_t travel[] = {{
 {}
+}};
 
 /* end */
 """
@@ -322,13 +342,16 @@ def get_objects(obj):
         .plac = {},
         .fixd = {},
         .is_treasure = {},
-        .longs = (const char* []) {{
+        .descriptions = (const char* []) {{
 {}
         }},
         .sounds = (const char* []) {{
 {}
         }},
         .texts = (const char* []) {{
+{}
+        }},
+        .changes = (const char* []) {{
 {}
         }},
     }},
@@ -337,17 +360,17 @@ def get_objects(obj):
     for (i, item) in enumerate(obj):
         attr = item[1]
         i_msg = make_c_string(attr["inventory"])
-        longs_str = ""
-        if attr["longs"] == None:
-            longs_str = " " * 12 + "NULL,"
+        descriptions_str = ""
+        if attr["descriptions"] == None:
+            descriptions_str = " " * 12 + "NULL,"
         else:
             labels = []
-            for l_msg in attr["longs"]:
+            for l_msg in attr["descriptions"]:
                 if not isinstance(l_msg, str):
                     labels.append(l_msg)
                     l_msg = l_msg[1]
-                longs_str += " " * 12 + make_c_string(l_msg) + ",\n"
-            longs_str = longs_str[:-1] # trim trailing newline
+                descriptions_str += " " * 12 + make_c_string(l_msg) + ",\n"
+            descriptions_str = descriptions_str[:-1] # trim trailing newline
             if labels:
                 global statedefines
                 statedefines += "/* States for %s */\n" % item[0]
@@ -370,6 +393,13 @@ def get_objects(obj):
              for l_msg in attr["texts"]:
                  texts_str += " " * 12 + make_c_string(l_msg) + ",\n"
              texts_str = texts_str[:-1] # trim trailing newline
+        changes_str = ""
+        if attr.get("changes") == None:
+            changes_str = " " * 12 + "NULL,"
+        else:
+             for l_msg in attr["changes"]:
+                 changes_str += " " * 12 + make_c_string(l_msg) + ",\n"
+             changes_str = changes_str[:-1] # trim trailing newline
         locs = attr.get("locations", ["LOC_NOWHERE", "LOC_NOWHERE"])
         immovable = attr.get("immovable", False)
         try:
@@ -381,7 +411,7 @@ def get_objects(obj):
             sys.stderr.write("dungeon: unknown object location in %s\n" % locs)
             sys.exit(1)
         treasure = "true" if attr.get("treasure") else "false"
-        obj_str += template.format(i, i_msg, locs[0], locs[1], treasure, longs_str, sounds_str, texts_str)
+        obj_str += template.format(i, i_msg, locs[0], locs[1], treasure, descriptions_str, sounds_str, texts_str, changes_str)
     obj_str = obj_str[:-1] # trim trailing newline
     return obj_str
 
@@ -548,7 +578,19 @@ def buildtravel(locs, objs, voc):
         elif cond[0] == "not":
             # FIXME: Allow named as well as numbered states
             try:
-                return 300 + objnames.index(cond[1]) + 100 * cond[2]
+                obj = objnames.index(cond[1])
+                if type(cond[2]) == int:
+                    state = cond[2]
+                else:
+                    for (i, stateclause) in enumerate(objs[obj][1]["descriptions"]):
+                        if type(stateclause) == list:
+                            if stateclause[0] == cond[2]:
+                                state = i
+                                break
+                    else:
+                        sys.stderr.write("dungeon: unmatched state symbol %s in not clause of %s\n" % (cond[2], name))
+                        sys.exit(0);
+                return 300 + obj + 100 * state
             except ValueError:
                 sys.stderr.write("dungeon: unknown object name %s in not clause of %s\n" % (cond[1], name))
                 sys.exit(1)
@@ -588,7 +630,10 @@ def buildtravel(locs, objs, voc):
     #     }
     #     TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
     # }
-    travel = [0]
+    #
+    # In order to de-crypticize the runtime code, we're going to break these
+    # magic numbers up into a struct.
+    travel = [[0, 0, False]]
     tkey = [0]
     oldloc = 0
     while ltravel:
@@ -598,13 +643,26 @@ def buildtravel(locs, objs, voc):
         if loc != oldloc:
             tkey.append(len(travel))
             oldloc = loc 
-            if travel:
-                travel[-1] *= -1
+        elif travel:
+            travel[-1][2] = not travel[-1][2]
         while rule:
-            travel.append(rule.pop(0) + newloc * 1000)
-        travel[-1] *= -1
+            travel.append([rule.pop(0), newloc, False])
+        travel[-1][2] = True
     return (travel, tkey)
 
+def get_travel(travel):
+    template = """    {{
+        .motion = {},
+        .dest = {},
+        .stop = {},
+    }},
+"""
+    out = ""
+    for entry in travel:
+        out += template.format(entry[0], entry[1], entry[2]).lower()
+    out = out[:-1] # trim trailing newline
+    return out
+
 if __name__ == "__main__":
     with open(yaml_name, "r") as f:
         db = yaml.load(f)
@@ -630,7 +688,7 @@ if __name__ == "__main__":
         get_motions(db["motions"]),
         get_actions(db["actions"]),
         "const long tkey[] = {%s};" % bigdump(tkey),
-        "const long travel[] = {%s};" % bigdump(travel), 
+        get_travel(travel), 
     )
 
     h = h_template.format(