1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-05 16:44:21 +03:00
inform7/docs/words-test/1-bsc.html
2020-03-19 00:11:25 +00:00

132 lines
9.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Booklet Title</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">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html"><b>unit test tools</b></a></li>
</ul>
<h2>Unit Test Tools</h2>
<ul>
<li><a href="../inflections-test/index.html">inflections-test</a></li>
<li><a href="../kinds-test/index.html">kinds-test</a></li>
<li><a href="../linguistics-test/index.html">linguistics-test</a></li>
<li><a href="../problems-test/index.html">problems-test</a></li>
<li><a href="../syntax-test/index.html">syntax-test</a></li>
<li><a href="../words-test/index.html">words-test</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
<li><a href="../../../inweb/docs/foundation-test/index.html">foundation-test</a></li>
</ul>
</nav>
<main role="main">
<!--Weave of '1/bsc' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="../units.html">Unit Test Tools</a></li><li><a href="index.html">words-test</a></li><li><a href="index.html#1">Chapter 1: Everything</a></li><li><b>Basics</b></li></ul><p class="purpose">Some fundamental definitions.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Identity</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Identity. </b></p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">INTOOL_NAME</span><span class="plain"> </span><span class="string">"words-test"</span>
</pre>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>Since we want to include the words module, we have to define the following
structure and initialiser:
</p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">VOCABULARY_MEANING_INITIALISER</span><span class="plain"> </span><span class="functiontext">Basics::ignore</span>
</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">vocabulary_meaning</span><span class="plain"> {</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">enigmatic_number</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">vocabulary_meaning</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure vocabulary_meaning is private to this section.</p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b></p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">LEXER_PROBLEM_HANDLER</span><span class="plain"> </span><span class="functiontext">Basics::lexer_problem_handler</span>
</pre>
<pre class="display">
<span class="reserved">vocabulary_meaning</span><span class="plain"> </span><span class="functiontext">Basics::ignore</span><span class="plain">(</span><span class="reserved">vocabulary_entry</span><span class="plain"> *</span><span class="identifier">ve</span><span class="plain">) {</span>
<span class="reserved">vocabulary_meaning</span><span class="plain"> </span><span class="identifier">vm</span><span class="plain">;</span>
<span class="identifier">vm</span><span class="element">.enigmatic_number</span><span class="plain"> = 16339;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">vm</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Basics::lexer_problem_handler</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">err</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">problem_source_description</span><span class="plain">, </span><span class="identifier">wchar_t</span><span class="plain"> *</span><span class="identifier">word</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">err</span><span class="plain"> == </span><span class="constant">MEMORY_OUT_LEXERERROR</span><span class="plain">)</span>
<span class="functiontext">Errors::fatal</span><span class="plain">(</span><span class="string">"Out of memory: unable to create lexer workspace"</span><span class="plain">);</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">word_t</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">word</span><span class="plain">) </span><span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">word_t</span><span class="plain">, </span><span class="string">"%w"</span><span class="plain">, </span><span class="identifier">word</span><span class="plain">);</span>
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">err</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="constant">STRING_TOO_LONG_LEXERERROR</span><span class="plain">:</span>
<span class="functiontext">Errors::with_text</span><span class="plain">(</span><span class="string">"Too much text in quotation marks: %S"</span><span class="plain">, </span><span class="identifier">word_t</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">WORD_TOO_LONG_LEXERERROR</span><span class="plain">:</span>
<span class="functiontext">Errors::with_text</span><span class="plain">(</span><span class="string">"Word too long: %S"</span><span class="plain">, </span><span class="identifier">word_t</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">I6_TOO_LONG_LEXERERROR</span><span class="plain">:</span>
<span class="functiontext">Errors::with_text</span><span class="plain">(</span><span class="string">"I6 inclusion too long: %S"</span><span class="plain">, </span><span class="identifier">word_t</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">STRING_NEVER_ENDS_LEXERERROR</span><span class="plain">:</span>
<span class="functiontext">Errors::with_text</span><span class="plain">(</span><span class="string">"Quoted text never ends: %S"</span><span class="plain">, </span><span class="identifier">problem_source_description</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">COMMENT_NEVER_ENDS_LEXERERROR</span><span class="plain">:</span>
<span class="functiontext">Errors::with_text</span><span class="plain">(</span><span class="string">"Square-bracketed text never ends: %S"</span><span class="plain">, </span><span class="identifier">problem_source_description</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">I6_NEVER_ENDS_LEXERERROR</span><span class="plain">:</span>
<span class="functiontext">Errors::with_text</span><span class="plain">(</span><span class="string">"I6 inclusion text never ends: %S"</span><span class="plain">, </span><span class="identifier">problem_source_description</span><span class="plain">);</span>
<span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">default</span><span class="plain">:</span>
<span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"unknown lexer error"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">word_t</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Basics::ignore appears nowhere else.</p>
<p class="endnote">The function Basics::lexer_problem_handler appears nowhere else.</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. </b></p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">PREFORM_LANGUAGE_TYPE</span><span class="plain"> </span><span class="reserved">void</span>
</pre>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Chapter 1: Everything.)</i></li><li><a href="1-pc.html">Continue with 'Program Control'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>