2021-11-13 15:29:56 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2022-01-30 15:32:38 +02:00
< title > Read, Move, Stop Stages< / title >
2021-11-13 15:29:56 +02:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< meta name = "viewport" content = "width=device-width initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Navigation.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Fonts.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "../docs-assets/Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< / head >
< body class = "commentary-font" >
< nav role = "navigation" >
2022-04-28 19:37:28 +03:00
< h1 > < a href = "../index.html" >
2021-11-13 15:29:56 +02:00
< img src = "../docs-assets/Inform.png" height = 72" >
< / a > < / h1 >
2022-04-28 19:37:28 +03:00
< ul > < li > < a href = "../index.html" > home< / a > < / li >
2022-04-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-05 14:14:27 +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 >
2021-11-13 15:29:56 +02:00
< / ul >
< / nav >
< main role = "main" >
2022-01-30 15:32:38 +02:00
<!-- Weave of 'Read, Move, Stop Stages' generated by Inweb -->
2021-11-13 15:29:56 +02: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" > pipeline< / a > < / li > < li > < a href = "index.html#2" > Chapter 2: Pipelines< / a > < / li > < li > < b > Read, Move, Stop Stages< / b > < / li > < / ul > < / div >
2021-11-13 15:29:56 +02:00
< p class = "purpose" > Four simple pipeline stages.< / p >
2022-01-30 15:32:38 +02:00
< ul class = "toc" > < li > < a href = "2-rmss.html#SP2" > § 2. Read< / a > < / li > < li > < a href = "2-rmss.html#SP3" > § 3. Move< / a > < / li > < li > < a href = "2-rmss.html#SP4" > § 4. Stop< / a > < / li > < / ul > < hr class = "tocbar" >
2021-11-13 15:29:56 +02:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > < / p >
< pre class = "displayed-code all-displayed-code code-font" >
2021-11-22 02:22:16 +02:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > SimpleStages::create_pipeline_stages< / 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" > SimpleStages::create_pipeline_stages< / span > < / span > :< br / > Parsing Pipelines - < a href = "2-pp.html#SP10" > § 10< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
2022-01-30 15:32:38 +02:00
< span class = "plain-syntax" > < / span > < a href = "2-pp.html#SP3" class = "function-link" > < span class = "function-syntax" > ParsingPipelines::new_stage< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "stop"< / span > < span class = "plain-syntax" > , < / span > < a href = "2-rmss.html#SP4" class = "function-link" > < span class = "function-syntax" > SimpleStages::run_stop_stage< / span > < / a > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > NO_STAGE_ARG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-pp.html#SP3" class = "function-link" > < span class = "function-syntax" > ParsingPipelines::new_stage< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "read"< / span > < span class = "plain-syntax" > , < / span > < a href = "2-rmss.html#SP2" class = "function-link" > < span class = "function-syntax" > SimpleStages::run_read_stage< / span > < / a > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > FILE_STAGE_ARG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-pp.html#SP3" class = "function-link" > < span class = "function-syntax" > ParsingPipelines::new_stage< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "move"< / span > < span class = "plain-syntax" > , < / span > < a href = "2-rmss.html#SP3" class = "function-link" > < span class = "function-syntax" > SimpleStages::run_move_stage< / span > < / a > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > GENERAL_STAGE_ARG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > );< / span >
2021-11-13 15:29:56 +02:00
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. Read. < / b > < / p >
< pre class = "displayed-code all-displayed-code code-font" >
2022-01-30 15:32:38 +02:00
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > SimpleStages::run_read_stage< / 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" > SimpleStages::run_read_stage< / span > < / span > :< br / > < a href = "2-rmss.html#SP1" > § 1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > pipeline_step< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > ) {< / span >
2021-11-13 15:29:56 +02: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 > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "identifier-syntax" > parsed_filename< / span > < span class = "plain-syntax" > ;< / span >
2022-03-01 02:41:22 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > BinaryInter::test_file< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > )) < / span > < span class = "identifier-syntax" > BinaryInter::read< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > tree< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
2022-02-10 01:48:51 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TextualInter::read< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > tree< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
2021-11-13 15:29:56 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. Move. < / b > < / p >
< pre class = "displayed-code all-displayed-code code-font" >
2022-01-30 15:32:38 +02:00
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > SimpleStages::run_move_stage< / 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" > SimpleStages::run_move_stage< / span > < / span > :< br / > < a href = "2-rmss.html#SP1" > § 1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > pipeline_step< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > ) {< / span >
2021-11-13 15:29:56 +02: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 = "identifier-syntax" > inter_package< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > pack< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / 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" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > step_argument< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "(%d):(%c+)"< / 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" > from_rep< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::atoi< / 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 > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > );< / span >
2022-01-13 01:54:53 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > pipeline< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > trees< / span > < span class = "plain-syntax" > [< / span > < span class = "identifier-syntax" > from_rep< / span > < span class = "plain-syntax" > ] == < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ) {< / span >
2021-11-16 20:15:49 +02:00
< span class = "plain-syntax" > < / span > < a href = "2-pe.html#SP2" class = "function-link" > < span class = "function-syntax" > PipelineErrors::error_with< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "there is no Inter tree in slot %S"< / 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-11-16 00:44:29 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2022-02-03 17:51:44 +02:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > pack< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > InterPackage::from_URL< / span > < span class = "plain-syntax" > (< / span >
2022-01-13 01:54:53 +02:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > pipeline< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > trees< / span > < span class = "plain-syntax" > [< / span > < span class = "identifier-syntax" > from_rep< / 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 >
2021-11-16 00:44:29 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pack< / span > < span class = "plain-syntax" > == < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ) {< / span >
2021-11-16 20:15:49 +02:00
< span class = "plain-syntax" > < / span > < a href = "2-pe.html#SP2" class = "function-link" > < span class = "function-syntax" > PipelineErrors::error_with< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "that tree has no such package as '%S'"< / 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 >
2021-11-16 00:44:29 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
2021-11-16 20:15:49 +02:00
< span class = "plain-syntax" > < / span > < a href = "2-pe.html#SP2" class = "function-link" > < span class = "function-syntax" > PipelineErrors::error_with< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > ,< / span >
2021-11-16 00:44:29 +02:00
< span class = "plain-syntax" > < / span > < span class = "string-syntax" > "destination should take the form 'N:URL', not '%S'"< / 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 = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > ;< / span >
2021-11-13 15:29:56 +02: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 >
2022-02-06 03:12:01 +02:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Transmigration::move< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > pack< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > LargeScale::main_package< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > ephemera< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > tree< / span > < span class = "plain-syntax" > ), < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
2021-11-13 15:29:56 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2022-01-30 15:32:38 +02:00
< p class = "commentary firstcommentary" > < a id = "SP4" class = "paragraph-anchor" > < / a > < b > § 4. Stop. < / b > The "stop" stage is special, in that it always returns false, thus stopping
2021-11-13 15:29:56 +02:00
the pipeline:
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
2022-01-30 15:32:38 +02:00
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > SimpleStages::run_stop_stage< / 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" > SimpleStages::run_stop_stage< / span > < / span > :< br / > < a href = "2-rmss.html#SP1" > § 1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > pipeline_step< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > step< / span > < span class = "plain-syntax" > ) {< / span >
2021-11-13 15:29:56 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< nav role = "progress" > < div class = "progresscontainer" >
2022-01-30 15:32:38 +02:00
< ul class = "progressbar" > < li class = "progressprev" > < a href = "2-ns.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-wtmd.html" > P< / a > < / li > < li class = "progresschapter" > < a href = "1-pm.html" > 1< / a > < / li > < li class = "progresscurrentchapter" > 2< / li > < li class = "progresssection" > < a href = "2-pp.html" > pp< / a > < / li > < li class = "progresssection" > < a href = "2-rp.html" > rp< / a > < / li > < li class = "progresssection" > < a href = "2-pe.html" > pe< / a > < / li > < li class = "progresssection" > < a href = "2-ns.html" > ns< / a > < / li > < li class = "progresscurrent" > rmss< / li > < li class = "progresschapter" > < a href = "3-ps.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-lbks.html" > 4< / a > < / li > < li class = "progresschapter" > < a href = "5-msms.html" > 5< / a > < / li > < li class = "progresschapter" > < a href = "6-erms.html" > 6< / a > < / li > < li class = "progressnext" > < a href = "3-ps.html" > ❯ < / a > < / li > < / ul > < / div >
2021-11-13 15:29:56 +02:00
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >