3 # This is the open-adventure dungeon generator. It consumes a YAML description of
4 # the dungeon and outputs a dungeon.h and dungeon.c pair of C code files.
6 # The nontrivial part of this is the compilation of the YAML for
7 # movement rules to the travel array that's actually used by
12 YAML_NAME = "adventure.yaml"
15 H_TEMPLATE_PATH = "templates/dungeon.h.tpl"
16 C_TEMPLATE_PATH = "templates/dungeon.c.tpl"
18 DONOTEDIT_COMMENT = "/* Generated from adventure.yaml - do not hand-hack! */\n\n"
22 def make_c_string(string):
23 """Render a Python string into C string literal format."""
26 string = string.replace("\n", "\\n")
27 string = string.replace("\t", "\\t")
28 string = string.replace('"', '\\"')
29 string = string.replace("'", "\\'")
30 string = '"' + string + '"'
34 reflist = [x[0] for x in l]
37 ref_str += " {},\n".format(ref)
38 ref_str = ref_str[:-1] # trim trailing newline
41 def get_string_group(strings):
49 strs = "(const char* []) {" + ", ".join([make_c_string(s) for s in strings]) + "}"
51 sg_str = template.format(strs, n)
54 def get_arbitrary_messages(arb):
59 arb_str += template.format(make_c_string(item[1]))
60 arb_str = arb_str[:-1] # trim trailing newline
63 def get_class_messages(cls):
71 threshold = item["threshold"]
72 message = make_c_string(item["message"])
73 cls_str += template.format(threshold, message)
74 cls_str = cls_str[:-1] # trim trailing newline
77 def get_turn_thresholds(trn):
86 threshold = item["threshold"]
87 point_loss = item["point_loss"]
88 message = make_c_string(item["message"])
89 trn_str += template.format(threshold, point_loss, message)
90 trn_str = trn_str[:-1] # trim trailing newline
93 def get_locations(loc):
94 template = """ {{ // {}: {}
104 for (i, item) in enumerate(loc):
105 short_d = make_c_string(item[1]["description"]["short"])
106 long_d = make_c_string(item[1]["description"]["long"])
107 sound = item[1].get("sound", "SILENT")
108 loud = "true" if item[1].get("loud") else "false"
109 loc_str += template.format(i, item[0], short_d, long_d, sound, loud)
110 loc_str = loc_str[:-1] # trim trailing newline
113 def get_objects(obj):
114 template = """ {{ // {}: {}
120 .descriptions = (const char* []) {{
123 .sounds = (const char* []) {{
126 .texts = (const char* []) {{
129 .changes = (const char* []) {{
135 for (i, item) in enumerate(obj):
138 words_str = get_string_group(attr["words"])
140 words_str = get_string_group([])
141 i_msg = make_c_string(attr["inventory"])
142 descriptions_str = ""
143 if attr["descriptions"] == None:
144 descriptions_str = " " * 12 + "NULL,"
147 for l_msg in attr["descriptions"]:
148 descriptions_str += " " * 12 + make_c_string(l_msg) + ",\n"
149 for label in attr.get("states", []):
151 descriptions_str = descriptions_str[:-1] # trim trailing newline
154 statedefines += "/* States for %s */\n" % item[0]
155 for (j, label) in enumerate(labels):
156 statedefines += "#define %s\t%d\n" % (label, j)
159 if attr.get("sounds") == None:
160 sounds_str = " " * 12 + "NULL,"
162 for l_msg in attr["sounds"]:
163 sounds_str += " " * 12 + make_c_string(l_msg) + ",\n"
164 sounds_str = sounds_str[:-1] # trim trailing newline
166 if attr.get("texts") == None:
167 texts_str = " " * 12 + "NULL,"
169 for l_msg in attr["texts"]:
170 texts_str += " " * 12 + make_c_string(l_msg) + ",\n"
171 texts_str = texts_str[:-1] # trim trailing newline
173 if attr.get("changes") == None:
174 changes_str = " " * 12 + "NULL,"
176 for l_msg in attr["changes"]:
177 changes_str += " " * 12 + make_c_string(l_msg) + ",\n"
178 changes_str = changes_str[:-1] # trim trailing newline
179 locs = attr.get("locations", ["LOC_NOWHERE", "LOC_NOWHERE"])
180 immovable = attr.get("immovable", False)
182 if type(locs) == str:
183 locs = [locs, -1 if immovable else 0]
185 sys.stderr.write("dungeon: unknown object location in %s\n" % locs)
187 treasure = "true" if attr.get("treasure") else "false"
188 obj_str += template.format(i, item[0], words_str, i_msg, locs[0], locs[1], treasure, descriptions_str, sounds_str, texts_str, changes_str)
189 obj_str = obj_str[:-1] # trim trailing newline
192 def get_obituaries(obit):
200 query = make_c_string(o["query"])
201 yes = make_c_string(o["yes_response"])
202 obit_str += template.format(query, yes)
203 obit_str = obit_str[:-1] # trim trailing newline
217 item = member["hint"]
218 number = item["number"]
219 penalty = item["penalty"]
220 turns = item["turns"]
221 question = make_c_string(item["question"])
222 hint = make_c_string(item["hint"])
223 hnt_str += template.format(number, penalty, turns, question, hint)
224 hnt_str = hnt_str[:-1] # trim trailing newline
227 def get_condbits(locations):
229 for (name, loc) in locations:
230 conditions = loc["conditions"]
231 hints = loc.get("hints") or []
233 for flag in conditions:
235 flaglist.append(flag)
236 line = "|".join([("(1<<COND_%s)" % f) for f in flaglist])
237 trail = "|".join([("(1<<COND_H%s)" % f['name']) for f in hints])
240 if line.startswith("|"):
244 cnd_str += " " + line + ",\t// " + name + "\n"
247 def get_motions(motions):
253 for motion in motions:
255 if contents["words"] == None:
256 words_str = get_string_group([])
258 words_str = get_string_group(contents["words"])
259 mot_str += template.format(words_str)
261 if contents.get("oldstyle", True) == False:
262 for word in contents["words"]:
264 ignore += word.upper()
267 def get_actions(actions):
275 for action in actions:
278 if contents["words"] == None:
279 words_str = get_string_group([])
281 words_str = get_string_group(contents["words"])
283 if contents["message"] == None:
286 message = make_c_string(contents["message"])
288 if contents.get("noaction") == None:
293 act_str += template.format(words_str, message, noaction)
295 if contents.get("oldstyle", True) == False:
296 for word in contents["words"]:
298 ignore += word.upper()
299 act_str = act_str[:-1] # trim trailing newline
304 for (i, entry) in enumerate(arr):
306 if out and out[-1] == ' ':
309 out += str(arr[i]).lower() + ", "
310 out = out[:-2] + "\n"
313 def buildtravel(locs, objs):
314 assert len(locs) <= 300
315 assert len(objs) <= 100
316 # THIS CODE IS WAAAY MORE COMPLEX THAN IT NEEDS TO BE. It's the
317 # result of a massive refactoring exercise that concentrated all
318 # the old nastiness in one spot. It hasn't been finally simplified
319 # because there's no need to do it until one of the assertions
320 # fails. Hint: if you try cleaning this up, the acceptance test is
321 # simple - the output dungeon.c must not change.
323 # This function first compiles the YAML to a form identical to the
324 # data in section 3 of the old adventure.text file, then a second
325 # stage unpacks that data into the travel array. Here are the
326 # rules of that intermediate form:
328 # Each row of data contains a location number (X), a second
329 # location number (Y), and a list of motion numbers (see section 4).
330 # each motion represents a verb which will go to Y if currently at X.
331 # Y, in turn, is interpreted as follows. Let M=Y/1000, N=Y mod 1000.
332 # If N<=300 it is the location to go to.
333 # If 300<N<=500 N-300 is used in a computed goto to
334 # a section of special code.
335 # If N>500 message N-500 from section 6 is printed,
336 # and he stays wherever he is.
337 # Meanwhile, M specifies the conditions on the motion.
338 # If M=0 it's unconditional.
339 # If 0<M<100 it is done with M% probability.
340 # If M=100 unconditional, but forbidden to dwarves.
341 # If 100<M<=200 he must be carrying object M-100.
342 # If 200<M<=300 must be carrying or in same room as M-200.
343 # If 300<M<=400 game.prop(M % 100) must *not* be 0.
344 # If 400<M<=500 game.prop(M % 100) must *not* be 1.
345 # If 500<M<=600 game.prop(M % 100) must *not* be 2, etc.
346 # If the condition (if any) is not met, then the next *different*
347 # "destination" value is used (unless it fails to meet *its* conditions,
348 # in which case the next is found, etc.). Typically, the next dest will
349 # be for one of the same verbs, so that its only use is as the alternate
350 # destination for those verbs. For instance:
351 # 15 110022 29 31 34 35 23 43
353 # This says that, from loc 15, any of the verbs 29, 31, etc., will take
354 # him to 22 if he's carrying object 10, and otherwise will go to 14.
357 # This says that, from 11, 49 takes him to 8 unless game.prop[3]=0, in which
358 # case he goes to 9. Verb 50 takes him to 9 regardless of game.prop[3].
361 for i, motion in enumerate(db["motions"]):
363 for word in motion[1]["words"]:
364 verbmap[word.upper()] = i
367 def dencode(action, name):
368 "Decode a destination number"
369 if action[0] == "goto":
371 return locnames.index(action[1])
373 sys.stderr.write("dungeon: unknown location %s in goto clause of %s\n" % (action[1], name))
374 elif action[0] == "special":
375 return 300 + action[1]
376 elif action[0] == "speak":
378 return 500 + msgnames.index(action[1])
380 sys.stderr.write("dungeon: unknown location %s in carry clause of %s\n" % (cond[1], name))
384 def cencode(cond, name):
387 elif cond == ["nodwarves"]:
389 elif cond[0] == "pct":
391 elif cond[0] == "carry":
393 return 100 + objnames.index(cond[1])
395 sys.stderr.write("dungeon: unknown object name %s in carry clause of %s\n" % (cond[1], name))
397 elif cond[0] == "with":
399 return 200 + objnames.index(cond[1])
401 sys.stderr.write("dungeon: unknown object name %s in with clause of \n" % (cond[1], name))
403 elif cond[0] == "not":
405 obj = objnames.index(cond[1])
406 if type(cond[2]) == int:
408 elif cond[2] in objs[obj][1].get("states", []):
409 state = objs[obj][1].get("states").index(cond[2])
411 for (i, stateclause) in enumerate(objs[obj][1]["descriptions"]):
412 if type(stateclause) == list:
413 if stateclause[0] == cond[2]:
417 sys.stderr.write("dungeon: unmatched state symbol %s in not clause of %s\n" % (cond[2], name))
419 return 300 + obj + 100 * state
421 sys.stderr.write("dungeon: unknown object name %s in not clause of %s\n" % (cond[1], name))
427 for (i, (name, loc)) in enumerate(locs):
429 for rule in loc["travel"]:
431 dest = dencode(rule["action"], name) + 1000 * cencode(rule.get("cond"), name)
433 tt += [motionnames[verbmap[e]].upper() for e in rule["verbs"]]
434 if not rule["verbs"]:
435 tt.append(1) # Magic dummy entry for null rules
436 ltravel.append(tuple(tt))
438 # At this point the ltravel data is in the Section 3
439 # representation from the FORTRAN version. Next we perform the
440 # same mapping into wgat used to be the runtime format.
442 travel = [[0, "LOC_NOWHERE", 0, 0, 0, 0, 0, 0, "false", "false"]]
446 rule = list(ltravel.pop(0))
450 tkey.append(len(travel))
453 travel[-1][-1] = "false" if travel[-1][-1] == "true" else "true"
455 cond = newloc // 1000
456 nodwarves = (cond == 100)
458 condtype = "cond_goto"
459 condarg1 = condarg2 = 0
461 condtype = "cond_pct"
465 condtype = "cond_goto"
469 condtype = "cond_carry"
470 condarg1 = objnames[cond - 100]
473 condtype = "cond_with"
474 condarg1 = objnames[cond - 200]
477 condtype = "cond_not"
478 condarg1 = cond % 100
479 condarg2 = (cond - 300) // 100.
482 desttype = "dest_goto";
483 destval = locnames[dest]
485 desttype = "dest_speak";
486 destval = msgnames[dest - 500]
488 desttype = "dest_special";
489 destval = locnames[dest - 300]
490 travel.append([len(tkey)-1,
491 locnames[len(tkey)-1],
498 "true" if nodwarves else "false",
500 travel[-1][-1] = "true"
501 return (travel, tkey)
503 def get_travel(travel):
504 template = """ {{ // from {}: {}
517 out += template.format(*entry)
518 out = out[:-1] # trim trailing newline
521 if __name__ == "__main__":
522 with open(YAML_NAME, "r") as f:
525 locnames = [x[0] for x in db["locations"]]
526 msgnames = [el[0] for el in db["arbitrary_messages"]]
527 objnames = [el[0] for el in db["objects"]]
528 motionnames = [el[0] for el in db["motions"]]
530 (travel, tkey) = buildtravel(db["locations"],
534 with open(H_TEMPLATE_PATH, "r") as htf:
535 # read in dungeon.h template
536 h_template = DONOTEDIT_COMMENT + htf.read()
537 with open(C_TEMPLATE_PATH, "r") as ctf:
538 # read in dungeon.c template
539 c_template = DONOTEDIT_COMMENT + ctf.read()
541 print('ERROR: reading template failed ({})'.format(e.strerror))
544 c = c_template.format(
546 arbitrary_messages = get_arbitrary_messages(db["arbitrary_messages"]),
547 classes = get_class_messages(db["classes"]),
548 turn_thresholds = get_turn_thresholds(db["turn_thresholds"]),
549 locations = get_locations(db["locations"]),
550 objects = get_objects(db["objects"]),
551 obituaries = get_obituaries(db["obituaries"]),
552 hints = get_hints(db["hints"]),
553 conditions = get_condbits(db["locations"]),
554 motions = get_motions(db["motions"]),
555 actions = get_actions(db["actions"]),
556 tkeys = bigdump(tkey),
557 travel = get_travel(travel),
561 # 0-origin index of birds's last song. Bird should
562 # die after player hears this.
563 deathbird = len(dict(db["objects"])["BIRD"]["sounds"]) - 1
565 h = h_template.format(
566 num_locations = len(db["locations"])-1,
567 num_objects = len(db["objects"])-1,
568 num_hints = len(db["hints"]),
569 num_classes = len(db["classes"])-1,
570 num_deaths = len(db["obituaries"]),
571 num_thresholds = len(db["turn_thresholds"]),
572 num_motions = len(db["motions"]),
573 num_actions = len(db["actions"]),
574 num_travel = len(travel),
575 num_keys = len(tkey),
576 bird_endstate = deathbird,
577 arbitrary_messages = get_refs(db["arbitrary_messages"]),
578 locations = get_refs(db["locations"]),
579 objects = get_refs(db["objects"]),
580 motions = get_refs(db["motions"]),
581 actions = get_refs(db["actions"]),
582 state_definitions = statedefines
585 with open(H_NAME, "w") as hf:
588 with open(C_NAME, "w") as cf: