1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 18:14:21 +03:00
inform7/docs/inter-module/3-ie.html
2019-08-04 13:04:42 +01:00

165 lines
24 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>3/idt</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 '3/ie' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">inter</a></li><li><a href="index.html#3">Chapter 3: Language Definition</a></li><li><b>Inter Errors</b></li></ul><p class="purpose">To issue error messages.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Reading textual inter</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Reading textual inter. </b></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">inter_error_location</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">text_file_position</span><span class="plain"> *</span><span class="identifier">error_tfp</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">error_line</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">error_interb</span><span class="plain">;</span>
<span class="identifier">size_t</span><span class="plain"> </span><span class="identifier">error_offset</span><span class="plain">;</span>
<span class="identifier">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">inter_error_location</span><span class="plain">;</span>
<span class="reserved">inter_error_location</span><span class="plain"> </span><span class="functiontext">Inter::Errors::file_location</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">line</span><span class="plain">, </span><span class="identifier">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
<span class="reserved">inter_error_location</span><span class="plain"> </span><span class="identifier">eloc</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_tfp</span><span class="plain"> = </span><span class="identifier">tfp</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_line</span><span class="plain"> = </span><span class="identifier">line</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_interb</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_offset</span><span class="plain"> = 0;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">eloc</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">inter_error_location</span><span class="plain"> </span><span class="functiontext">Inter::Errors::interb_location</span><span class="plain">(</span><span class="identifier">filename</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain">, </span><span class="identifier">size_t</span><span class="plain"> </span><span class="identifier">at</span><span class="plain">) {</span>
<span class="reserved">inter_error_location</span><span class="plain"> </span><span class="identifier">eloc</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_tfp</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_line</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_interb</span><span class="plain"> = </span><span class="identifier">F</span><span class="plain">;</span>
<span class="identifier">eloc</span><span class="element">.error_offset</span><span class="plain"> = </span><span class="identifier">at</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">eloc</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inter_error_message</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inter_error_location</span><span class="plain"> </span><span class="identifier">error_at</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">error_body</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">error_quote</span><span class="plain">;</span>
<span class="identifier">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">inter_error_message</span><span class="plain">;</span>
<span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="functiontext">Inter::Errors::quoted</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">err</span><span class="plain">, </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">quote</span><span class="plain">, </span><span class="reserved">inter_error_location</span><span class="plain"> *</span><span class="identifier">eloc</span><span class="plain">) {</span>
<span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="identifier">iem</span><span class="plain"> = </span><span class="functiontext">Inter::Errors::plain</span><span class="plain">(</span><span class="identifier">err</span><span class="plain">, </span><span class="identifier">eloc</span><span class="plain">);</span>
<span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_quote</span><span class="plain"> = </span><span class="identifier">Str::duplicate</span><span class="plain">(</span><span class="identifier">quote</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">iem</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="functiontext">Inter::Errors::plain</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">err</span><span class="plain">, </span><span class="reserved">inter_error_location</span><span class="plain"> *</span><span class="identifier">eloc</span><span class="plain">) {</span>
<span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="identifier">iem</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">inter_error_message</span><span class="plain">);</span>
<span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_body</span><span class="plain"> = </span><span class="identifier">Str::duplicate</span><span class="plain">(</span><span class="identifier">err</span><span class="plain">);</span>
<span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_quote</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">eloc</span><span class="plain">) </span><span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_at</span><span class="plain"> = *</span><span class="identifier">eloc</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">iem</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Inter::Errors::issue</span><span class="plain">(</span><span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="identifier">iem</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">iem</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no error to issue"</span><span class="plain">);</span>
<span class="functiontext">Inter::Errors::issue_to</span><span class="plain">(</span><span class="identifier">STDERR</span><span class="plain">, </span><span class="identifier">iem</span><span class="plain">);</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">CORE_MODULE</span>
<span class="identifier">LOG</span><span class="plain">(</span><span class="string">"Inter error:\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
<span class="functiontext">Inter::Errors::issue_to</span><span class="plain">(</span><span class="identifier">DL</span><span class="plain">, </span><span class="identifier">iem</span><span class="plain">);</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Inter::Errors::issue_to</span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">, </span><span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="identifier">iem</span><span class="plain">) {</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">, </span><span class="string">"%S"</span><span class="plain">, </span><span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_body</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_quote</span><span class="plain">)</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">, </span><span class="string">": '%S'"</span><span class="plain">, </span><span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_quote</span><span class="plain">);</span>
<span class="reserved">inter_error_location</span><span class="plain"> </span><span class="identifier">eloc</span><span class="plain"> = </span><span class="identifier">iem</span><span class="plain">-</span><span class="element">&gt;error_at</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">eloc</span><span class="element">.error_interb</span><span class="plain">) {</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%f, position %08x: "</span><span class="plain">, </span><span class="identifier">eloc</span><span class="element">.error_interb</span><span class="plain">, </span><span class="identifier">eloc</span><span class="element">.error_offset</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">eloc</span><span class="element">.error_tfp</span><span class="plain">)</span>
<span class="identifier">Errors::in_text_file_S</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">, </span><span class="identifier">eloc</span><span class="element">.error_tfp</span><span class="plain">);</span>
<span class="reserved">else</span>
<span class="identifier">Errors::in_text_file_S</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">eloc</span><span class="element">.error_line</span><span class="plain">)</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"&gt;--&gt; %S\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">eloc</span><span class="element">.error_line</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">E</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="functiontext">Inter::Errors::gather_first</span><span class="plain">(</span><span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="identifier">E</span><span class="plain">, </span><span class="reserved">inter_error_message</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">E</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">E</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">F</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Inter::Errors::file_location is used in 2/in (<a href="2-in.html#SP6">&#167;6</a>), 2/tw (<a href="2-tw.html#SP3">&#167;3</a>), 3/iitf (<a href="3-iitf.html#SP1">&#167;1</a>).</p>
<p class="endnote">The function Inter::Errors::interb_location is used in 2/tw (<a href="2-tw.html#SP3">&#167;3</a>), 3/iibf (<a href="3-iibf.html#SP1">&#167;1</a>).</p>
<p class="endnote">The function Inter::Errors::quoted is used in 2/st (<a href="2-st.html#SP10">&#167;10</a>), 3/iitf (<a href="3-iitf.html#SP1">&#167;1</a>), 3/idt (<a href="3-idt.html#SP3">&#167;3</a>), 4/tmc (<a href="4-tmc.html#SP2">&#167;2</a>), 4/tpc (<a href="4-tpc.html#SP2">&#167;2</a>), 4/tkc (<a href="4-tkc.html#SP2">&#167;2</a>), 4/tcc2 (<a href="4-tcc2.html#SP2">&#167;2</a>), 4/tic (<a href="4-tic.html#SP2">&#167;2</a>), 4/tpc5 (<a href="4-tpc5.html#SP2">&#167;2</a>), 4/tpc6 (<a href="4-tpc6.html#SP2">&#167;2</a>), 4/tpc7 (<a href="4-tpc7.html#SP2">&#167;2</a>), 5/tic (<a href="5-tic.html#SP2">&#167;2</a>).</p>
<p class="endnote">The function Inter::Errors::plain is used in 3/dfn (<a href="3-dfn.html#SP3">&#167;3</a>, <a href="3-dfn.html#SP4">&#167;4</a>), 3/iibf (<a href="3-iibf.html#SP3">&#167;3</a>), 4/tcc (<a href="4-tcc.html#SP1">&#167;1</a>), 4/tsc (<a href="4-tsc.html#SP1">&#167;1</a>), 4/tvc (<a href="4-tvc.html#SP2">&#167;2</a>), 4/tpc (<a href="4-tpc.html#SP2">&#167;2</a>), 4/tlc (<a href="4-tlc.html#SP2">&#167;2</a>), 4/tac (<a href="4-tac.html#SP2">&#167;2</a>), 4/tpc2 (<a href="4-tpc2.html#SP2">&#167;2</a>), 4/tkc (<a href="4-tkc.html#SP2">&#167;2</a>), 4/tcc2 (<a href="4-tcc2.html#SP2">&#167;2</a>), 4/trc (<a href="4-trc.html#SP2">&#167;2</a>), 4/tic (<a href="4-tic.html#SP2">&#167;2</a>), 4/tpc5 (<a href="4-tpc5.html#SP2">&#167;2</a>), 4/tpc6 (<a href="4-tpc6.html#SP2">&#167;2</a>), 4/tpc7 (<a href="4-tpc7.html#SP2">&#167;2</a>), 5/tlc (<a href="5-tlc.html#SP2">&#167;2</a>), 5/tlc2 (<a href="5-tlc2.html#SP2">&#167;2</a>), 5/tic (<a href="5-tic.html#SP2">&#167;2</a>), 5/trc (<a href="5-trc.html#SP2">&#167;2</a>), 5/tvc (<a href="5-tvc.html#SP2">&#167;2</a>), 5/tlc3 (<a href="5-tlc3.html#SP2">&#167;2</a>), 5/tcc (<a href="5-tcc.html#SP2">&#167;2</a>), 5/tec (<a href="5-tec.html#SP2">&#167;2</a>), 5/trc2 (<a href="5-trc2.html#SP2">&#167;2</a>), 5/tcc2 (<a href="5-tcc2.html#SP2">&#167;2</a>), 5/tsc (<a href="5-tsc.html#SP2">&#167;2</a>).</p>
<p class="endnote">The function Inter::Errors::issue is used in 2/st (<a href="2-st.html#SP10">&#167;10</a>), 2/trn (<a href="2-trn.html#SP3_1_1">&#167;3.1.1</a>), 3/iibf (<a href="3-iibf.html#SP1_6">&#167;1.6</a>, <a href="3-iibf.html#SP3">&#167;3</a>), 3/iitf (<a href="3-iitf.html#SP1">&#167;1</a>, <a href="3-iitf.html#SP2">&#167;2</a>).</p>
<p class="endnote">The function Inter::Errors::issue_to appears nowhere else.</p>
<p class="endnote">The function Inter::Errors::gather_first appears nowhere else.</p>
<p class="endnote">The structure inter_error_location is accessed in 2/tw, 3/iibf and here.</p>
<p class="endnote">The structure inter_error_message is accessed in 2/in and here.</p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b></p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Inter::Errors::backtrace</span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">, </span><span class="reserved">inter_tree_node</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain">) {</span>
<span class="reserved">inter_tree_node</span><span class="plain"> *</span><span class="identifier">X</span><span class="plain"> = </span><span class="identifier">F</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">n</span><span class="plain"> = 0;</span>
<span class="reserved">while</span><span class="plain"> (</span><span class="identifier">TRUE</span><span class="plain">) {</span>
<span class="identifier">X</span><span class="plain"> = </span><span class="functiontext">Inter::Tree::parent</span><span class="plain">(</span><span class="identifier">X</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">X</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">break</span><span class="plain">;</span>
<span class="identifier">n</span><span class="plain">++;</span>
<span class="plain">}</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">i</span><span class="plain"> = </span><span class="identifier">n</span><span class="plain">; </span><span class="identifier">i</span><span class="plain"> &gt;= 0; </span><span class="identifier">i</span><span class="plain">--) {</span>
<span class="reserved">inter_tree_node</span><span class="plain"> *</span><span class="identifier">X</span><span class="plain"> = </span><span class="identifier">F</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">m</span><span class="plain"> = 0;</span>
<span class="reserved">while</span><span class="plain"> (</span><span class="identifier">TRUE</span><span class="plain">) {</span>
<span class="reserved">inter_tree_node</span><span class="plain"> *</span><span class="identifier">Y</span><span class="plain"> = </span><span class="functiontext">Inter::Tree::parent</span><span class="plain">(</span><span class="identifier">X</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Y</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">m</span><span class="plain"> == </span><span class="identifier">i</span><span class="plain">) {</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%2d. "</span><span class="plain">, (</span><span class="identifier">n</span><span class="plain">-</span><span class="identifier">i</span><span class="plain">));</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">i</span><span class="plain"> == 0) </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"** "</span><span class="plain">); </span><span class="reserved">else</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">" "</span><span class="plain">);</span>
<span class="functiontext">Inter::Defn::write_construct_text_allowing_nop</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">X</span><span class="plain">);</span>
<span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">X</span><span class="plain"> = </span><span class="identifier">Y</span><span class="plain">;</span>
<span class="identifier">m</span><span class="plain">++;</span>
<span class="plain">}</span>
<span class="plain">}</span>
<span class="identifier">LOOP_THROUGH_INTER_CHILDREN</span><span class="plain">(</span><span class="identifier">C</span><span class="plain">, </span><span class="identifier">F</span><span class="plain">) {</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%2d. "</span><span class="plain">, (</span><span class="identifier">n</span><span class="plain">+1));</span>
<span class="functiontext">Inter::Defn::write_construct_text_allowing_nop</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">C</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Inter::Errors::backtrace is used in 3/dfn (<a href="3-dfn.html#SP4">&#167;4</a>).</p>
<hr class="tocbar">
<ul class="toc"><li><a href="3-idt.html">Back to 'Inter Data Types'</a></li><li><i>(This section ends Chapter 3: Language Definition.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>