mirror of
https://github.com/ganelson/inform.git
synced 2024-07-08 18:14:21 +03:00
152 lines
14 KiB
HTML
152 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Build Methodology</title>
|
|
<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="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
|
|
</head>
|
|
<body>
|
|
<nav role="navigation">
|
|
<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>
|
|
<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>
|
|
</ul><h2>Compiler Webs</h2><ul>
|
|
<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>
|
|
</ul><h2>Inbuild Modules</h2><ul>
|
|
<li><a href="index.html"><span class="selectedlink">supervisor</span></a></li>
|
|
</ul><h2>Inform7 Modules</h2><ul>
|
|
<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>
|
|
<li><a href="../problems-module/index.html">problems</a></li>
|
|
<li><a href="../index-module/index.html">index</a></li>
|
|
</ul><h2>Inter Modules</h2><ul>
|
|
<li><a href="../bytecode-module/index.html">bytecode</a></li>
|
|
<li><a href="../building-module/index.html">building</a></li>
|
|
<li><a href="../codegen-module/index.html">codegen</a></li>
|
|
</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>
|
|
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
<main role="main">
|
|
|
|
<!--Weave of 'Build Methodology' 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#3">Chapter 3: Incremental Builds</a></li><li><b>Build Methodology</b></li></ul><p class="purpose">Whether to run tasks internally in some merged tool, or run via the shell, or simply trace to the standard output what we think ought to be done.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. </b>This is rather grandly named for what it is: it's just a bundle of settings
|
|
about how to carry out build steps. Should we (a) make a dry run, just printing
|
|
hypothetical shell commands, or (b) issue those shell commands via <code class="display"><span class="extract">system</span></code>,
|
|
or (c) take direct action by calling functions within the current executable?
|
|
If (a) or (b) then we will need to know the locations of the executable files
|
|
for the tools <code class="display"><span class="extract">inter</span></code>, <code class="display"><span class="extract">inform6</span></code>, <code class="display"><span class="extract">inform7</span></code> and <code class="display"><span class="extract">inblorb</span></code>.
|
|
</p>
|
|
|
|
|
|
<pre class="definitions">
|
|
<span class="definitionkeyword">enum</span> <span class="constant">DRY_RUN_METHODOLOGY</span><span class="definitionkeyword"> from </span><span class="constant">1</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">SHELL_METHODOLOGY</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">INTERNAL_METHODOLOGY</span>
|
|
</pre>
|
|
|
|
<pre class="display">
|
|
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">build_methodology</span><span class="plain"> {</span>
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">to_inter</span><span class="plain">;</span>
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">to_inform6</span><span class="plain">;</span>
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">to_inform7</span><span class="plain">;</span>
|
|
<span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">to_inblorb</span><span class="plain">;</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">methodology</span><span class="plain">;</span>
|
|
<span class="identifier">MEMORY_MANAGEMENT</span>
|
|
<span class="plain">} </span><span class="reserved">build_methodology</span><span class="plain">;</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The structure build_methodology is accessed in 3/bs2, 3/is, 3/is2, 3/is3, 3/is4, 4/em, 4/km, 4/lm, 4/pm, 4/tm and here.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP2"></a><b>§2. </b>If the <code class="display"><span class="extract">tangled</span></code> flag is set, we expect <code class="display"><span class="extract">inform7</span></code>, for example, to be at
|
|
<code class="display"><span class="extract">tools_path/inform7/Tangled/inform7</span></code>; if it is clear, we expect it only to
|
|
be <code class="display"><span class="extract">tools_path/inform7</span></code>. This is relevant only for the command-line Inbuild,
|
|
which used tangled mode by default, but untangled mode if the user has
|
|
specified an explicit path at the command line.
|
|
</p>
|
|
|
|
<pre class="display">
|
|
<span class="reserved">build_methodology</span><span class="plain"> *</span><span class="functiontext">BuildMethodology::new<button class="popup" onclick="togglePopup('usagePopup131')">...<span class="popuptext" id="usagePopup131">Usage of <b>BuildMethodology::new</b>:<br><a href="#SP3">§3</a></span></button></span><span class="plain">(</span><span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">tools_path</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">tangled</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">meth</span><span class="plain">) {</span>
|
|
<span class="reserved">build_methodology</span><span class="plain"> *</span><span class="identifier">BM</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">build_methodology</span><span class="plain">);</span>
|
|
<span class="identifier">BM</span><span class="plain">-></span><span class="element">methodology</span><span class="plain"> = </span><span class="identifier">meth</span><span class="plain">;</span>
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">inter_path</span><span class="plain"> = </span><span class="identifier">tools_path</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">tangled</span><span class="plain">) {</span>
|
|
<span class="identifier">inter_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inter_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inter"</span><span class="plain">);</span>
|
|
<span class="identifier">inter_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inter_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Tangled"</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="identifier">BM</span><span class="plain">-></span><span class="element">to_inter</span><span class="plain"> = </span><span class="identifier">Filenames::in_folder</span><span class="plain">(</span><span class="identifier">inter_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inter"</span><span class="plain">);</span>
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">inform6_path</span><span class="plain"> = </span><span class="identifier">tools_path</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">tangled</span><span class="plain">) {</span>
|
|
<span class="identifier">inform6_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inform6_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inform6"</span><span class="plain">);</span>
|
|
<span class="identifier">inform6_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inform6_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Tangled"</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="identifier">BM</span><span class="plain">-></span><span class="element">to_inform6</span><span class="plain"> = </span><span class="identifier">Filenames::in_folder</span><span class="plain">(</span><span class="identifier">inform6_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inform6"</span><span class="plain">);</span>
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">inform7_path</span><span class="plain"> = </span><span class="identifier">tools_path</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">tangled</span><span class="plain">) {</span>
|
|
<span class="identifier">inform7_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inform7_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inform7"</span><span class="plain">);</span>
|
|
<span class="identifier">inform7_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inform7_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Tangled"</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="identifier">BM</span><span class="plain">-></span><span class="element">to_inform7</span><span class="plain"> = </span><span class="identifier">Filenames::in_folder</span><span class="plain">(</span><span class="identifier">inform7_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inform7"</span><span class="plain">);</span>
|
|
<span class="identifier">pathname</span><span class="plain"> *</span><span class="identifier">inblorb_path</span><span class="plain"> = </span><span class="identifier">tools_path</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">tangled</span><span class="plain">) {</span>
|
|
<span class="identifier">inblorb_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inblorb_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inblorb"</span><span class="plain">);</span>
|
|
<span class="identifier">inblorb_path</span><span class="plain"> = </span><span class="identifier">Pathnames::subfolder</span><span class="plain">(</span><span class="identifier">inblorb_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Tangled"</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="identifier">BM</span><span class="plain">-></span><span class="element">to_inblorb</span><span class="plain"> = </span><span class="identifier">Filenames::in_folder</span><span class="plain">(</span><span class="identifier">inblorb_path</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inblorb"</span><span class="plain">);</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">BM</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3"></a><b>§3. </b>The <code class="display"><span class="extract">inform7</span></code> tool only ever uses the internal methodology, for which
|
|
these filenames are irrelevant, since no shell commands are ever issued.
|
|
It gets its BM by calling the following:
|
|
</p>
|
|
|
|
<pre class="display">
|
|
<span class="reserved">build_methodology</span><span class="plain"> *</span><span class="functiontext">BuildMethodology::stay_in_current_process<button class="popup" onclick="togglePopup('usagePopup132')">...<span class="popuptext" id="usagePopup132">Usage of <b>BuildMethodology::stay_in_current_process</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="functiontext"><a href="#SP2">BuildMethodology::new</a></span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="constant">INTERNAL_METHODOLOGY</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><a href="3-bg.html">Back to 'Build Graphs'</a></li><li><a href="3-ib.html">Continue with 'Incremental Building'</a></li></ul><hr class="tocbar">
|
|
<!--End of weave-->
|
|
<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">
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|