pylint cleanup.
[open-adventure.git] / make_graph.py
index a2b0afc6453572fb61491cbcbf79f8a13ac3c361..1cb975c1e95e5ad0e72bd9d8f27b126a27f63571 100755 (executable)
@@ -1,24 +1,30 @@
 #!/usr/bin/env python3
 """\
-usage: make-graph.py [-a] [-m] [-s]
+usage: make-graph.py [-a] -d] [-m] [-s]
 
-Make a DOT graph of Colossal Cave
+Make a DOT graph of Colossal Cave.
 
 -a = emit graph of entire dungeon
+-d = emit graoh of mazw all different
 -m = emit graph of maze all alike
 -s = emit graph of surface locations
 """
 # Copyright (c) 2017 by Eric S. Raymond
 # SPDX-License-Identifier: BSD-2-clause
 
-import sys, yaml, getopt
+import sys, getopt, yaml
 
 def allalike(loc):
     "Select out loci related to the Maze All Alike"
     return ("ALIKE" in loc) or (loc == "LOC_PITBRINK") or ("MAZEEND" in loc) or ("STALACTITE" in loc)
 
-def surface(attrs):
+def alldifferent(loc):
+    "Select out loci related to the Maze All Alike"
+    return ("DIFFERENT" in loc) or (loc == "LOC_DEADEND13")
+
+def surface(loc):
     "Select out surface locations"
+    attrs = location_lookup[loc]
     if ("ABOVE" in attrs["conditions"]) and attrs["conditions"]["ABOVE"]:
         return True
     if ("FOREST" in attrs["conditions"]) and attrs["conditions"]["FOREST"]:
@@ -29,27 +35,84 @@ def abbreviate(d):
     m = {"NORTH":"N", "EAST":"E", "SOUTH":"S", "WEST":"W", "UPWAR":"U", "DOWN":"D"}
     return m.get(d, d)
 
+def roomlabel(loc):
+    "Generate a room label from the description, if possible"
+    loc_descriptions = location_lookup[loc]['description']
+    description = loc[4:]
+    longd = loc_descriptions["long"]
+    short = loc_descriptions["maptag"] or loc_descriptions["short"]
+    if short is None and longd is not None and len(longd) < 20:
+        short = loc_descriptions["long"]
+    if short is not None:
+        if short.startswith("You're "):
+            short = short[7:]
+        if short.startswith("You are "):
+            short = short[8 :]
+        if short.startswith("in ") or short.startswith("at ") or short.startswith("on "):
+            short = short[3:]
+        if short.startswith("the "):
+            short = short[4:]
+        if short[:3] in {"n/s", "e/w"}:
+            short = short[:3].upper() + short[3:]
+        elif short[:2] in {"ne", "sw", "se", "nw"}:
+            short = short[:2].upper() + short[2:]
+        else:
+            short = short[0].upper() + short[1:]
+        description += "\\n" + short
+    return description
+
+# A forwarder is a location that you can't actually stop in - when you go there
+# it ships some message (which is the point) then shifts you to a nexr location.
+# A forwarder has a zero-length array of notion verbs in its travel section.
+#
+# Here is an examoke forwarder kocation:
+#
+# - LOC_GRUESOME:
+#    description:
+#      long: 'There is now one more gruesome aspect to the spectacular vista.'
+#      short: !!null
+#      maptag: !!null
+#    conditions: {DEEP: true}
+#    travel: [
+#      {verbs: [], action: [goto, LOC_NOWHERE]},
+#    ]
+
+def is_forwarder(loc):
+    "Is a location a forwarder?"
+    travel = location_lookup[loc]['travel']
+    return len(travel) == 1 and len(travel[0]['verbs']) == 0
+
+def forward(loc):
+    "Chase a location through forwarding links."
+    while is_forwarder(loc):
+        loc = location_lookup[loc]["travel"][0]["action"][1]
+    return loc
+
 if __name__ == "__main__":
     with open("adventure.yaml", "r") as f:
         db = yaml.safe_load(f)
 
+    location_lookup = dict(db["locations"])
+
     try:
-        (options, arguments) = getopt.getopt(sys.argv[1:], "ams")
+        (options, arguments) = getopt.getopt(sys.argv[1:], "adms")
     except getopt.GetoptError as e:
         print(e)
         sys.exit(1)
 
-    subset = "maze"
+    subset = allalike
     for (switch, val) in options:
         if switch == '-a':
-            subset = "all"
+            subset = lambda loc: True
+        elif switch == '-d':
+            subset = alldifferent
         elif switch == '-m':
-            subset = "maze"
+            subset = allalike
         elif switch == '-s':
-            subset = "surface"
+            subset = surface
         else:
             sys.stderr.write(__doc__)
-            raise SystemExit(1)        
+            raise SystemExit(1)
 
     startlocs = {}
     for obj in db["objects"]:
@@ -72,20 +135,18 @@ if __name__ == "__main__":
                 startlocs[location] = [objname]
 
     print("digraph G {")
-    
-    for (loc, attrs) in db["locations"]:        
-        if subset == "surface" and not surface(attrs):
+
+    for (loc, attrs) in db["locations"]:
+        if is_forwarder(loc):
+            continue
+        if not subset(loc):
             continue
-        if subset == "maze" and not allalike(loc):
-            continue;
-        node_label = loc[4:]
+        node_label = roomlabel(loc)
         if loc in startlocs:
             node_label += "\\n" + ",".join(startlocs[loc]).lower()
         print('    %s [shape=box,label="%s"]' % (loc[4:], node_label))
-        
-    for (loc, attrs) in db["locations"]:        
-        if subset == "surface" and not surface(attrs):
-            continue
+
+    for (loc, attrs) in db["locations"]:
         travel = attrs["travel"]
         if len(travel) > 0:
             for dest in travel:
@@ -94,12 +155,14 @@ if __name__ == "__main__":
                     continue
                 action = dest["action"]
                 if action[0] == "goto":
-                    dest = action[1]
-                    if subset == "maze" and not (allalike(loc) or allalike(dest)):
-                        continue;
+                    dest = forward(action[1])
+                    if not (subset(loc) or subset(dest)):
+                        continue
                     arc = "%s -> %s" % (loc[4:], dest[4:])
                     label=",".join(verbs).lower()
                     if len(label) > 0:
                         arc += ' [label="%s"]' % label
                     print("    " + arc)
     print("}")
+
+# end