3 # This is the new open-adventure dungeon generator. It'll eventually
4 # replace the existing dungeon.c It currently outputs a .h and .c pair
7 # The nontrivial part of this is the compilation of the YAML for
8 # movement rules to the travel array that's actually used by
9 # playermove(). This program first compiles the YAML to a form
10 # identical to the data in section 3 of the old adventure.text file,
11 # then a second stage packs that data into the travel array.
13 # Here are the rules of the intermediate form:
15 # Each row of data contains a location number (X), a second
16 # location number (Y), and a list of motion numbers (see section 4).
17 # each motion represents a verb which will go to Y if currently at X.
18 # Y, in turn, is interpreted as follows. Let M=Y/1000, N=Y mod 1000.
19 # If N<=300 it is the location to go to.
20 # If 300<N<=500 N-300 is used in a computed goto to
21 # a section of special code.
22 # If N>500 message N-500 from section 6 is printed,
23 # and he stays wherever he is.
24 # Meanwhile, M specifies the conditions on the motion.
25 # If M=0 it's unconditional.
26 # If 0<M<100 it is done with M% probability.
27 # If M=100 unconditional, but forbidden to dwarves.
28 # If 100<M<=200 he must be carrying object M-100.
29 # If 200<M<=300 must be carrying or in same room as M-200.
30 # If 300<M<=400 game.prop(M % 100) must *not* be 0.
31 # If 400<M<=500 game.prop(M % 100) must *not* be 1.
32 # If 500<M<=600 game.prop(M % 100) must *not* be 2, etc.
33 # If the condition (if any) is not met, then the next *different*
34 # "destination" value is used (unless it fails to meet *its* conditions,
35 # in which case the next is found, etc.). Typically, the next dest will
36 # be for one of the same verbs, so that its only use is as the alternate
37 # destination for those verbs. For instance:
38 # 15 110022 29 31 34 35 23 43
40 # This says that, from loc 15, any of the verbs 29, 31, etc., will take
41 # him to 22 if he's carrying object 10, and otherwise will go to 14.
44 # This says that, from 11, 49 takes him to 8 unless game.prop(3)=0, in which
45 # case he goes to 9. Verb 50 takes him to 9 regardless of game.prop(3).
49 yaml_name = "adventure.yaml"
55 h_template = """/* Generated from adventure.yaml - do not hand-hack! */
62 #define SILENT -1 /* no sound */
64 /* Symbols for cond bits */
65 #define COND_LIT 0 /* Light */
66 #define COND_OILY 1 /* If bit 2 is on: on for oil, off for water */
67 #define COND_FLUID 2 /* Liquid asset, see bit 1 */
68 #define COND_NOARRR 3 /* Pirate doesn't go here unless following */
69 #define COND_NOBACK 4 /* Cannot use "back" to move away */
71 #define COND_DEEP 6 /* Deep - e.g where dwarves are active */
72 #define COND_FOREST 7 /* In the forest */
73 #define COND_FORCED 8 /* Only one way in or out of here */
74 /* Bits past 10 indicate areas of interest to "hint" routines */
75 #define COND_HBASE 10 /* Base for location hint bits */
76 #define COND_HCAVE 11 /* Trying to get into cave */
77 #define COND_HBIRD 12 /* Trying to catch bird */
78 #define COND_HSNAKE 13 /* Trying to deal with snake */
79 #define COND_HMAZE 14 /* Lost in maze */
80 #define COND_HDARK 15 /* Pondering dark room */
81 #define COND_HWITT 16 /* At Witt's End */
82 #define COND_HCLIFF 17 /* Cliff with urn */
83 #define COND_HWOODS 18 /* Lost in forest */
84 #define COND_HOGRE 19 /* Trying to deal with ogre */
85 #define COND_HJADE 20 /* Found all treasures except jade */
88 const char* inventory;
102 descriptions_t description;
109 const char* yes_response;
114 const int point_loss;
127 const char* question;
145 /* Abstract out the encoding of words in the travel array. Gives us
146 * some hope of getting to a less cryptic representation than we
147 * inherited from FORTRAN, someday. To understand these, read the
148 * encoding description for travel.
150 #define T_DESTINATION(entry) MOD((entry).opcode / 1000, 1000)
151 #define T_NODWARVES(entry) ((entry).opcode / 1000000 == 100)
152 #define T_MOTION(entry) MOD((entry).opcode, 1000)
153 #define T_TERMINATE(entry) (T_MOTION(entry) == 1)
154 #define T_STOP(entry) ((entry).stop)
155 #define T_HIGH(entry) ((entry).opcode / 1000)
156 #define T_LOW(entry) ((entry).opcode % 1000)
157 #define L_SPEAK(loc) ((loc) - 500)
159 extern const location_t locations[];
160 extern const object_t objects[];
161 extern const char* arbitrary_messages[];
162 extern const class_t classes[];
163 extern const turn_threshold_t turn_thresholds[];
164 extern const obituary_t obituaries[];
165 extern const hint_t hints[];
166 extern long conditions[];
167 extern const motion_t motions[];
168 extern const action_t actions[];
169 extern const travelop_t travel[];
170 extern const long tkey[];
172 #define NLOCATIONS {}
177 #define NTHRESHOLDS {}
182 enum arbitrary_messages_refs {{
186 enum locations_refs {{
202 /* State definitions */
205 #endif /* end NEWDB_H */
208 c_template = """/* Generated from adventure.yaml - do not hand-hack! */
213 const char* arbitrary_messages[] = {{
217 const class_t classes[] = {{
221 const turn_threshold_t turn_thresholds[] = {{
225 const location_t locations[] = {{
229 const object_t objects[] = {{
233 const obituary_t obituaries[] = {{
237 const hint_t hints[] = {{
241 long conditions[] = {{
245 const motion_t motions[] = {{
249 const action_t actions[] = {{
255 const travelop_t travel[] = {{
262 def make_c_string(string):
263 """Render a Python string into C string literal format."""
266 string = string.replace("\n", "\\n")
267 string = string.replace("\t", "\\t")
268 string = string.replace('"', '\\"')
269 string = string.replace("'", "\\'")
270 string = '"' + string + '"'
274 reflist = [x[0] for x in l]
277 ref_str += " {},\n".format(ref)
278 ref_str = ref_str[:-1] # trim trailing newline
281 def get_arbitrary_messages(arb):
286 arb_str += template.format(make_c_string(item[1]))
287 arb_str = arb_str[:-1] # trim trailing newline
290 def get_class_messages(cls):
298 threshold = item["threshold"]
299 message = make_c_string(item["message"])
300 cls_str += template.format(threshold, message)
301 cls_str = cls_str[:-1] # trim trailing newline
304 def get_turn_thresholds(trn):
313 threshold = item["threshold"]
314 point_loss = item["point_loss"]
315 message = make_c_string(item["message"])
316 trn_str += template.format(threshold, point_loss, message)
317 trn_str = trn_str[:-1] # trim trailing newline
320 def get_locations(loc):
321 template = """ {{ // {}
331 for (i, item) in enumerate(loc):
332 short_d = make_c_string(item[1]["description"]["short"])
333 long_d = make_c_string(item[1]["description"]["long"])
334 sound = item[1].get("sound", "SILENT")
335 loud = "true" if item[1].get("loud") else "false"
336 loc_str += template.format(i, short_d, long_d, sound, loud)
337 loc_str = loc_str[:-1] # trim trailing newline
340 def get_objects(obj):
341 template = """ {{ // {}
346 .longs = (const char* []) {{
349 .sounds = (const char* []) {{
352 .texts = (const char* []) {{
358 for (i, item) in enumerate(obj):
360 i_msg = make_c_string(attr["inventory"])
362 if attr["longs"] == None:
363 longs_str = " " * 12 + "NULL,"
366 for l_msg in attr["longs"]:
367 if not isinstance(l_msg, str):
370 longs_str += " " * 12 + make_c_string(l_msg) + ",\n"
371 longs_str = longs_str[:-1] # trim trailing newline
374 statedefines += "/* States for %s */\n" % item[0]
375 for (i, (label, message)) in enumerate(labels):
376 if len(message) >= 45:
377 message = message[:45] + "..."
378 statedefines += "#define %s\t%d /* %s */\n" % (label, i, message)
381 if attr.get("sounds") == None:
382 sounds_str = " " * 12 + "NULL,"
384 for l_msg in attr["sounds"]:
385 sounds_str += " " * 12 + make_c_string(l_msg) + ",\n"
386 sounds_str = sounds_str[:-1] # trim trailing newline
388 if attr.get("texts") == None:
389 texts_str = " " * 12 + "NULL,"
391 for l_msg in attr["texts"]:
392 texts_str += " " * 12 + make_c_string(l_msg) + ",\n"
393 texts_str = texts_str[:-1] # trim trailing newline
394 locs = attr.get("locations", ["LOC_NOWHERE", "LOC_NOWHERE"])
395 immovable = attr.get("immovable", False)
397 if type(locs) == str:
398 locs = [locnames.index(locs), -1 if immovable else 0]
400 locs = [locnames.index(x) for x in locs]
402 sys.stderr.write("dungeon: unknown object location in %s\n" % locs)
404 treasure = "true" if attr.get("treasure") else "false"
405 obj_str += template.format(i, i_msg, locs[0], locs[1], treasure, longs_str, sounds_str, texts_str)
406 obj_str = obj_str[:-1] # trim trailing newline
409 def get_obituaries(obit):
417 query = make_c_string(o["query"])
418 yes = make_c_string(o["yes_response"])
419 obit_str += template.format(query, yes)
420 obit_str = obit_str[:-1] # trim trailing newline
423 def get_hints(hnt, arb):
435 item = member["hint"]
436 number = item["number"]
437 penalty = item["penalty"]
438 turns = item["turns"]
439 question = make_c_string(item["question"])
440 hint = make_c_string(item["hint"])
441 hnt_str += template.format(number, penalty, turns, question, hint)
442 hnt_str = hnt_str[:-1] # trim trailing newline
445 def get_condbits(locations):
447 for (name, loc) in locations:
448 conditions = loc["conditions"]
449 hints = loc.get("hints") or []
451 for flag in conditions:
453 flaglist.append(flag)
454 line = "|".join([("(1<<COND_%s)" % f) for f in flaglist])
455 trail = "|".join([("(1<<COND_H%s)" % f['name']) for f in hints])
458 if line.startswith("|"):
462 cnd_str += " " + line + ",\t// " + name + "\n"
465 def recompose(type_word, value):
466 "Compose the internal code for a vocabulary word from its YAML entry"
467 parts = ("motion", "action", "object", "special")
469 return value + 1000 * parts.index(type_word)
471 sys.stderr.write("dungeon: %s is not a known word\n" % word)
474 sys.stderr.write("%s is not a known word classifier\n" % attrs["type"])
477 def get_motions(motions):
483 for motion in motions:
485 if contents["words"] == None:
486 mot_str += template.format("NULL")
488 c_words = [make_c_string(s) for s in contents["words"]]
489 words_str = "(const char* []) {" + ", ".join(c_words) + "}"
490 mot_str += template.format(words_str)
493 def get_actions(actions):
500 for action in actions:
503 if contents["words"] == None:
506 c_words = [make_c_string(s) for s in contents["words"]]
507 words_str = "(const char* []) {" + ", ".join(c_words) + "}"
509 if contents["message"] == None:
510 message = "NO_MESSAGE"
512 message = contents["message"]
514 act_str += template.format(words_str, message)
515 act_str = act_str[:-1] # trim trailing newline
520 for (i, entry) in enumerate(arr):
522 if out and out[-1] == ' ':
525 out += str(arr[i]) + ", "
526 out = out[:-2] + "\n"
529 def buildtravel(locs, objs, voc):
532 for entry in db["vocabulary"]:
533 if entry["type"] == "motion" and entry["value"] not in verbmap:
534 verbmap[entry["word"]] = entry["value"]
535 def dencode(action, name):
536 "Decode a destination number"
537 if action[0] == "goto":
539 return locnames.index(action[1])
541 sys.stderr.write("dungeon: unknown location %s in goto clause of %s\n" % (cond[1], name))
542 elif action[0] == "special":
543 return 300 + action[1]
544 elif action[0] == "speak":
546 return 500 + msgnames.index(action[1])
548 sys.stderr.write("dungeon: unknown location %s in carry clause of %s\n" % (cond[1], name))
552 def cencode(cond, name):
555 elif cond[0] == "pct":
557 elif cond[0] == "carry":
559 return 100 + objnames.index(cond[1])
561 sys.stderr.write("dungeon: unknown object name %s in carry clause of %s\n" % (cond[1], name))
563 elif cond[0] == "with":
565 return 200 + objnames.index(cond[1])
567 sys.stderr.write("dungeon: unknown object name %s in with clause of \n" % (cond[1], name))
569 elif cond[0] == "not":
570 # FIXME: Allow named as well as numbered states
572 obj = objnames.index(cond[1])
573 if type(cond[2]) == int:
576 for (i, stateclause) in enumerate(objs[obj][1]["longs"]):
577 if type(stateclause) == list:
578 if stateclause[0] == cond[2]:
582 sys.stderr.write("dungeon: unmatched state symbol %s in not clause of %s\n" % (cond[2], name))
584 return 300 + obj + 100 * state
586 sys.stderr.write("dungeon: unknown object name %s in not clause of %s\n" % (cond[1], name))
592 for (i, (name, loc)) in enumerate(locs):
594 for rule in loc["travel"]:
596 dest = dencode(rule["action"], name) + 1000 * cencode(rule.get("cond"), name)
598 tt += [verbmap[e] for e in rule["verbs"]]
599 if not rule["verbs"]:
601 ltravel.append(tuple(tt))
603 # At this point the ltravel data is in the Section 3
604 # representation from the FORTRAN version. Next we perform the
605 # same mapping into the runtime format. This was the C translation
606 # of the FORTRAN code:
608 # while ((loc = GETNUM(database)) != -1) {
609 # long newloc = GETNUM(NULL);
611 # if (TKEY[loc] == 0) {
614 # TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
616 # while ((L = GETNUM(NULL)) != 0) {
617 # TRAVEL[TRVS] = newloc * 1000 + L;
619 # if (TRVS == TRVSIZ)
620 # BUG(TOO_MANY_TRAVEL_OPTIONS);
622 # TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
625 # We're going to break the magic numbers up into a struct.
626 travel = [[0, False]]
630 rule = list(ltravel.pop(0))
634 tkey.append(len(travel))
637 travel[-1][1] = not travel[-1][1]
639 travel.append([rule.pop(0) + newloc * 1000, False])
641 return (travel, tkey)
643 def get_travel(travel):
651 out += template.format(entry[0], entry[1]).lower()
652 out = out[:-1] # trim trailing newline
655 if __name__ == "__main__":
656 with open(yaml_name, "r") as f:
659 locnames = [x[0] for x in db["locations"]]
660 msgnames = [el[0] for el in db["arbitrary_messages"]]
661 objnames = [el[0] for el in db["objects"]]
663 (travel, tkey) = buildtravel(db["locations"],
667 c = c_template.format(
669 get_arbitrary_messages(db["arbitrary_messages"]),
670 get_class_messages(db["classes"]),
671 get_turn_thresholds(db["turn_thresholds"]),
672 get_locations(db["locations"]),
673 get_objects(db["objects"]),
674 get_obituaries(db["obituaries"]),
675 get_hints(db["hints"], db["arbitrary_messages"]),
676 get_condbits(db["locations"]),
677 get_motions(db["motions"]),
678 get_actions(db["actions"]),
679 "const long tkey[] = {%s};" % bigdump(tkey),
683 h = h_template.format(
684 len(db["locations"])-1,
685 len(db["objects"])-1,
687 len(db["classes"])-1,
688 len(db["obituaries"]),
689 len(db["turn_thresholds"]),
693 get_refs(db["arbitrary_messages"]),
694 get_refs(db["locations"]),
695 get_refs(db["objects"]),
696 get_refs(db["motions"]),
697 get_refs(db["actions"]),
701 with open(h_name, "w") as hf:
704 with open(c_name, "w") as cf: