1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-03 07:24:58 +03:00
inform7/docs/inpolicy/1-mn.html
Graham Nelson 1268a0f40e Colonised
2020-04-14 17:56:54 +01:00

124 lines
13 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Main</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>Other Tools</h2><ul>
<li><a href="../inblorb/index.html">inblorb</a></li>
<li><a href="../indoc/index.html">indoc</a></li>
<li><a href="index.html"><span class="selectedlink">inpolicy</span></a></li>
<li><a href="../inrtps/index.html">inrtps</a></li>
</ul><h2>Foundation</h2><ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
</ul>
</nav>
<main role="main">
<!--Weave of 'Main' generated by 7-->
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../other.html">Other Tools</a></li><li><a href="index.html">inpolicy</a></li><li><a href="index.html#1">Chapter 1: Setting Up</a></li><li><b>Main</b></li></ul><p class="purpose">The top level, which decides what is to be done and then carries this plan out.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Main routine</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Main routine. </b></p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">SILENCE_CLSW</span>
<span class="definitionkeyword">enum</span> <span class="constant">VERBOSE_CLSW</span>
<span class="definitionkeyword">enum</span> <span class="constant">PROBLEMS_CLSW</span>
</pre>
<pre class="display">
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">path_to_inpolicy</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">; </span><span class="comment"> where we are installed</span>
<span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">path_to_inpolicy_workspace</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">; </span><span class="comment"> the materials pathname</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">return_happy</span><span class="plain"> = </span><span class="constant">TRUE</span><span class="plain">, </span><span class="identifier">silence_mode</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">, </span><span class="identifier">verbose_mode</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">main</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">argc</span><span class="plain">, </span><span class="reserved">char</span><span class="plain"> **</span><span class="identifier">argv</span><span class="plain">) {</span>
<span class="functiontext"><a href="1-fm.html#SP8">Foundation::start</a></span><span class="plain">();</span>
<span class="functiontext"><a href="3-cla.html#SP14">CommandLine::declare_heading</a></span><span class="plain">(</span>
<span class="identifier">L</span><span class="string">"[[Purpose]]\n\n"</span>
<span class="identifier">L</span><span class="string">"usage: inpolicy [options]\n"</span><span class="plain">);</span>
<span class="functiontext"><a href="3-cla.html#SP5">CommandLine::declare_switch</a></span><span class="plain">(</span><span class="constant">PROBLEMS_CLSW</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"check-problems"</span><span class="plain">, </span><span class="constant">1</span><span class="plain">,</span>
<span class="identifier">L</span><span class="string">"check problem test case coverage"</span><span class="plain">);</span>
<span class="functiontext"><a href="3-cla.html#SP6">CommandLine::declare_boolean_switch</a></span><span class="plain">(</span><span class="constant">SILENCE_CLSW</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"silence"</span><span class="plain">, </span><span class="constant">1</span><span class="plain">,</span>
<span class="identifier">L</span><span class="string">"print nothing unless there's something wrong"</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">);</span>
<span class="functiontext"><a href="3-cla.html#SP6">CommandLine::declare_boolean_switch</a></span><span class="plain">(</span><span class="constant">VERBOSE_CLSW</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"verbose"</span><span class="plain">, </span><span class="constant">1</span><span class="plain">,</span>
<span class="identifier">L</span><span class="string">"explain what inpolicy is doing"</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">);</span>
<span class="functiontext"><a href="3-cla.html#SP8">CommandLine::read</a></span><span class="plain">(</span><span class="identifier">argc</span><span class="plain">, </span><span class="identifier">argv</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, &amp;</span><span class="functiontext"><a href="#SP2">Main::respond</a></span><span class="plain">, &amp;</span><span class="functiontext"><a href="#SP1">Main::disallow</a></span><span class="plain">);</span>
<span class="identifier">path_to_inpolicy</span><span class="plain"> = </span><span class="functiontext"><a href="3-pth.html#SP3">Pathnames::installation_path</a></span><span class="plain">(</span><span class="string">"INPOLICY_PATH"</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inpolicy"</span><span class="plain">);</span>
<span class="identifier">path_to_inpolicy_workspace</span><span class="plain"> = </span><span class="functiontext"><a href="3-pth.html#SP4">Pathnames::subfolder</a></span><span class="plain">(</span><span class="identifier">path_to_inpolicy</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Workspace"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">verbose_mode</span><span class="plain">) </span><span class="identifier">PRINT</span><span class="plain">(</span><span class="string">"Installation path is %p\n"</span><span class="plain">, </span><span class="identifier">path_to_inpolicy</span><span class="plain">);</span>
<span class="functiontext"><a href="1-fm.html#SP9">Foundation::end</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">return_happy</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="constant">0</span><span class="plain">; </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">return</span><span class="plain"> </span><span class="constant">1</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Main::disallow<button class="popup" onclick="togglePopup('usagePopup0')">...<span class="popuptext" id="usagePopup0">Usage of <b>Main::disallow</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">id</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">arg</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">state</span><span class="plain">) {</span>
<span class="functiontext"><a href="3-em.html#SP2">Errors::fatal</a></span><span class="plain">(</span><span class="string">"no arguments are allowed at the command line"</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b></p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="identifier">RUNTEST</span><span class="plain">(</span><span class="identifier">Routine</span><span class="plain">)</span>
<span class="identifier">path_to_inpolicy</span><span class="plain"> = </span><span class="functiontext"><a href="3-pth.html#SP3">Pathnames::installation_path</a></span><span class="plain">(</span><span class="string">"INPOLICY_PATH"</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"inpolicy"</span><span class="plain">);</span>
<span class="identifier">path_to_inpolicy_workspace</span><span class="plain"> = </span><span class="functiontext"><a href="3-pth.html#SP4">Pathnames::subfolder</a></span><span class="plain">(</span><span class="identifier">path_to_inpolicy</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Workspace"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">silence_mode</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Routine</span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">) == </span><span class="constant">FALSE</span><span class="plain">) { </span><span class="identifier">return_happy</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">; </span><span class="identifier">Routine</span><span class="plain">(</span><span class="constant">STDERR</span><span class="plain">); }</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Routine</span><span class="plain">(</span><span class="constant">STDOUT</span><span class="plain">) == </span><span class="constant">FALSE</span><span class="plain">) </span><span class="identifier">return_happy</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Main::respond<button class="popup" onclick="togglePopup('usagePopup1')">...<span class="popuptext" id="usagePopup1">Usage of <b>Main::respond</b>:<br><a href="#SP1">&#167;1</a></span></button></span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">id</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">val</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">arg</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">state</span><span class="plain">) {</span>
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">id</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">PROBLEMS_CLSW:</span><span class="plain"> </span><span class="identifier">RUNTEST</span><span class="plain">(</span><span class="functiontext"><a href="2-pc.html#SP7">Coverage::check</a></span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">SILENCE_CLSW:</span><span class="plain"> </span><span class="identifier">silence_mode</span><span class="plain"> = </span><span class="identifier">val</span><span class="plain">; </span><span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">VERBOSE_CLSW:</span><span class="plain"> </span><span class="identifier">verbose_mode</span><span class="plain"> = </span><span class="identifier">val</span><span class="plain">; </span><span class="reserved">break</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="1-bsc.html">Back to 'Basics'</a></li><li><i>(This section ends Chapter 1: Setting Up.)</i></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>