2 # SPDX-FileCopyrightText: Eric S. Raymond <esr@thyrsus.com>
3 # SPDX-License-Identifier: BSD-2-Clause
5 This is the open-adventure dungeon generator. It consumes a YAML description of
6 the dungeon and outputs a dungeon.h and dungeon.c pair of C code files.
8 The nontrivial part of this is the compilation of the YAML for
9 movement rules to the travel array that's actually used by
13 # 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
17 YAML_NAME = "adventure.yaml"
20 H_TEMPLATE_PATH = "templates/dungeon.h.tpl"
21 C_TEMPLATE_PATH = "templates/dungeon.c.tpl"
23 DONOTEDIT_COMMENT = "/* Generated from adventure.yaml - do not hand-hack! */\n\n"
27 def make_c_string(string):
28 """Render a Python string into C string literal format."""
31 string = string.replace("\n", "\\n")
32 string = string.replace("\t", "\\t")
33 string = string.replace('"', '\\"')
34 string = string.replace("'", "\\'")
35 string = '"' + string + '"'
39 reflist = [x[0] for x in l]
42 ref_str += " {},\n".format(ref)
43 ref_str = ref_str[:-1] # trim trailing newline
46 def get_string_group(strings):
54 strs = "(const char* []) {" + ", ".join([make_c_string(s) for s in strings]) + "}"
56 sg_str = template.format(strs, n)
59 def get_arbitrary_messages(arb):
64 arb_str += template.format(make_c_string(item[1]))
65 arb_str = arb_str[:-1] # trim trailing newline
68 def get_class_messages(cls):
76 threshold = item["threshold"]
77 message = make_c_string(item["message"])
78 cls_str += template.format(threshold, message)
79 cls_str = cls_str[:-1] # trim trailing newline
82 def get_turn_thresholds(trn):
91 threshold = item["threshold"]
92 point_loss = item["point_loss"]
93 message = make_c_string(item["message"])
94 trn_str += template.format(threshold, point_loss, message)
95 trn_str = trn_str[:-1] # trim trailing newline
98 def get_locations(loc):
99 template = """ {{ // {}: {}
109 for (i, item) in enumerate(loc):
110 short_d = make_c_string(item[1]["description"]["short"])
111 long_d = make_c_string(item[1]["description"]["long"])
112 sound = item[1].get("sound", "SILENT")
113 loud = "true" if item[1].get("loud") else "false"
114 loc_str += template.format(i, item[0], short_d, long_d, sound, loud)
115 loc_str = loc_str[:-1] # trim trailing newline
118 def get_objects(obj):
119 template = """ {{ // {}: {}
125 .descriptions = (const char* []) {{
128 .sounds = (const char* []) {{
131 .texts = (const char* []) {{
134 .changes = (const char* []) {{
141 for (i, item) in enumerate(obj):
144 words_str = get_string_group(attr["words"])
146 words_str = get_string_group([])
147 i_msg = make_c_string(attr["inventory"])
148 descriptions_str = ""
149 if attr["descriptions"] is None:
150 descriptions_str = " " * 12 + "NULL,"
153 for l_msg in attr["descriptions"]:
154 descriptions_str += " " * 12 + make_c_string(l_msg) + ",\n"
155 for label in attr.get("states", []):
157 descriptions_str = descriptions_str[:-1] # trim trailing newline
160 statedefines += "/* States for %s */\n" % item[0]
161 for (n, label) in enumerate(labels):
162 statedefines += "#define %s\t%d\n" % (label, n)
163 max_state = max(max_state, n)
166 if attr.get("sounds") is None:
167 sounds_str = " " * 12 + "NULL,"
169 for l_msg in attr["sounds"]:
170 sounds_str += " " * 12 + make_c_string(l_msg) + ",\n"
171 sounds_str = sounds_str[:-1] # trim trailing newline
173 if attr.get("texts") is None:
174 texts_str = " " * 12 + "NULL,"
176 for l_msg in attr["texts"]:
177 texts_str += " " * 12 + make_c_string(l_msg) + ",\n"
178 texts_str = texts_str[:-1] # trim trailing newline
180 if attr.get("changes") is None:
181 changes_str = " " * 12 + "NULL,"
183 for l_msg in attr["changes"]:
184 changes_str += " " * 12 + make_c_string(l_msg) + ",\n"
185 changes_str = changes_str[:-1] # trim trailing newline
186 locs = attr.get("locations", ["LOC_NOWHERE", "LOC_NOWHERE"])
187 immovable = attr.get("immovable", False)
189 if isinstance(locs, str):
190 locs = [locs, -1 if immovable else 0]
192 sys.stderr.write("dungeon: unknown object location in %s\n" % locs)
194 treasure = "true" if attr.get("treasure") else "false"
195 obj_str += template.format(i, item[0], words_str, i_msg, locs[0], locs[1], treasure, descriptions_str, sounds_str, texts_str, changes_str)
196 obj_str = obj_str[:-1] # trim trailing newline
197 statedefines += "/* Maximum state value */\n#define MAX_STATE %d\n" % max_state
200 def get_obituaries(obit):
208 query = make_c_string(o["query"])
209 yes = make_c_string(o["yes_response"])
210 obit_str += template.format(query, yes)
211 obit_str = obit_str[:-1] # trim trailing newline
225 item = member["hint"]
226 number = item["number"]
227 penalty = item["penalty"]
228 turns = item["turns"]
229 question = make_c_string(item["question"])
230 hint = make_c_string(item["hint"])
231 hnt_str += template.format(number, penalty, turns, question, hint)
232 hnt_str = hnt_str[:-1] # trim trailing newline
235 def get_condbits(locations):
237 for (name, loc) in locations:
238 conditions = loc["conditions"]
239 hints = loc.get("hints") or []
241 for flag in conditions:
243 flaglist.append(flag)
244 line = "|".join([("(1<<COND_%s)" % f) for f in flaglist])
245 trail = "|".join([("(1<<COND_H%s)" % f['name']) for f in hints])
248 if line.startswith("|"):
252 cnd_str += " " + line + ",\t// " + name + "\n"
255 def get_motions(motions):
261 for motion in motions:
263 if contents["words"] is None:
264 words_str = get_string_group([])
266 words_str = get_string_group(contents["words"])
267 mot_str += template.format(words_str)
269 if not contents.get("oldstyle", True):
270 for word in contents["words"]:
272 ignore += word.upper()
275 def get_actions(actions):
283 for action in actions:
286 if contents["words"] is None:
287 words_str = get_string_group([])
289 words_str = get_string_group(contents["words"])
291 if contents["message"] is None:
294 message = make_c_string(contents["message"])
296 if contents.get("noaction") is None:
301 act_str += template.format(words_str, message, noaction)
303 if not contents.get("oldstyle", True):
304 for word in contents["words"]:
306 ignore += word.upper()
307 act_str = act_str[:-1] # trim trailing newline
312 for (i, _) in enumerate(arr):
314 if out and out[-1] == ' ':
317 out += str(arr[i]).lower() + ", "
318 out = out[:-2] + "\n"
321 def buildtravel(locs, objs):
322 assert len(locs) <= 300
323 assert len(objs) <= 100
324 # THIS CODE IS WAAAY MORE COMPLEX THAN IT NEEDS TO BE. It's the
325 # result of a massive refactoring exercise that concentrated all
326 # the old nastiness in one spot. It hasn't been finally simplified
327 # because there's no need to do it until one of the assertions
328 # fails. Hint: if you try cleaning this up, the acceptance test is
329 # simple - the output dungeon.c must not change.
331 # This function first compiles the YAML to a form identical to the
332 # data in section 3 of the old adventure.text file, then a second
333 # stage unpacks that data into the travel array. Here are the
334 # rules of that intermediate form:
336 # Each row of data contains a location number (X), a second
337 # location number (Y), and a list of motion numbers (see section 4).
338 # each motion represents a verb which will go to Y if currently at X.
339 # Y, in turn, is interpreted as follows. Let M=Y/1000, N=Y mod 1000.
340 # If N<=300 it is the location to go to.
341 # If 300<N<=500 N-300 is used in a computed goto to
342 # a section of special code.
343 # If N>500 message N-500 from section 6 is printed,
344 # and he stays wherever he is.
345 # Meanwhile, M specifies the conditions on the motion.
346 # If M=0 it's unconditional.
347 # If 0<M<100 it is done with M% probability.
348 # If M=100 unconditional, but forbidden to dwarves.
349 # If 100<M<=200 he must be carrying object M-100.
350 # If 200<M<=300 must be carrying or in same room as M-200.
351 # If 300<M<=400 game.prop(M % 100) must *not* be 0.
352 # If 400<M<=500 game.prop(M % 100) must *not* be 1.
353 # If 500<M<=600 game.prop(M % 100) must *not* be 2, etc.
354 # If the condition (if any) is not met, then the next *different*
355 # "destination" value is used (unless it fails to meet *its* conditions,
356 # in which case the next is found, etc.). Typically, the next dest will
357 # be for one of the same verbs, so that its only use is as the alternate
358 # destination for those verbs. For instance:
359 # 15 110022 29 31 34 35 23 43
361 # This says that, from loc 15, any of the verbs 29, 31, etc., will take
362 # him to 22 if he's carrying object 10, and otherwise will go to 14.
365 # This says that, from 11, 49 takes him to 8 unless game.prop[3]=0, in which
366 # case he goes to 9. Verb 50 takes him to 9 regardless of game.prop[3].
369 for i, motion in enumerate(db["motions"]):
371 for word in motion[1]["words"]:
372 verbmap[word.upper()] = i
375 def dencode(action, name):
376 "Decode a destination number"
377 if action[0] == "goto":
379 return locnames.index(action[1])
381 sys.stderr.write("dungeon: unknown location %s in goto clause of %s\n" % (action[1], name))
383 elif action[0] == "special":
384 return 300 + action[1]
385 elif action[0] == "speak":
387 return 500 + msgnames.index(action[1])
389 sys.stderr.write("dungeon: unknown location %s in carry clause of %s\n" % (cond[1], name))
393 return '' # Pacify pylint
394 def cencode(cond, name):
397 if cond == ["nodwarves"]:
399 elif cond[0] == "pct":
401 elif cond[0] == "carry":
403 return 100 + objnames.index(cond[1])
405 sys.stderr.write("dungeon: unknown object name %s in carry clause of %s\n" % (cond[1], name))
407 elif cond[0] == "with":
409 return 200 + objnames.index(cond[1])
411 sys.stderr.write("dungeon: unknown object name %s in with clause of %s\n" % (cond[1], name))
413 elif cond[0] == "not":
415 obj = objnames.index(cond[1])
416 if isinstance(cond[2], int):
418 elif cond[2] in objs[obj][1].get("states", []):
419 state = objs[obj][1].get("states").index(cond[2])
421 for (i, stateclause) in enumerate(objs[obj][1]["descriptions"]):
422 if isinstance(stateclause, list):
423 if stateclause[0] == cond[2]:
427 sys.stderr.write("dungeon: unmatched state symbol %s in not clause of %s\n" % (cond[2], name))
429 return 300 + obj + 100 * state
431 sys.stderr.write("dungeon: unknown object name %s in not clause of %s\n" % (cond[1], name))
437 for (i, (name, loc)) in enumerate(locs):
439 for rule in loc["travel"]:
441 dest = dencode(rule["action"], name) + 1000 * cencode(rule.get("cond"), name)
443 tt += [motionnames[verbmap[e]].upper() for e in rule["verbs"]]
444 if not rule["verbs"]:
445 tt.append(1) # Magic dummy entry for null rules
446 ltravel.append(tuple(tt))
448 # At this point the ltravel data is in the Section 3
449 # representation from the FORTRAN version. Next we perform the
450 # same mapping into what used to be the runtime format.
452 travel = [[0, "LOC_NOWHERE", 0, 0, 0, 0, 0, 0, "false", "false"]]
456 rule = list(ltravel.pop(0))
460 tkey.append(len(travel))
463 travel[-1][-1] = "false" if travel[-1][-1] == "true" else "true"
465 cond = newloc // 1000
466 nodwarves = (cond == 100)
468 condtype = "cond_goto"
469 condarg1 = condarg2 = 0
471 condtype = "cond_pct"
475 condtype = "cond_goto"
479 condtype = "cond_carry"
480 condarg1 = objnames[cond - 100]
483 condtype = "cond_with"
484 condarg1 = objnames[cond - 200]
487 condtype = "cond_not"
488 condarg1 = cond % 100
489 condarg2 = (cond - 300) // 100.
492 desttype = "dest_goto"
493 destval = locnames[dest]
495 desttype = "dest_speak"
496 destval = msgnames[dest - 500]
498 desttype = "dest_special"
499 destval = locnames[dest - 300]
500 travel.append([len(tkey)-1,
501 locnames[len(tkey)-1],
508 "true" if nodwarves else "false",
510 travel[-1][-1] = "true"
511 return (travel, tkey)
513 def get_travel(travel):
514 template = """ {{ // from {}: {}
527 out += template.format(*entry)
528 out = out[:-1] # trim trailing newline
531 if __name__ == "__main__":
532 with open(YAML_NAME, "r", encoding='ascii', errors='surrogateescape') as f:
533 db = yaml.safe_load(f)
535 locnames = [x[0] for x in db["locations"]]
536 msgnames = [el[0] for el in db["arbitrary_messages"]]
537 objnames = [el[0] for el in db["objects"]]
538 motionnames = [el[0] for el in db["motions"]]
540 (travel, tkey) = buildtravel(db["locations"],
544 with open(H_TEMPLATE_PATH, "r", encoding='ascii', errors='surrogateescape') as htf:
545 # read in dungeon.h template
546 h_template = DONOTEDIT_COMMENT + htf.read()
547 with open(C_TEMPLATE_PATH, "r", encoding='ascii', errors='surrogateescape') as ctf:
548 # read in dungeon.c template
549 c_template = DONOTEDIT_COMMENT + ctf.read()
551 print('ERROR: reading template failed ({})'.format(e.strerror))
554 c = c_template.format(
556 arbitrary_messages = get_arbitrary_messages(db["arbitrary_messages"]),
557 classes = get_class_messages(db["classes"]),
558 turn_thresholds = get_turn_thresholds(db["turn_thresholds"]),
559 locations = get_locations(db["locations"]),
560 objects = get_objects(db["objects"]),
561 obituaries = get_obituaries(db["obituaries"]),
562 hints = get_hints(db["hints"]),
563 conditions = get_condbits(db["locations"]),
564 motions = get_motions(db["motions"]),
565 actions = get_actions(db["actions"]),
566 tkeys = bigdump(tkey),
567 travel = get_travel(travel),
571 # 0-origin index of birds's last song. Bird should
572 # die after player hears this.
573 deathbird = len(dict(db["objects"])["BIRD"]["sounds"]) - 1
575 h = h_template.format(
576 num_locations = len(db["locations"])-1,
577 num_objects = len(db["objects"])-1,
578 num_hints = len(db["hints"]),
579 num_classes = len(db["classes"])-1,
580 num_deaths = len(db["obituaries"]),
581 num_thresholds = len(db["turn_thresholds"]),
582 num_motions = len(db["motions"]),
583 num_actions = len(db["actions"]),
584 num_travel = len(travel),
585 num_keys = len(tkey),
586 bird_endstate = deathbird,
587 arbitrary_messages = get_refs(db["arbitrary_messages"]),
588 locations = get_refs(db["locations"]),
589 objects = get_refs(db["objects"]),
590 motions = get_refs(db["motions"]),
591 actions = get_refs(db["actions"]),
592 state_definitions = statedefines
595 with open(H_NAME, "w", encoding='ascii', errors='surrogateescape') as hf:
598 with open(C_NAME, "w", encoding='ascii', errors='surrogateescape') as cf: