X-Git-Url: https://jxself.org/git/?p=open-adventure.git;a=blobdiff_plain;f=make_dungeon.py;h=63eee94ed241863772ee71465c6a25b7d07e7c7c;hp=724b941d9652c10b824e1c9ec42486cd7a075a76;hb=HEAD;hpb=d9e33a847881bf510c2933aa0801bfda16d89dae diff --git a/make_dungeon.py b/make_dungeon.py index 724b941..8d7f719 100755 --- a/make_dungeon.py +++ b/make_dungeon.py @@ -1,14 +1,16 @@ #!/usr/bin/env python3 +# SPDX-FileCopyrightText: (C) Eric S. Raymond +# 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. + +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 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(). -# -# Copyright (c) 2017 by Eric S. Raymond -# SPDX-License-Identifier: BSD-2-clause +# 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 import sys, yaml @@ -22,9 +24,10 @@ DONOTEDIT_COMMENT = "/* Generated from adventure.yaml - do not hand-hack! */\n\n statedefines = "" + 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") @@ -33,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 = {}, @@ -49,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 = {}, @@ -74,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 = {}, @@ -90,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 = {{ @@ -110,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 = {}, @@ -134,6 +146,7 @@ def get_objects(obj): }}, }}, """ + max_state = 0 obj_str = "" for (i, item) in enumerate(obj): attr = item[1] @@ -143,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 = [] @@ -151,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 (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 = {}, @@ -203,9 +231,10 @@ 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): template = """ {{ .number = {}, @@ -224,9 +253,10 @@ def get_hints(hnt): 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: @@ -237,7 +267,7 @@ def get_condbits(locations): if conditions[flag]: flaglist.append(flag) line = "|".join([("(1<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 300500 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 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 = {}, @@ -518,11 +581,12 @@ 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: + with open(YAML_NAME, "r", encoding="ascii", errors="surrogateescape") as f: db = yaml.safe_load(f) locnames = [x[0] for x in db["locations"]] @@ -530,35 +594,39 @@ if __name__ == "__main__": 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") as htf: + 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") as ctf: + 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)) - exit(-1) + print("ERROR: reading template failed ({})".format(e.strerror)) + sys.exit(-1) c = c_template.format( - 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 + 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 @@ -566,29 +634,30 @@ if __name__ == "__main__": deathbird = len(dict(db["objects"])["BIRD"]["sounds"]) - 1 h = h_template.format( - 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 + 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