ifhub/inform7
1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-05 16:44:21 +03:00
Code Issues Projects Releases Wiki Activity
inform7/docs/inblorb/1-be.html
Graham Nelson 2c292048cd Conform to new README system
2020-03-23 21:42:00 +00:00

200 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>1/mn</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="../webs.html">Sources</a></h1>
<ul>
<li><a href="../compiler.html">compiler</a></li>
<li><a href="../other.html"><b>other tools</b></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="../inpolicy/index.html">inpolicy</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 '1/be' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="../other.html">Other Tools</a></li><li><a href="index.html">inblorb</a></li><li><a href="index.html#1">Chapter 1: Blurbs</a></li><li><b>Blorb Errors</b></li></ul><p class="purpose">To spool error messages into the HTML report.</p>
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b>Foundation has a perfectly good library of code for error messages, but
we won't use it, because we need to do something unusual with them: they
must not only be printed to standard error, but also spooled into HTML
format for possible use on a status HTML page. Hence this section.
</p>
<p class="inwebparagraph">Inblorb is in any case only minimally helpful when diagnosing problems,
because it's intended to be used as the back end of a system which only
generates correct blurb files, so that everything will work &mdash; ideally, the
Inform user will never know that Inblorb exists.
</p>
<p class="inwebparagraph">First, the current position of errors is recorded so that we can report
the source of the trouble:
</p>
<pre class="display">
<span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">error_position</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::set_error_position</span><span class="plain">(</span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
<span class="identifier">error_position</span><span class="plain"> = </span><span class="identifier">tfp</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::describe_file_position</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">error_position</span><span class="plain">) {</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%f, line %d: "</span><span class="plain">,</span>
<span class="identifier">error_position</span><span class="plain">-</span><span class="element">&gt;text_file_filename</span><span class="plain">,</span>
<span class="identifier">error_position</span><span class="plain">-</span><span class="element">&gt;line_count</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function BlorbErrors::set_error_position is used in 1/bp (<a href="1-bp.html#SP1">&#167;1</a>, <a href="1-bp.html#SP7">&#167;7</a>).</p>
<p class="endnote">The function BlorbErrors::describe_file_position is used in <a href="#SP2">&#167;2</a>, <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>Fatalities:
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::fatal</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::describe_file_position</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="string">"Fatal error: %s\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">Main::print_report</span><span class="plain">();</span>
<span class="identifier">exit</span><span class="plain">(1);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::fatal_fs</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">fn</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::describe_file_position</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="string">"Fatal error: %s: filename '%f'\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">, </span><span class="identifier">fn</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">Main::print_report</span><span class="plain">();</span>
<span class="identifier">exit</span><span class="plain">(1);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function BlorbErrors::fatal is used in 1/bp (<a href="1-bp.html#SP7_2">&#167;7.2</a>), 2/bw (<a href="2-bw.html#SP8">&#167;8</a>, <a href="2-bw.html#SP17">&#167;17</a>, <a href="2-bw.html#SP19">&#167;19</a>, <a href="2-bw.html#SP21">&#167;21</a>), 3/wm (<a href="3-wm.html#SP9">&#167;9</a>).</p>
<p class="endnote">The function BlorbErrors::fatal_fs is used in 2/bw (<a href="2-bw.html#SP24_3_1">&#167;24.3.1</a>), 3/sd (<a href="3-sd.html#SP12">&#167;12</a>), 3/bs6 (<a href="3-bs6.html#SP2">&#167;2</a>).</p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>Mere indispositions:
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::error</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::describe_file_position</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="string">"Error: %s\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::error_1</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">, </span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">s</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::describe_file_position</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="string">"Error: %s: '%s'\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">, </span><span class="identifier">s</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::error_1S</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">s</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::describe_file_position</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="string">"Error: %s: '%S'\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">, </span><span class="identifier">s</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::error_1f</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::describe_file_position</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="string">"Error: %s: '%f'\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">, </span><span class="identifier">F</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::errorf_1S</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">s1</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">, </span><span class="identifier">s1</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::errorf_2S</span><span class="plain">(</span><span class="reserved">char</span><span class="plain"> *</span><span class="identifier">erm</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">s1</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">s2</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">, </span><span class="identifier">erm</span><span class="plain">, </span><span class="identifier">s1</span><span class="plain">, </span><span class="identifier">s2</span><span class="plain">);</span>
<span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ERM</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function BlorbErrors::error is used in 3/sd (<a href="3-sd.html#SP3">&#167;3</a>, <a href="3-sd.html#SP5">&#167;5</a>).</p>
<p class="endnote">The function BlorbErrors::error_1 is used in 1/bp (<a href="1-bp.html#SP7_1">&#167;7.1</a>).</p>
<p class="endnote">The function BlorbErrors::error_1S is used in 1/bp (<a href="1-bp.html#SP7_1">&#167;7.1</a>, <a href="1-bp.html#SP7_2">&#167;7.2</a>), 3/rls (<a href="3-rls.html#SP6_7">&#167;6.7</a>, <a href="3-rls.html#SP9">&#167;9</a>), 3/plc (<a href="3-plc.html#SP6">&#167;6</a>).</p>
<p class="endnote">The function BlorbErrors::error_1f is used in 2/bw (<a href="2-bw.html#SP17">&#167;17</a>, <a href="2-bw.html#SP19">&#167;19</a>, <a href="2-bw.html#SP22">&#167;22</a>), 3/wm (<a href="3-wm.html#SP9">&#167;9</a>).</p>
<p class="endnote">The function BlorbErrors::errorf_1S is used in 3/rls (<a href="3-rls.html#SP6_4">&#167;6.4</a>), 3/tmp (<a href="3-tmp.html#SP6">&#167;6</a>).</p>
<p class="endnote">The function BlorbErrors::errorf_2S is used in 3/rls (<a href="3-rls.html#SP8_2_1">&#167;8.2.1</a>).</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. </b>As noted, errors are spooled to a placeholder variable, for the benefit of
the report:
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BlorbErrors::spool_error</span><span class="plain">(</span><span class="constant">OUTPUT_STREAM</span><span class="plain">) {</span>
<span class="functiontext">Placeholders::append_to</span><span class="plain">(</span><span class="identifier">I</span><span class="string">"CBLORBERRORS"</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"&lt;li&gt;"</span><span class="plain">);</span>
<span class="functiontext">Placeholders::append_to</span><span class="plain">(</span><span class="identifier">I</span><span class="string">"CBLORBERRORS"</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">);</span>
<span class="functiontext">Placeholders::append_to</span><span class="plain">(</span><span class="identifier">I</span><span class="string">"CBLORBERRORS"</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"&lt;/li&gt;"</span><span class="plain">);</span>
<span class="identifier">STREAM_COPY</span><span class="plain">(</span><span class="constant">STDERR</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">);</span>
<span class="identifier">error_count</span><span class="plain">++;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function BlorbErrors::spool_error is used in <a href="#SP2">&#167;2</a>, <a href="#SP3">&#167;3</a>.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="1-mn.html">Back to 'Main'</a></li><li><a href="1-bp.html">Continue with 'Blurb Parser'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>
Reference in a new issue View git blame Copy permalink