2022-04-09 16:52:23 +03:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > Index Stage< / title >
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< meta name = "viewport" content = "width=device-width initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Navigation.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Fonts.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "../docs-assets/Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< / head >
< body class = "commentary-font" >
< nav role = "navigation" >
2022-04-28 19:37:28 +03:00
< h1 > < a href = "../index.html" >
2022-04-09 16:52:23 +03:00
< img src = "../docs-assets/Inform.png" height = 72" >
< / a > < / h1 >
2022-04-28 19:37:28 +03:00
< ul > < li > < a href = "../index.html" > home< / a > < / li >
2022-04-09 16:52:23 +03:00
< / ul > < h2 > Compiler< / h2 > < ul >
< li > < a href = "../structure.html" > structure< / a > < / li >
< li > < a href = "../inbuildn.html" > inbuild< / a > < / li >
< li > < a href = "../inform7n.html" > inform7< / a > < / li >
< li > < a href = "../intern.html" > inter< / a > < / li >
< li > < a href = "../services.html" > services< / a > < / li >
2022-04-18 17:46:46 +03:00
< li > < a href = "../secrets.html" > secrets< / a > < / li >
2022-04-09 16:52:23 +03:00
< / ul > < h2 > Other Tools< / h2 > < ul >
< li > < a href = "../inblorbn.html" > inblorb< / a > < / li >
< li > < a href = "../indocn.html" > indoc< / a > < / li >
< li > < a href = "../inform6.html" > inform6< / a > < / li >
< li > < a href = "../inpolicyn.html" > inpolicy< / a > < / li >
< li > < a href = "../inrtpsn.html" > inrtps< / a > < / li >
< / ul > < h2 > Resources< / h2 > < ul >
< li > < a href = "../extensions.html" > extensions< / a > < / li >
< li > < a href = "../kits.html" > kits< / a > < / li >
< / ul > < h2 > Repository< / h2 > < ul >
< li > < a href = "https://github.com/ganelson/inform" > < img src = "../docs-assets/github.png" height = 18 > github< / a > < / li >
< / ul > < h2 > Related Projects< / h2 > < ul >
2022-04-28 19:20:06 +03:00
< li > < a href = "../../../inweb/index.html" > inweb< / a > < / li >
< li > < a href = "../../../intest/index.html" > intest< / a > < / li >
2022-04-09 16:52:23 +03:00
< / ul >
< / nav >
< main role = "main" >
<!-- Weave of 'Index Stage' generated by Inweb -->
< div class = "breadcrumbs" >
2022-04-28 19:37:28 +03:00
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../intern.html" > Inter Modules< / a > < / li > < li > < a href = "index.html" > index< / a > < / li > < li > < a href = "index.html#1" > Chapter 1: Starting Up< / a > < / li > < li > < b > Index Stage< / b > < / li > < / ul > < / div >
2022-04-09 16:52:23 +03:00
< p class = "purpose" > A pipeline stage for generating the index of an Inform project.< / p >
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > This is not really a general-purpose pipeline stage: it makes sense only in
the context of an Inform compilation run, and will (silently) do nothing if
run in any other pipeline.
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > IndexStage::create_pipeline_stage< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ParsingPipelines::new_stage< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "index"< / span > < span class = "plain-syntax" > , < / span > < a href = "1-is.html#SP2" class = "function-link" > < span class = "function-syntax" > IndexStage::run< / span > < / a > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > NO_STAGE_ARG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. < / b > The implementation here needs an < span class = "extract" > < span class = "extract-syntax" > inform_project< / span > < / span > structure to work from,
and that exists only in the < a href = "../supervisor-module/index.html" class = "internal" > supervisor< / a > module — which is not a part of
the Inter stand-alone tool. So running < span class = "extract" > < span class = "extract-syntax" > inter< / span > < / span > at the command line does not
allow the indexer to do anything.
< / p >
< p class = "commentary" > Moreover, and in a sneaky fashion, updating the extensions documentation and
generating an EPS map are also sometimes part of the indexing process, depending
on the command-line settings used when invoking < span class = "extract" > < span class = "extract-syntax" > inform7< / span > < / span > .
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > define< / span > < span class = "constant-syntax" > INDEX_REQUIRED_BIT< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 1< / span >
< span class = "definition-keyword" > define< / span > < span class = "constant-syntax" > CENSUS_UPDATE_REQUIRED_BIT< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 2< / span >
< span class = "definition-keyword" > define< / span > < span class = "constant-syntax" > EPS_MAP_REQUIRED_BIT< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 4< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > IndexStage::run< / span > < button class = "popup" onclick = "togglePopup('usagePopup1')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup1" > Usage of < span class = "code-font" > < span class = "function-syntax" > IndexStage::run< / span > < / span > :< br / > < a href = "1-is.html#SP1" > § 1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pipeline_step< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > ifdef< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > SUPERVISOR_MODULE< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > inter_tree< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > tree< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > req< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > INDEX_REQUIRED_BIT< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > ifdef< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > CORE_MODULE< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > req< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Task::get_index_requirements< / span > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > endif< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > inform_project< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > ifdef< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > SUPERVISOR_MODULE< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > InterSkill::get_associated_project< / span > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > endif< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > ((< / span > < span class = "identifier-syntax" > req< / span > < span class = "plain-syntax" > & < / span > < span class = "constant-syntax" > INDEX_REQUIRED_BIT< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > req< / span > < span class = "plain-syntax" > & < / span > < span class = "constant-syntax" > EPS_MAP_REQUIRED_BIT< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_session< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > = < / span > < a href = "1-is.html#SP3" class = "function-link" > < span class = "function-syntax" > IndexStage::index_session_for< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > req< / span > < span class = "plain-syntax" > & < / span > < span class = "constant-syntax" > INDEX_REQUIRED_BIT< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "1-ia.html#SP3_1" class = "function-link" > < span class = "function-syntax" > Indexing::generate_index_website< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > Projects::index_structure< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > ));< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > req< / span > < span class = "plain-syntax" > & < / span > < span class = "constant-syntax" > CENSUS_UPDATE_REQUIRED_BIT< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ExtensionWebsite::index_after_compilation< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > ifdef< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > CORE_MODULE< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > req< / span > < span class = "plain-syntax" > & < / span > < span class = "constant-syntax" > EPS_MAP_REQUIRED_BIT< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "1-ia.html#SP3_3" class = "function-link" > < span class = "function-syntax" > Indexing::generate_EPS_map< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > Task::epsmap_file< / span > < span class = "plain-syntax" > (), < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > endif< / span >
< span class = "plain-syntax" > < / span > < a href = "1-ia.html#SP3_4" class = "function-link" > < span class = "function-syntax" > Indexing::close_session< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > endif< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. < / b > The actual indexing work is all done using the < a href = "1-ia.html" class = "internal" > Indexing API< / a > .
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > ifdef< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > SUPERVISOR_MODULE< / span >
< span class = "reserved-syntax" > index_session< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > IndexStage::index_session_for< / span > < button class = "popup" onclick = "togglePopup('usagePopup2')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup2" > Usage of < span class = "code-font" > < span class = "function-syntax" > IndexStage::index_session_for< / span > < / span > :< br / > < a href = "1-is.html#SP2" > § 2< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > inter_tree< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > inform_project< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_session< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > = < / span > < a href = "1-ia.html#SP2" class = "function-link" > < span class = "function-syntax" > Indexing::open_session< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > inform_language< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > E< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Languages::find_for< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "English"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > Projects::nest_list< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > ));< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > inform_language< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Projects::get_language_of_index< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > project< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > E< / span > < span class = "plain-syntax" > != < / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "1-ia.html#SP3" class = "function-link" > < span class = "function-syntax" > Indexing::localise< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Filenames::in< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > Languages::path_to_bundle< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > E< / span > < span class = "plain-syntax" > ), < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Index.txt"< / span > < span class = "plain-syntax" > ));< / span >
< span class = "plain-syntax" > < / span > < a href = "1-ia.html#SP3" class = "function-link" > < span class = "function-syntax" > Indexing::localise< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Filenames::in< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > Languages::path_to_bundle< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > ), < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Index.txt"< / span > < span class = "plain-syntax" > ));< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > endif< / span >
< / pre >
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "1-im.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-wtmd.html" > P< / a > < / li > < li class = "progresscurrentchapter" > 1< / li > < li class = "progresssection" > < a href = "1-im.html" > im< / a > < / li > < li class = "progresscurrent" > is< / li > < li class = "progresssection" > < a href = "1-ia.html" > ia< / a > < / li > < li class = "progresschapter" > < a href = "2-il.html" > 2< / a > < / li > < li class = "progresschapter" > < a href = "3-tpt.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-mc.html" > 4< / a > < / li > < li class = "progressnext" > < a href = "1-ia.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >