2020-02-27 13:18:25 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > 5/kts< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
< link href = "inweb.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< / head >
< body >
<!-- Weave of '5/es' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../webs.html" > ★ < / a > < / li > < li > < a href = "index.html" > inbuild< / a > < / li > < li > < a href = "index.html#5" > Chapter 5: Services for the Inform Compiler< / a > < / li > < li > < b > Extension Services< / b > < / li > < / ul > < p class = "purpose" > An Inform 7 extension.< / p >
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. < / b > < / p >
< pre class = "display" >
< span class = "reserved" > typedef< / span > < span class = "plain" > < / span > < span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > {< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "identifier" > as_copy< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > wording< / span > < span class = "plain" > < / span > < span class = "identifier" > body_text< / span > < span class = "plain" > ; < / span > < span class = "comment" > Body of source text supplied in extension, if any< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > body_text_unbroken< / span > < span class = "plain" > ; < / span > < span class = "comment" > Does this contain text waiting to be sentence-broken?< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > wording< / span > < span class = "plain" > < / span > < span class = "identifier" > documentation_text< / span > < span class = "plain" > ; < / span > < span class = "comment" > Documentation supplied in extension, if any< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > standard< / span > < span class = "plain" > ; < / span > < span class = "comment" > the (or perhaps just a) Standard Rules extension< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > authorial_modesty< / span > < span class = "plain" > ; < / span > < span class = "comment" > Do not credit in the compiled game< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > rubric_as_lexed< / span > < span class = "plain" > ; < / span > < span class = "comment" > brief description found in opening lines< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > extra_credit_as_lexed< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > source_file< / span > < span class = "plain" > *< / span > < span class = "identifier" > read_into_file< / span > < span class = "plain" > ; < / span > < span class = "comment" > Which source file loaded this< / span >
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "reserved" > inbuild_requirement< / span > < span class = "plain" > *< / span > < span class = "identifier" > must_satisfy< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > loaded_from_built_in_area< / span > < span class = "plain" > ; < / span > < span class = "comment" > Located within Inform application< / span >
2020-03-11 02:21:09 +02:00
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > parse_node_tree< / span > < span class = "plain" > *< / span > < span class = "identifier" > syntax_tree< / span > < span class = "plain" > ;< / span >
2020-02-27 13:18:25 +02:00
< span class = "reserved" > struct< / span > < span class = "plain" > < / span > < span class = "identifier" > parse_node< / span > < span class = "plain" > *< / span > < span class = "identifier" > inclusion_sentence< / span > < span class = "plain" > ; < / span > < span class = "comment" > Where the source called for this< / span >
< span class = "identifier" > MEMORY_MANAGEMENT< / span >
< span class = "plain" > } < / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::scan< / span > < span class = "plain" > (< / span > < span class = "reserved" > inbuild_genre< / span > < span class = "plain" > *< / span > < span class = "identifier" > G< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "identifier" > C< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > = < / span > < span class = "identifier" > CREATE< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > );< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > = < / span > < span class = "identifier" > C< / span > < span class = "plain" > ;< / span >
< span class = "functiontext" > Copies::set_content< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "identifier" > STORE_POINTER_inform_extension< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > ));< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > body_text< / span > < span class = "plain" > = < / span > < span class = "identifier" > EMPTY_WORDING< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > body_text_unbroken< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > documentation_text< / span > < span class = "plain" > = < / span > < span class = "identifier" > EMPTY_WORDING< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > standard< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > authorial_modesty< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > read_into_file< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > rubric_as_lexed< / span > < span class = "plain" > = < / span > < span class = "identifier" > Str::new< / span > < span class = "plain" > ();< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > extra_credit_as_lexed< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > must_satisfy< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > loaded_from_built_in_area< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
2020-03-11 02:21:09 +02:00
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > syntax_tree< / span > < span class = "plain" > = < / span > < span class = "identifier" > ParseTree::new_tree< / span > < span class = "plain" > ();< / span >
2020-02-27 13:18:25 +02:00
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > inclusion_sentence< / span > < span class = "plain" > = < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > );< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > );< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > reqs< / span > < span class = "plain" > );< / span >
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > = < / span > < span class = "identifier" > C< / span > < span class = "plain" > -< / span > < span class = "element" > > location_if_file< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > semantic_version_number< / span > < span class = "plain" > < / span > < span class = "identifier" > V< / span > < span class = "plain" > = < / span > < span class = "identifier" > VersionNumbers::null< / span > < span class = "plain" > ();< / span >
< < span class = "cwebmacro" > Scan the file< / span > < span class = "cwebmacronumber" > 1.1< / span > > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > ) == 0) { < / span > < span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > , < / span > < span class = "string" > "Unknown"< / span > < span class = "plain" > ); }< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > ) == 0) { < / span > < span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > , < / span > < span class = "string" > "Anonymous"< / span > < span class = "plain" > ); }< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > ) > < / span > < span class = "constant" > MAX_EXTENSION_TITLE_LENGTH< / span > < span class = "plain" > ) {< / span >
< span class = "functiontext" > Copies::attach< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Copies::new_error_N< / span > < span class = "plain" > (< / span > < span class = "constant" > EXT_TITLE_TOO_LONG_CE< / span > < span class = "plain" > , < / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > )));< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > ) > < / span > < span class = "constant" > MAX_EXTENSION_AUTHOR_LENGTH< / span > < span class = "plain" > ) {< / span >
< span class = "functiontext" > Copies::attach< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Copies::new_error_N< / span > < span class = "plain" > (< / span > < span class = "constant" > EXT_AUTHOR_TOO_LONG_CE< / span > < span class = "plain" > , < / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > )));< / span >
< span class = "plain" > }< / span >
< span class = "identifier" > C< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Editions::new< / span > < span class = "plain" > (< / span > < span class = "functiontext" > Works::new< / span > < span class = "plain" > (< / span > < span class = "identifier" > extension_genre< / span > < span class = "plain" > , < / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > , < / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > ), < / span > < span class = "identifier" > V< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > reqs< / span > < span class = "plain" > ) > 0) {< / span >
< span class = "identifier" > compatibility_specification< / span > < span class = "plain" > *< / span > < span class = "identifier" > CS< / span > < span class = "plain" > = < / span > < span class = "identifier" > Compatibility::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > reqs< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > CS< / span > < span class = "plain" > ) < / span > < span class = "identifier" > C< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > compatibility< / span > < span class = "plain" > = < / span > < span class = "identifier" > CS< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > else< / span > < span class = "plain" > {< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > err< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > err< / span > < span class = "plain" > , < / span > < span class = "string" > "cannot read compatibility '%S'"< / span > < span class = "plain" > , < / span > < span class = "identifier" > reqs< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Copies::attach< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Copies::new_error< / span > < span class = "plain" > (< / span > < span class = "constant" > EXT_MISWORDED_CE< / span > < span class = "plain" > , < / span > < span class = "identifier" > err< / span > < span class = "plain" > ));< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > err< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "functiontext" > Works::add_to_database< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > work< / span > < span class = "plain" > , < / span > < span class = "constant" > CLAIMED_WDBC< / span > < span class = "plain" > );< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > );< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > );< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > reqs< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Extensions::scan is used in 4/em (< a href = "4-em.html#SP3" > § 3< / a > ).< / p >
2020-03-11 02:21:09 +02:00
< p class = "endnote" > The structure inform_extension is accessed in 1/ic, 3/is2, 3/is3, 4/lm, 4/pbm, 4/pfm, 4/tm, 4/pm, 5/kts, 5/ed, 5/ed2, 5/ts, 5/ps, 5/ls, 5/ps2, 6/hdn, 6/inc and here.< / p >
2020-02-27 13:18:25 +02:00
< p class = "inwebparagraph" > < a id = "SP1_1" > < / a > < b > § 1.1. < / b > The following scans a potential extension file. If it seems malformed, a
suitable error is written to the stream < code class = "display" > < span class = "extract" > error_text< / span > < / code > . If not, this is left
alone, and the version number is returned.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Scan the file< / span > < span class = "cwebmacronumber" > 1.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > );< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > version_text< / span > < span class = "plain" > );< / span >
< span class = "reserved" > FILE< / span > < span class = "plain" > *< / span > < span class = "identifier" > EXTF< / span > < span class = "plain" > = < / span > < span class = "identifier" > Filenames::fopen_caseless< / span > < span class = "plain" > (< / span > < span class = "identifier" > F< / span > < span class = "plain" > , < / span > < span class = "string" > "r"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > EXTF< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) {< / span >
< span class = "functiontext" > Copies::attach< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Copies::new_error_on_file< / span > < span class = "plain" > (< / span > < span class = "constant" > OPEN_FAILED_CE< / span > < span class = "plain" > , < / span > < span class = "identifier" > F< / span > < span class = "plain" > ));< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > {< / span >
< < span class = "cwebmacro" > Read the titling line of the extension and normalise its casing< / span > < span class = "cwebmacronumber" > 1.1.1< / span > > < span class = "plain" > ;< / span >
< < span class = "cwebmacro" > Read the rubric text, if any is present< / span > < span class = "cwebmacronumber" > 1.1.2< / span > > < span class = "plain" > ;< / span >
< < span class = "cwebmacro" > Parse the version, title, author and VM requirements from the titling line< / span > < span class = "cwebmacronumber" > 1.1.3< / span > > < span class = "plain" > ;< / span >
< span class = "identifier" > fclose< / span > < span class = "plain" > (< / span > < span class = "identifier" > EXTF< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::len< / span > < span class = "plain" > (< / span > < span class = "identifier" > version_text< / span > < span class = "plain" > ) > 0) {< / span >
< span class = "identifier" > V< / span > < span class = "plain" > = < / span > < span class = "identifier" > VersionNumbers::from_text< / span > < span class = "plain" > (< / span > < span class = "identifier" > version_text< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > VersionNumbers::is_null< / span > < span class = "plain" > (< / span > < span class = "identifier" > V< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > error_text< / span > < span class = "plain" > );< / span >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > error_text< / span > < span class = "plain" > , < / span > < span class = "string" > "the version number '%S' is malformed"< / span > < span class = "plain" > , < / span > < span class = "identifier" > version_text< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Copies::attach< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Copies::new_error< / span > < span class = "plain" > (< / span > < span class = "constant" > EXT_MISWORDED_CE< / span > < span class = "plain" > , < / span > < span class = "identifier" > error_text< / span > < span class = "plain" > ));< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > error_text< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > );< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > version_text< / span > < span class = "plain" > );< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP1" > § 1< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP1_1_1" > < / a > < b > § 1.1.1. < / b > The titling line is terminated by any of < code class = "display" > < span class = "extract" > 0A< / span > < / code > , < code class = "display" > < span class = "extract" > 0D< / span > < / code > , < code class = "display" > < span class = "extract" > 0A 0D< / span > < / code > or < code class = "display" > < span class = "extract" > 0D 0A< / span > < / code > , or
by the local < code class = "display" > < span class = "extract" > \n< / span > < / code > for good measure.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Read the titling line of the extension and normalise its casing< / span > < span class = "cwebmacronumber" > 1.1.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > c< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > while< / span > < span class = "plain" > ((< / span > < span class = "identifier" > c< / span > < span class = "plain" > = < / span > < span class = "identifier" > TextFiles::utf8_fgetc< / span > < span class = "plain" > (< / span > < span class = "identifier" > EXTF< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > )) != < / span > < span class = "identifier" > EOF< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == 0< / span > < span class = "identifier" > xFEFF< / span > < span class = "plain" > ) < / span > < span class = "reserved" > continue< / span > < span class = "plain" > ; < / span > < span class = "comment" > skip the optional Unicode BOM pseudo-character< / span >
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '\< / span > < span class = "plain" > x< / span > < span class = "character" > 0a'< / span > < span class = "plain" > ) || (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '\< / span > < span class = "plain" > x< / span > < span class = "character" > 0d'< / span > < span class = "plain" > ) || (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '\< / span > < span class = "plain" > n< / span > < span class = "character" > '< / span > < span class = "plain" > )) < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > PUT_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > c< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "functiontext" > Works::normalise_casing< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > );< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP1_1" > § 1.1< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP1_1_2" > < / a > < b > § 1.1.2. < / b > In the following, all possible newlines are converted to white space, and
all white space before a quoted rubric text is ignored. We need to do this
partly because users have probably keyed a double line break before the
rubric, but also because we might have stopped reading the titling line
halfway through a line division combination like < code class = "display" > < span class = "extract" > 0A 0D< / span > < / code > , so that the first
thing we read here is a meaningless < code class = "display" > < span class = "extract" > 0D< / span > < / code > .
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Read the rubric text, if any is present< / span > < span class = "cwebmacronumber" > 1.1.2< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > c< / span > < span class = "plain" > , < / span > < span class = "identifier" > found_start< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > while< / span > < span class = "plain" > ((< / span > < span class = "identifier" > c< / span > < span class = "plain" > = < / span > < span class = "identifier" > TextFiles::utf8_fgetc< / span > < span class = "plain" > (< / span > < span class = "identifier" > EXTF< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > , < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > , < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > )) != < / span > < span class = "identifier" > EOF< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '\< / span > < span class = "plain" > x< / span > < span class = "character" > 0a'< / span > < span class = "plain" > ) || (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '\< / span > < span class = "plain" > x< / span > < span class = "character" > 0d'< / span > < span class = "plain" > ) || (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '\< / span > < span class = "plain" > n< / span > < span class = "character" > '< / span > < span class = "plain" > ) || (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '\< / span > < span class = "plain" > t< / span > < span class = "character" > '< / span > < span class = "plain" > )) < / span > < span class = "identifier" > c< / span > < span class = "plain" > = < / span > < span class = "character" > ' '< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > c< / span > < span class = "plain" > != < / span > < span class = "character" > ' '< / span > < span class = "plain" > ) & & (< / span > < span class = "identifier" > found_start< / span > < span class = "plain" > == < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > )) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '"'< / span > < span class = "plain" > ) < / span > < span class = "identifier" > found_start< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > c< / span > < span class = "plain" > == < / span > < span class = "character" > '"'< / span > < span class = "plain" > ) < / span > < span class = "reserved" > break< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > found_start< / span > < span class = "plain" > ) < / span > < span class = "identifier" > PUT_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > rubric_as_lexed< / span > < span class = "plain" > , < / span > < span class = "identifier" > c< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP1_1" > § 1.1< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP1_1_3" > < / a > < b > § 1.1.3. < / b > In general, once case-normalised, a titling line looks like this:
< / p >
< blockquote >
< p > Version 2/070423 Of Going To The Zoo (For Glulx Only) By Cary Grant Begins Here.< / p >
< / blockquote >
< p class = "inwebparagraph" > and the version information, the VM restriction and the full stop are all
optional, but the division word "of" and the concluding "begin[s] here"
are not. We break it up into pieces; for speed, we won't use the lexer to
load the entire file.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Parse the version, title, author and VM requirements from the titling line< / span > < span class = "cwebmacronumber" > 1.1.3< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > match_results< / span > < span class = "plain" > < / span > < span class = "identifier" > mr< / span > < span class = "plain" > = < / span > < span class = "identifier" > Regexp::create_mr< / span > < span class = "plain" > ();< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::get_last_char< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > ) == < / span > < span class = "character" > '.'< / span > < span class = "plain" > ) < / span > < span class = "identifier" > Str::delete_last_character< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "(%c*) Begin Here"< / span > < span class = "plain" > )) ||< / span >
< span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "(%c*) Begins Here"< / span > < span class = "plain" > ))) {< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [0]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > ((< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "(%c*) Start Here"< / span > < span class = "plain" > )) ||< / span >
< span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "(%c*) Starts Here"< / span > < span class = "plain" > ))) {< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [0]);< / span >
< span class = "plain" > }< / span >
< span class = "functiontext" > Copies::attach< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Copies::new_error< / span > < span class = "plain" > (< / span > < span class = "constant" > EXT_MISWORDED_CE< / span > < span class = "plain" > ,< / span >
< span class = "identifier" > I< / span > < span class = "string" > "the opening line does not end 'begin(s) here'"< / span > < span class = "plain" > ));< / span >
< span class = "plain" > }< / span >
< < span class = "cwebmacro" > Scan the version text, if any, and advance to the position past Version... Of< / span > < span class = "cwebmacronumber" > 1.1.3.1< / span > > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "The (%c*)"< / span > < span class = "plain" > )) < / span > < span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [0]);< / span >
< < span class = "cwebmacro" > Divide the remaining text into a claimed author name and title, divided by By< / span > < span class = "cwebmacronumber" > 1.1.3.2< / span > > < span class = "plain" > ;< / span >
< < span class = "cwebmacro" > Extract the VM requirements text, if any, from the claimed title< / span > < span class = "cwebmacronumber" > 1.1.3.3< / span > > < span class = "plain" > ;< / span >
< span class = "identifier" > Regexp::dispose_of< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > );< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP1_1" > § 1.1< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP1_1_3_1" > < / a > < b > § 1.1.3.1. < / b > We make no attempt to check the version number for validity: the purpose
of the census is to identify extensions and reject accidentally included
other files, not to syntax-check all extensions to see if they would work
if used.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Scan the version text, if any, and advance to the position past Version... Of< / span > < span class = "cwebmacronumber" > 1.1.3.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "Version (%c*?) Of (%c*)"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > version_text< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [0]);< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP1_1_3" > § 1.1.3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP1_1_3_2" > < / a > < b > § 1.1.3.2. < / b > The earliest "by" is the divider: note that extension titles are not
allowed to contain this word, so "North By Northwest By Cary Grant" is
not a situation we need to contend with.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Divide the remaining text into a claimed author name and title, divided by By< / span > < span class = "cwebmacronumber" > 1.1.3.2< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "(%c*?) By (%c*)"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [0]);< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_author_name< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > } < / span > < span class = "reserved" > else< / span > < span class = "plain" > {< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > , < / span > < span class = "identifier" > titling_line< / span > < span class = "plain" > );< / span >
< span class = "functiontext" > Copies::attach< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Copies::new_error< / span > < span class = "plain" > (< / span > < span class = "constant" > EXT_MISWORDED_CE< / span > < span class = "plain" > ,< / span >
< span class = "identifier" > I< / span > < span class = "string" > "the titling line does not give both author and title"< / span > < span class = "plain" > ));< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP1_1_3" > § 1.1.3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP1_1_3_3" > < / a > < b > § 1.1.3.3. < / b > Similarly, extension titles are not allowed to contain parentheses, so
this is unambiguous.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Extract the VM requirements text, if any, from the claimed title< / span > < span class = "cwebmacronumber" > 1.1.3.3< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Regexp::match< / span > < span class = "plain" > (& < / span > < span class = "identifier" > mr< / span > < span class = "plain" > , < / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "(%c*?) *(%(%c*%))"< / span > < span class = "plain" > )) {< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > claimed_title< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [0]);< / span >
< span class = "identifier" > Str::copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > reqs< / span > < span class = "plain" > , < / span > < span class = "identifier" > mr< / span > < span class = "plain" > .< / span > < span class = "identifier" > exp< / span > < span class = "plain" > [1]);< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP1_1_3" > § 1.1.3< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. < / b > < / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::write< / span > < span class = "plain" > (< / span > < span class = "identifier" > OUTPUT_STREAM< / span > < span class = "plain" > , < / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "none"< / span > < span class = "plain" > );< / span >
< span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "%X"< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > work< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::write_name_to_file< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "identifier" > OUTPUT_STREAM< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "%S"< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > work< / span > < span class = "plain" > -< / span > < span class = "element" > > raw_title< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::write_author_to_file< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "identifier" > OUTPUT_STREAM< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > WRITE< / span > < span class = "plain" > (< / span > < span class = "string" > "%S"< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > work< / span > < span class = "plain" > -< / span > < span class = "element" > > raw_author_name< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Extensions::write appears nowhere else.< / p >
< p class = "endnote" > The function Extensions::write_name_to_file appears nowhere else.< / p >
< p class = "endnote" > The function Extensions::write_author_to_file appears nowhere else.< / p >
< p class = "inwebparagraph" > < a id = "SP3" > < / a > < b > § 3. < / b > Three pieces of information (not available when the EF is created) will
be set later on, by other parts of Inform calling the routines below.
< / p >
< p class = "inwebparagraph" > The rubric text for an extension, which is double-quoted matter just below
its "begins here" line, is parsed as a sentence and will be read as an
assertion in the usual way when the material from this extension is being
worked through (quite a long time after the EF structure was created). When
that happens, the following routine will be called to set the rubric; and
the one after for the optional extra credit line, used to acknowledge I6
sources, collaborators, translators and so on.
< / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::set_rubric< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > text< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > internal_error< / span > < span class = "plain" > (< / span > < span class = "string" > "unfound ef"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > rubric_as_lexed< / span > < span class = "plain" > = < / span > < span class = "identifier" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > text< / span > < span class = "plain" > );< / span >
< span class = "identifier" > LOGIF< / span > < span class = "plain" > (< / span > < span class = "identifier" > EXTENSIONS_CENSUS< / span > < span class = "plain" > , < / span > < span class = "string" > "Extension rubric: %S\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > rubric_as_lexed< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Extensions::get_rubric< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > rubric_as_lexed< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::set_extra_credit< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "identifier" > text_stream< / span > < span class = "plain" > *< / span > < span class = "identifier" > text< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > internal_error< / span > < span class = "plain" > (< / span > < span class = "string" > "unfound ef"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > extra_credit_as_lexed< / span > < span class = "plain" > = < / span > < span class = "identifier" > Str::duplicate< / span > < span class = "plain" > (< / span > < span class = "identifier" > text< / span > < span class = "plain" > );< / span >
< span class = "identifier" > LOGIF< / span > < span class = "plain" > (< / span > < span class = "identifier" > EXTENSIONS_CENSUS< / span > < span class = "plain" > , < / span > < span class = "string" > "Extension extra credit: %S\< / span > < span class = "plain" > n< / span > < span class = "string" > "< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > extra_credit_as_lexed< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Extensions::set_rubric appears nowhere else.< / p >
< p class = "endnote" > The function Extensions::get_rubric is used in 5/ec (< a href = "5-ec.html#SP2" > § 2< / a > ).< / p >
< p class = "endnote" > The function Extensions::set_extra_credit appears nowhere else.< / p >
< p class = "inwebparagraph" > < a id = "SP4" > < / a > < b > § 4. < / b > The use option "authorial modesty" is unusual in applying to the extension
it is found in, not the whole source text. When we read it, we call one of
the following routines, depending on whether it was in an extension or in
the main source text:
< / p >
< pre class = "display" >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > general_authorial_modesty< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::set_authorial_modesty< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > internal_error< / span > < span class = "plain" > (< / span > < span class = "string" > "unfound ef"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > authorial_modesty< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::set_general_authorial_modesty< / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) { < / span > < span class = "identifier" > general_authorial_modesty< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ; }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::set_inclusion_sentence< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "identifier" > parse_node< / span > < span class = "plain" > *< / span > < span class = "identifier" > N< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > inclusion_sentence< / span > < span class = "plain" > = < / span > < span class = "identifier" > N< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< span class = "identifier" > parse_node< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Extensions::get_inclusion_sentence< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > inclusion_sentence< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::is_standard< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > standard< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::make_standard< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > standard< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::must_satisfy< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "reserved" > inbuild_requirement< / span > < span class = "plain" > *< / span > < span class = "identifier" > req< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > must_satisfy< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > must_satisfy< / span > < span class = "plain" > = < / span > < span class = "identifier" > req< / span > < span class = "plain" > ;< / span >
2020-03-11 02:21:09 +02:00
< span class = "reserved" > else< / span > < span class = "plain" > < / span > < span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > VersionNumbers::intersect_range< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > must_satisfy< / span > < span class = "plain" > -< / span > < span class = "element" > > version_range< / span > < span class = "plain" > , < / span > < span class = "identifier" > req< / span > < span class = "plain" > -< / span > < span class = "element" > > version_range< / span > < span class = "plain" > )) {< / span >
< span class = "plain" > #< / span > < span class = "identifier" > ifdef< / span > < span class = "plain" > < / span > < span class = "identifier" > CORE_MODULE< / span >
< span class = "functiontext" > Extensions::set_inclusion_sentence< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > , < / span > < span class = "identifier" > current_sentence< / span > < span class = "plain" > );< / span >
< span class = "plain" > #< / span > < span class = "identifier" > endif< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::satisfies< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "functiontext" > Requirements::meets< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > must_satisfy< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Extensions::set_authorial_modesty appears nowhere else.< / p >
< p class = "endnote" > The function Extensions::set_general_authorial_modesty appears nowhere else.< / p >
2020-03-11 02:21:09 +02:00
< p class = "endnote" > The function Extensions::set_inclusion_sentence is used in 6/inc (< a href = "6-inc.html#SP6_1" > § 6.1< / a > ).< / p >
2020-02-27 13:18:25 +02:00
2020-03-11 02:21:09 +02:00
< p class = "endnote" > The function Extensions::get_inclusion_sentence is used in 6/inc (< a href = "6-inc.html#SP6_1_1" > § 6.1.1< / a > ).< / p >
2020-02-27 13:18:25 +02:00
< p class = "endnote" > The function Extensions::is_standard appears nowhere else.< / p >
< p class = "endnote" > The function Extensions::make_standard is used in 4/em (< a href = "4-em.html#SP5" > § 5< / a > ).< / p >
2020-03-11 02:21:09 +02:00
< p class = "endnote" > The function Extensions::must_satisfy is used in 5/ed2 (< a href = "5-ed2.html#SP4" > § 4< / a > ), 6/inc (< a href = "6-inc.html#SP6" > § 6< / a > ).< / p >
2020-02-27 13:18:25 +02:00
< p class = "endnote" > The function Extensions::satisfies appears nowhere else.< / p >
< p class = "inwebparagraph" > < a id = "SP5" > < / a > < b > § 5. < / b > < / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > Extensions::read_source_text_for< / span > < span class = "plain" > (< / span > < span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "identifier" > E< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > filename< / span > < span class = "plain" > *< / span > < span class = "identifier" > F< / span > < span class = "plain" > = < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > -< / span > < span class = "element" > > location_if_file< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > int< / span > < span class = "plain" > < / span > < span class = "identifier" > doc_only< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > census_mode< / span > < span class = "plain" > ) < / span > < span class = "identifier" > doc_only< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > TEMPORARY_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > synopsis< / span > < span class = "plain" > );< / span >
< < span class = "cwebmacro" > Concoct a synopsis for the extension to be read< / span > < span class = "cwebmacronumber" > 5.1< / span > > < span class = "plain" > ;< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > read_into_file< / span > < span class = "plain" > = < / span > < span class = "functiontext" > SourceText::read_file< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > , < / span > < span class = "identifier" > F< / span > < span class = "plain" > , < / span > < span class = "identifier" > synopsis< / span > < span class = "plain" > , < / span > < span class = "identifier" > doc_only< / span > < span class = "plain" > , < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > );< / span >
< span class = "identifier" > DISCARD_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > synopsis< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > read_into_file< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > read_into_file< / span > < span class = "plain" > -> < / span > < span class = "identifier" > your_ref< / span > < span class = "plain" > = < / span > < span class = "identifier" > STORE_POINTER_inbuild_copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > );< / span >
< span class = "identifier" > wording< / span > < span class = "plain" > < / span > < span class = "identifier" > EXW< / span > < span class = "plain" > = < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > read_into_file< / span > < span class = "plain" > -> < / span > < span class = "identifier" > text_read< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > Wordings::nonempty< / span > < span class = "plain" > (< / span > < span class = "identifier" > EXW< / span > < span class = "plain" > )) < / span > < < span class = "cwebmacro" > Break the extension's text into body and documentation< / span > < span class = "cwebmacronumber" > 5.3< / span > > < span class = "character" > ;< / span >
2020-03-11 02:21:09 +02:00
< span class = "reserved" > inform_project< / span > < span class = "plain" > *< / span > < span class = "identifier" > project< / span > < span class = "plain" > = < / span > < span class = "functiontext" > Inbuild::project< / span > < span class = "plain" > ();< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > project< / span > < span class = "plain" > ) < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > syntax_tree< / span > < span class = "plain" > = < / span > < span class = "identifier" > project< / span > < span class = "plain" > -< / span > < span class = "element" > > syntax_tree< / span > < span class = "plain" > ;< / span >
< span class = "identifier" > Sentences::break< / span > < span class = "plain" > (< / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > syntax_tree< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > body_text< / span > < span class = "plain" > , < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > , -1);< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > body_text_unbroken< / span > < span class = "plain" > = < / span > < span class = "identifier" > FALSE< / span > < span class = "plain" > ;< / span >
2020-02-27 13:18:25 +02:00
< span class = "plain" > }< / span >
< span class = "plain" > }< / span >
2020-03-11 02:21:09 +02:00
< span class = "reserved" > inform_extension< / span > < span class = "plain" > *< / span > < span class = "functiontext" > Extensions::corresponding_to< / span > < span class = "plain" > (< / span > < span class = "identifier" > source_file< / span > < span class = "plain" > *< / span > < span class = "identifier" > sf< / span > < span class = "plain" > ) {< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > sf< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > inbuild_copy< / span > < span class = "plain" > *< / span > < span class = "identifier" > C< / span > < span class = "plain" > = < / span > < span class = "identifier" > RETRIEVE_POINTER_inbuild_copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > sf< / span > < span class = "plain" > -> < / span > < span class = "identifier" > your_ref< / span > < span class = "plain" > );< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > == < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > work< / span > < span class = "plain" > -< / span > < span class = "element" > > genre< / span > < span class = "plain" > != < / span > < span class = "identifier" > extension_genre< / span > < span class = "plain" > ) < / span > < span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "identifier" > NULL< / span > < span class = "plain" > ;< / span >
< span class = "reserved" > return< / span > < span class = "plain" > < / span > < span class = "functiontext" > ExtensionManager::from_copy< / span > < span class = "plain" > (< / span > < span class = "identifier" > C< / span > < span class = "plain" > );< / span >
< span class = "plain" > }< / span >
2020-02-27 13:18:25 +02:00
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Extensions::read_source_text_for is used in 4/em (< a href = "4-em.html#SP10" > § 10< / a > ).< / p >
2020-03-11 02:21:09 +02:00
< p class = "endnote" > The function Extensions::corresponding_to is used in 6/hdn (< a href = "6-hdn.html#SP18" > § 18< / a > ).< / p >
2020-02-27 13:18:25 +02:00
< p class = "inwebparagraph" > < a id = "SP5_1" > < / a > < b > § 5.1. < / b > We concoct a textual synopsis in the form
< / p >
< p class = "inwebparagraph" > < / p >
< pre class = "display" >
< span class = "plain" > "Pantomime Sausages by Mr Punch"< / span >
< / pre >
< p class = "inwebparagraph" > to be used by < code class = "display" > < span class = "extract" > SourceFiles::read_extension_source_text< / span > < / code > for printing to < code class = "display" > < span class = "extract" > stdout< / span > < / code > . Since
we dare not assume < code class = "display" > < span class = "extract" > stdout< / span > < / code > can manage characters outside the basic ASCII
range, we flatten them from general ISO to plain ASCII.
< / p >
< p class = "macrodefinition" > < code class = "display" >
< < span class = "cwebmacrodefn" > Concoct a synopsis for the extension to be read< / span > < span class = "cwebmacronumber" > 5.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > WRITE_TO< / span > < span class = "plain" > (< / span > < span class = "identifier" > synopsis< / span > < span class = "plain" > , < / span > < span class = "string" > "%S by %S"< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > work< / span > < span class = "plain" > -< / span > < span class = "element" > > title< / span > < span class = "plain" > , < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > as_copy< / span > < span class = "plain" > -< / span > < span class = "element" > > edition< / span > < span class = "plain" > -< / span > < span class = "element" > > work< / span > < span class = "plain" > -< / span > < span class = "element" > > author_name< / span > < span class = "plain" > );< / span >
< span class = "identifier" > LOOP_THROUGH_TEXT< / span > < span class = "plain" > (< / span > < span class = "identifier" > pos< / span > < span class = "plain" > , < / span > < span class = "identifier" > synopsis< / span > < span class = "plain" > )< / span >
< span class = "identifier" > Str::put< / span > < span class = "plain" > (< / span > < span class = "identifier" > pos< / span > < span class = "plain" > ,< / span >
< span class = "identifier" > Characters::make_filename_safe< / span > < span class = "plain" > (< / span > < span class = "identifier" > Str::get< / span > < span class = "plain" > (< / span > < span class = "identifier" > pos< / span > < span class = "plain" > )));< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP5" > § 5< / a > .< / p >
< p class = "inwebparagraph" > < a id = "SP5_2" > < / a > < b > § 5.2. < / b > If an extension file contains the special text (outside literal mode) of
< / p >
< p class = "inwebparagraph" > < / p >
< pre class = "display" >
< span class = "plain" > ---- Documentation ----< / span >
< / pre >
< p class = "inwebparagraph" > then this is taken as the end of the Inform source, and the beginning of a
snippet of documentation about the extension; text from that point on is
saved until later, but not broken into sentences for the parse tree, and it
is therefore invisible to the rest of Inform. If this division line is not
present then the extension contains only body source and no documentation.
< / p >
< pre class = "display" >
< span class = "plain" > < < / span > < span class = "identifier" > extension< / span > < span class = "plain" > -< / span > < span class = "identifier" > body< / span > < span class = "plain" > > ::=< / span >
< span class = "plain" > *** ---- < / span > < span class = "identifier" > documentation< / span > < span class = "plain" > ---- ... | ==> < / span > < span class = "identifier" > TRUE< / span >
< span class = "plain" > ... ==> < / span > < span class = "identifier" > FALSE< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "inwebparagraph" > < a id = "SP5_3" > < / a > < b > § 5.3. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Break the extension's text into body and documentation< / span > < span class = "cwebmacronumber" > 5.3< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< span class = "plain" > < < / span > < span class = "identifier" > extension< / span > < span class = "plain" > -< / span > < span class = "identifier" > body< / span > < span class = "plain" > > (< / span > < span class = "identifier" > EXW< / span > < span class = "plain" > );< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > body_text< / span > < span class = "plain" > = < / span > < span class = "identifier" > GET_RW< / span > < span class = "plain" > (< < / span > < span class = "identifier" > extension< / span > < span class = "plain" > -< / span > < span class = "identifier" > body< / span > < span class = "plain" > > , 1);< / span >
< span class = "reserved" > if< / span > < span class = "plain" > (< < < / span > < span class = "identifier" > r< / span > < span class = "plain" > > > ) < / span > < span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > documentation_text< / span > < span class = "plain" > = < / span > < span class = "identifier" > GET_RW< / span > < span class = "plain" > (< < / span > < span class = "identifier" > extension< / span > < span class = "plain" > -< / span > < span class = "identifier" > body< / span > < span class = "plain" > > , 2);< / span >
< span class = "identifier" > E< / span > < span class = "plain" > -< / span > < span class = "element" > > body_text_unbroken< / span > < span class = "plain" > = < / span > < span class = "identifier" > TRUE< / span > < span class = "plain" > ; < / span > < span class = "comment" > mark this to be sentence-broken< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP5" > § 5< / a > .< / p >
< hr class = "tocbar" >
< ul class = "toc" > < li > < a href = "5-kts.html" > Back to 'Kits'< / a > < / li > < li > < a href = "5-ed.html" > Continue with 'Extension Dictionary'< / a > < / li > < / ul > < hr class = "tocbar" >
<!-- End of weave -->
< / body >
< / html >
