This section masterminds the creation of the World and Kinds index pages, though it delegates much of the work elsewhere. Though it does belong to core Inform, these indexes will look pretty sparse if the spatial Plugins aren't plugged in.
int suppress_panel_changes = FALSE; void IXPhysicalWorld::render(OUTPUT_STREAM, int test_only) { if (Task::wraps_existing_storyfile()) return; in this case there is no model world if (PluginManager::active(map_plugin) == FALSE) return; in this case there is no model world IXInstances::make_faux(); EPSMap::traverse_for_map_parameters(1); PL::SpatialMap::establish_spatial_coordinates(); if (test_only) { PL::SpatialMap::perform_map_internal_test(OUT); } else { PL::HTMLMap::render_map_as_HTML(OUT); PL::HTMLMap::add_region_key(OUT); RenderEPSMap::render_map_as_EPS(); IXBackdrops::index_object_further(OUT, NULL, 0, FALSE, 1); Index::anchor(OUT, I"MDETAILS"); int unruly = FALSE; Mark parts, directions and kinds as ineligible for listing in the World index1.1; Give room details within each region in turn in the World index1.2; Give room details for rooms outside any region in the World index1.3; Give details of everything still unmentioned in the World index1.4; } }
§1.1. Mark parts, directions and kinds as ineligible for listing in the World index1.1 =
faux_instance *I; LOOP_OVER_OBJECTS(I) if ((IXSpatial::no_detail_index(I)) || (IXInstances::is_a_direction(I))) IXInstances::increment_indexing_count(I);
- This code is used in §1.
§1.2. Give room details within each region in turn in the World index1.2 =
faux_instance *reg; LOOP_OVER_OBJECTS(reg) if (IXInstances::is_a_region(reg)) { int subheaded = FALSE; IXInstances::increment_indexing_count(reg); faux_instance *rm; LOOP_OVER_ROOMS(rm) if (IXInstances::region_of(rm) == reg) { if (subheaded == FALSE) { Start a new details panel on the World index1.2.2; Index the name and super-region of the region1.2.1; IXBackdrops::index_object_further(OUT, reg, 0, FALSE, 2); HTML_OPEN("p"); subheaded = TRUE; } PL::HTMLMap::render_single_room_as_HTML(OUT, rm); IXInstances::increment_indexing_count(rm); } }
- This code is used in §1.
§1.2.1. Index the name and super-region of the region1.2.1 =
WRITE("<b>The <i>%+W</i> region", IXInstances::get_name(reg)); faux_instance *within = IXInstances::region_of(reg); if (within) WRITE(" within the <i>%+W</i> region", IXInstances::get_name(within)); WRITE("</b>");
- This code is used in §1.2.
§1.3. Give room details for rooms outside any region in the World index1.3 =
faux_instance *I; LOOP_OVER_ROOMS(I) if (IXInstances::indexed_yet(I) == FALSE) { Start a new details panel on the World index1.2.2; PL::HTMLMap::render_single_room_as_HTML(OUT, I); }
- This code is used in §1.
§1.4. By this point we've accounted for rooms (and their contents and any parts thereof), directions (which we excluded), regions (ditto), and the player object (which the Player plugin put in the right place). The only remainder will be things which are offstage (and their contents and any parts thereof):
Give details of everything still unmentioned in the World index1.4 =
int out_of_play_count = 0; faux_instance *I; LOOP_OVER_OBJECTS(I) if ((IXInstances::indexed_yet(I) == FALSE) && (IXInstances::progenitor(I) == NULL)) { Start a new details panel on the World index1.2.2; if (++out_of_play_count == 1) { suppress_panel_changes = TRUE; WRITE("<b>Nowhere (that is, initially not in any room):</b>"); HTML_TAG("br"); } IXPhysicalWorld::index(OUT, I, 2, FALSE); } suppress_panel_changes = FALSE;
- This code is used in §1.
§1.2.2. Start a new details panel on the World index1.2.2 =
if ((unruly) && (suppress_panel_changes == FALSE)) HTML_TAG("hr"); unruly = TRUE;
§2. Indexing individual objects.
default MAX_OBJECT_INDEX_DEPTH 10000
faux_instance *indexing_room = NULL; int xtras_count = 0; faux_instance *IXPhysicalWorld::room_being_indexed(void) { return indexing_room; } void IXPhysicalWorld::set_room_being_indexed(faux_instance *I) { indexing_room = I; } void IXPhysicalWorld::index(OUTPUT_STREAM, faux_instance *I, int depth, int details) { if (depth == MAX_OBJECT_INDEX_DEPTH) internal_error("MAX_OBJECT_INDEX_DEPTH exceeded"); if (I) { if (depth > NUMBER_CREATED(faux_instance) + 1) return; to recover from errors IXInstances::increment_indexing_count(I); if (IXInstances::is_a_room(I)) indexing_room = I; } Begin the object citation line2.1; int xtra = -1; if (I) xtra = xtras_count++; if (xtra >= 0) Index::extra_link(OUT, xtra); Index the name part of the object citation2.3; if (I) Index the kind attribution part of the object citation2.4; Index the link icons part of the object citation2.5; End the object citation line2.2; if (details) Add a subsidiary paragraph of details about this object2.7; if (xtra >= 0) { Index::extra_div_open(OUT, xtra, depth+1, "e0e0e0"); Add the chain of kinds2.8; Add the catalogue of specific properties2.9; PluginCalls::add_to_World_index(OUT, I); IXPhysicalWorld::index_usages(OUT, I); Index::extra_div_close(OUT, "e0e0e0"); } Recurse the index citation for the object as necessary2.6; }
§2.1. Begin the object citation line2.1 =
if (details) { HTML::open_indented_p(OUT, depth, "halftight"); if (I != indexing_room) Index::anchor(OUT, I->anchor_text); } else { #ifdef IF_MODULE if (I) IXSpatial::index_spatial_relationship(OUT, I); #endif }
- This code is used in §2.
§2.2. End the object citation line2.2 =
if (details) HTML_CLOSE("p");
- This code is used in §2.
§2.3. Index the name part of the object citation2.3 =
Quote the name of the object being indexed2.3.1;
- This code is used in §2.
§2.3.1. Quote the name of the object being indexed2.3.1 =
TEMPORARY_TEXT(name) IXInstances::write_name(name, I); if ((Str::len(name) == 0) && (I)) IXInstances::write_kind(name, I); if (Str::len(name) == 0) { WRITE("nameless"); } else { int embolden = details; if (IXInstances::is_a_room(I)) embolden = TRUE; if (embolden) WRITE("<b>"); WRITE("%S", name); if (embolden) WRITE("</b>"); if (details) Elaborate the name of the object being indexed2.3.1.1; }
- This code is used in §2.3.
§2.3.1.1. Elaborate the name of the object being indexed2.3.1.1 =
if (I) { WRITE(", a kind of "); IXInstances::write_kind(OUT, I); }
- This code is used in §2.3.1.
§2.4. Index the kind attribution part of the object citation2.4 =
if (PluginCalls::annotate_in_World_index(OUT, I) == FALSE) { if (I->specify_kind) { WRITE(" - <i>"); IXInstances::write_kind(OUT, I); WRITE("</i>"); } }
- This code is used in §2.
§2.5. Index the link icons part of the object citation2.5 =
if (I->created_at > 0) Index::link(OUT, I->created_at);
- This code is used in §2.
§2.6. This either recurses down through subkinds or through the spatial hierarchy.
Recurse the index citation for the object as necessary2.6 =
#ifdef IF_MODULE IXSpatial::index_object_further(OUT, I, depth, details); #endif
- This code is used in §2.
§2.7. Add a subsidiary paragraph of details about this object2.7 =
HTML::open_indented_p(OUT, depth, "tight"); IXInferences::index(OUT, IXInstances::as_subject(I), TRUE);
- This code is used in §2.
§2.8. Add the chain of kinds2.8 =
HTML::open_indented_p(OUT, 1, "tight"); IXInstances::write_kind_chain(OUT, I); if (I->kind_set_at > 0) Index::link(OUT, I->kind_set_at); WRITE(" > <b>"); IXInstances::write_name(OUT, I); WRITE("</b>"); HTML_CLOSE("p");
- This code is used in §2.
§2.9. Add the catalogue of specific properties2.9 =
IXInferences::index_specific(OUT, IXInstances::as_subject(I));
- This code is used in §2.
void IXPhysicalWorld::index_usages(OUTPUT_STREAM, faux_instance *I) { int k = 0; parse_node *at; LOOP_OVER_LINKED_LIST(at, parse_node, I->usages) { source_file *sf = Lexer::file_of_origin(Wordings::first_wn(Node::get_text(at))); if (Projects::draws_from_source_file(Task::project(), sf)) { k++; if (k == 1) { HTML::open_indented_p(OUT, 1, "tight"); WRITE("<i>mentioned in rules:</i> "); } else WRITE("; "); Index::link(OUT, Wordings::first_wn(Node::get_text(at))); } } if (k > 0) HTML_CLOSE("p"); }