-#!/usr/bin/env python
-
-# 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;
- const bool noaction;
-}} action_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 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 NTRAVEL {}
-#define NKEYS {}
-
-#define BIRD_ENDSTATE {}
-
-enum arbitrary_messages_refs {{
-{}
-}};
-
-enum locations_refs {{
-{}
-}};
-
-enum object_refs {{
-{}
-}};
-
-enum motion_refs {{
-{}
-}};
-
-enum action_refs {{
-{}
-}};
-
-/* State definitions */
-
-{}
-#endif /* end DUNGEON_H */
+#!/usr/bin/env python3
+# SPDX-FileCopyrightText: 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[] = {{
-{}
-}};
-
-const motion_t motions[] = {{
-{}
-}};
+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 action_t actions[] = {{
-{}
-}};
+# 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 long tkey[] = {{{}}};
+import sys, yaml
-const travelop_t travel[] = {{
-{}
-}};
+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 char *ignore = \"{}\";
+DONOTEDIT_COMMENT = "/* Generated from adventure.yaml - do not hand-hack! */\n\n"
-/* end */
-"""
+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")
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 = []
if labels:
global statedefines
statedefines += "/* States for %s */\n" % item[0]
- for (j, label) in enumerate(labels):
- statedefines += "#define %s\t%d\n" % (label, j)
+ for (n, label) in enumerate(labels):
+ statedefines += "#define %s\t%d\n" % (label, 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)
obit_str = obit_str[:-1] # trim trailing newline
return obit_str
-def get_hints(hnt, arb):
+def get_hints(hnt):
template = """ {{
.number = {},
.penalty = {},
}},
"""
hnt_str = ""
- md = dict(arb)
for member in hnt:
item = member["hint"]
number = item["number"]
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()
for action in actions:
contents = action[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"])
- if contents.get("noaction") == None:
+ 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()
def bigdump(arr):
out = ""
- for (i, entry) in enumerate(arr):
+ for (i, _) in enumerate(arr):
if i % 10 == 0:
if out and out[-1] == ' ':
out = out[:-1]
# 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.
#
return locnames.index(action[1])
except ValueError:
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":
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]
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.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))
# 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]
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)
condarg2 = (cond - 300) // 100.
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],
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"]]
(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_actions(db["actions"]),
- 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
)
# 0-origin index of birds's last song. Bird should
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(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"]),
- 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
)
- 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
projects / open-adventure.git / blobdiff