2023-04-27 01:11:43 +03:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > Text Provenance< / title >
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< meta name = "viewport" content = "width=device-width initial-scale=1" >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Navigation.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Fonts.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "../docs-assets/Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< / head >
< body class = "commentary-font" >
< nav role = "navigation" >
< h1 > < a href = "../index.html" >
< img src = "../docs-assets/Inform.png" height = 72" >
< / a > < / h1 >
< ul > < li > < a href = "../index.html" > home< / a > < / li >
< / 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 >
< li > < a href = "../secrets.html" > secrets< / a > < / li >
< / 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 >
< / ul > < h2 > Resources< / h2 > < ul >
< li > < a href = "../extensions.html" > extensions< / a > < / li >
< li > < a href = "../kits.html" > kits< / a > < / li >
< / ul > < h2 > Repository< / h2 > < ul >
< li > < a href = "https://github.com/ganelson/inform" > < img src = "../docs-assets/github.png" height = 18 > github< / a > < / li >
< / ul > < h2 > Related Projects< / h2 > < ul >
< li > < a href = "../../../inweb/index.html" > inweb< / a > < / li >
< li > < a href = "../../../intest/index.html" > intest< / a > < / li >
< / ul >
< / nav >
< main role = "main" >
<!-- Weave of 'Text Provenance' generated by Inweb -->
< div class = "breadcrumbs" >
< 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" > bytecode< / a > < / li > < li > < a href = "index.html#3" > Chapter 3: Their Instructions< / a > < / li > < li > < b > Text Provenance< / b > < / li > < / ul > < / div >
< p class = "purpose" > Recording where fragments of text originally came from.< / p >
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > Inter code sometimes needs to contain fragments of not-yet-parsed Inform 6
syntax code, in the form of < span class = "extract" > < span class = "extract-syntax" > SPLAT_IST< / span > < / span > and < span class = "extract" > < span class = "extract-syntax" > INSERT_IST< / span > < / span > instructions. In order
for it to be possible to relate errors in those fragments to the original text
files they came from, we need to record their "provenance".
< / p >
< p class = "commentary" > This is only a wrapper for saying something like "line 17 in < span class = "extract" > < span class = "extract-syntax" > whatever.txt< / span > < / span > ".
Line numbers count from 1 at the top of a text file.
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > typedef< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > textual_filename< / 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" > line_number< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > ;< / span >
< / pre >
2023-06-12 12:03:15 +03:00
< ul class = "endnotetexts" > < li > The structure text_provenance is accessed in 4/tpc8 and here.< / li > < / ul >
2023-04-27 01:11:43 +03:00
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. < / b > This provides a "don't know, or, it didn't come from a text file, I made it up"
value:
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
2023-06-12 12:03:15 +03:00
< span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Provenance::nowhere< / 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" > Provenance::nowhere< / span > < / span > :< br / > The Insert Construct - < a href = "4-tic.html#SP6" > § 6< / a > < br / > The Provenance Construct - < a href = "4-tpc8.html#SP7" > § 7< / a > < br / > The Splat Construct - < a href = "5-tsc.html#SP6" > § 6< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
2023-04-27 01:11:43 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > nowhere< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > nowhere< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > textual_filename< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > nowhere< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > line_number< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > nowhere< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Provenance::is_somewhere< / 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" > Provenance::is_somewhere< / span > < / span > :< br / > < a href = "3-tp.html#SP4" > § 4< / a > , < a href = "3-tp.html#SP5" > § 5< / a > , < a href = "3-tp.html#SP6" > § 6< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > Str::len< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > textual_filename< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TRUE< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < 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 >
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. < / b > Composing:
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
2023-06-12 12:03:15 +03:00
< span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Provenance::at_file_and_line< / 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" > Provenance::at_file_and_line< / span > < / span > :< br / > The Insert Construct - < a href = "4-tic.html#SP6" > § 6< / a > < br / > The Provenance Construct - < a href = "4-tpc8.html#SP7" > § 7< / a > < br / > The Splat Construct - < a href = "5-tsc.html#SP6" > § 6< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > file< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > line< / span > < span class = "plain-syntax" > ) {< / span >
2023-04-27 01:11:43 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > somewhere< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > somewhere< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > textual_filename< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > Str::duplicate< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > file< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > somewhere< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > line_number< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > line< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > somewhere< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP4" class = "paragraph-anchor" > < / a > < b > § 4. < / b > Decomposing:
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Provenance::get_line< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "3-tp.html#SP2" class = "function-link" > < span class = "function-syntax" > Provenance::is_somewhere< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > )) < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > line_number< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< span class = "identifier-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > Provenance::get_filename< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "3-tp.html#SP2" class = "function-link" > < span class = "function-syntax" > Provenance::is_somewhere< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > ))< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Filenames::from_text< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > textual_filename< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP5" class = "paragraph-anchor" > < / a > < b > § 5. < / b > Altering in place:
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Provenance::set_line< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > lc< / 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" > where< / span > < span class = "plain-syntax" > ) & & (< / span > < a href = "3-tp.html#SP2" class = "function-link" > < span class = "function-syntax" > Provenance::is_somewhere< / span > < / a > < span class = "plain-syntax" > (*< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > )))< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > line_number< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > lc< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2023-04-28 13:18:56 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Provenance::advance_line< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > by< / 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" > where< / span > < span class = "plain-syntax" > ) & & (< / span > < a href = "3-tp.html#SP2" class = "function-link" > < span class = "function-syntax" > Provenance::is_somewhere< / span > < / a > < span class = "plain-syntax" > (*< / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > )))< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > where< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > line_number< / span > < span class = "plain-syntax" > += < / span > < span class = "identifier-syntax" > by< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2023-04-27 01:11:43 +03:00
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP6" class = "paragraph-anchor" > < / a > < b > § 6. < / b > Writing to text:
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
2023-06-12 12:03:15 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Provenance::write< / 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" > Provenance::write< / span > < / span > :< br / > The Insert Construct - < a href = "4-tic.html#SP5" > § 5< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUTPUT_STREAM< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > text_provenance< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > at< / span > < span class = "plain-syntax" > ) {< / span >
2023-04-27 01:11:43 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "3-tp.html#SP2" class = "function-link" > < span class = "function-syntax" > Provenance::is_somewhere< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > at< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < a href = "3-iitf.html#SP11" class = "function-link" > < span class = "function-syntax" > TextualInter::write_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > at< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > textual_filename< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > " %d"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > at< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > line_number< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "< nowhere> "< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "3-ie.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-wtmd.html" > P< / a > < / li > < li class = "progresschapter" > < a href = "1-bm.html" > 1< / a > < / li > < li class = "progresschapter" > < a href = "2-it.html" > 2< / a > < / li > < li class = "progresscurrentchapter" > 3< / li > < li class = "progresssection" > < a href = "3-ic.html" > ic< / a > < / li > < li class = "progresssection" > < a href = "3-iibf.html" > iibf< / a > < / li > < li class = "progresssection" > < a href = "3-iitf.html" > iitf< / a > < / li > < li class = "progresssection" > < a href = "3-vi.html" > vi< / a > < / li > < li class = "progresssection" > < a href = "3-ivp.html" > ivp< / a > < / li > < li class = "progresssection" > < a href = "3-idt.html" > idt< / a > < / li > < li class = "progresssection" > < a href = "3-mtd.html" > mtd< / a > < / li > < li class = "progresssection" > < a href = "3-ie.html" > ie< / a > < / li > < li class = "progresscurrent" > tp< / li > < li class = "progresschapter" > < a href = "4-tcc.html" > 4< / a > < / li > < li class = "progresschapter" > < a href = "5-tac.html" > 5< / a > < / li > < li class = "progresschapter" > < a href = "6-tpc.html" > 6< / a > < / li > < li class = "progressnext" > < a href = "4-tcc.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >