X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=make_dungeon.py;h=63eee94ed241863772ee71465c6a25b7d07e7c7c;hp=9b729cc2505193b54a81e576ed47bb2c2cd3c253;hb=HEAD;hpb=6af7db8cd9bbac9b238897a03fe1e6a04b26b944

diff --git a/make_dungeon.py b/make_dungeon.py
index 9b729cc..8d7f719 100755
--- a/make_dungeon.py
+++ b/make_dungeon.py
@@ -1,259 +1,33 @@
-#!/usr/bin/python3
-
-# 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().
-
-import sys, yaml
-
-yaml_name = "adventure.yaml"
-h_name = "dungeon.h"
-c_name = "dungeon.c"
-
-statedefines = ""
-
-h_template = """/* Generated from adventure.yaml - do not hand-hack! */
-#ifndef DUNGEON_H
-#define DUNGEON_H
-
-#include <stdio.h>
-#include <stdbool.h>
-
-#define SILENT	-1	/* no sound */
-
-/* Symbols for cond bits */
-#define COND_LIT	0	/* Light */
-#define COND_OILY	1	/* If bit 2 is on: on for oil, off for water */
-#define COND_FLUID	2	/* Liquid asset, see bit 1 */
-#define COND_NOARRR	3	/* Pirate doesn't go here unless following */
-#define COND_NOBACK	4	/* Cannot use "back" to move away */
-#define COND_ABOVE	5
-#define COND_DEEP	6	/* Deep - e.g where dwarves are active */
-#define COND_FOREST	7	/* In the forest */
-#define COND_FORCED	8	/* Only one way in or out of here */
-/* Bits past 10 indicate areas of interest to "hint" routines */
-#define COND_HBASE	10	/* Base for location hint bits */
-#define COND_HCAVE	11	/* Trying to get into cave */
-#define COND_HBIRD	12	/* Trying to catch bird */
-#define COND_HSNAKE	13	/* Trying to deal with snake */
-#define COND_HMAZE	14	/* Lost in maze */
-#define COND_HDARK	15	/* Pondering dark room */
-#define COND_HWITT	16	/* At Witt's End */
-#define COND_HCLIFF	17	/* Cliff with urn */
-#define COND_HWOODS	18	/* Lost in forest */
-#define COND_HOGRE	19	/* Trying to deal with ogre */
-#define COND_HJADE	20	/* Found all treasures except jade */
-
-typedef struct {{
-  const char** strs;
-  const int n;
-}} string_group_t;
-
-typedef struct {{
-  const string_group_t words;
-  const char* inventory;
-  int plac, fixd;
-  bool is_treasure;
-  const char** descriptions;
-  const char** sounds;
-  const char** texts;
-  const char** changes;
-}} object_t;
-
-typedef struct {{
-  const char* small;
-  const char* big;
-}} descriptions_t;
-
-typedef struct {{
-  descriptions_t description;
-  const long sound;
-  const bool loud;
-}} location_t;
-
-typedef struct {{
-  const char* query;
-  const char* yes_response;
-}} obituary_t;
-
-typedef struct {{
-  const int threshold;
-  const int point_loss;
-  const char* message;
-}} turn_threshold_t;
-
-typedef struct {{
-  const int threshold;
-  const char* message;
-}} class_t;
-
-typedef struct {{
-  const int number;
-  const int turns;
-  const int penalty;
-  const char* question;
-  const char* hint;
-}} hint_t;
-
-typedef struct {{
-  const string_group_t words;
-}} motion_t;
-
-typedef struct {{
-  const string_group_t words;
-  const char* message;
-}} 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 condtype;
-  const long condarg1;
-  const long condarg2;
-  const enum desttype_t desttype;
-  const long destval;
-  const bool nodwarves;
-  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_TERMINATE(entry)	((entry).motion == 1)
-
-extern const location_t locations[];
-extern const object_t objects[];
-extern const char* arbitrary_messages[];
-extern const class_t classes[];
-extern const turn_threshold_t turn_thresholds[];
-extern const obituary_t obituaries[];
-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;
-
-#define NLOCATIONS	{}
-#define NOBJECTS	{}
-#define NHINTS		{}
-#define NCLASSES	{}
-#define NDEATHS		{}
-#define NTHRESHOLDS	{}
-#define NMOTIONS        {}
-#define NACTIONS  	{}
-#define NSPECIALS       {}
-#define NTRAVEL		{}
-#define NKEYS		{}
-
-#define BIRD_ENDSTATE	{}
-
-enum arbitrary_messages_refs {{
-{}
-}};
-
-enum locations_refs {{
-{}
-}};
-
-enum object_refs {{
-{}
-}};
-
-enum motion_refs {{
-{}
-}};
-
-enum action_refs {{
-{}
-}};
-
-enum special_refs {{
-{}
-}};
-
-/* State definitions */
-
-{}
-#endif /* end DUNGEON_H */
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: (C) Eric S. Raymond <esr@thyrsus.com>
+# SPDX-License-Identifier: BSD-2-Clause
 """
+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.
 
-c_template = """/* Generated from adventure.yaml - do not hand-hack! */
-
-#include "{}"
-
-const char* arbitrary_messages[] = {{
-{}
-}};
-
-const class_t classes[] = {{
-{}
-}};
-
-const turn_threshold_t turn_thresholds[] = {{
-{}
-}};
-
-const location_t locations[] = {{
-{}
-}};
-
-const object_t objects[] = {{
-{}
-}};
-
-const obituary_t obituaries[] = {{
-{}
-}};
-
-const hint_t hints[] = {{
-{}
-}};
-
-long conditions[] = {{
-{}
-}};
+The nontrivial part of this is the compilation of the YAML for
+movement rules to the travel array that's actually used by
+playermove().
+"""
 
-const motion_t motions[] = {{
-{}
-}};
+# pylint: disable=consider-using-f-string,line-too-long,invalid-name,missing-function-docstring,too-many-branches,global-statement,multiple-imports,too-many-locals,too-many-statements,too-many-nested-blocks,no-else-return,raise-missing-from,redefined-outer-name
 
-const action_t actions[] = {{
-{}
-}};
-
-const special_t specials[] = {{
-{}
-}};
+import sys, yaml
 
-const long tkey[] = {{{}}};
+YAML_NAME = "adventure.yaml"
+H_NAME = "dungeon.h"
+C_NAME = "dungeon.c"
+H_TEMPLATE_PATH = "templates/dungeon.h.tpl"
+C_TEMPLATE_PATH = "templates/dungeon.c.tpl"
 
-const travelop_t travel[] = {{
-{}
-}};
+DONOTEDIT_COMMENT = "/* Generated from adventure.yaml - do not hand-hack! */\n\n"
 
-const char *ignore = \"{}\";
+statedefines = ""
 
-/* end */
-"""
 
 def make_c_string(string):
     """Render a Python string into C string literal format."""
-    if string == None:
+    if string is None:
         return "NULL"
     string = string.replace("\n", "\\n")
     string = string.replace("\t", "\\t")
@@ -262,14 +36,16 @@ def make_c_string(string):
     string = '"' + string + '"'
     return string
 
+
 def get_refs(l):
     reflist = [x[0] for x in l]
     ref_str = ""
     for ref in reflist:
         ref_str += "    {},\n".format(ref)
-    ref_str = ref_str[:-1] # trim trailing newline
+    ref_str = ref_str[:-1]  # trim trailing newline
     return ref_str
 
+
 def get_string_group(strings):
     template = """{{
             .strs = {},
@@ -278,20 +54,24 @@ def get_string_group(strings):
     if strings == []:
         strs = "NULL"
     else:
-        strs = "(const char* []) {" + ", ".join([make_c_string(s) for s in strings]) + "}"
+        strs = (
+            "(const char* []) {" + ", ".join([make_c_string(s) for s in strings]) + "}"
+        )
     n = len(strings)
     sg_str = template.format(strs, n)
     return sg_str
 
+
 def get_arbitrary_messages(arb):
     template = """    {},
 """
     arb_str = ""
     for item in arb:
         arb_str += template.format(make_c_string(item[1]))
-    arb_str = arb_str[:-1] # trim trailing newline
+    arb_str = arb_str[:-1]  # trim trailing newline
     return arb_str
 
+
 def get_class_messages(cls):
     template = """    {{
         .threshold = {},
@@ -303,9 +83,10 @@ def get_class_messages(cls):
         threshold = item["threshold"]
         message = make_c_string(item["message"])
         cls_str += template.format(threshold, message)
-    cls_str = cls_str[:-1] # trim trailing newline
+    cls_str = cls_str[:-1]  # trim trailing newline
     return cls_str
 
+
 def get_turn_thresholds(trn):
     template = """    {{
         .threshold = {},
@@ -319,9 +100,10 @@ def get_turn_thresholds(trn):
         point_loss = item["point_loss"]
         message = make_c_string(item["message"])
         trn_str += template.format(threshold, point_loss, message)
-    trn_str = trn_str[:-1] # trim trailing newline
+    trn_str = trn_str[:-1]  # trim trailing newline
     return trn_str
 
+
 def get_locations(loc):
     template = """    {{ // {}: {}
         .description = {{
@@ -339,9 +121,10 @@ def get_locations(loc):
         sound = item[1].get("sound", "SILENT")
         loud = "true" if item[1].get("loud") else "false"
         loc_str += template.format(i, item[0], short_d, long_d, sound, loud)
-    loc_str = loc_str[:-1] # trim trailing newline
+    loc_str = loc_str[:-1]  # trim trailing newline
     return loc_str
 
+
 def get_objects(obj):
     template = """    {{ // {}: {}
         .words = {},
@@ -363,6 +146,7 @@ def get_objects(obj):
         }},
     }},
 """
+    max_state = 0
     obj_str = ""
     for (i, item) in enumerate(obj):
         attr = item[1]
@@ -372,7 +156,7 @@ def get_objects(obj):
             words_str = get_string_group([])
         i_msg = make_c_string(attr["inventory"])
         descriptions_str = ""
-        if attr["descriptions"] == None:
+        if attr["descriptions"] is None:
             descriptions_str = " " * 12 + "NULL,"
         else:
             labels = []
@@ -380,47 +164,62 @@ def get_objects(obj):
                 descriptions_str += " " * 12 + make_c_string(l_msg) + ",\n"
             for label in attr.get("states", []):
                 labels.append(label)
-            descriptions_str = descriptions_str[:-1] # trim trailing newline
+            descriptions_str = descriptions_str[:-1]  # trim trailing newline
             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 (n, label) in enumerate(labels):
+                    statedefines += "#define %s\t%d\n" % (label, n)
+                    max_state = max(max_state, n)
                 statedefines += "\n"
         sounds_str = ""
-        if attr.get("sounds") == None:
+        if attr.get("sounds") is None:
             sounds_str = " " * 12 + "NULL,"
         else:
-             for l_msg in attr["sounds"]:
-                 sounds_str += " " * 12 + make_c_string(l_msg) + ",\n"
-             sounds_str = sounds_str[:-1] # trim trailing newline
+            for l_msg in attr["sounds"]:
+                sounds_str += " " * 12 + make_c_string(l_msg) + ",\n"
+            sounds_str = sounds_str[:-1]  # trim trailing newline
         texts_str = ""
-        if attr.get("texts") == None:
+        if attr.get("texts") is None:
             texts_str = " " * 12 + "NULL,"
         else:
-             for l_msg in attr["texts"]:
-                 texts_str += " " * 12 + make_c_string(l_msg) + ",\n"
-             texts_str = texts_str[:-1] # trim trailing newline
+            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:
+        if attr.get("changes") is 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
+            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:
-            if type(locs) == str:
+            if isinstance(locs, str):
                 locs = [locs, -1 if immovable else 0]
         except IndexError:
             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, item[0], words_str, i_msg, locs[0], locs[1], treasure, descriptions_str, sounds_str, texts_str, changes_str)
-    obj_str = obj_str[:-1] # trim trailing newline
+        obj_str += template.format(
+            i,
+            item[0],
+            words_str,
+            i_msg,
+            locs[0],
+            locs[1],
+            treasure,
+            descriptions_str,
+            sounds_str,
+            texts_str,
+            changes_str,
+        )
+    obj_str = obj_str[:-1]  # trim trailing newline
+    statedefines += "/* Maximum state value */\n#define MAX_STATE %d\n" % max_state
     return obj_str
 
+
 def get_obituaries(obit):
     template = """    {{
         .query = {},
@@ -432,10 +231,11 @@ def get_obituaries(obit):
         query = make_c_string(o["query"])
         yes = make_c_string(o["yes_response"])
         obit_str += template.format(query, yes)
-    obit_str = obit_str[:-1] # trim trailing newline
+    obit_str = obit_str[:-1]  # trim trailing newline
     return obit_str
 
-def get_hints(hnt, arb):
+
+def get_hints(hnt):
     template = """    {{
         .number = {},
         .penalty = {},
@@ -445,7 +245,6 @@ def get_hints(hnt, arb):
     }},
 """
     hnt_str = ""
-    md = dict(arb)
     for member in hnt:
         item = member["hint"]
         number = item["number"]
@@ -454,9 +253,10 @@ def get_hints(hnt, arb):
         question = make_c_string(item["question"])
         hint = make_c_string(item["hint"])
         hnt_str += template.format(number, penalty, turns, question, hint)
-    hnt_str = hnt_str[:-1] # trim trailing newline
+    hnt_str = hnt_str[:-1]  # trim trailing newline
     return hnt_str
 
+
 def get_condbits(locations):
     cnd_str = ""
     for (name, loc) in locations:
@@ -467,7 +267,7 @@ def get_condbits(locations):
             if conditions[flag]:
                 flaglist.append(flag)
         line = "|".join([("(1<<COND_%s)" % f) for f in flaglist])
-        trail = "|".join([("(1<<COND_H%s)" % f['name']) for f in hints])
+        trail = "|".join([("(1<<COND_H%s)" % f["name"]) for f in hints])
         if trail:
             line += "|" + trail
         if line.startswith("|"):
@@ -477,6 +277,7 @@ def get_condbits(locations):
         cnd_str += "    " + line + ",\t// " + name + "\n"
     return cnd_str
 
+
 def get_motions(motions):
     template = """    {{
         .words = {},
@@ -485,94 +286,74 @@ def get_motions(motions):
     mot_str = ""
     for motion in motions:
         contents = motion[1]
-        if contents["words"] == None:
+        if contents["words"] is None:
             words_str = get_string_group([])
         else:
             words_str = get_string_group(contents["words"])
         mot_str += template.format(words_str)
         global ignore
-        if contents.get("oldstyle", True) == False:
+        if not contents.get("oldstyle", True):
             for word in contents["words"]:
                 if len(word) == 1:
                     ignore += word.upper()
     return mot_str
 
+
 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:
+        if contents["words"] is None:
             words_str = get_string_group([])
         else:
             words_str = get_string_group(contents["words"])
 
-        if contents["message"] == None:
+        if contents["message"] is None:
             message = "NULL"
         else:
             message = make_c_string(contents["message"])
 
-        spc_str += template.format(words_str, message)
+        if contents.get("noaction") is None:
+            noaction = "false"
+        else:
+            noaction = "true"
+
+        act_str += template.format(words_str, message, noaction)
         global ignore
-        if contents.get("oldstyle", True) == False:
+        if not contents.get("oldstyle", True):
             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 = ""
-    for (i, entry) in enumerate(arr):
+    for (i, _) in enumerate(arr):
         if i % 10 == 0:
-            if out and out[-1] == ' ':
+            if out and out[-1] == " ":
                 out = out[:-1]
             out += "\n    "
         out += str(arr[i]).lower() + ", "
     out = out[:-2] + "\n"
     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
+    # because there's no need to do it until one of the assertions
     # fails. Hint: if you try cleaning this up, the acceptance test is
     # simple - the output dungeon.c must not change.
     #
@@ -585,31 +366,31 @@ def buildtravel(locs, objs):
     # 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.
+    # 		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 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
+    # 		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
+    # 		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 = []
@@ -620,27 +401,37 @@ def buildtravel(locs, objs):
                 verbmap[word.upper()] = i
         except TypeError:
             pass
+
     def dencode(action, name):
         "Decode a destination number"
         if action[0] == "goto":
             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)
+                )
+                raise ValueError
         elif action[0] == "special":
             return 300 + action[1]
         elif action[0] == "speak":
             try:
                 return 500 + msgnames.index(action[1])
             except ValueError:
-                sys.stderr.write("dungeon: unknown location %s in carry clause of %s\n" % (cond[1], name))
+                sys.stderr.write(
+                    "dungeon: unknown location %s in carry clause of %s\n"
+                    % (cond[1], name)
+                )
         else:
             print(cond)
             raise ValueError
+        return ""  # Pacify pylint
+
     def cencode(cond, name):
         if cond is None:
             return 0
-        elif cond == ["nodwarves"]:
+        if cond == ["nodwarves"]:
             return 100
         elif cond[0] == "pct":
             return cond[1]
@@ -648,33 +439,45 @@ def buildtravel(locs, objs):
             try:
                 return 100 + objnames.index(cond[1])
             except ValueError:
-                sys.stderr.write("dungeon: unknown object name %s in carry clause of %s\n" % (cond[1], name))
+                sys.stderr.write(
+                    "dungeon: unknown object name %s in carry clause of %s\n"
+                    % (cond[1], name)
+                )
                 sys.exit(1)
         elif cond[0] == "with":
             try:
                 return 200 + objnames.index(cond[1])
             except IndexError:
-                sys.stderr.write("dungeon: unknown object name %s in with clause of \n" % (cond[1], name))
+                sys.stderr.write(
+                    "dungeon: unknown object name %s in with clause of %s\n"
+                    % (cond[1], name)
+                )
                 sys.exit(1)
         elif cond[0] == "not":
             try:
                 obj = objnames.index(cond[1])
-                if type(cond[2]) == int:
+                if isinstance(cond[2], int):
                     state = cond[2]
                 elif cond[2] in objs[obj][1].get("states", []):
                     state = objs[obj][1].get("states").index(cond[2])
                 else:
                     for (i, stateclause) in enumerate(objs[obj][1]["descriptions"]):
-                        if type(stateclause) == list:
+                        if isinstance(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);
+                        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.stderr.write(
+                    "dungeon: unknown object name %s in not clause of %s\n"
+                    % (cond[1], name)
+                )
                 sys.exit(1)
         else:
             print(cond)
@@ -684,16 +487,18 @@ def buildtravel(locs, objs):
         if "travel" in loc:
             for rule in loc["travel"]:
                 tt = [i]
-                dest = dencode(rule["action"], name) + 1000 * cencode(rule.get("cond"), name)
+                dest = dencode(rule["action"], name) + 1000 * cencode(
+                    rule.get("cond"), name
+                )
                 tt.append(dest)
                 tt += [motionnames[verbmap[e]].upper() for e in rule["verbs"]]
                 if not rule["verbs"]:
-                    tt.append(1)	# Magic dummy entry for null rules
+                    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 wgat used to be the runtime format.
+    # same mapping into what used to be the runtime format.
 
     travel = [[0, "LOC_NOWHERE", 0, 0, 0, 0, 0, 0, "false", "false"]]
     tkey = [0]
@@ -704,12 +509,12 @@ def buildtravel(locs, objs):
         newloc = rule.pop(0)
         if loc != oldloc:
             tkey.append(len(travel))
-            oldloc = loc 
+            oldloc = loc
         elif travel:
-            travel[-1][-1] = "false" if travel[-1][-1] == "true" else "true" 
+            travel[-1][-1] = "false" if travel[-1][-1] == "true" else "true"
         while rule:
             cond = newloc // 1000
-            nodwarves = (cond == 100)
+            nodwarves = cond == 100
             if cond == 0:
                 condtype = "cond_goto"
                 condarg1 = condarg2 = 0
@@ -732,30 +537,35 @@ def buildtravel(locs, objs):
             else:
                 condtype = "cond_not"
                 condarg1 = cond % 100
-                condarg2 = (cond - 300) // 100.
+                condarg2 = (cond - 300) // 100.0
             dest = newloc % 1000
             if dest <= 300:
-                desttype = "dest_goto";
+                desttype = "dest_goto"
                 destval = locnames[dest]
             elif dest > 500:
-                desttype = "dest_speak";
+                desttype = "dest_speak"
                 destval = msgnames[dest - 500]
             else:
-                desttype = "dest_special";
+                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.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 = """    {{ // from {}: {}
         .motion = {},
@@ -771,37 +581,52 @@ def get_travel(travel):
     out = ""
     for entry in travel:
         out += template.format(*entry)
-    out = out[:-1] # trim trailing newline
+    out = out[:-1]  # trim trailing newline
     return out
 
+
 if __name__ == "__main__":
-    with open(yaml_name, "r") as f:
-        db = yaml.load(f)
+    with open(YAML_NAME, "r", encoding="ascii", errors="surrogateescape") as f:
+        db = yaml.safe_load(f)
 
     locnames = [x[0] for x in db["locations"]]
     msgnames = [el[0] for el in db["arbitrary_messages"]]
     objnames = [el[0] for el in db["objects"]]
     motionnames = [el[0] for el in db["motions"]]
 
-    (travel, tkey) = buildtravel(db["locations"],
-                                 db["objects"])
+    (travel, tkey) = buildtravel(db["locations"], db["objects"])
     ignore = ""
+    try:
+        with open(
+            H_TEMPLATE_PATH, "r", encoding="ascii", errors="surrogateescape"
+        ) as htf:
+            # read in dungeon.h template
+            h_template = DONOTEDIT_COMMENT + htf.read()
+        with open(
+            C_TEMPLATE_PATH, "r", encoding="ascii", errors="surrogateescape"
+        ) as ctf:
+            # read in dungeon.c template
+            c_template = DONOTEDIT_COMMENT + ctf.read()
+    except IOError as e:
+        print("ERROR: reading template failed ({})".format(e.strerror))
+        sys.exit(-1)
+
     c = c_template.format(
-        h_name,
-        get_arbitrary_messages(db["arbitrary_messages"]),
-        get_class_messages(db["classes"]),
-        get_turn_thresholds(db["turn_thresholds"]),
-        get_locations(db["locations"]),
-        get_objects(db["objects"]),
-        get_obituaries(db["obituaries"]),
-        get_hints(db["hints"], db["arbitrary_messages"]),
-        get_condbits(db["locations"]),
-        get_motions(db["motions"]),
-        get_specials(db["actions"]),
-        get_specials(db["specials"]),
-        bigdump(tkey),
-        get_travel(travel), 
-        ignore,
+        h_file=H_NAME,
+        arbitrary_messages=get_arbitrary_messages(db["arbitrary_messages"]),
+        classes=get_class_messages(db["classes"]),
+        turn_thresholds=get_turn_thresholds(db["turn_thresholds"]),
+        locations=get_locations(db["locations"]),
+        objects=get_objects(db["objects"]),
+        obituaries=get_obituaries(db["obituaries"]),
+        hints=get_hints(db["hints"]),
+        conditions=get_condbits(db["locations"]),
+        motions=get_motions(db["motions"]),
+        actions=get_actions(db["actions"]),
+        tkeys=bigdump(tkey),
+        travel=get_travel(travel),
+        ignore=ignore,
+        dwarflocs=", ".join(db["dwarflocs"]) + ",",
     )
 
     # 0-origin index of birds's last song.  Bird should
@@ -809,31 +634,30 @@ if __name__ == "__main__":
     deathbird = len(dict(db["objects"])["BIRD"]["sounds"]) - 1
 
     h = h_template.format(
-        len(db["locations"])-1,
-        len(db["objects"])-1,
-        len(db["hints"]),
-        len(db["classes"])-1,
-        len(db["obituaries"]),
-        len(db["turn_thresholds"]),
-        len(db["motions"]),
-        len(db["actions"]),
-        len(db["specials"]),
-        len(travel),
-        len(tkey),
-        deathbird,
-        get_refs(db["arbitrary_messages"]),
-        get_refs(db["locations"]),
-        get_refs(db["objects"]),
-        get_refs(db["motions"]),
-        get_refs(db["actions"]),
-        get_refs(db["specials"]),
-        statedefines,
+        num_locations=len(db["locations"]) - 1,
+        num_objects=len(db["objects"]) - 1,
+        num_hints=len(db["hints"]),
+        num_classes=len(db["classes"]) - 1,
+        num_deaths=len(db["obituaries"]),
+        num_thresholds=len(db["turn_thresholds"]),
+        num_motions=len(db["motions"]),
+        num_actions=len(db["actions"]),
+        num_travel=len(travel),
+        num_keys=len(tkey),
+        bird_endstate=deathbird,
+        arbitrary_messages=get_refs(db["arbitrary_messages"]),
+        locations=get_refs(db["locations"]),
+        objects=get_refs(db["objects"]),
+        motions=get_refs(db["motions"]),
+        actions=get_refs(db["actions"]),
+        state_definitions=statedefines,
+        ndwarflocs=str(len(db["dwarflocs"])),
     )
 
-    with open(h_name, "w") as hf:
+    with open(H_NAME, "w", encoding="ascii", errors="surrogateescape") as hf:
         hf.write(h)
 
-    with open(c_name, "w") as cf:
+    with open(C_NAME, "w", encoding="ascii", errors="surrogateescape") as cf:
         cf.write(c)
 
 # end