2020-03-23 15:04:43 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-08 22:41:00 +00:00
< title > Build Files< / title >
2020-04-20 22:26:08 +00:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-23 15:04:43 +00:00
< 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" >
2020-04-20 22:26:08 +00:00
< 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" >
2020-04-21 16:55:17 +00:00
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-20 22:26:08 +00:00
2020-03-23 15:04:43 +00:00
< / head >
< body >
< nav role = "navigation" >
2020-04-13 16:06:45 +00:00
< h1 > < a href = "../index.html" >
2020-04-20 22:26:08 +00:00
< img src = "../docs-assets/Octagram.png" width = 72 height = 72" >
2020-04-13 16:06:45 +00:00
< / a > < / h1 >
< ul > < li > < a href = "../inweb/index.html" > inweb< / a > < / li >
< / ul > < h2 > Foundation Module< / h2 > < ul >
< li > < a href = "index.html" > < span class = "selectedlink" > foundation< / span > < / a > < / li >
2020-03-23 15:04:43 +00:00
< li > < a href = "../foundation-test/index.html" > foundation-test< / a > < / li >
2020-04-13 16:06:45 +00:00
< / ul > < h2 > Example Webs< / h2 > < ul >
2020-04-12 16:24:23 +00:00
< li > < a href = "../goldbach/index.html" > goldbach< / a > < / li >
< li > < a href = "../twinprimes/twinprimes.html" > twinprimes< / a > < / li >
2020-04-15 22:45:08 +00:00
< li > < a href = "../eastertide/index.html" > eastertide< / a > < / li >
2020-04-14 17:36:42 +00:00
< / ul > < h2 > Repository< / h2 > < ul >
2020-04-20 22:34:44 +00:00
< li > < a href = "https://github.com/ganelson/inweb" > < img src = "../docs-assets/github.png" height = 18 > github< / a > < / li >
2020-04-14 17:36:42 +00:00
< / ul > < h2 > Related Projects< / h2 > < ul >
< li > < a href = "../../../inform/docs/index.html" > inform< / a > < / li >
< li > < a href = "../../../intest/docs/index.html" > intest< / a > < / li >
2020-03-23 15:04:43 +00:00
2020-04-13 16:06:45 +00:00
< / ul >
2020-03-23 15:04:43 +00:00
< / nav >
< main role = "main" >
2020-04-16 22:51:03 +00:00
<!-- Weave of 'Build Files' generated by Inweb -->
2020-04-13 16:06:45 +00:00
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "index.html" > foundation< / a > < / li > < li > < a href = "index.html#8" > Chapter 8: Literate Programming< / a > < / li > < li > < b > Build Files< / b > < / li > < / ul > < p class = "purpose" > Manages the build metadata for an inweb project.< / p >
2020-03-23 15:04:43 +00:00
2020-04-15 22:45:08 +00:00
< ul class = "toc" > < li > < a href = "8-bf.html#SP1" > § 1. About build files< / a > < / li > < li > < a href = "8-bf.html#SP5" > § 5. Bibliographic implications< / a > < / li > < li > < a href = "8-bf.html#SP7" > § 7. Advancing< / a > < / li > < / ul > < hr class = "tocbar" >
2020-03-23 15:04:43 +00:00
2020-04-22 22:57:09 +00:00
< p class = "inwebparagraph" > < a id = "SP1" > < / a > < b > § 1. About build files. < / b > When we read a web, we look for a file in it called < span class = "extract" > < span class = "extract-syntax" > build.txt< / span > < / span > . If no such
2020-03-23 15:04:43 +00:00
file exists, we look for the same thing in the current working directory.
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "function-syntax" > BuildFiles::build_file_for_web< / span > < button class = "popup" onclick = "togglePopup('usagePopup1')" > ...< span class = "popuptext" id = "usagePopup1" > Usage of < b > BuildFiles::build_file_for_web< / b > :< br > < a href = "8-bf.html#SP5" > § 5< / a > , < a href = "8-bf.html#SP7" > § 7< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > web_md< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > = < / span > < a href = "3-fln.html#SP2" class = "function-link" > < span class = "function-syntax" > Filenames::in< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > path_to_web< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "build.txt"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-tf.html#SP1" class = "function-link" > < span class = "function-syntax" > TextFiles::exists< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > )) < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > = < / span > < a href = "3-fln.html#SP2" class = "function-link" > < span class = "function-syntax" > Filenames::in< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "build.txt"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-tf.html#SP1" class = "function-link" > < span class = "function-syntax" > TextFiles::exists< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > )) < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ;< / span >
2020-04-21 16:55:17 +00:00
< 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 = "inwebparagraph" > < a id = "SP2" > < / a > < b > § 2. < / b > The format of such a file is very simple: up to three text fields:
2020-03-23 15:04:43 +00:00
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< 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" > build_file_data< / span > < span class = "plain-syntax" > {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > prerelease_text< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > build_code< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > struct< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > build_date< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > ;< / span >
< / pre > < ul class = "endnotetexts" > < li > The structure build_file_data is private to this section.< / li > < / ul > < p class = "inwebparagraph" > < a id = "SP3" > < / a > < b > § 3. < / b > Here's how to read in a build file:
2020-03-23 15:04:43 +00:00
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::read< / span > < button class = "popup" onclick = "togglePopup('usagePopup2')" > ...< span class = "popuptext" id = "usagePopup2" > Usage of < b > BuildFiles::read< / b > :< br > < a href = "8-bf.html#SP5" > § 5< / a > , < a href = "8-bf.html#SP7" > § 7< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > ;< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > prerelease_text< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP2" class = "function-link" > < span class = "function-syntax" > Str::new< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_code< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP2" class = "function-link" > < span class = "function-syntax" > Str::new< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_date< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP2" class = "function-link" > < span class = "function-syntax" > Str::new< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < a href = "4-tf.html#SP5" class = "function-link" > < span class = "function-syntax" > TextFiles::read< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "unable to read build file"< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > TRUE< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > & < / span > < a href = "8-bf.html#SP3" class = "function-link" > < span class = "function-syntax" > BuildFiles::build_file_helper< / span > < / a > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > , (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > *) & < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::build_file_helper< / span > < button class = "popup" onclick = "togglePopup('usagePopup3')" > ...< span class = "popuptext" id = "usagePopup3" > Usage of < b > BuildFiles::build_file_helper< / b > :< br > none< / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > text_file_position< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > tfp< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > state< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > = (< / span > < span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > *) < / span > < span class = "identifier-syntax" > state< / span > < span class = "plain-syntax" > ;< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > text< / 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 = "plain-syntax" > < / span > < span class = "reserved-syntax" > match_results< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > = < / span > < a href = "4-pm.html#SP9" class = "function-link" > < span class = "function-syntax" > Regexp::create_mr< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-pm.html#SP10" class = "function-link" > < span class = "function-syntax" > Regexp::match< / span > < / a > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "Build Date: *(%c*)"< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > build_date< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP3" class = "function-link" > < span class = "function-syntax" > Str::duplicate< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > exp< / span > < span class = "plain-syntax" > [0]);< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-pm.html#SP10" class = "function-link" > < span class = "function-syntax" > Regexp::match< / span > < / a > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "Build Number: *(%c*)"< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > build_code< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP3" class = "function-link" > < span class = "function-syntax" > Str::duplicate< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > exp< / span > < span class = "plain-syntax" > [0]);< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-pm.html#SP10" class = "function-link" > < span class = "function-syntax" > Regexp::match< / span > < / a > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "Prerelease: *(%c*)"< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > prerelease_text< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP3" class = "function-link" > < span class = "function-syntax" > Str::duplicate< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > exp< / span > < span class = "plain-syntax" > [0]);< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "3-em.html#SP5" class = "function-link" > < span class = "function-syntax" > Errors::in_text_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "can't parse build file line"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > tfp< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "4-pm.html#SP9" class = "function-link" > < span class = "function-syntax" > Regexp::dispose_of< / span > < / a > < span class = "plain-syntax" > (& < / span > < span class = "identifier-syntax" > mr< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
< / pre > < p class = "inwebparagraph" > < a id = "SP4" > < / a > < b > § 4. < / b > And here is how to write one:
2020-03-23 15:04:43 +00:00
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::write< / span > < button class = "popup" onclick = "togglePopup('usagePopup4')" > ...< span class = "popuptext" id = "usagePopup4" > Usage of < b > BuildFiles::write< / b > :< br > < a href = "8-bf.html#SP7" > § 7< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > vr_stream< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > = & < / span > < span class = "identifier-syntax" > vr_stream< / span > < span class = "plain-syntax" > ;< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "2-str.html#SP24" class = "function-link" > < span class = "function-syntax" > Streams::open_to_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > UTF8_ENC< / span > < span class = "plain-syntax" > ) == < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "3-em.html#SP2" class = "function-link" > < span class = "function-syntax" > Errors::fatal_with_file< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "can't write build file"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > prerelease_text< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > )< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Prerelease: %S\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > prerelease_text< / 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" > "Build Date: %S\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_date< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_code< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > )< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Build Number: %S\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_code< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "2-str.html#SP34" class = "function-link" > < span class = "function-syntax" > Streams::close< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
< / pre > < p class = "inwebparagraph" > < a id = "SP5" > < / a > < b > § 5. Bibliographic implications. < / b > Whenever a web is read in by Inweb, its build file is looked at in order to
2020-03-23 15:04:43 +00:00
set some bibliographic data.
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::set_bibliographic_data_for< / span > < button class = "popup" onclick = "togglePopup('usagePopup5')" > ...< span class = "popuptext" id = "usagePopup5" > Usage of < b > BuildFiles::set_bibliographic_data_for< / b > :< br > Web Structure - < a href = "8-ws.html#SP5_3" > § 5.3< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > web_md< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bf.html#SP1" class = "function-link" > < span class = "function-syntax" > BuildFiles::build_file_for_web< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bf.html#SP3" class = "function-link" > < span class = "function-syntax" > BuildFiles::read< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > prerelease_text< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "8-bdfw.html#SP7" class = "function-link" > < span class = "function-syntax" > Bibliographic::set_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Prerelease"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > prerelease_text< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_code< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "8-bdfw.html#SP7" class = "function-link" > < span class = "function-syntax" > Bibliographic::set_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Build Number"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_code< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_date< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "8-bdfw.html#SP7" class = "function-link" > < span class = "function-syntax" > Bibliographic::set_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Build Date"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_date< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< / pre > < p class = "inwebparagraph" > < a id = "SP6" > < / a > < b > § 6. < / b > A little later on, i.e., once the Contents page has been read, we want to
2020-03-23 15:04:43 +00:00
synthesize the semantic version number for the project. Note that this is
called even if no build file had ever been found, so it's quite legal for
the Contents page to specify all of this.
< / p >
2020-04-22 22:57:09 +00:00
< p class = "inwebparagraph" > If no error occurs, then the expansion < span class = "extract" > < span class = "extract-syntax" > [[Semantic Version Number]]< / span > < / span > is
2020-03-23 15:04:43 +00:00
guaranteed to produce a semver-legal version number.
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::deduce_semver< / span > < button class = "popup" onclick = "togglePopup('usagePopup6')" > ...< span class = "popuptext" id = "usagePopup6" > Usage of < b > BuildFiles::deduce_semver< / b > :< br > Web Structure - < a href = "8-ws.html#SP5_3" > § 5.3< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > web_md< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bdfw.html#SP6" class = "function-link" > < span class = "function-syntax" > Bibliographic::get_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Semantic Version Number"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%S"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > s< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > v< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bdfw.html#SP6" class = "function-link" > < span class = "function-syntax" > Bibliographic::get_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Version Number"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > v< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%S"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > v< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bdfw.html#SP6" class = "function-link" > < span class = "function-syntax" > Bibliographic::get_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Prerelease"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "-%S"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > b< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bdfw.html#SP6" class = "function-link" > < span class = "function-syntax" > Bibliographic::get_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Build Number"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > b< / span > < span class = "plain-syntax" > ) > < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "+%S"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > b< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / 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" > WS< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > version_number< / span > < span class = "plain-syntax" > = < / span > < a href = "7-vn.html#SP7" class = "function-link" > < span class = "function-syntax" > VersionNumbers::from_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "7-vn.html#SP4" class = "function-link" > < span class = "function-syntax" > VersionNumbers::is_null< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > version_number< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < a href = "3-em.html#SP2" class = "function-link" > < span class = "function-syntax" > Errors::fatal_with_text< / span > < / a > < span class = "plain-syntax" > (< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "string-syntax" > "Combined version '%S' does not comply with the semver standard"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > } < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "8-bdfw.html#SP7" class = "function-link" > < span class = "function-syntax" > Bibliographic::set_datum< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "Semantic Version Number"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > combined< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre > < p class = "inwebparagraph" > < a id = "SP7" > < / a > < b > § 7. Advancing. < / b > We update the build date to today and, if supplied, also increment the build
2020-03-23 15:04:43 +00:00
number if we find that the date has changed.
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::advance_for_web< / span > < button class = "popup" onclick = "togglePopup('usagePopup7')" > ...< span class = "popuptext" id = "usagePopup7" > Usage of < b > BuildFiles::advance_for_web< / b > :< br > none< / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > web_md< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > WS< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bf.html#SP1" class = "function-link" > < span class = "function-syntax" > BuildFiles::build_file_for_web< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > WS< / 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" > F< / span > < span class = "plain-syntax" > ) < / span > < a href = "8-bf.html#SP7" class = "function-link" > < span class = "function-syntax" > BuildFiles::advance< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > < / span > < a href = "3-em.html#SP2" class = "function-link" > < span class = "function-syntax" > Errors::fatal< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "web has no build file"< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::advance< / span > < button class = "popup" onclick = "togglePopup('usagePopup8')" > ...< span class = "popuptext" id = "usagePopup8" > Usage of < b > BuildFiles::advance< / b > :< br > none< / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > filename< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > build_file_data< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > = < / span > < a href = "8-bf.html#SP3" class = "function-link" > < span class = "function-syntax" > BuildFiles::read< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "8-bf.html#SP8" class = "function-link" > < span class = "function-syntax" > BuildFiles::dated_today< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_date< / span > < span class = "plain-syntax" > ) == < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "8-bf.html#SP9" class = "function-link" > < span class = "function-syntax" > BuildFiles::increment< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > .< / span > < span class = "element-syntax" > build_code< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "8-bf.html#SP4" class = "function-link" > < span class = "function-syntax" > BuildFiles::write< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > bfd< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< / pre > < p class = "inwebparagraph" > < a id = "SP8" > < / a > < b > § 8. < / b > The standard date format we use is "26 February 2018". If the contents of
2020-04-22 22:57:09 +00:00
< span class = "extract" > < span class = "extract-syntax" > dateline< / span > < / span > match today's date in this format, we return < span class = "extract" > < span class = "extract-syntax" > TRUE< / span > < / span > ; otherwise we
rewrite < span class = "extract" > < span class = "extract-syntax" > dateline< / span > < / span > to today and return < span class = "extract" > < span class = "extract-syntax" > FALSE< / span > < / span > .
2020-03-23 15:04:43 +00:00
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::dated_today< / span > < button class = "popup" onclick = "togglePopup('usagePopup9')" > ...< span class = "popuptext" id = "usagePopup9" > Usage of < b > BuildFiles::dated_today< / b > :< br > < a href = "8-bf.html#SP7" > § 7< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > dateline< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > char< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > monthname< / span > < span class = "plain-syntax" > [12] = { < / span > < span class = "string-syntax" > "January"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "February"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "March"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "April"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "May"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "June"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "string-syntax" > "July"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "August"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "September"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "October"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "November"< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "December"< / span > < span class = "plain-syntax" > };< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > today< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > today< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%d %s %d"< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_mday< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > monthname< / span > < span class = "plain-syntax" > [< / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_mon< / span > < span class = "plain-syntax" > ], < / span > < span class = "identifier-syntax" > the_present< / span > < span class = "plain-syntax" > -> < / span > < span class = "identifier-syntax" > tm_year< / span > < span class = "plain-syntax" > +1900);< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > rv< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > TRUE< / span > < span class = "plain-syntax" > ;< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP19" class = "function-link" > < span class = "function-syntax" > Str::ne< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > dateline< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > today< / span > < span class = "plain-syntax" > )) {< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > rv< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > ;< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "4-sm.html#SP15" class = "function-link" > < span class = "function-syntax" > Str::clear< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > dateline< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "4-sm.html#SP17" class = "function-link" > < span class = "function-syntax" > Str::copy< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > dateline< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > today< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > DISCARD_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > today< / 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" > rv< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
2020-04-22 22:57:09 +00:00
< / pre > < p class = "inwebparagraph" > < a id = "SP9" > < / a > < b > § 9. < / b > Traditional Inform build codes are four-character, e.g., < span class = "extract" > < span class = "extract-syntax" > 3Q27< / span > < / span > . Here, we
2020-03-23 15:04:43 +00:00
read such a code and increase it by one. The two-digit code at the back is
2020-04-22 22:57:09 +00:00
incremented, but rolls around from < span class = "extract" > < span class = "extract-syntax" > 99< / span > < / span > to < span class = "extract" > < span class = "extract-syntax" > 01< / span > < / span > , in which case the letter is
advanced, except that < span class = "extract" > < span class = "extract-syntax" > I< / span > < / span > and < span class = "extract" > < span class = "extract-syntax" > O< / span > < / span > are skipped, and if the letter passes < span class = "extract" > < span class = "extract-syntax" > Z< / span > < / span >
then it rolls back around to < span class = "extract" > < span class = "extract-syntax" > A< / span > < / span > and the initial digit is incremented.
2020-03-23 15:04:43 +00:00
< / p >
< p class = "inwebparagraph" > This allows for 21384 distinct build codes, enough to use one each day for
some 58 years.
< / p >
2020-04-21 16:55:17 +00:00
< pre class = "displayed-code all-displayed-code" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > BuildFiles::increment< / span > < button class = "popup" onclick = "togglePopup('usagePopup10')" > ...< span class = "popuptext" id = "usagePopup10" > Usage of < b > BuildFiles::increment< / b > :< br > < a href = "8-bf.html#SP7" > § 7< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > ) {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "4-sm.html#SP8" class = "function-link" > < span class = "function-syntax" > Str::len< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > ) != < / span > < span class = "constant-syntax" > 4< / span > < span class = "plain-syntax" > ) < / span > < a href = "3-em.html#SP7" class = "function-link" > < span class = "function-syntax" > Errors::with_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "build code malformed: %S"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > N< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP13" class = "function-link" > < span class = "function-syntax" > Str::get_at< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) - < / span > < span class = "character-syntax" > '0'< / 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" > L< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP13" class = "function-link" > < span class = "function-syntax" > Str::get_at< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > 1< / 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" > M1< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP13" class = "function-link" > < span class = "function-syntax" > Str::get_at< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > 2< / span > < span class = "plain-syntax" > ) - < / span > < span class = "character-syntax" > '0'< / 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" > M2< / span > < span class = "plain-syntax" > = < / span > < a href = "4-sm.html#SP13" class = "function-link" > < span class = "function-syntax" > Str::get_at< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > 3< / span > < span class = "plain-syntax" > ) - < / span > < span class = "character-syntax" > '0'< / span > < span class = "plain-syntax" > ;< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > ((< / span > < span class = "identifier-syntax" > N< / span > < span class = "plain-syntax" > < < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > N< / span > < span class = "plain-syntax" > > < / span > < span class = "constant-syntax" > 9< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > < < / span > < span class = "character-syntax" > 'A'< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > > < / span > < span class = "character-syntax" > 'Z'< / span > < span class = "plain-syntax" > ) ||< / span >
< span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > M1< / span > < span class = "plain-syntax" > < < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > M1< / span > < span class = "plain-syntax" > > < / span > < span class = "constant-syntax" > 9< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > M2< / span > < span class = "plain-syntax" > < < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > M2< / span > < span class = "plain-syntax" > > < / span > < span class = "constant-syntax" > 9< / span > < span class = "plain-syntax" > )) {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "3-em.html#SP7" class = "function-link" > < span class = "function-syntax" > Errors::with_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "build code malformed: %S"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< 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" > M2< / 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" > M2< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > 10< / span > < span class = "plain-syntax" > ) { < / span > < span class = "identifier-syntax" > M2< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > M1< / 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" > M1< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > 10< / span > < span class = "plain-syntax" > ) { < / span > < span class = "identifier-syntax" > M1< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 0< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > M2< / span > < span class = "plain-syntax" > = < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > L< / 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" > L< / span > < span class = "plain-syntax" > == < / span > < span class = "character-syntax" > 'I'< / span > < span class = "plain-syntax" > ) || (< / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > == < / span > < span class = "character-syntax" > 'O'< / span > < span class = "plain-syntax" > )) < / span > < span class = "identifier-syntax" > L< / 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" > L< / span > < span class = "plain-syntax" > > < / span > < span class = "character-syntax" > 'Z'< / span > < span class = "plain-syntax" > ) { < / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > = < / span > < span class = "character-syntax" > 'A'< / span > < span class = "plain-syntax" > ; < / span > < span class = "identifier-syntax" > N< / span > < span class = "plain-syntax" > ++; }< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > N< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > 10< / span > < span class = "plain-syntax" > ) < / span > < a href = "3-em.html#SP7" class = "function-link" > < span class = "function-syntax" > Errors::with_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "build code overflowed: %S"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > else< / span > < span class = "plain-syntax" > {< / span >
2020-04-21 23:52:25 +00:00
< span class = "plain-syntax" > < / span > < a href = "4-sm.html#SP15" class = "function-link" > < span class = "function-syntax" > Str::clear< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > );< / span >
2020-04-21 16:55:17 +00:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > WRITE_TO< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%d%c%d%d"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > N< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > M1< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > M2< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PRINT< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Build code advanced to %S\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > T< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< / pre > < hr class = "tocbar" >
2020-04-01 19:43:48 +00:00
< ul class = "toc" > < li > < a href = "8-wm.html" > Back to 'Web Modules'< / a > < / li > < li > < i > (This section ends Chapter 8: Literate Programming.)< / i > < / li > < / ul > < hr class = "tocbar" >
2020-03-23 15:04:43 +00:00
<!-- End of weave -->
< / main >
< / body >
< / html >
