-#!/usr/bin/python3
+#!/usr/bin/env python
-# This is the new open-adventure dungeon generator. It'll eventually
-# replace the existing dungeon.c It currently outputs a .h and .c pair
-# for C code.
+# 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 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 unpacks that data into the travel array.
+# playermove().
#
-# Here are the rules of the intermediate form:
-#
-# Each row of data contains a location number (X), a second
-# 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.
-# 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 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
-# 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
-# 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).
+# Copyright (c) 2017 by Eric S. Raymond
+# SPDX-License-Identifier: BSD-2-clause
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 long message;
-}} action_t;
-
-typedef struct {{
- const long motion;
- const long cond;
- 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) (entry).dest
-#define T_CONDITION(entry) (entry).cond
-#define T_NODWARVES(entry) (T_CONDITION(entry) == 100)
-#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[];
-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 action_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 {}
-
-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 */
-"""
-
-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[] = {{
-{}
-}};
-
-const action_t actions[] = {{
-{}
-}};
-
-const action_t specials[] = {{
-{}
-}};
-
-const long tkey[] = {{{}}};
-
-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."""
return trn_str
def get_locations(loc):
- template = """ {{ // {}
+ template = """ {{ // {}: {}
.description = {{
.small = {},
.big = {},
long_d = make_c_string(item[1]["description"]["long"])
sound = item[1].get("sound", "SILENT")
loud = "true" if item[1].get("loud") else "false"
- loc_str += template.format(i, short_d, long_d, sound, loud)
+ loc_str += template.format(i, item[0], short_d, long_d, sound, loud)
loc_str = loc_str[:-1] # trim trailing newline
return loc_str
def get_objects(obj):
- template = """ {{ // {}
+ template = """ {{ // {}: {}
.words = {},
.inventory = {},
.plac = {},
else:
labels = []
for l_msg in attr["descriptions"]:
- if not isinstance(l_msg, str):
- labels.append(l_msg)
- l_msg = l_msg[1]
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
if labels:
global statedefines
statedefines += "/* States for %s */\n" % item[0]
- for (i, (label, message)) in enumerate(labels):
- if len(message) >= 45:
- message = message[:45] + "..."
- statedefines += "#define %s\t%d /* %s */\n" % (label, i, message)
+ for (n, label) in enumerate(labels):
+ statedefines += "#define %s\t%d\n" % (label, n)
statedefines += "\n"
sounds_str = ""
if attr.get("sounds") == None:
immovable = attr.get("immovable", False)
try:
if type(locs) == str:
- locs = [locnames.index(locs), -1 if immovable else 0]
- else:
- locs = [locnames.index(x) for x in locs]
+ 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, words_str, i_msg, locs[0], locs[1], treasure, descriptions_str, sounds_str, texts_str, changes_str)
+ 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
return obj_str
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"]
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"
+ message = "NULL"
+ else:
+ message = make_c_string(contents["message"])
+
+ if contents.get("noaction") == None:
+ noaction = "false"
else:
- message = contents["message"]
-
- act_str += template.format(words_str, message)
+ noaction = "true"
+
+ act_str += template.format(words_str, message, noaction)
global ignore
if contents.get("oldstyle", True) == False:
for word in contents["words"]:
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 assertions
+ # fails. Hint: if you try cleaning this up, the acceptance test is
+ # simple - the output dungeon.c must not change.
+ #
+ # This function first compiles the YAML to a form identical to the
+ # data in section 3 of the old adventure.text file, then a second
+ # stage unpacks that data into the travel array. Here are the
+ # rules of that intermediate form:
+ #
+ # Each row of data contains a location number (X), a second
+ # 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.
+ # 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 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
+ # 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
+ # 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 = []
verbmap = {}
for i, motion in enumerate(db["motions"]):
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))
elif action[0] == "special":
return 300 + action[1]
elif action[0] == "speak":
raise ValueError
def cencode(cond, name):
if cond is None:
- return 0;
+ return 0
+ elif cond == ["nodwarves"]:
+ return 100
elif cond[0] == "pct":
return cond[1]
elif cond[0] == "carry":
sys.stderr.write("dungeon: unknown object name %s in with clause of \n" % (cond[1], name))
sys.exit(1)
elif cond[0] == "not":
- # FIXME: Allow named as well as numbered states
try:
obj = objnames.index(cond[1])
if type(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:
tt = [i]
dest = dencode(rule["action"], name) + 1000 * cencode(rule.get("cond"), name)
tt.append(dest)
- tt += [verbmap[e] for e in rule["verbs"]]
+ tt += [motionnames[verbmap[e]].upper() for e in rule["verbs"]]
if not rule["verbs"]:
- tt.append(1)
+ 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 the runtime format. This was the C translation
- # of the FORTRAN code:
- # long loc;
- # while ((loc = GETNUM(database)) != -1) {
- # long newloc = GETNUM(NULL);
- # long L;
- # if (TKEY[loc] == 0) {
- # TKEY[loc] = TRVS;
- # } else {
- # TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
- # }
- # while ((L = GETNUM(NULL)) != 0) {
- # TRAVEL[TRVS] = newloc * 1000 + L;
- # TRVS = TRVS + 1;
- # if (TRVS == TRVSIZ)
- # BUG(TOO_MANY_TRAVEL_OPTIONS);
- # }
- # TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
- # }
- #
- # In order to de-crypticize the runtime code, we're going to break these
- # magic numbers up into a struct.
- travel = [[0, 0, 0, False]]
+ # same mapping into what used to be the runtime format.
+
+ travel = [[0, "LOC_NOWHERE", 0, 0, 0, 0, 0, 0, "false", "false"]]
tkey = [0]
oldloc = 0
while ltravel:
tkey.append(len(travel))
oldloc = loc
elif travel:
- travel[-1][-1] = not travel[-1][-1]
+ travel[-1][-1] = "false" if travel[-1][-1] == "true" else "true"
while rule:
- travel.append([rule.pop(0), newloc // 1000, newloc % 1000, False])
- travel[-1][-1] = True
+ cond = newloc // 1000
+ nodwarves = (cond == 100)
+ if cond == 0:
+ condtype = "cond_goto"
+ condarg1 = condarg2 = 0
+ elif cond < 100:
+ condtype = "cond_pct"
+ condarg1 = cond
+ condarg2 = 0
+ elif cond == 100:
+ condtype = "cond_goto"
+ condarg1 = 100
+ condarg2 = 0
+ elif cond <= 200:
+ condtype = "cond_carry"
+ condarg1 = objnames[cond - 100]
+ condarg2 = 0
+ elif cond <= 300:
+ condtype = "cond_with"
+ condarg1 = objnames[cond - 200]
+ condarg2 = 0
+ else:
+ condtype = "cond_not"
+ condarg1 = cond % 100
+ condarg2 = (cond - 300) // 100.
+ dest = newloc % 1000
+ if dest <= 300:
+ desttype = "dest_goto";
+ destval = locnames[dest]
+ elif dest > 500:
+ desttype = "dest_speak";
+ destval = msgnames[dest - 500]
+ else:
+ 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[-1][-1] = "true"
return (travel, tkey)
def get_travel(travel):
- template = """ {{
+ template = """ {{ // from {}: {}
.motion = {},
- .cond = {},
- .dest = {},
+ .condtype = {},
+ .condarg1 = {},
+ .condarg2 = {},
+ .desttype = {},
+ .destval = {},
+ .nodwarves = {},
.stop = {},
}},
"""
out = ""
for entry in travel:
- out += template.format(entry[0], entry[1], entry[2], entry[3]).lower()
+ out += template.format(*entry)
out = out[:-1] # trim trailing newline
return out
if __name__ == "__main__":
- with open(yaml_name, "r") as f:
+ with open(YAML_NAME, "r") as f:
db = yaml.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"])
ignore = ""
+ try:
+ with open(H_TEMPLATE_PATH, "r") as htf:
+ # read in dungeon.h template
+ h_template = DONOTEDIT_COMMENT + htf.read()
+ with open(C_TEMPLATE_PATH, "r") 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)
+
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"]),
- get_actions(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
)
+ # 0-origin index of birds's last song. Bird should
+ # die after player hears this.
+ 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),
- 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
)
- with open(h_name, "w") as hf:
+ with open(H_NAME, "w") as hf:
hf.write(h)
- with open(c_name, "w") as cf:
+ with open(C_NAME, "w") as cf:
cf.write(c)
# end
projects / open-adventure.git / blobdiff