2019-03-17 14:40:57 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2021-04-20 12:34:54 +03:00
< title > Index Interpreter< / title >
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 02:11:25 +02:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2019-03-17 14:40:57 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-05-03 03:01:21 +03:00
2020-05-03 03:20:55 +03:00
< 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" >
2021-07-04 01:11:42 +03:00
< 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" >
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-14 19:56:54 +03:00
2019-03-17 14:40:57 +02:00
< / head >
2020-05-03 03:01:21 +03:00
< body class = "commentary-font" >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
2022-04-28 19:37:28 +03:00
< h1 > < a href = "../index.html" >
2020-05-03 18:34:53 +03:00
< img src = "../docs-assets/Inform.png" height = 72" >
2020-04-14 19:56:54 +03:00
< / a > < / h1 >
2022-04-28 19:37:28 +03:00
< ul > < li > < a href = "../index.html" > home< / a > < / li >
2022-04-04 20:31:44 +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-04 20:31:44 +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 >
2022-04-09 16:52:23 +03:00
< / ul > < h2 > Resources< / h2 > < ul >
< li > < a href = "../extensions.html" > extensions< / a > < / li >
< li > < a href = "../kits.html" > kits< / a > < / li >
2022-04-04 20:31:44 +03:00
< / 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 >
2020-03-19 02:11:25 +02:00
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-19 02:11:25 +02:00
< / nav >
< main role = "main" >
2021-04-20 12:34:54 +03:00
<!-- Weave of 'Index Interpreter' generated by Inweb -->
2020-05-03 03:01:21 +03:00
< 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#2" > Chapter 2: Utilities< / a > < / li > < li > < b > Index Interpreter< / b > < / li > < / ul > < / div >
2021-07-07 01:26:06 +03:00
< p class = "purpose" > An index is generated by interpreting an index structure file.< / p >
2019-03-17 14:40:57 +02:00
2021-07-26 15:48:49 +03:00
< ul class = "toc" > < li > < a href = "2-ii.html#SP3" > § 3. Registering< / a > < / li > < li > < a href = "2-ii.html#SP5" > § 5. Opening and closing HTML files< / a > < / li > < / ul > < hr class = "tocbar" >
2021-07-07 01:26:06 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > The index is generated by a bare-bones structure file. These are identified
by name: in particular < span class = "extract" > < span class = "extract-syntax" > Basic< / span > < / span > is the barer version, for Basic Inform projects,
while < span class = "extract" > < span class = "extract-syntax" > Standard< / span > < / span > is the index as generated to suit typical IF uses of the Standard
Rules — so, in other words, that's the index which most Inform users know.
These names have to correspond to < span class = "extract" > < span class = "extract-syntax" > .indext< / span > < / span > structure files stored in the
Inform distribution.
< / p >
< p class = "commentary" > The structure file really just shows which index elements to include on which
pages. For example:
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > page Kinds e9cf08< / span >
< span class = "plain-syntax" > element Ch< / span >
< span class = "plain-syntax" > element Ar< / span >
< span class = "plain-syntax" > element Vl< / span >
< / pre >
< p class = "commentary" > declares a new index page with leafname < span class = "extract" > < span class = "extract-syntax" > Kinds.html< / span > < / span > , and with the highlight
2022-05-03 00:59:04 +03:00
colour (in CSS hexadecimal style) < span class = "extract" > < span class = "extract-syntax" > e9cf08< / span > < / span > ; and then declares that it contains
2021-07-07 01:26:06 +03:00
the three elements < span class = "extract" > < span class = "extract-syntax" > Ch< / span > < / span > , < span class = "extract" > < span class = "extract-syntax" > Ar< / span > < / span > and < span class = "extract" > < span class = "extract-syntax" > Vl< / span > < / span > , in that order. Note that this file does
2021-07-26 02:34:51 +03:00
not contain any user-facing text: all of that comes from < a href = "../html-module/2-lcl.html" class = "internal" > Localisation (in html)< / a > .
2021-07-07 01:26:06 +03:00
< / p >
2021-06-29 01:33:14 +03:00
2021-07-07 01:26:06 +03:00
< p class = "commentary" > The file also doesn't contain instructions for what goes into those elements.
All of that is hardwired into this module's code: for example, < span class = "extract" > < span class = "extract-syntax" > Ar< / span > < / span > is generated
by the function < a href = "3-ae2.html#SP1" class = "internal" > ArithmeticElement::render< / a > in < a href = "3-ae2.html" class = "internal" > Arithmetic Element< / a > .
< / p >
2020-05-03 03:01:21 +03:00
2021-07-07 01:26:06 +03:00
< p class = "commentary" > The method here is basically to read all the declarations, generating a set
2021-07-26 15:48:49 +03:00
of < a href = "2-ii.html#SP3" class = "internal" > index_page< / a > and < a href = "2-ii.html#SP4" class = "internal" > index_element< / a > objects to represent them, and only to
2021-07-07 01:26:06 +03:00
begin writing some HTML when this scanning is done, i.e., when the whole structure
file has been read.
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-26 15:48:49 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > InterpretIndex::generate< / 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" > InterpretIndex::generate< / span > < / span > :< br / > Indexing API - < a href = "1-ia.html#SP3_1" > § 3.1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > structure< / 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 >
2021-07-27 15:55:53 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > localisation_dictionary< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > = < / span > < a href = "1-ia.html#SP6" class = "function-link" > < span class = "function-syntax" > Indexing::get_localisation< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "1-ia.html#SP7" class = "function-link" > < span class = "function-syntax" > Indexing::empty_list_of_pages< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > index_structure< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > InstalledFiles::index_structure_file< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > structure< / span > < span class = "plain-syntax" > );< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "2-ii.html#SP1_1" class = "named-paragraph-link" > < span class = "named-paragraph" > Read the structure file line by line< / span > < span class = "named-paragraph-number" > 1.1< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "2-ii.html#SP1_2" class = "named-paragraph-link" > < span class = "named-paragraph" > Actually generate the index files< / span > < span class = "named-paragraph-number" > 1.2< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
2020-05-03 03:01:21 +03:00
< span class = "plain-syntax" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2021-07-27 02:42:09 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1_1" class = "paragraph-anchor" > < / a > < b > § 1.1. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Read the structure file line by line< / span > < span class = "named-paragraph-number" > 1.1< / span > < / span > < span class = "comment-syntax" > =< / span >
2021-07-07 01:26:06 +03:00
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TextFiles::read< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > index_structure< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "unable to read index structure file"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > ,< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > & < / span > < a href = "2-ii.html#SP2" class = "function-link" > < span class = "function-syntax" > InterpretIndex::read_structure< / span > < / a > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > , (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > *) < / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< / pre >
< ul class = "endnotetexts" > < li > This code is used in < a href = "2-ii.html#SP1" > § 1< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. < / b > < span class = "extract" > < span class = "extract-syntax" > contents< / span > < / span > is currently implemented identically to < span class = "extract" > < span class = "extract-syntax" > pages< / span > < / span > , but it is supposed to
represent the home page of the index. The declaration for it should come
last in the structure file, like so:
< / p >
2021-07-04 01:11:42 +03:00
2021-07-07 01:26:06 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > contents Welcome 111111< / span >
< / pre >
< p class = "commentary" > It has no elements, because its only content will be a menu of links to the other
pages.
< / p >
2021-07-04 01:11:42 +03:00
2021-07-07 01:26:06 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-27 02:42:09 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > InterpretIndex::read_structure< / 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" > InterpretIndex::read_structure< / span > < / span > :< br / > < a href = "2-ii.html#SP1_1" > § 1.1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text_file_position< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > tfp< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > state< / 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 > < span class = "reserved-syntax" > index_session< / span > < span class = "plain-syntax" > *) < / span > < span class = "identifier-syntax" > state< / span > < span class = "plain-syntax" > ;< / span >
2021-07-27 15:55:53 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > localisation_dictionary< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > = < / span > < a href = "1-ia.html#SP6" class = "function-link" > < span class = "function-syntax" > Indexing::get_localisation< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > match_results< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Regexp::create_mr< / 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" > Regexp::match< / span > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "page (%C+) (%C+)"< / span > < span class = "plain-syntax" > )) {< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "2-ii.html#SP2_1" class = "named-paragraph-link" > < span class = "named-paragraph" > Register a new index page< / span > < span class = "named-paragraph-number" > 2.1< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > Regexp::match< / span > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "contents (%C+) (%C+)"< / span > < span class = "plain-syntax" > )) {< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "2-ii.html#SP2_1" class = "named-paragraph-link" > < span class = "named-paragraph" > Register a new index page< / span > < span class = "named-paragraph-number" > 2.1< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > Regexp::match< / span > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "element (%C+)"< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "2-ii.html#SP2_2" class = "named-paragraph-link" > < span class = "named-paragraph" > Register a new index element< / span > < span class = "named-paragraph-number" > 2.2< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Regexp::dispose_of< / span > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-07-07 01:26:06 +03:00
< p class = "commentary firstcommentary" > < a id = "SP2_1" class = "paragraph-anchor" > < / a > < b > § 2.1. < / b > Note that the heading written on < span class = "extract" > < span class = "extract-syntax" > Kinds.html< / span > < / span > , say, is drawn from the
localisation file under the key < span class = "extract" > < span class = "extract-syntax" > %Title< / span > < / span > in the context < span class = "extract" > < span class = "extract-syntax" > %%Kinds< / span > < / span > . In English,
that will be "Kinds", but if the index is being generated with a Dutch localisation
dictionary then perhaps it would be "Soorten". Under the hood, though, the filename
will be < span class = "extract" > < span class = "extract-syntax" > Kinds.html< / span > < / span > either way.
< / p >
< p class = "commentary" > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Register a new index page< / span > < span class = "named-paragraph-number" > 2.1< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > col< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > .< / span > < span class = "identifier-syntax" > exp< / span > < span class = "plain-syntax" > [1];< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > .< / span > < span class = "identifier-syntax" > exp< / span > < span class = "plain-syntax" > [0];< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > path< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > path< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "Index.Pages.%S.Title"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > );< / span >
2021-07-26 02:34:51 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > heading< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Localisation::read< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > path< / span > < span class = "plain-syntax" > );< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Str::clear< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > path< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > path< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "Index.Pages.%S.Caption"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > );< / span >
2021-07-26 02:34:51 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > explanation< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Localisation::read< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > path< / span > < span class = "plain-syntax" > );< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > path< / span > < span class = "plain-syntax" > )< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < a href = "2-ii.html#SP3" class = "function-link" > < span class = "function-syntax" > InterpretIndex::register_page< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > col< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > heading< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > explanation< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< / pre >
< ul class = "endnotetexts" > < li > This code is used in < a href = "2-ii.html#SP2" > § 2< / a > (twice).< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP2_2" class = "paragraph-anchor" > < / a > < b > § 2.2. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Register a new index element< / span > < span class = "named-paragraph-number" > 2.2< / span > < / span > < span class = "comment-syntax" > =< / span >
2021-07-04 01:11:42 +03:00
< / p >
2021-07-07 01:26:06 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-27 15:55:53 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > latest< / span > < span class = "plain-syntax" > = < / span > < a href = "1-ia.html#SP7" class = "function-link" > < span class = "function-syntax" > Indexing::latest_page< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > latest< / span > < span class = "plain-syntax" > == < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > internal_error< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "element without page"< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > elt< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > .< / span > < span class = "identifier-syntax" > exp< / span > < span class = "plain-syntax" > [0];< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > tkey< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > hkey< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > tkey< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "Index.Elements.%S.Title"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > elt< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > hkey< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "Index.Elements.%S.Heading"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > elt< / span > < span class = "plain-syntax" > );< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < a href = "2-ii.html#SP4" class = "function-link" > < span class = "function-syntax" > InterpretIndex::register_element< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > elt< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > latest< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > Localisation::read< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > tkey< / span > < span class = "plain-syntax" > ), < / span > < span class = "identifier-syntax" > hkey< / span > < span class = "plain-syntax" > );< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > tkey< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > hkey< / span > < span class = "plain-syntax" > )< / span >
2021-07-07 01:26:06 +03:00
< / pre >
< ul class = "endnotetexts" > < li > This code is used in < a href = "2-ii.html#SP2" > § 2< / a > .< / li > < / ul >
2021-07-27 02:42:09 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1_2" class = "paragraph-anchor" > < / a > < b > § 1.2. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Actually generate the index files< / span > < span class = "named-paragraph-number" > 1.2< / span > < / span > < span class = "comment-syntax" > =< / span >
2019-03-17 14:40:57 +02:00
< / p >
2021-07-07 01:26:06 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > ;< / span >
2021-07-27 15:55:53 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > linked_list< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > = < / span > < a href = "1-ia.html#SP7" class = "function-link" > < span class = "function-syntax" > Indexing::get_list_of_pages< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > LOOP_OVER_LINKED_LIST< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > ) {< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > leafname< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > leafname< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%S.html"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > page_leafname< / span > < span class = "plain-syntax" > );< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "Index.Pages.%S.Title"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > page_leafname< / span > < span class = "plain-syntax" > );< / span >
2021-07-26 15:48:49 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > index_file_struct< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > = & < / span > < span class = "identifier-syntax" > index_file_struct< / span > < span class = "plain-syntax" > ;< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < a href = "2-ii.html#SP5" class = "function-link" > < span class = "function-syntax" > InterpretIndex::open_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > leafname< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > Localisation::read< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > D< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > ),< / span >
< span class = "plain-syntax" > -1, < / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-26 15:48:49 +03:00
< span class = "plain-syntax" > < / span > < a href = "3-tpt.html#SP2" class = "function-link" > < span class = "function-syntax" > Elements::periodic_table< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > leafname< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-ii.html#SP6" class = "function-link" > < span class = "function-syntax" > InterpretIndex::close_index_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > );< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > key< / span > < span class = "plain-syntax" > )< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > leafname< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > }< / span >
2021-07-26 15:48:49 +03:00
< span class = "plain-syntax" > < / span > < a href = "3-ge2.html#SP2" class = "function-link" > < span class = "function-syntax" > GroupedElement::detail_pages< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< / pre >
< ul class = "endnotetexts" > < li > This code is used in < a href = "2-ii.html#SP1" > § 1< / a > .< / li > < / ul >
2021-07-26 15:48:49 +03:00
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. Registering. < / b > So, then, here are the objects representing the index pages and their elements
2021-07-07 01:26:06 +03:00
of content:
2020-05-03 03:01:21 +03:00
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-04 01:11:42 +03:00
< span class = "reserved-syntax" > typedef< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_page< / 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" > no_elements< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > key_colour< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > page_title< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > page_explanation< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > page_leafname< / span > < span class = "plain-syntax" > ;< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > linked_list< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > elements< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > of < / span > < span class = "extract" > < span class = "extract-syntax" > index_element< / span > < / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_session< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > for_session< / span > < span class = "plain-syntax" > ;< / span >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > CLASS_DEFINITION< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > ;< / span >
2021-07-07 01:26:06 +03:00
2021-07-26 15:48:49 +03:00
< span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > InterpretIndex::register_page< / span > < button class = "popup" onclick = "togglePopup('usagePopup3')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup3" > Usage of < span class = "code-font" > < span class = "function-syntax" > InterpretIndex::register_page< / span > < / span > :< br / > < a href = "2-ii.html#SP2_1" > § 2.1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > col< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > title< / span > < span class = "plain-syntax" > ,< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > exp< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > leaf< / 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 >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > CREATE< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > no_elements< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > key_colour< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > col< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > page_title< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > title< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > page_explanation< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > exp< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > page_leafname< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > leaf< / span > < span class = "plain-syntax" > );< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > elements< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NEW_LINKED_LIST< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > index_element< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > for_session< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > ;< / span >
2021-07-27 15:55:53 +03:00
< span class = "plain-syntax" > < / span > < a href = "1-ia.html#SP7" class = "function-link" > < span class = "function-syntax" > Indexing::add_page< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > new_page< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2021-07-27 02:42:09 +03:00
< ul class = "endnotetexts" > < li > The structure index_page is accessed in 2/sas, 3/tpt, 4/sm and here.< / li > < / ul >
2021-07-26 15:48:49 +03:00
< p class = "commentary firstcommentary" > < a id = "SP4" class = "paragraph-anchor" > < / a > < b > § 4. < / b > < / p >
2019-03-17 14:40:57 +02:00
2021-07-04 01:11:42 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > typedef< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_element< / 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" > atomic_number< / span > < span class = "plain-syntax" > ; < / span > < span class = "comment-syntax" > 1, 2, 3, ..., within its page< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > chemical_symbol< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > element_name< / span > < span class = "plain-syntax" > ;< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > explanation_key< / span > < span class = "plain-syntax" > ;< / span >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > owning_page< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > CLASS_DEFINITION< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > index_element< / span > < span class = "plain-syntax" > ;< / span >
2021-07-07 01:26:06 +03:00
2021-07-26 15:48:49 +03:00
< span class = "reserved-syntax" > index_element< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > InterpretIndex::register_element< / span > < button class = "popup" onclick = "togglePopup('usagePopup4')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup4" > Usage of < span class = "code-font" > < span class = "function-syntax" > InterpretIndex::register_element< / span > < / span > :< br / > < a href = "2-ii.html#SP2_2" > § 2.2< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > abb< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > ,< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > title< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > explanation< / 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" > owner< / 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" > internal_error< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "template creates index elements improperly"< / 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" > Str::len< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > abb< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 2< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > internal_error< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "abbreviation for index element too long"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_element< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > CREATE< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > index_element< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > owning_page< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > atomic_number< / span > < span class = "plain-syntax" > = ++(< / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > no_elements< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > chemical_symbol< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > abb< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > element_name< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > title< / span > < span class = "plain-syntax" > );< / span >
2021-07-23 01:24:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > explanation_key< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > explanation< / span > < span class = "plain-syntax" > );< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ADD_TO_LINKED_LIST< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > index_element< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > elements< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > ie< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2021-07-04 01:11:42 +03:00
< / pre >
2021-07-05 01:04:18 +03:00
< ul class = "endnotetexts" > < li > The structure index_element is accessed in 2/sas, 3/tpt and here.< / li > < / ul >
2021-07-26 15:48:49 +03:00
< p class = "commentary firstcommentary" > < a id = "SP5" class = "paragraph-anchor" > < / a > < b > § 5. Opening and closing HTML files. < / b > < / p >
2021-07-04 01:11:42 +03:00
2021-07-07 01:26:06 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-27 02:42:09 +03:00
< span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > InterpretIndex::open_file< / span > < button class = "popup" onclick = "togglePopup('usagePopup5')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup5" > Usage of < span class = "code-font" > < span class = "function-syntax" > InterpretIndex::open_file< / span > < / span > :< br / > < a href = "2-ii.html#SP1_2" > § 1.2< / a > < br / > Grouped Element - < a href = "3-ge2.html#SP2" > § 2< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > IF< / span > < span class = "plain-syntax" > ,< / span >
2021-07-26 15:48:49 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > index_page< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > index_leaf< / span > < span class = "plain-syntax" > ,< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > title< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > sub< / 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 >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > = < / span > < a href = "2-il.html#SP3" class = "function-link" > < span class = "function-syntax" > IndexLocations::filename< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > index_leaf< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > sub< / span > < span class = "plain-syntax" > );< / span >
2021-07-26 15:48:49 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > STREAM_OPEN_TO_FILE< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > IF< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > UTF8_ENC< / span > < span class = "plain-syntax" > ) == < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > ) {< / span >
2021-07-04 01:11:42 +03:00
< 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" > Problems::fatal_on_file< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Can't open index file"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / 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" > ifndef< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > CORE_MODULE< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Errors::fatal_with_file< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "can't open index file"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > #< / span > < span class = "identifier-syntax" > endif< / span >
2020-05-03 03:01:21 +03:00
< span class = "plain-syntax" > }< / span >
2022-05-05 01:23:12 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > InformPages::header< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > IF< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > title< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > JAVASCRIPT_FOR_STANDARD_PAGES_IRES< / span > < span class = "plain-syntax" > , (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > *) < / span > < span class = "identifier-syntax" > page< / span > < span class = "plain-syntax" > );< / span >
2021-07-27 02:42:09 +03:00
< span class = "plain-syntax" > < / span > < a href = "2-iu.html#SP13" class = "function-link" > < span class = "function-syntax" > IndexUtilities::clear_page_data< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > session< / span > < span class = "plain-syntax" > );< / span >
2021-07-26 15:48:49 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > IF< / span > < span class = "plain-syntax" > ;< / span >
2021-07-04 01:11:42 +03:00
< span class = "plain-syntax" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2021-07-26 15:48:49 +03:00
< p class = "commentary firstcommentary" > < a id = "SP6" class = "paragraph-anchor" > < / a > < b > § 6. < / b > < / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2021-07-27 02:42:09 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > InterpretIndex::close_index_file< / span > < button class = "popup" onclick = "togglePopup('usagePopup6')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup6" > Usage of < span class = "code-font" > < span class = "function-syntax" > InterpretIndex::close_index_file< / span > < / span > :< br / > < a href = "2-ii.html#SP1_2" > § 1.2< / a > < br / > Grouped Element - < a href = "3-ge2.html#SP2" > § 2< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > ifl< / span > < span class = "plain-syntax" > ) {< / span >
2022-05-05 01:23:12 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > InformPages::footer< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > ifl< / span > < span class = "plain-syntax" > );< / span >
2021-07-07 01:26:06 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > STREAM_CLOSE< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > ifl< / span > < span class = "plain-syntax" > );< / span >
2021-07-05 01:04:18 +03:00
< span class = "plain-syntax" > }< / span >
2021-07-04 01:11:42 +03:00
< / pre >
2020-05-03 03:01:21 +03:00
< nav role = "progress" > < div class = "progresscontainer" >
2021-07-27 15:55:53 +03:00
< ul class = "progressbar" > < li class = "progressprev" > < a href = "2-il.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-wtmd.html" > P< / a > < / li > < li class = "progresschapter" > < a href = "1-im.html" > 1< / a > < / li > < li class = "progresscurrentchapter" > 2< / li > < li class = "progresssection" > < a href = "2-il.html" > il< / a > < / li > < li class = "progresscurrent" > ii< / li > < li class = "progresssection" > < a href = "2-sas.html" > sas< / a > < / li > < li class = "progresssection" > < a href = "2-iu.html" > iu< / a > < / li > < li class = "progresssection" > < a href = "2-ir.html" > ir< / a > < / li > < li class = "progresssection" > < a href = "2-lxc.html" > lxc< / a > < / li > < li class = "progresssection" > < a href = "2-fi.html" > fi< / a > < / li > < li class = "progresssection" > < a href = "2-fs.html" > fs< / 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 = "2-sas.html" > ❯ < / a > < / li > < / ul > < / div >
2020-05-03 03:01:21 +03:00
< / nav > <!-- End of weave -->
2019-03-17 14:40:57 +02:00
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >