Parallel to the World index of space is the Scenes index of time, and in this section we render it as HTML.
§1. The mapping of time is on the one hand simpler than the mapping of space since there is only one dimension, but on the other hand more complex since scenes can be multiply present at the same instant of time (whereas rooms cannot be multiply present at the same point in space). We resolve this with a notation which takes a little bit of on-screen explanation, but seems natural enough to learn in practice.
void PL::Scenes::Index::index(OUTPUT_STREAM) {
int nr = NUMBER_CREATED(scene);
scene **sorted = Memory::I7_calloc(nr, sizeof(scene *), INDEX_SORTING_MREASON);
<Sort the scenes 1.1>;
<Tabulate the scenes 1.2>;
<Show the legend for the scene table icons 1.3>;
<Give details of each scene in turn 1.5>;
Memory::I7_array_free(sorted, INDEX_SORTING_MREASON, nr, sizeof(scene *));
}
void PL::Scenes::Index::index_rules(OUTPUT_STREAM) {
Rulebooks::index_scene(OUT); rules in generic scene-ending rulebooks
<Show the generic scene-change rules 1.4>;
}
The function PL::Scenes::Index::index appears nowhere else.
The function PL::Scenes::Index::index_rules appears nowhere else.
§1.1. As usual, we sort with the C library's qsort.
<Sort the scenes 1.1> =
int i = 0;
scene *sc;
LOOP_OVER(sc, scene) sorted[i++] = sc;
qsort(sorted, (size_t) nr, sizeof(scene *), PL::Scenes::Index::compare_scenes);
This code is used in §1.
§1.2. The sorted ordering is used as-is later on, when we get to the details, but for the tabulation it's refined further. First we have the start-of-play scenes, in sorted order; then scenes with a condition for their beginning (end 0), in sorted order; then scenes that don't, and which haven't been covered as a result of one of the earlier ones, also in sorted order. (This third category is usually empty except for scenes the author has forgotten about and created but never made use of.)
<Tabulate the scenes 1.2> =
int i;
for (i=0; i<nr; i++) {
scene *sc = sorted[i];
if ((sc->start_of_play) || (sc == SC_entire_game))
PL::Scenes::Index::index_from_scene(OUT, sc, 0, START_OF_PLAY_END, NULL, sorted, nr);
}
for (i=0; i<nr; i++) {
scene *sc = sorted[i];
if ((sc->anchor_condition[0]) && (sc != SC_entire_game))
PL::Scenes::Index::index_from_scene(OUT, sc, 0, START_OF_PLAY_END, NULL, sorted, nr);
}
for (i=0; i<nr; i++) {
scene *sc = sorted[i];
if (sc->indexed == FALSE)
PL::Scenes::Index::index_from_scene(OUT, sc, 0, NEVER_HAPPENS_END, NULL, sorted, nr);
}
This code is used in §1.
§1.3.
<Show the legend for the scene table icons 1.3> =
HTML_OPEN("p"); WRITE("Legend: ");
PL::Scenes::Index::scene_icon_legend(OUT, "WPB", "Begins when play begins");
WRITE("; ");
PL::Scenes::Index::scene_icon_legend(OUT, "WhenC", "can begin whenever some condition holds");
WRITE("; ");
PL::Scenes::Index::scene_icon_legend(OUT, "Segue", "follows when a previous scene ends");
WRITE("; ");
PL::Scenes::Index::scene_icon_legend(OUT, "Simul", "begins simultaneously");
WRITE("; ");
PL::Scenes::Index::scene_icon_legend(OUT, "WNever", "never begins");
WRITE("; ");
PL::Scenes::Index::scene_icon_legend(OUT, "ENever", "never ends");
WRITE("; ");
PL::Scenes::Index::scene_icon_legend(OUT, "Recurring", "recurring (can happen more than once)");
WRITE(". <i>Scene names are italicised when and if they appear for a second "
"or subsequent time because the scene can begin in more than one way</i>.");
HTML_CLOSE("p");
This code is used in §1.
§1.4.
<Show the generic scene-change rules 1.4> =
HTML_OPEN("p");
Index::anchor(OUT, I"SRULES");
WRITE("<b>General rules applying to scene changes</b>");
HTML_CLOSE("p");
Rulebooks::index_rules_box(OUT, "When a scene begins", EMPTY_WORDING, NULL,
built_in_rulebooks[WHEN_SCENE_BEGINS_RB], NULL, NULL, 1, FALSE);
Rulebooks::index_rules_box(OUT, "When a scene ends", EMPTY_WORDING, NULL,
built_in_rulebooks[WHEN_SCENE_ENDS_RB], NULL, NULL, 1, FALSE);
This code is used in §1.
§1.5.
<Give details of each scene in turn 1.5> =
Index::anchor(OUT, I"SDETAILS");
int i;
for (i=0; i<nr; i++) {
HTML_TAG("hr");
scene *sc = sorted[i];
<Give details of a specific scene 1.5.1>;
}
This code is used in §1.
§1.5.1. The curious condition about end 1 here is to avoid printing "Ends: Never" in cases where fancier ends for the scene exist, so that the scene can, in fact, end.
<Give details of a specific scene 1.5.1> =
<Index the name and recurrence status of the scene 1.5.1.1>;
if (sc == SC_entire_game) <Explain the Entire Game scene 1.5.1.2>;
int end;
for (end=0; end<sc->no_ends; end++) {
if ((end == 1) && (sc->no_ends > 2) &&
(sc->anchor_condition[1]==NULL) && (sc->anchor_scene[1]==NULL))
continue;
<Index the conditions for this scene end to occur 1.5.1.4>;
<Index the rules which apply when this scene end occurs 1.5.1.5>;
if (end == 0) <Index the rules which apply during this scene 1.5.1.3>;
}
This code is used in §1.5.
§1.5.1.1.
<Index the name and recurrence status of the scene 1.5.1.1> =
HTMLFiles::open_para(OUT, 1, "hanging");
Index::anchor_numbered(OUT, sc->allocation_id);
WRITE("<b>The <i>%+W</i> scene</b>", PL::Scenes::get_name(sc));
Index::link(OUT, Wordings::first_wn(ParseTree::get_text(sc->scene_declared_at)));
if (World::Inferences::get_EO_state(
Instances::as_subject(sc->as_instance), P_recurring) > 0)
WRITE(" <i>recurring</i>");
HTML_CLOSE("p");
This code is used in §1.5.1.
§1.5.1.2.
<Explain the Entire Game scene 1.5.1.2> =
HTMLFiles::open_para(OUT, 1, "tight");
WRITE("The Entire Game scene is built-in. It is going on whenever play is "
"going on. (It is recurring so that if the story ends, but then resumes, "
"it too will end but then begin again.)");
HTML_CLOSE("p");
This code is used in §1.5.1.
§1.5.1.3.
<Index the rules which apply during this scene 1.5.1.3> =
int rbc = 0;
rulebook *rb;
LOOP_OVER(rb, rulebook) {
if (Rulebooks::is_empty(rb, Rulebooks::scene_context(sc)) == FALSE) {
if (rbc++ == 0) {
HTMLFiles::open_para(OUT, 1, "hanging");
WRITE("<i>During this scene:</i>");
HTML_CLOSE("p");
}
HTMLFiles::open_para(OUT, 2, "hanging");
WRITE("<i>%+W</i>", rb->primary_name); HTML_CLOSE("p");
int ignore_me = 0;
Rulebooks::index(OUT, rb, "", Rulebooks::scene_context(sc), &ignore_me);
}
}
This code is used in §1.5.1.
§1.5.1.4.
<Index the conditions for this scene end to occur 1.5.1.4> =
HTMLFiles::open_para(OUT, 1, "hanging");
WRITE("<i>%s ", (end==0)?"Begins":"Ends");
if (end >= 2) WRITE("%+W ", sc->end_names[end]);
WRITE("when:</i> ");
int count = 0;
<Index the play-begins condition 1.5.1.4.1>;
<Index the I7 condition for a scene to end 1.5.1.4.2>;
<Index connections to other scene ends 1.5.1.4.3>;
if (count == 0) WRITE("<b>never</b>");
HTML_CLOSE("p");
This code is used in §1.5.1.
§1.5.1.4.1.
<Index the play-begins condition 1.5.1.4.1> =
if ((end==0) && (sc->start_of_play)) {
if (count > 0) {
HTML_TAG("br");
WRITE("<i>or when:</i> ");
}
WRITE("<b>play begins</b>");
count++;
}
This code is used in §1.5.1.4.
§1.5.1.4.2.
<Index the I7 condition for a scene to end 1.5.1.4.2> =
if (sc->anchor_condition[end]) {
if (count > 0) {
HTML_TAG("br");
WRITE("<i>or when:</i> ");
}
WRITE("%+W", ParseTree::get_text(sc->anchor_condition[end]));
Index::link(OUT, Wordings::first_wn(ParseTree::get_text(sc->anchor_condition_set[end])));
count++;
}
This code is used in §1.5.1.4.
§1.5.1.4.3.
<Index connections to other scene ends 1.5.1.4.3> =
scene_connector *scon;
for (scon = sc->anchor_scene[end]; scon; scon=scon->next) {
if (count > 0) {
HTML_TAG("br");
WRITE("<i>or when:</i> ");
}
wording NW = Instances::get_name(scon->connect_to->as_instance, FALSE);
WRITE("<b>%+W</b> <i>%s</i>", NW, (scon->end==0)?"begins":"ends");
if (scon->end >= 2) WRITE(" %+W", scon->connect_to->end_names[scon->end]);
Index::link(OUT, Wordings::first_wn(ParseTree::get_text(scon->where_said)));
count++;
}
This code is used in §1.5.1.4.
§1.5.1.5.
<Index the rules which apply when this scene end occurs 1.5.1.5> =
if (Rulebooks::is_empty(sc->end_rulebook[end], Rulebooks::no_rule_context()) == FALSE) {
HTMLFiles::open_para(OUT, 1, "hanging");
WRITE("<i>What happens:</i>"); HTML_CLOSE("p");
int ignore_me = 0;
Rulebooks::index(OUT, sc->end_rulebook[end], "", Rulebooks::no_rule_context(), &ignore_me);
}
This code is used in §1.5.1.
§2. Table of Scenes. We finally return to the table of scenes. The following is recursive, and is called at the top level for each scene in turn which starts at the start of play (see above).
A scene entry can be arrived at in three ways: through one of its ends, in
which case end is the number (0 for begins, 1 for standard ends, and so on),
or through being already active at the start of play, or through being covered
in the index even though it never happens in play. This means we need two
additional end numbers. They are only ever used at the top level, that is,
on the initial call when depth is 0.
define START_OF_PLAY_END -1
define NEVER_HAPPENS_END -2
void PL::Scenes::Index::index_from_scene(OUTPUT_STREAM, scene *sc, int depth,
int end, scene *sc_from, scene **sorted, int nr) {
HTMLFiles::open_para(OUT, depth+1, "tight");
<Indicate the route by which this scene was reached 2.1>;
<Name the scene in the table, italicised if we've seen it already 2.2>;
if (sc->indexed == FALSE) {
<Show the never-ends icon if appropriate 2.3>;
<Show the recurring icon if appropriate 2.4>;
}
HTML_CLOSE("p");
if (sc->indexed) return;
sc->indexed = TRUE;
<Indent to tabulate other scenes connected to the ends of this one 2.5>;
}
The function PL::Scenes::Index::index_from_scene is used in §1.2, §2.5.
§2.1.
<Indicate the route by which this scene was reached 2.1> =
switch(end) {
case 0: PL::Scenes::Index::scene_icon(OUT, "Simul"); break;
case 1: PL::Scenes::Index::scene_icon(OUT, "Segue"); break;
case START_OF_PLAY_END: break;
case NEVER_HAPPENS_END: PL::Scenes::Index::scene_icon(OUT, "WNever"); break;
default:
PL::Scenes::Index::scene_icon(OUT, "Segue");
WRITE("[ends %+W] ", sc_from->end_names[end]); break;
}
if ((sc->indexed == FALSE) || (depth == 0)) {
if (sc == SC_entire_game) PL::Scenes::Index::scene_icon(OUT, "WPB");
else if (sc->anchor_condition[0]) PL::Scenes::Index::scene_icon(OUT, "WhenC");
if (sc->start_of_play) PL::Scenes::Index::scene_icon(OUT, "WPB");
}
This code is used in §2.
§2.2.
<Name the scene in the table, italicised if we've seen it already 2.2> =
if (sc->indexed) WRITE("<i>");
WRITE("%+W", Instances::get_name(sc->as_instance, FALSE));
if (sc->indexed) WRITE("</i>");
else Index::below_link_numbered(OUT, sc->allocation_id);
This code is used in §2.
§2.3.
<Show the never-ends icon if appropriate 2.3> =
int ways_to_end = 0, e;
for (e=1; e<sc->no_ends; e++) {
if (sc->anchor_scene[e]) ways_to_end++;
if (sc->anchor_condition[e]) ways_to_end++;
}
if (ways_to_end == 0) PL::Scenes::Index::scene_icon_append(OUT, "ENever");
This code is used in §2.
§2.4.
<Show the recurring icon if appropriate 2.4> =
inference_subject *subj = Instances::as_subject(sc->as_instance);
if (World::Inferences::get_EO_state(subj, P_recurring) > UNKNOWN_CE)
PL::Scenes::Index::scene_icon_append(OUT, "Recurring");
This code is used in §2.
§2.5. And this is where the routine recurses, so that consequent scenes are
tabulated underneath the present one, indented one step further in (since
indentation is coupled to depth). First we recurse to scenes which end when
this one does; then to scenes which begin when this one ends.
<Indent to tabulate other scenes connected to the ends of this one 2.5> =
int i;
for (i=0; i<nr; i++) {
scene *sc2 = sorted[i];
scene_connector *scon;
for (scon = sc2->anchor_scene[0]; scon; scon=scon->next)
if ((scon->connect_to == sc) && (scon->end >= 1))
PL::Scenes::Index::index_from_scene(OUT, sc2, depth + 1, scon->end, sc, sorted, nr);
}
for (i=0; i<nr; i++) {
scene *sc2 = sorted[i];
scene_connector *scon;
for (scon = sc2->anchor_scene[0]; scon; scon=scon->next)
if ((scon->connect_to == sc) && (scon->end == 0))
PL::Scenes::Index::index_from_scene(OUT, sc2, depth, scon->end, sc, sorted, nr);
}
This code is used in §2.
void PL::Scenes::Index::scene_icon(OUTPUT_STREAM, char *si) {
PL::Scenes::Index::scene_icon_unspaced(OUT, si); WRITE(" ");
}
void PL::Scenes::Index::scene_icon_append(OUTPUT_STREAM, char *si) {
WRITE(" "); PL::Scenes::Index::scene_icon_unspaced(OUT, si);
}
void PL::Scenes::Index::scene_icon_legend(OUTPUT_STREAM, char *si, char *gloss) {
PL::Scenes::Index::scene_icon_unspaced(OUT, si); WRITE(" <i>%s</i>", gloss);
}
void PL::Scenes::Index::scene_icon_unspaced(OUTPUT_STREAM, char *si) {
HTML_TAG_WITH("img", "border=0 src=inform:/scene_icons/%s.png", si);
}
The function PL::Scenes::Index::scene_icon is used in §2.1.
The function PL::Scenes::Index::scene_icon_append is used in §2.3, §2.4.
The function PL::Scenes::Index::scene_icon_legend is used in §1.3.
The function PL::Scenes::Index::scene_icon_unspaced appears nowhere else.
§4. Lastly: the following is the criterion used for sorting the scenes into their indexing order. The Entire Game always comes first, and then come the rest in ascending alphabetical order.
int PL::Scenes::Index::compare_scenes(const void *ent1, const void *ent2) {
const scene *sc1 = *((const scene **) ent1);
const scene *sc2 = *((const scene **) ent2);
if ((sc1 == SC_entire_game) && (sc2 != SC_entire_game)) return -1;
if ((sc1 != SC_entire_game) && (sc2 == SC_entire_game)) return 1;
wording SW1 = Instances::get_name(sc1->as_instance, FALSE);
wording SW2 = Instances::get_name(sc2->as_instance, FALSE);
return Wordings::strcmp(SW1, SW2);
}
The function PL::Scenes::Index::compare_scenes is used in §1.1.