2022-06-04 01:56:04 +03:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > Kit Versioning< / 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 >
< li > < a href = "../inrtpsn.html" > inrtps< / 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 'Kit Versioning' generated by Inweb -->
< div class = "breadcrumbs" >
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "index.html" > inpolicy< / a > < / li > < li > < a href = "index.html#2" > Chapter 2: Policies< / a > < / li > < li > < b > Kit Versioning< / b > < / li > < / ul > < / div >
< p class = "purpose" > To ensure that the built-in kits share version numbers with the core compiler.< / p >
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > This implements < span class = "extract" > < span class = "extract-syntax" > -kit-versions< / span > < / span > :
< / 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" > KitVersioning::show_versions< / 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" > KitVersioning::show_versions< / span > < / span > :< br / > Main - < a href = "1-mn.html#SP2" > § 2< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > web_md< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > inform7_web< / span > < span class = "plain-syntax" > =< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/8-ws.html#SP5" class = "function-link" > < span class = "function-syntax" > WebMetadata::get_without_modules< / span > < / a > < span class = "plain-syntax" > (< / span > < a href = "../../../inweb/foundation-module/3-pth.html#SP5" class = "function-link" > < span class = "function-syntax" > Pathnames::from_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "inform7"< / span > < span class = "plain-syntax" > ), < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > core_V< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > inform7_web< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > version_number< / 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" > "Core version is %v\n"< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > core_V< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-kv.html#SP3" class = "function-link" > < span class = "function-syntax" > KitVersioning::iterate< / span > < / a > < span class = "plain-syntax" > (< / span > < a href = "../../../inweb/foundation-module/7-vn.html#SP4" class = "function-link" > < span class = "function-syntax" > VersionNumbers::null< / span > < / a > < span class = "plain-syntax" > ());< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. < / b > And < span class = "extract" > < span class = "extract-syntax" > -sync-kit-versions< / span > < / span > :
< / 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" > KitVersioning::sync_versions< / 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" > KitVersioning::sync_versions< / span > < / span > :< br / > Main - < a href = "1-mn.html#SP2" > § 2< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > web_md< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > inform7_web< / span > < span class = "plain-syntax" > =< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/8-ws.html#SP5" class = "function-link" > < span class = "function-syntax" > WebMetadata::get_without_modules< / span > < / a > < span class = "plain-syntax" > (< / span > < a href = "../../../inweb/foundation-module/3-pth.html#SP5" class = "function-link" > < span class = "function-syntax" > Pathnames::from_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "inform7"< / span > < span class = "plain-syntax" > ), < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > core_V< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > inform7_web< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > version_number< / span > < span class = "plain-syntax" > ;< / span >
2022-11-11 00:34:19 +02:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PRINT< / span > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "inform7 web has version %v\n"< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > core_V< / span > < span class = "plain-syntax" > );< / span >
2022-06-04 01:56:04 +03:00
< span class = "plain-syntax" > < / span > < a href = "2-kv.html#SP3" class = "function-link" > < span class = "function-syntax" > KitVersioning::iterate< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > core_V< / 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 > Both use the following to work through the built-in kits:
< / 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" > KitVersioning::iterate< / 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" > KitVersioning::iterate< / span > < / span > :< br / > < a href = "2-kv.html#SP1" > § 1< / a > , < a href = "2-kv.html#SP2" > § 2< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "2-kv.html#SP3" class = "function-link" > < span class = "function-syntax" > KitVersioning::show_version< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "WorldModelKit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-kv.html#SP3" class = "function-link" > < span class = "function-syntax" > KitVersioning::show_version< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "EnglishLanguageKit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-kv.html#SP3" class = "function-link" > < span class = "function-syntax" > KitVersioning::show_version< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "CommandParserKit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-kv.html#SP3" class = "function-link" > < span class = "function-syntax" > KitVersioning::show_version< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "BasicInformKit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "2-kv.html#SP3" class = "function-link" > < span class = "function-syntax" > KitVersioning::show_version< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "BasicInformExtrasKit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > set_to< / 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" > KitVersioning::show_version< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > name< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > pathname< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/3-pth.html#SP5" class = "function-link" > < span class = "function-syntax" > Pathnames::from_text< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "inform7/Internal/Inter"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/3-pth.html#SP4" class = "function-link" > < span class = "function-syntax" > Pathnames::down< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > name< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > = < / span > < a href = "2-kv.html#SP4" class = "function-link" > < span class = "function-syntax" > KitVersioning::read_version< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > P< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > set_to< / 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" > "Kit %S has version %v\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > name< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > V< / 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 > The actual work, then, is done by this function, which returns the version
number of the kit stored at the path < span class = "extract" > < span class = "extract-syntax" > kit< / span > < / span > ; if < span class = "extract" > < span class = "extract-syntax" > set_to< / span > < / span > is other than null,
the kit's version is changed to < span class = "extract" > < span class = "extract-syntax" > set_to< / span > < / span > , and this value returned. In both
cases, the kit's JSON metadata file is read in; in the second case, it is
then written back out, modified to include the new version number. (Note
that no file write occurs unless an actual change is needed: if < span class = "extract" > < span class = "extract-syntax" > set_to< / span > < / span >
is the same as the version it already has, there's no need to rewrite.)
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > KitVersioning::read_version< / 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" > KitVersioning::read_version< / span > < / span > :< br / > < a href = "2-kv.html#SP3" > § 3< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > pathname< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > kit< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > ) {< / 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 > < a href = "../../../inweb/foundation-module/3-fln.html#SP2" class = "function-link" > < span class = "function-syntax" > Filenames::in< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > kit< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "kit_metadata.json"< / 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" > contents< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/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 file of JSON metadata"< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > TRUE< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > & < / span > < a href = "2-kv.html#SP5" class = "function-link" > < span class = "function-syntax" > KitVersioning::read_metadata_file_helper< / span > < / a > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > contents< / span > < span class = "plain-syntax" > );< / 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 > < a href = "../../../inweb/foundation-module/4-tf.html#SP4" class = "function-link" > < span class = "function-syntax" > TextFiles::at< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > 1< / span > < span class = "plain-syntax" > );< / span >
2023-03-22 07:45:28 +02:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > JSON_value< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > value< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/4-jsn.html#SP11" class = "function-link" > < span class = "function-syntax" > JSON::decode< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > contents< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > tfp< / span > < span class = "plain-syntax" > );< / span >
2022-06-04 01:56:04 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > ((< / span > < span class = "identifier-syntax" > value< / span > < span class = "plain-syntax" > ) & & (< / span > < span class = "identifier-syntax" > value< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > JSON_type< / span > < span class = "plain-syntax" > == < / span > < span class = "constant-syntax" > ERROR_JSONTYPE< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/3-em.html#SP6" class = "function-link" > < span class = "function-syntax" > Errors::at_position< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Syntax error in metadata file for kit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / 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" > return< / span > < span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/7-vn.html#SP4" class = "function-link" > < span class = "function-syntax" > VersionNumbers::null< / span > < / a > < 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" > contents< / span > < span class = "plain-syntax" > )< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > JSON_value< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > is< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/4-jsn.html#SP7" class = "function-link" > < span class = "function-syntax" > JSON::look_up_object< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > value< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "is"< / 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" > is< / span > < span class = "plain-syntax" > == < / span > < span class = "identifier-syntax" > NULL< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/3-em.html#SP6" class = "function-link" > < span class = "function-syntax" > Errors::at_position< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Semantic error in metadata file for kit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / 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" > return< / span > < span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/7-vn.html#SP4" class = "function-link" > < span class = "function-syntax" > VersionNumbers::null< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > JSON_value< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > version< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/4-jsn.html#SP7" class = "function-link" > < span class = "function-syntax" > JSON::look_up_object< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > is< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "version"< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > semantic_version_number< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/7-vn.html#SP4" class = "function-link" > < span class = "function-syntax" > VersionNumbers::null< / span > < / a > < 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" > version< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/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" > version< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > if_string< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "../../../inweb/foundation-module/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" > V< / span > < span class = "plain-syntax" > )) {< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/3-em.html#SP6" class = "function-link" > < span class = "function-syntax" > Errors::at_position< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "string-syntax" > "Malformed version number in metadata file for kit"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / 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" > return< / span > < span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/7-vn.html#SP4" class = "function-link" > < span class = "function-syntax" > VersionNumbers::null< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > }< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "../../../inweb/foundation-module/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" > set_to< / span > < span class = "plain-syntax" > ) == < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > )< / span >
2022-11-11 00:34:19 +02:00
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "2-kv.html#SP4_1" class = "named-paragraph-link" > < span class = "named-paragraph" > Decide whether to impose the new version< / span > < span class = "named-paragraph-number" > 4.1< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
2022-06-04 01:56:04 +03:00
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > return< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2022-11-11 00:34:19 +02:00
< p class = "commentary firstcommentary" > < a id = "SP4_1" class = "paragraph-anchor" > < / a > < b > § 4.1. < / b > The following test used to be just < span class = "extract" > < span class = "extract-syntax" > VersionNumbers::ne(set_to, V)< / span > < / span > , but this,
because it properly followed the semver standard, regarded them as equal if they
differed only in the build code — so < span class = "extract" > < span class = "extract-syntax" > 10.1.0-beta+6V20< / span > < / span > would not be updated to
< span class = "extract" > < span class = "extract-syntax" > 10.1.0-beta+6V44< / span > < / span > , for example. We now force a sync if there is any textual
difference at all.
< / p >
< p class = "commentary" > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Decide whether to impose the new version< / span > < span class = "named-paragraph-number" > 4.1< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TEMPORARY_TEXT< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > a< / 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" > b< / 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" > a< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%v"< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > set_to< / 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" > b< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%v"< / 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" > if< / span > < span class = "plain-syntax" > (< / span > < a href = "../../../inweb/foundation-module/4-sm.html#SP19" class = "function-link" > < span class = "function-syntax" > Str::ne< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > a< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > b< / span > < span class = "plain-syntax" > ))< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "2-kv.html#SP4_1_1" class = "named-paragraph-link" > < span class = "named-paragraph" > Change the version to set_to< / span > < span class = "named-paragraph-number" > 4.1.1< / span > < / a > < / 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" > a< / 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" > b< / span > < span class = "plain-syntax" > )< / span >
< / pre >
< ul class = "endnotetexts" > < li > This code is used in < a href = "2-kv.html#SP4" > § 4< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP4_1_1" class = "paragraph-anchor" > < / a > < b > § 4.1.1. < / b > We change the JSON object for the kit's metadata (at object.is.version), and
2022-06-04 01:56:04 +03:00
then encode the object out as a new version of the file:
< / p >
2022-11-11 00:34:19 +02:00
< p class = "commentary" > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Change the version to set_to< / span > < span class = "named-paragraph-number" > 4.1.1< / span > < / span > < span class = "comment-syntax" > =< / span >
2022-06-04 01:56:04 +03:00
< / p >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > if< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > version< / 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" > version< / span > < span class = "plain-syntax" > = < / span > < a href = "../../../inweb/foundation-module/4-jsn.html#SP4" class = "function-link" > < span class = "function-syntax" > JSON::new_string< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > ""< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/4-jsn.html#SP6" class = "function-link" > < span class = "function-syntax" > JSON::add_to_object< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > is< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "string-syntax" > "version"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > version< / span > < span class = "plain-syntax" > );< / 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" > "Rewriting %f to impose version number %v (was %v)\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/4-sm.html#SP15" class = "function-link" > < span class = "function-syntax" > Str::clear< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > version< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > if_string< / 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" > version< / span > < span class = "plain-syntax" > -> < / span > < span class = "element-syntax" > if_string< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%v"< / span > < span class = "plain-syntax" > , & < / span > < span class = "identifier-syntax" > set_to< / 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" > JSON_struct< / 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" > JSON_struct< / 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" > STREAM_OPEN_TO_FILE< / span > < 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 = "../../../inweb/foundation-module/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" > "unable to open metadata file for output: %f"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > F< / span > < span class = "plain-syntax" > );< / span >
2023-03-22 07:45:28 +02:00
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/foundation-module/4-jsn.html#SP18" class = "function-link" > < span class = "function-syntax" > JSON::encode< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > value< / span > < span class = "plain-syntax" > );< / span >
2022-06-04 01:56:04 +03:00
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > STREAM_CLOSE< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > V< / span > < span class = "plain-syntax" > = < / span > < span class = "identifier-syntax" > set_to< / span > < span class = "plain-syntax" > ;< / span >
< / pre >
2022-11-11 00:34:19 +02:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "2-kv.html#SP4_1" > § 4.1< / a > .< / li > < / ul >
2022-06-04 01:56:04 +03:00
< p class = "commentary firstcommentary" > < a id = "SP5" class = "paragraph-anchor" > < / a > < b > § 5. < / b > < / 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" > KitVersioning::read_metadata_file_helper< / span > < button class = "popup" onclick = "togglePopup('usagePopup5')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup5" > Usage of < span class = "code-font" > < span class = "function-syntax" > KitVersioning::read_metadata_file_helper< / span > < / span > :< br / > < a href = "2-kv.html#SP4" > § 4< / a > < / 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 = "plain-syntax" > < / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > v_state< / 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" > contents< / span > < span class = "plain-syntax" > = (< / span > < span class = "reserved-syntax" > text_stream< / span > < span class = "plain-syntax" > *) < / span > < span class = "identifier-syntax" > v_state< / 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" > contents< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "%S\n"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text< / 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 = "2-pc.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "M-ui.html" > M< / a > < / li > < li class = "progresschapter" > < a href = "1-bsc.html" > 1< / a > < / li > < li class = "progresscurrentchapter" > 2< / li > < li class = "progresssection" > < a href = "2-pc.html" > pc< / a > < / li > < li class = "progresscurrent" > kv< / li > < li class = "progressnextoff" > ❯ < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >