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 unpacks 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 */
93 const string_group_t words;
94 const char* inventory;
97 const char** descriptions;
100 const char** changes;
109 descriptions_t description;
116 const char* yes_response;
121 const int point_loss;
134 const char* question;
139 const string_group_t words;
143 const string_group_t words;
148 const string_group_t words;
156 const bool nodwarves;
160 /* Abstract out the encoding of words in the travel array. Gives us
161 * some hope of getting to a less cryptic representation than we
162 * inherited from FORTRAN, someday. To understand these, read the
163 * encoding description for travel.
165 #define T_TERMINATE(entry) ((entry).motion == 1)
166 #define L_SPEAK(loc) ((loc) - 500)
168 extern const location_t locations[];
169 extern const object_t objects[];
170 extern const char* arbitrary_messages[];
171 extern const class_t classes[];
172 extern const turn_threshold_t turn_thresholds[];
173 extern const obituary_t obituaries[];
174 extern const hint_t hints[];
175 extern long conditions[];
176 extern const motion_t motions[];
177 extern const action_t actions[];
178 extern const special_t specials[];
179 extern const travelop_t travel[];
180 extern const long tkey[];
181 extern const char *ignore;
183 #define NLOCATIONS {}
188 #define NTHRESHOLDS {}
195 #define BIRD_ENDSTATE {}
197 enum arbitrary_messages_refs {{
201 enum locations_refs {{
221 /* State definitions */
224 #endif /* end DUNGEON_H */
227 c_template = """/* Generated from adventure.yaml - do not hand-hack! */
231 const char* arbitrary_messages[] = {{
235 const class_t classes[] = {{
239 const turn_threshold_t turn_thresholds[] = {{
243 const location_t locations[] = {{
247 const object_t objects[] = {{
251 const obituary_t obituaries[] = {{
255 const hint_t hints[] = {{
259 long conditions[] = {{
263 const motion_t motions[] = {{
267 const action_t actions[] = {{
271 const special_t specials[] = {{
275 const long tkey[] = {{{}}};
277 const travelop_t travel[] = {{
281 const char *ignore = \"{}\";
286 def make_c_string(string):
287 """Render a Python string into C string literal format."""
290 string = string.replace("\n", "\\n")
291 string = string.replace("\t", "\\t")
292 string = string.replace('"', '\\"')
293 string = string.replace("'", "\\'")
294 string = '"' + string + '"'
298 reflist = [x[0] for x in l]
301 ref_str += " {},\n".format(ref)
302 ref_str = ref_str[:-1] # trim trailing newline
305 def get_string_group(strings):
313 strs = "(const char* []) {" + ", ".join([make_c_string(s) for s in strings]) + "}"
315 sg_str = template.format(strs, n)
318 def get_arbitrary_messages(arb):
323 arb_str += template.format(make_c_string(item[1]))
324 arb_str = arb_str[:-1] # trim trailing newline
327 def get_class_messages(cls):
335 threshold = item["threshold"]
336 message = make_c_string(item["message"])
337 cls_str += template.format(threshold, message)
338 cls_str = cls_str[:-1] # trim trailing newline
341 def get_turn_thresholds(trn):
350 threshold = item["threshold"]
351 point_loss = item["point_loss"]
352 message = make_c_string(item["message"])
353 trn_str += template.format(threshold, point_loss, message)
354 trn_str = trn_str[:-1] # trim trailing newline
357 def get_locations(loc):
358 template = """ {{ // {}
368 for (i, item) in enumerate(loc):
369 short_d = make_c_string(item[1]["description"]["short"])
370 long_d = make_c_string(item[1]["description"]["long"])
371 sound = item[1].get("sound", "SILENT")
372 loud = "true" if item[1].get("loud") else "false"
373 loc_str += template.format(i, short_d, long_d, sound, loud)
374 loc_str = loc_str[:-1] # trim trailing newline
377 def get_objects(obj):
378 template = """ {{ // {}
384 .descriptions = (const char* []) {{
387 .sounds = (const char* []) {{
390 .texts = (const char* []) {{
393 .changes = (const char* []) {{
399 for (i, item) in enumerate(obj):
402 words_str = get_string_group(attr["words"])
404 words_str = get_string_group([])
405 i_msg = make_c_string(attr["inventory"])
406 descriptions_str = ""
407 if attr["descriptions"] == None:
408 descriptions_str = " " * 12 + "NULL,"
411 for l_msg in attr["descriptions"]:
412 descriptions_str += " " * 12 + make_c_string(l_msg) + ",\n"
413 for label in attr.get("states", []):
415 descriptions_str = descriptions_str[:-1] # trim trailing newline
418 statedefines += "/* States for %s */\n" % item[0]
419 for (i, label) in enumerate(labels):
420 statedefines += "#define %s\t%d\n" % (label, i)
423 if attr.get("sounds") == None:
424 sounds_str = " " * 12 + "NULL,"
426 for l_msg in attr["sounds"]:
427 sounds_str += " " * 12 + make_c_string(l_msg) + ",\n"
428 sounds_str = sounds_str[:-1] # trim trailing newline
430 if attr.get("texts") == None:
431 texts_str = " " * 12 + "NULL,"
433 for l_msg in attr["texts"]:
434 texts_str += " " * 12 + make_c_string(l_msg) + ",\n"
435 texts_str = texts_str[:-1] # trim trailing newline
437 if attr.get("changes") == None:
438 changes_str = " " * 12 + "NULL,"
440 for l_msg in attr["changes"]:
441 changes_str += " " * 12 + make_c_string(l_msg) + ",\n"
442 changes_str = changes_str[:-1] # trim trailing newline
443 locs = attr.get("locations", ["LOC_NOWHERE", "LOC_NOWHERE"])
444 immovable = attr.get("immovable", False)
446 if type(locs) == str:
447 locs = [locnames.index(locs), -1 if immovable else 0]
449 locs = [locnames.index(x) for x in locs]
451 sys.stderr.write("dungeon: unknown object location in %s\n" % locs)
453 treasure = "true" if attr.get("treasure") else "false"
454 obj_str += template.format(i, words_str, i_msg, locs[0], locs[1], treasure, descriptions_str, sounds_str, texts_str, changes_str)
455 obj_str = obj_str[:-1] # trim trailing newline
458 def get_obituaries(obit):
466 query = make_c_string(o["query"])
467 yes = make_c_string(o["yes_response"])
468 obit_str += template.format(query, yes)
469 obit_str = obit_str[:-1] # trim trailing newline
472 def get_hints(hnt, arb):
484 item = member["hint"]
485 number = item["number"]
486 penalty = item["penalty"]
487 turns = item["turns"]
488 question = make_c_string(item["question"])
489 hint = make_c_string(item["hint"])
490 hnt_str += template.format(number, penalty, turns, question, hint)
491 hnt_str = hnt_str[:-1] # trim trailing newline
494 def get_condbits(locations):
496 for (name, loc) in locations:
497 conditions = loc["conditions"]
498 hints = loc.get("hints") or []
500 for flag in conditions:
502 flaglist.append(flag)
503 line = "|".join([("(1<<COND_%s)" % f) for f in flaglist])
504 trail = "|".join([("(1<<COND_H%s)" % f['name']) for f in hints])
507 if line.startswith("|"):
511 cnd_str += " " + line + ",\t// " + name + "\n"
514 def get_motions(motions):
520 for motion in motions:
522 if contents["words"] == None:
523 words_str = get_string_group([])
525 words_str = get_string_group(contents["words"])
526 mot_str += template.format(words_str)
528 if contents.get("oldstyle", True) == False:
529 for word in contents["words"]:
531 ignore += word.upper()
534 def get_actions(actions):
541 for action in actions:
544 if contents["words"] == None:
545 words_str = get_string_group([])
547 words_str = get_string_group(contents["words"])
549 if contents["message"] == None:
550 message = "NO_MESSAGE"
552 message = contents["message"]
554 act_str += template.format(words_str, message)
556 if contents.get("oldstyle", True) == False:
557 for word in contents["words"]:
559 ignore += word.upper()
560 act_str = act_str[:-1] # trim trailing newline
563 def get_specials(specials):
570 for special in specials:
571 contents = special[1]
573 if contents["words"] == None:
574 words_str = get_string_group([])
576 words_str = get_string_group(contents["words"])
578 if contents["message"] == None:
581 message = make_c_string(contents["message"])
583 spc_str += template.format(words_str, message)
585 if contents.get("oldstyle", True) == False:
586 for word in contents["words"]:
588 ignore += word.upper()
589 spc_str = spc_str[:-1] # trim trailing newline
594 for (i, entry) in enumerate(arr):
596 if out and out[-1] == ' ':
599 out += str(arr[i]).lower() + ", "
600 out = out[:-2] + "\n"
603 def buildtravel(locs, objs):
606 for i, motion in enumerate(db["motions"]):
608 for word in motion[1]["words"]:
609 verbmap[word.upper()] = i
612 def dencode(action, name):
613 "Decode a destination number"
614 if action[0] == "goto":
616 return locnames.index(action[1])
618 sys.stderr.write("dungeon: unknown location %s in goto clause of %s\n" % (cond[1], name))
619 elif action[0] == "special":
620 return 300 + action[1]
621 elif action[0] == "speak":
623 return 500 + msgnames.index(action[1])
625 sys.stderr.write("dungeon: unknown location %s in carry clause of %s\n" % (cond[1], name))
629 def cencode(cond, name):
632 elif cond == ["nodwarves"]:
634 elif cond[0] == "pct":
636 elif cond[0] == "carry":
638 return 100 + objnames.index(cond[1])
640 sys.stderr.write("dungeon: unknown object name %s in carry clause of %s\n" % (cond[1], name))
642 elif cond[0] == "with":
644 return 200 + objnames.index(cond[1])
646 sys.stderr.write("dungeon: unknown object name %s in with clause of \n" % (cond[1], name))
648 elif cond[0] == "not":
650 obj = objnames.index(cond[1])
651 if type(cond[2]) == int:
653 elif cond[2] in objs[obj][1].get("states", []):
654 state = objs[obj][1].get("states").index(cond[2])
656 for (i, stateclause) in enumerate(objs[obj][1]["descriptions"]):
657 if type(stateclause) == list:
658 if stateclause[0] == cond[2]:
662 sys.stderr.write("dungeon: unmatched state symbol %s in not clause of %s\n" % (cond[2], name))
664 return 300 + obj + 100 * state
666 sys.stderr.write("dungeon: unknown object name %s in not clause of %s\n" % (cond[1], name))
672 for (i, (name, loc)) in enumerate(locs):
674 for rule in loc["travel"]:
676 dest = dencode(rule["action"], name) + 1000 * cencode(rule.get("cond"), name)
678 tt += [verbmap[e] for e in rule["verbs"]]
679 if not rule["verbs"]:
681 ltravel.append(tuple(tt))
683 # At this point the ltravel data is in the Section 3
684 # representation from the FORTRAN version. Next we perform the
685 # same mapping into the runtime format. This was the C translation
686 # of the FORTRAN code:
688 # while ((loc = GETNUM(database)) != -1) {
689 # long newloc = GETNUM(NULL);
691 # if (TKEY[loc] == 0) {
694 # TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
696 # while ((L = GETNUM(NULL)) != 0) {
697 # TRAVEL[TRVS] = newloc * 1000 + L;
699 # if (TRVS == TRVSIZ)
700 # BUG(TOO_MANY_TRAVEL_OPTIONS);
702 # TRAVEL[TRVS - 1] = -TRAVEL[TRVS - 1];
705 # In order to de-crypticize the runtime code, we're going to break these
706 # magic numbers up into a struct.
707 travel = [[0, 0, 0, False, False]]
711 rule = list(ltravel.pop(0))
715 tkey.append(len(travel))
718 travel[-1][-1] = not travel[-1][-1]
720 cond = newloc // 1000
721 travel.append([rule.pop(0),
726 travel[-1][-1] = True
727 return (travel, tkey)
729 def get_travel(travel):
740 out += template.format(*entry).lower()
741 out = out[:-1] # trim trailing newline
744 if __name__ == "__main__":
745 with open(yaml_name, "r") as f:
748 locnames = [x[0] for x in db["locations"]]
749 msgnames = [el[0] for el in db["arbitrary_messages"]]
750 objnames = [el[0] for el in db["objects"]]
752 (travel, tkey) = buildtravel(db["locations"],
755 c = c_template.format(
757 get_arbitrary_messages(db["arbitrary_messages"]),
758 get_class_messages(db["classes"]),
759 get_turn_thresholds(db["turn_thresholds"]),
760 get_locations(db["locations"]),
761 get_objects(db["objects"]),
762 get_obituaries(db["obituaries"]),
763 get_hints(db["hints"], db["arbitrary_messages"]),
764 get_condbits(db["locations"]),
765 get_motions(db["motions"]),
766 get_specials(db["actions"]),
767 get_specials(db["specials"]),
773 # 0-origin index of birds's last song. Bird should
774 # die after player hears this.
775 deathbird = len(dict(db["objects"])["BIRD"]["sounds"]) - 1
777 h = h_template.format(
778 len(db["locations"])-1,
779 len(db["objects"])-1,
781 len(db["classes"])-1,
782 len(db["obituaries"]),
783 len(db["turn_thresholds"]),
790 get_refs(db["arbitrary_messages"]),
791 get_refs(db["locations"]),
792 get_refs(db["objects"]),
793 get_refs(db["motions"]),
794 get_refs(db["actions"]),
795 get_refs(db["specials"]),
799 with open(h_name, "w") as hf:
802 with open(c_name, "w") as cf: