1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-16 22:14:23 +03:00
inform7/docs/inbuild-module/2-ce.html

357 lines
44 KiB
HTML
Raw Normal View History

2020-03-29 19:39:17 +03:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>2/cps</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"><b>compiler tools</b></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="../inbuild-module/index.html">inbuild</a></li>
<li><a href="../arch-module/index.html">arch</a></li>
<li><a href="../words-module/index.html">words</a></li>
<li><a href="../syntax-module/index.html">syntax</a></li>
<li><a href="../html-module/index.html">html</a></li>
</ul>
<h2>Inform7 Modules</h2>
<ul>
<li><a href="../core-module/index.html">core</a></li>
<li><a href="../problems-module/index.html">problems</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="../index-module/index.html">index</a></li>
</ul>
<h2>Inter Modules</h2>
<ul>
<li><a href="../inter-module/index.html">inter</a></li>
<li><a href="../building-module/index.html">building</a></li>
<li><a href="../codegen-module/index.html">codegen</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 '2/ce' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="../compiler.html">Compiler Modules</a></li><li><a href="index.html">inbuild</a></li><li><a href="index.html#2">Chapter 2: Conceptual Framework</a></li><li><b>Copy Errors</b></li></ul><p class="purpose">A copy error is attached to a copy when scanning it reveals some malformation.</p>
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b>Copies can sometimes exist in a damaged form: for example, they are purportedly
extension files but have a mangled identification line. Each copy structure
therefore has a list attached of errors which occurred in reading it.
</p>
<p class="inwebparagraph">Each copy error has one of the following categories, and some are divided into
subcategories too. Otherwise an error has no real contents: only a ragbag of
contextual data &mdash; exactly what word it is that is too long, where the
sentence is which is mis-punctuated, and such. In every case most of these
fields are blank.
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">OPEN_FAILED_CE</span><span class="definitionkeyword"> from </span><span class="constant">1</span>
<span class="definitionkeyword">enum</span> <span class="constant">KIT_MISWORDED_CE</span>
<span class="definitionkeyword">enum</span> <span class="constant">EXT_MISWORDED_CE</span>
<span class="definitionkeyword">enum</span> <span class="constant">EXT_TITLE_TOO_LONG_CE</span>
<span class="definitionkeyword">enum</span> <span class="constant">EXT_AUTHOR_TOO_LONG_CE</span>
2020-04-07 03:06:09 +03:00
<span class="definitionkeyword">enum</span> <span class="constant">LEXER_CE</span><span class="plain"> </span><span class="comment">an error generated by the <code class="display"><span class="extract">words</span></code> module</span>
<span class="definitionkeyword">enum</span> <span class="constant">SYNTAX_CE</span><span class="plain"> </span><span class="comment">an error generated by the <code class="display"><span class="extract">syntax</span></code> module, or by our reading of the tree</span>
2020-03-29 19:39:17 +03:00
</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">copy_error</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inbuild_copy</span><span class="plain"> *</span><span class="identifier">copy</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">error_category</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">error_subcategory</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">details</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">details_file</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">details_N</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">details_W</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">details_node</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">details_node2</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">details_work</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">details_work2</span><span class="plain">;</span>
<span class="identifier">wchar_t</span><span class="plain"> *</span><span class="identifier">details_word</span><span class="plain">;</span>
<span class="identifier">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">copy_error</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
2020-03-31 02:17:21 +03:00
<p class="endnote">The structure copy_error is accessed in 2/nst, 3/is, 5/kts, 5/ls, 6/inc, 7/ed2, 7/ec and here.</p>
2020-03-29 19:39:17 +03:00
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>And now some creators.
</p>
<pre class="display">
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="functiontext">CopyErrors::new</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">cat</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">subcat</span><span class="plain">) {</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">copy_error</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">copy</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">error_category</span><span class="plain"> = </span><span class="identifier">cat</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">error_subcategory</span><span class="plain"> = </span><span class="identifier">subcat</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_file</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_N</span><span class="plain"> = -1;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_W</span><span class="plain"> = </span><span class="identifier">EMPTY_WORDING</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_node</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_node2</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_work</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_work2</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_word</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">CE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="functiontext">CopyErrors::new_T</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">cat</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">subcat</span><span class="plain">, </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">NB</span><span class="plain">) {</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain"> = </span><span class="functiontext">CopyErrors::new</span><span class="plain">(</span><span class="identifier">cat</span><span class="plain">, </span><span class="identifier">subcat</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</span><span class="plain"> = </span><span class="identifier">Str::duplicate</span><span class="plain">(</span><span class="identifier">NB</span><span class="plain">);</span>
2020-03-29 19:39:17 +03:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">CE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="functiontext">CopyErrors::new_N</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">cat</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">subcat</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">N</span><span class="plain">) {</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain"> = </span><span class="functiontext">CopyErrors::new</span><span class="plain">(</span><span class="identifier">cat</span><span class="plain">, </span><span class="identifier">subcat</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_N</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">CE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="functiontext">CopyErrors::new_F</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">cat</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">subcat</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="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain"> = </span><span class="functiontext">CopyErrors::new</span><span class="plain">(</span><span class="identifier">cat</span><span class="plain">, </span><span class="identifier">subcat</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_file</span><span class="plain"> = </span><span class="identifier">F</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">CE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="functiontext">CopyErrors::new_WT</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">cat</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">subcat</span><span class="plain">, </span><span class="identifier">wchar_t</span><span class="plain"> *</span><span class="identifier">details_word</span><span class="plain">, </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">NB</span><span class="plain">) {</span>
<span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain"> = </span><span class="functiontext">CopyErrors::new</span><span class="plain">(</span><span class="identifier">cat</span><span class="plain">, </span><span class="identifier">subcat</span><span class="plain">);</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_word</span><span class="plain"> = </span><span class="identifier">details_word</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</span><span class="plain"> = </span><span class="identifier">Str::duplicate</span><span class="plain">(</span><span class="identifier">NB</span><span class="plain">);</span>
2020-03-29 19:39:17 +03:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">CE</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
2020-04-01 22:43:13 +03:00
<p class="endnote">The function CopyErrors::new is used in 5/ps2 (<a href="5-ps2.html#SP7">&#167;7</a>), 6/st (<a href="6-st.html#SP12">&#167;12</a>), 6/hdn (<a href="6-hdn.html#SP13_1">&#167;13.1</a>, <a href="6-hdn.html#SP13_2">&#167;13.2</a>, <a href="6-hdn.html#SP23_1">&#167;23.1</a>, <a href="6-hdn.html#SP24_1">&#167;24.1</a>, <a href="6-hdn.html#SP23_3">&#167;23.3</a>), 6/inc (<a href="6-inc.html#SP3_1">&#167;3.1</a>, <a href="6-inc.html#SP6_1_2">&#167;6.1.2</a>, <a href="6-inc.html#SP7_1">&#167;7.1</a>, <a href="6-inc.html#SP9_1">&#167;9.1</a>, <a href="6-inc.html#SP11">&#167;11</a>).</p>
2020-03-29 19:39:17 +03:00
2020-04-01 22:43:13 +03:00
<p class="endnote">The function CopyErrors::new_T is used in 5/es (<a href="5-es.html#SP2_2">&#167;2.2</a>, <a href="5-es.html#SP2_2_3">&#167;2.2.3</a>, <a href="5-es.html#SP2_2_3_2">&#167;2.2.3.2</a>, <a href="5-es.html#SP2_3">&#167;2.3</a>), 5/kts (<a href="5-kts.html#SP5">&#167;5</a>, <a href="5-kts.html#SP5_1">&#167;5.1</a>, <a href="5-kts.html#SP5_3">&#167;5.3</a>), 6/hdn (<a href="6-hdn.html#SP23_2">&#167;23.2</a>), 6/inc (<a href="6-inc.html#SP6_1_1">&#167;6.1.1</a>, <a href="6-inc.html#SP6_1_2">&#167;6.1.2</a>).</p>
2020-03-29 19:39:17 +03:00
2020-03-31 02:17:21 +03:00
<p class="endnote">The function CopyErrors::new_N is used in 5/es (<a href="5-es.html#SP2_3">&#167;2.3</a>), 6/st (<a href="6-st.html#SP4">&#167;4</a>).</p>
2020-03-29 19:39:17 +03:00
2020-03-31 02:17:21 +03:00
<p class="endnote">The function CopyErrors::new_F is used in 5/es (<a href="5-es.html#SP2_2">&#167;2.2</a>), 6/st (<a href="6-st.html#SP1">&#167;1</a>).</p>
2020-03-29 19:39:17 +03:00
<p class="endnote">The function CopyErrors::new_WT is used in 6/st (<a href="6-st.html#SP2">&#167;2</a>).</p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>It becomes tiresome to make creators for every conceivable possibility, so
we also offer these functions to tack extra details on:
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">CopyErrors::supply_wording</span><span class="plain">(</span><span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain">, </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">details_W</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_W</span><span class="plain"> = </span><span class="identifier">details_W</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">CopyErrors::supply_work</span><span class="plain">(</span><span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain">, </span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">w</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_work</span><span class="plain"> = </span><span class="identifier">w</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">CopyErrors::supply_works</span><span class="plain">(</span><span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain">, </span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">w1</span><span class="plain">, </span><span class="reserved">inbuild_work</span><span class="plain"> *</span><span class="identifier">w2</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_work</span><span class="plain"> = </span><span class="identifier">w1</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_work2</span><span class="plain"> = </span><span class="identifier">w2</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">CopyErrors::supply_node</span><span class="plain">(</span><span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain">, </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">n</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_node</span><span class="plain"> = </span><span class="identifier">n</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">CopyErrors::supply_nodes</span><span class="plain">(</span><span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain">, </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">n1</span><span class="plain">, </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">n2</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_node</span><span class="plain"> = </span><span class="identifier">n1</span><span class="plain">;</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_node2</span><span class="plain"> = </span><span class="identifier">n2</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function CopyErrors::supply_wording is used in 6/st (<a href="6-st.html#SP4">&#167;4</a>), 6/hdn (<a href="6-hdn.html#SP23_2">&#167;23.2</a>), 6/inc (<a href="6-inc.html#SP11">&#167;11</a>).</p>
<p class="endnote">The function CopyErrors::supply_work is used in 6/hdn (<a href="6-hdn.html#SP23_1">&#167;23.1</a>, <a href="6-hdn.html#SP23_2">&#167;23.2</a>).</p>
<p class="endnote">The function CopyErrors::supply_works is used in 6/hdn (<a href="6-hdn.html#SP24_1">&#167;24.1</a>).</p>
2020-04-01 22:43:13 +03:00
<p class="endnote">The function CopyErrors::supply_node is used in 5/ps2 (<a href="5-ps2.html#SP7">&#167;7</a>), 6/st (<a href="6-st.html#SP12">&#167;12</a>), 6/hdn (<a href="6-hdn.html#SP13_1">&#167;13.1</a>, <a href="6-hdn.html#SP13_2">&#167;13.2</a>, <a href="6-hdn.html#SP23_1">&#167;23.1</a>, <a href="6-hdn.html#SP23_2">&#167;23.2</a>, <a href="6-hdn.html#SP23_3">&#167;23.3</a>), 6/inc (<a href="6-inc.html#SP3_1">&#167;3.1</a>, <a href="6-inc.html#SP6_1_1">&#167;6.1.1</a>, <a href="6-inc.html#SP6_1_2">&#167;6.1.2</a>, <a href="6-inc.html#SP7_1">&#167;7.1</a>, <a href="6-inc.html#SP9_1">&#167;9.1</a>, <a href="6-inc.html#SP11">&#167;11</a>).</p>
2020-03-29 19:39:17 +03:00
<p class="endnote">The function CopyErrors::supply_nodes is used in 6/hdn (<a href="6-hdn.html#SP24_1">&#167;24.1</a>).</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. </b>The following should only be called from Copies.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">CopyErrors::supply_attached_copy</span><span class="plain">(</span><span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain">, </span><span class="reserved">inbuild_copy</span><span class="plain"> *</span><span class="identifier">C</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">copy</span><span class="plain"> = </span><span class="identifier">C</span><span class="plain">;</span>
2020-03-29 19:39:17 +03:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function CopyErrors::supply_attached_copy is used in 2/cps (<a href="2-cps.html#SP5">&#167;5</a>).</p>
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. </b>This produces a textual summary of the issue described. It wouldn't do for
a proper Inform problem message, but it's fine for the Inbuild command line
output.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">CopyErrors::write</span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">, </span><span class="reserved">copy_error</span><span class="plain"> *</span><span class="identifier">CE</span><span class="plain">) {</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">error_category</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">OPEN_FAILED_CE:</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"unable to open file %f"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_file</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">EXT_MISWORDED_CE:</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension misworded: %S"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</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">KIT_MISWORDED_CE:</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"kit has incorrect metadata: %S"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</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">EXT_TITLE_TOO_LONG_CE:</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"title too long: %d characters (max is %d)"</span><span class="plain">,</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_N</span><span class="plain">, </span><span class="constant">MAX_EXTENSION_TITLE_LENGTH</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">EXT_AUTHOR_TOO_LONG_CE:</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"author name too long: %d characters (max is %d)"</span><span class="plain">,</span>
<span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_N</span><span class="plain">, </span><span class="constant">MAX_EXTENSION_AUTHOR_LENGTH</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">LEXER_CE:</span><span class="plain"> </span>&lt;<span class="cwebmacro">Write a lexer error</span> <span class="cwebmacronumber">5.1</span>&gt;<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">SYNTAX_CE:</span><span class="plain"> </span>&lt;<span class="cwebmacro">Write a syntax error</span> <span class="cwebmacronumber">5.2</span>&gt;<span class="plain">; </span><span class="reserved">break</span><span class="plain">;</span>
<span class="identifier">default:</span><span class="plain"> </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"an unknown error occurred"</span><span class="plain">);</span>
2020-03-29 19:39:17 +03:00
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
2020-03-31 02:17:21 +03:00
<p class="endnote">The function CopyErrors::write is used in 2/cps (<a href="2-cps.html#SP5">&#167;5</a>), 7/ec (<a href="7-ec.html#SP5">&#167;5</a>).</p>
2020-03-29 19:39:17 +03:00
<p class="inwebparagraph"><a id="SP5_1"></a><b>&#167;5.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Write a lexer error</span> <span class="cwebmacronumber">5.1</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-07 03:06:09 +03:00
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">error_subcategory</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">STRING_TOO_LONG_LEXERERROR:</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Too much text in quotation marks: %w"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_word</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">WORD_TOO_LONG_LEXERERROR:</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Word too long: %w"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_word</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">I6_TOO_LONG_LEXERERROR:</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"I6 inclusion too long: %w"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details_word</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">STRING_NEVER_ENDS_LEXERERROR:</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Quoted text never ends: %S"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</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">COMMENT_NEVER_ENDS_LEXERERROR:</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Square-bracketed text never ends: %S"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</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">I6_NEVER_ENDS_LEXERERROR:</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"I6 inclusion text never ends: %S"</span><span class="plain">, </span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">details</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
<span class="identifier">default:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"lexer error"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP5">&#167;5</a>.</p>
<p class="inwebparagraph"><a id="SP5_2"></a><b>&#167;5.2. </b><code class="display">
&lt;<span class="cwebmacrodefn">Write a syntax error</span> <span class="cwebmacronumber">5.2</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-07 03:06:09 +03:00
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">CE</span><span class="plain">-&gt;</span><span class="element">error_subcategory</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">UnexpectedSemicolon_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"unexpected semicolon in sentence"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ParaEndsInColon_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"paragraph ends with a colon"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">SentenceEndsInColon_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"paragraph ends with a colon and full stop"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">SentenceEndsInSemicolon_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"paragraph ends with a semicolon and full stop"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">SemicolonAfterColon_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"paragraph ends with a colon and semicolon"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">SemicolonAfterStop_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"paragraph ends with a full stop and semicolon"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">HeadingOverLine_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"heading contains a line break"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">HeadingStopsBeforeEndOfLine_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"heading stops before end of line"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtNoBeginsHere_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension has no beginning"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtNoEndsHere_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension has no end"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtSpuriouslyContinues_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension continues after end"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtMultipleBeginsHere_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension has multiple 'begins here' sentences"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtBeginsAfterEndsHere_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension has a 'begins here' after its 'ends here'"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtEndsWithoutBegins_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension has an 'ends here' but no 'begins here'"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtMultipleEndsHere_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension has multiple 'ends here' sentences"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">BadTitleSentence_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"bibliographic sentence at the start is malformed"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">UnknownLanguageElement_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"unrecognised stipulation about Inform language elements"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">UnknownVirtualMachine_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"unrecognised stipulation about virtual machine"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">UseElementWithdrawn_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"use language element is no longer supported"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">IncludeExtQuoted_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension name should not be double-quoted"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">BogusExtension_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"can't find this extension"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtVersionTooLow_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension version too low"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtVersionMalformed_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension version is malformed"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtInadequateVM_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension is not compatible with the target virtual machine"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ExtMisidentifiedEnds_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"extension has an 'ends here' which doesn't match the 'begins here'"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">HeadingInPlaceOfUnincluded_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"heading is in place of an extension not included"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">UnequalHeadingInPlaceOf_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"heading is in place of another heading but of a diffeent level"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">HeadingInPlaceOfSubordinate_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"heading is in place of another heading subordinate to itself"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">HeadingInPlaceOfUnknown_SYNERROR:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"heading is in place of another heading which doesn't exist'"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">default:</span>
2020-03-29 19:39:17 +03:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"syntax error"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP5">&#167;5</a>.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="2-cps.html">Back to 'Copies'</a></li><li><a href="2-rqr.html">Continue with 'Requirements'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>