1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 18:14:21 +03:00
inform7/docs/supervisor-module/2-edt.html

149 lines
14 KiB
HTML
Raw Normal View History

2020-02-27 13:18:25 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
2020-04-14 19:56:54 +03:00
<title>Editions</title>
2020-03-19 02:11:25 +02:00
<meta name="viewport" content="width=device-width initial-scale=1">
2020-02-27 13:18:25 +02:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
2020-03-19 02:11:25 +02:00
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
2020-04-14 19:56:54 +03:00
2020-02-27 13:18:25 +02:00
</head>
<body>
2020-03-19 02:11:25 +02:00
<nav role="navigation">
2020-04-14 19:56:54 +03:00
<h1><a href="../index.html">
<img src="../docs-src/Figures/Inform.png" height=72">
</a></h1>
<ul><li><a href="../compiler.html">compiler tools</a></li>
2020-03-19 02:11:25 +02:00
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
2020-04-14 19:56:54 +03:00
</ul><h2>Compiler Webs</h2><ul>
2020-03-19 02:11:25 +02:00
<li><a href="../inbuild/index.html">inbuild</a></li>
<li><a href="../inform7/index.html">inform7</a></li>
<li><a href="../inter/index.html">inter</a></li>
2020-04-14 19:56:54 +03:00
</ul><h2>Inbuild Modules</h2><ul>
<li><a href="index.html"><span class="selectedlink">supervisor</span></a></li>
</ul><h2>Inform7 Modules</h2><ul>
2020-03-19 02:11:25 +02:00
<li><a href="../core-module/index.html">core</a></li>
<li><a href="../inflections-module/index.html">inflections</a></li>
<li><a href="../linguistics-module/index.html">linguistics</a></li>
<li><a href="../kinds-module/index.html">kinds</a></li>
<li><a href="../if-module/index.html">if</a></li>
<li><a href="../multimedia-module/index.html">multimedia</a></li>
2020-04-14 19:56:54 +03:00
<li><a href="../problems-module/index.html">problems</a></li>
2020-03-19 02:11:25 +02:00
<li><a href="../index-module/index.html">index</a></li>
2020-04-14 19:56:54 +03:00
</ul><h2>Inter Modules</h2><ul>
<li><a href="../bytecode-module/index.html">bytecode</a></li>
2020-03-19 02:11:25 +02:00
<li><a href="../building-module/index.html">building</a></li>
<li><a href="../codegen-module/index.html">codegen</a></li>
2020-04-14 19:56:54 +03:00
</ul><h2>Shared Modules</h2><ul>
<li><a href="../arch-module/index.html">arch</a></li>
<li><a href="../syntax-module/index.html">syntax</a></li>
<li><a href="../words-module/index.html">words</a></li>
<li><a href="../html-module/index.html">html</a></li>
2020-03-19 02:11:25 +02:00
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
2020-04-14 19:56:54 +03:00
</ul>
2020-03-19 02:11:25 +02:00
</nav>
<main role="main">
2020-04-14 19:56:54 +03:00
<!--Weave of 'Editions' generated by 7-->
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../compiler.html">Inbuild Modules</a></li><li><a href="index.html">supervisor</a></li><li><a href="index.html#2">Chapter 2: Conceptual Framework</a></li><li><b>Editions</b></li></ul><p class="purpose">An edition is a numbered version of a work.</p>
2020-02-27 13:18:25 +02:00
<ul class="toc"><li><a href="2-edt.html#SP1">&#167;1. Editions</a></li></ul><hr class="tocbar">
2020-02-27 13:18:25 +02:00
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Editions. </b>An "edition" of a work is a particular version numbered form of it. For
2020-03-29 19:39:17 +03:00
example, release 7 of Bronze by Emily Short would be an edition of the
work Bronze by Emily Short.
</p>
<p class="inwebparagraph">It is at this level that we record what works are compatible with which
target virtual machines, because we can imagine that, for example, version 7
might work with all VMs, while version 8 required a 32-bit architecture.
2020-02-27 13:18:25 +02:00
</p>
<pre class="display">
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inbuild_edition</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">work</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">semantic_version_number</span><span class="plain"> </span><span class="identifier">version</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">compatibility_specification</span><span class="plain"> *</span><span class="identifier">compatibility</span><span class="plain">;</span>
<span class="identifier">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">inbuild_edition</span><span class="plain">;</span>
2020-04-14 19:56:54 +03:00
<span class="reserved">inbuild_edition</span><span class="plain"> *</span><span class="functiontext">Editions::new<button class="popup" onclick="togglePopup('usagePopup63')">...<span class="popuptext" id="usagePopup63">Usage of <b>Editions::new</b>:<br>Extension Manager - <a href="4-em.html#SP4">&#167;4</a><br>Kit Manager - <a href="4-km.html#SP3">&#167;3</a><br>Language Manager - <a href="4-lm.html#SP3">&#167;3</a><br>Pipeline Manager - <a href="4-pm.html#SP4">&#167;4</a><br>Project Bundle Manager - <a href="4-pbm.html#SP2">&#167;2</a><br>Project File Manager - <a href="4-pfm.html#SP2">&#167;2</a><br>Template Manager - <a href="4-tm.html#SP3">&#167;3</a><br>Extension Services - <a href="5-es.html#SP2_3">&#167;2.3</a></span></button></span><span class="plain">(</span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">work</span><span class="plain">, </span><span class="identifier">semantic_version_number</span><span class="plain"> </span><span class="identifier">version</span><span class="plain">) {</span>
2020-02-27 13:18:25 +02:00
<span class="reserved">inbuild_edition</span><span class="plain"> *</span><span class="identifier">edition</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">inbuild_edition</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">edition</span><span class="plain">-&gt;</span><span class="element">work</span><span class="plain"> = </span><span class="identifier">work</span><span class="plain">;</span>
<span class="identifier">edition</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain"> = </span><span class="identifier">version</span><span class="plain">;</span>
<span class="identifier">edition</span><span class="plain">-&gt;</span><span class="element">compatibility</span><span class="plain"> = </span><span class="identifier">Compatibility::all</span><span class="plain">();</span>
2020-02-27 13:18:25 +02:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">edition</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Editions::write<button class="popup" onclick="togglePopup('usagePopup64')">...<span class="popuptext" id="usagePopup64">Usage of <b>Editions::write</b>:<br><a href="2-edt.html#SP3">&#167;3</a>, Copies - <a href="2-cps.html#SP6">&#167;6</a></span></button></span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">, </span><span class="reserved">inbuild_edition</span><span class="plain"> *</span><span class="identifier">E</span><span class="plain">) {</span>
2020-04-14 19:56:54 +03:00
<span class="functiontext"><a href="2-wrk.html#SP5">Works::write</a></span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">-&gt;</span><span class="element">work</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">semantic_version_number</span><span class="plain"> </span><span class="identifier">V</span><span class="plain"> = </span><span class="identifier">E</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain">;</span>
2020-02-27 13:18:25 +02:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">VersionNumbers::is_null</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">) {</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">" v%v"</span><span class="plain">, &amp;</span><span class="identifier">V</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
2020-03-29 19:39:17 +03:00
</pre>
<p class="inwebparagraph"></p>
2020-04-14 19:56:54 +03:00
<p class="endnote">The structure inbuild_edition is accessed in 2/wrk, 2/cps, 2/rqr, 2/nst, 3/bg, 3/is2, 4/em, 4/km, 4/lm, 4/pm, 4/pbm, 4/pfm, 4/tm, 5/es, 5/ks, 5/ls, 5/ps, 5/ps2, 5/ts, 6/hdn, 6/inc, 6/vmg, 7/ed, 7/ed2, 7/ec and here.</p>
2020-03-29 19:39:17 +03:00
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>When a copy is to be duplicated into a nest <code class="display"><span class="extract">N</span></code>, we need to work out where
to put it. For example, version 2.1 of the extension Marbles by Steve Hogarth
would go into <code class="display"><span class="extract">N/Extensions/Steve Hogarth/Marbles-v2_1.i7x</span></code>. The following
contributes only the un-filename-extended leafname <code class="display"><span class="extract">Marbles-v2_1</span></code>.
</p>
<pre class="display">
2020-04-14 19:56:54 +03:00
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Editions::write_canonical_leaf<button class="popup" onclick="togglePopup('usagePopup65')">...<span class="popuptext" id="usagePopup65">Usage of <b>Editions::write_canonical_leaf</b>:<br>Extension Manager - <a href="4-em.html#SP7">&#167;7</a><br>Kit Manager - <a href="4-km.html#SP6">&#167;6</a><br>Language Manager - <a href="4-lm.html#SP6">&#167;6</a><br>Pipeline Manager - <a href="4-pm.html#SP6">&#167;6</a><br>Template Manager - <a href="4-tm.html#SP6">&#167;6</a></span></button></span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">, </span><span class="reserved">inbuild_edition</span><span class="plain"> *</span><span class="identifier">E</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%S"</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">-&gt;</span><span class="element">work</span><span class="plain">-&gt;</span><span class="element">title</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">VersionNumbers::is_null</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">) {</span>
2020-03-11 02:21:09 +02:00
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">vn</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">vn</span><span class="plain">, </span><span class="string">"-v%v"</span><span class="plain">, &amp;(</span><span class="identifier">E</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain">));</span>
2020-03-11 02:21:09 +02:00
<span class="identifier">LOOP_THROUGH_TEXT</span><span class="plain">(</span><span class="identifier">pos</span><span class="plain">, </span><span class="identifier">vn</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Str::get</span><span class="plain">(</span><span class="identifier">pos</span><span class="plain">) == </span><span class="character">'.'</span><span class="plain">)</span>
<span class="identifier">PUT</span><span class="plain">(</span><span class="character">'_'</span><span class="plain">);</span>
<span class="reserved">else</span>
<span class="identifier">PUT</span><span class="plain">(</span><span class="identifier">Str::get</span><span class="plain">(</span><span class="identifier">pos</span><span class="plain">));</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">vn</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
2020-03-29 19:39:17 +03:00
</pre>
2020-03-11 02:21:09 +02:00
2020-03-29 19:39:17 +03:00
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>The <code class="display"><span class="extract">-inspect</span></code> command of Inbuild uses the following.
</p>
<pre class="display">
2020-04-14 19:56:54 +03:00
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Editions::inspect<button class="popup" onclick="togglePopup('usagePopup66')">...<span class="popuptext" id="usagePopup66">Usage of <b>Editions::inspect</b>:<br>Copies - <a href="2-cps.html#SP9">&#167;9</a></span></button></span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">, </span><span class="reserved">inbuild_edition</span><span class="plain"> *</span><span class="identifier">E</span><span class="plain">) {</span>
<span class="functiontext"><a href="2-edt.html#SP1">Editions::write</a></span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Compatibility::universal</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">-&gt;</span><span class="element">compatibility</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">) {</span>
2020-02-27 13:18:25 +02:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">" ("</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">Compatibility::write</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">E</span><span class="plain">-&gt;</span><span class="element">compatibility</span><span class="plain">);</span>
2020-02-27 13:18:25 +02:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">")"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<hr class="tocbar">
<ul class="toc"><li><a href="2-wrk.html">Back to 'Works'</a></li><li><a href="2-cps.html">Continue with 'Copies'</a></li></ul><hr class="tocbar">
<!--End of weave-->
2020-04-14 19:56:54 +03:00
<script>
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
</script>
<link href="Popups.css" rel="stylesheet" rev="stylesheet" type="text/css">
2020-03-19 02:11:25 +02:00
</main>
2020-02-27 13:18:25 +02:00
</body>
</html>