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
2019-04-22 15:42:10 +01:00

108 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>1/bsc</title>
<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>
<!--Weave of '1/mn' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">inpolicy 1</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">WRITEME_CLSW</span>
<span class="definitionkeyword">enum</span> <span class="constant">PROBLEMS_CLSW</span>
<span class="definitionkeyword">enum</span> <span class="constant">ADVANCE_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">Foundation::start</span><span class="plain">();</span>
<span class="functiontext">CommandLine::declare_heading</span><span class="plain">(</span>
<span class="identifier">L</span><span class="string">"[[Purpose]]\</span><span class="plain">n</span><span class="string">\</span><span class="plain">n</span><span class="string">"</span>
<span class="identifier">L</span><span class="string">"usage: inpolicy [options]\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
<span class="functiontext">CommandLine::declare_switch</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">, 1,</span>
<span class="identifier">L</span><span class="string">"check problem test case coverage"</span><span class="plain">);</span>
<span class="functiontext">CommandLine::declare_switch</span><span class="plain">(</span><span class="constant">ADVANCE_CLSW</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"advance-build"</span><span class="plain">, 2,</span>
<span class="identifier">L</span><span class="string">"increment daily build code for web X"</span><span class="plain">);</span>
<span class="functiontext">CommandLine::declare_switch</span><span class="plain">(</span><span class="constant">WRITEME_CLSW</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"write-me"</span><span class="plain">, 2,</span>
<span class="identifier">L</span><span class="string">"write a read-me file following instructions in file X"</span><span class="plain">);</span>
<span class="functiontext">CommandLine::declare_boolean_switch</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">, 1,</span>
<span class="identifier">L</span><span class="string">"print nothing unless there's something wrong"</span><span class="plain">);</span>
<span class="functiontext">CommandLine::declare_boolean_switch</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">, 1,</span>
<span class="identifier">L</span><span class="string">"explain what inpolicy is doing"</span><span class="plain">);</span>
<span class="functiontext">CommandLine::read</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">Main::respond</span><span class="plain">, &amp;</span><span class="functiontext">Main::disallow</span><span class="plain">);</span>
<span class="identifier">path_to_inpolicy</span><span class="plain"> = </span><span class="functiontext">Pathnames::installation_path</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">Pathnames::subfolder</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\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">path_to_inpolicy</span><span class="plain">);</span>
<span class="functiontext">Foundation::end</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"> 0; </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">return</span><span class="plain"> 1;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Main::disallow</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">Errors::fatal</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="endnote">The function main appears nowhere else.</p>
<p class="endnote">The function Main::disallow appears nowhere else.</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">Pathnames::installation_path</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">Pathnames::subfolder</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</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="constant">ADVANCE_CLSW</span><span class="plain">: </span><span class="functiontext">Inversion::maintain</span><span class="plain">(</span><span class="identifier">arg</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="constant">WRITEME_CLSW</span><span class="plain">: </span><span class="functiontext">Readme::write</span><span class="plain">(</span><span class="functiontext">Filenames::from_text</span><span class="plain">(</span><span class="identifier">arg</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="constant">PROBLEMS_CLSW</span><span class="plain">: </span><span class="identifier">RUNTEST</span><span class="plain">(</span><span class="functiontext">Coverage::check</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="constant">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="constant">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>
<p class="endnote">The function Main::respond is used in <a href="#SP1">&#167;1</a>.</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-->
</body>
</html>