1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-05 16:44:21 +03:00
inform7/docs/linguistics-module/1-lm.html

267 lines
21 KiB
HTML
Raw Normal View History

2019-03-17 14:40:57 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Booklet Title</title>
2020-03-19 02:11:25 +02:00
<meta name="viewport" content="width=device-width initial-scale=1">
2019-03-17 14:40:57 +02:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
2020-03-19 02:11:25 +02:00
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
2019-03-17 14:40:57 +02:00
</head>
<body>
2020-03-19 02:11:25 +02:00
<nav role="navigation">
<h1><a href="../webs.html">Sources</a></h1>
<ul>
<li><a href="../compiler.html"><b>compiler tools</b></a></li>
2020-03-19 02:11:25 +02:00
<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">
2019-03-17 14:40:57 +02:00
<!--Weave of '1/lm' generated by 7-->
2020-03-22 12:50:19 +02:00
<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">linguistics</a></li><li><a href="index.html#1">Chapter 1: Setting Up</a></li><li><b>Linguistics Module</b></li></ul><p class="purpose">Setting up the use of this module.</p>
2019-03-17 14:40:57 +02:00
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b>This section simoly sets up the module in ways expected by <code class="display"><span class="extract">foundation</span></code>, and
contains no code of interest. The following constant exists only in tools
which use this module:
</p>
2019-03-17 14:40:57 +02:00
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">LINGUISTICS_MODULE</span><span class="plain"> </span><span class="identifier">TRUE</span>
</pre>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>To begin with, this module needs to allocate memory:
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">adjectival_phrase_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">adjective_usage_array_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">quantifier_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">determiner_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_identity_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_form_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_meaning_array_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_sense_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_usage_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_usage_tier_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">preposition_identity_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">time_period_array_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">excerpt_meaning_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">noun_MT</span>
</pre>
<pre class="display">
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">adjectival_phrase</span><span class="plain">)</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">adjective_usage</span><span class="plain">, </span><span class="constant">1000</span><span class="plain">)</span>
2019-03-17 14:40:57 +02:00
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">quantifier</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">determiner</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">verb_identity</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">verb_form</span><span class="plain">)</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">verb_meaning</span><span class="plain">, </span><span class="constant">100</span><span class="plain">)</span>
2019-03-17 14:40:57 +02:00
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">verb_sense</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">verb_usage</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">verb_usage_tier</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">preposition_identity</span><span class="plain">)</span>
2020-04-07 03:06:09 +03:00
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">time_period</span><span class="plain">, </span><span class="constant">100</span><span class="plain">)</span>
2019-03-17 14:40:57 +02:00
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">excerpt_meaning</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">noun</span><span class="plain">)</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>Like all modules, this one must define a <code class="display"><span class="extract">start</span></code> and <code class="display"><span class="extract">end</span></code> function:
2019-03-17 14:40:57 +02:00
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">LinguisticsModule::start</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
&lt;<span class="cwebmacro">Register this module's memory allocation reasons</span> <span class="cwebmacronumber">3.1</span>&gt;<span class="character">;</span>
&lt;<span class="cwebmacro">Register this module's stream writers</span> <span class="cwebmacronumber">3.2</span>&gt;<span class="character">;</span>
&lt;<span class="cwebmacro">Register this module's debugging log aspects</span> <span class="cwebmacronumber">3.4</span>&gt;<span class="character">;</span>
&lt;<span class="cwebmacro">Register this module's debugging log writers</span> <span class="cwebmacronumber">3.5</span>&gt;<span class="character">;</span>
2019-03-17 14:40:57 +02:00
<span class="functiontext">Cardinals::enable_in_word_form</span><span class="plain">();</span>
<span class="functiontext">Articles::mark_for_preform</span><span class="plain">();</span>
<span class="functiontext">Prepositions::mark_for_preform</span><span class="plain">();</span>
<span class="functiontext">Diagrams::setup</span><span class="plain">();</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">LinguisticsModule::end</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="plain">}</span>
2019-03-17 14:40:57 +02:00
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function LinguisticsModule::start appears nowhere else.</p>
<p class="endnote">The function LinguisticsModule::end appears nowhere else.</p>
2019-03-17 14:40:57 +02:00
<p class="inwebparagraph"><a id="SP3_1"></a><b>&#167;3.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's memory allocation reasons</span> <span class="cwebmacronumber">3.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP3_2"></a><b>&#167;3.2. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's stream writers</span> <span class="cwebmacronumber">3.2</span>&gt; =
2019-03-17 14:40:57 +02:00
</code></p>
<pre class="displaydefn">
<span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP3_3"></a><b>&#167;3.3. </b></p>
2019-03-17 14:40:57 +02:00
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">EXCERPT_MEANINGS_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">EXCERPT_PARSING_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">TIME_PERIODS_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">VERB_USAGES_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">VERB_FORMS_DA</span>
</pre>
<p class="inwebparagraph"><a id="SP3_4"></a><b>&#167;3.4. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's debugging log aspects</span> <span class="cwebmacronumber">3.4</span>&gt; =
2019-03-17 14:40:57 +02:00
</code></p>
<pre class="displaydefn">
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">TIME_PERIODS_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"time periods"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">VERB_USAGES_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"verb usages"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">VERB_FORMS_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"verb forms"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">EXCERPT_MEANINGS_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"excerpt meanings"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">EXCERPT_PARSING_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"excerpt parsing"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP3_5"></a><b>&#167;3.5. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's debugging log writers</span> <span class="cwebmacronumber">3.5</span>&gt; =
2019-03-17 14:40:57 +02:00
</code></p>
<pre class="displaydefn">
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'M'</span><span class="plain">, </span><span class="functiontext">ExcerptMeanings::log</span><span class="plain">);</span>
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'t'</span><span class="plain">, </span><span class="functiontext">Occurrence::log</span><span class="plain">);</span>
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'p'</span><span class="plain">, </span><span class="functiontext">Prepositions::log</span><span class="plain">);</span>
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'w'</span><span class="plain">, </span><span class="functiontext">Verbs::log_verb</span><span class="plain">);</span>
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'y'</span><span class="plain">, </span><span class="functiontext">VerbMeanings::log</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. </b>This module uses <code class="display"><span class="extract">syntax</span></code>, and adds the following annotations to the
syntax tree.
</p>
2019-03-17 14:40:57 +02:00
<pre class="definitions">
2020-04-07 03:06:09 +03:00
<span class="definitionkeyword">enum</span> <span class="constant">meaning_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">excerpt_meaning</span></code>: for leaves</span>
<span class="definitionkeyword">enum</span> <span class="constant">verbal_certainty_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: certainty level if known</span>
<span class="definitionkeyword">enum</span> <span class="constant">sentence_is_existential_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: such as "there is a man"</span>
<span class="definitionkeyword">enum</span> <span class="constant">linguistic_error_here_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: one of the errors occurred here</span>
<span class="definitionkeyword">enum</span> <span class="constant">inverted_verb_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: an inversion of subject and object has occurred</span>
<span class="definitionkeyword">enum</span> <span class="constant">possessive_verb_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: this is a non-relative use of "to have"</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">verb_usage</span></code>: what's being done here</span>
<span class="definitionkeyword">enum</span> <span class="constant">preposition_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">preposition_identity</span></code>: which preposition, if any, qualifies it</span>
<span class="definitionkeyword">enum</span> <span class="constant">second_preposition_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">preposition_identity</span></code>: which further preposition, if any, qualifies it</span>
<span class="definitionkeyword">enum</span> <span class="constant">verb_meaning_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">verb_meaning</span></code>: what it means</span>
<span class="definitionkeyword">enum</span> <span class="constant">nounphrase_article_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: definite or indefinite article: see below</span>
<span class="definitionkeyword">enum</span> <span class="constant">plural_reference_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: used by PROPER NOUN nodes for evident plurals</span>
<span class="definitionkeyword">enum</span> <span class="constant">gender_reference_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: used by PROPER NOUN nodes for evident genders</span>
<span class="definitionkeyword">enum</span> <span class="constant">relationship_node_type_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: what kind of inference this assertion makes</span>
<span class="definitionkeyword">enum</span> <span class="constant">implicitly_refers_to_ANNOT</span><span class="plain"> </span><span class="comment"><code class="display"><span class="extract">int</span></code>: this will implicitly refer to something</span>
2019-03-17 14:40:57 +02:00
</pre>
<pre class="display">
<span class="identifier">DECLARE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">meaning</span><span class="plain">, </span><span class="reserved">excerpt_meaning</span><span class="plain">)</span>
<span class="identifier">DECLARE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">verb</span><span class="plain">, </span><span class="reserved">verb_usage</span><span class="plain">)</span>
<span class="identifier">DECLARE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">preposition</span><span class="plain">, </span><span class="reserved">preposition_identity</span><span class="plain">)</span>
<span class="identifier">DECLARE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">second_preposition</span><span class="plain">, </span><span class="reserved">preposition_identity</span><span class="plain">)</span>
<span class="identifier">DECLARE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="reserved">verb_meaning</span><span class="plain">, </span><span class="reserved">verb_meaning</span><span class="plain">)</span>
<span class="identifier">MAKE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">meaning</span><span class="plain">, </span><span class="reserved">excerpt_meaning</span><span class="plain">)</span>
<span class="identifier">MAKE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">verb</span><span class="plain">, </span><span class="reserved">verb_usage</span><span class="plain">)</span>
<span class="identifier">MAKE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">preposition</span><span class="plain">, </span><span class="reserved">preposition_identity</span><span class="plain">)</span>
<span class="identifier">MAKE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="identifier">second_preposition</span><span class="plain">, </span><span class="reserved">preposition_identity</span><span class="plain">)</span>
<span class="identifier">MAKE_ANNOTATION_FUNCTIONS</span><span class="plain">(</span><span class="reserved">verb_meaning</span><span class="plain">, </span><span class="reserved">verb_meaning</span><span class="plain">)</span>
</pre>
2019-03-17 14:40:57 +02:00
<p class="inwebparagraph"></p>
2019-03-17 14:40:57 +02:00
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. </b>This module requires <code class="display"><span class="extract">words</span></code>, which contains the Preform parser. When that
initialises, it calls the following routine to improve its performance.
</p>
2019-03-17 14:40:57 +02:00
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">LinguisticsModule::preform_optimiser</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="functiontext">Cardinals::preform_optimiser</span><span class="plain">();</span>
<span class="functiontext">VerbUsages::preform_optimiser</span><span class="plain">();</span>
<span class="functiontext">Prepositions::preform_optimiser</span><span class="plain">();</span>
<span class="functiontext">Quantifiers::make_built_in</span><span class="plain">();</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function LinguisticsModule::preform_optimiser appears nowhere else.</p>
<hr class="tocbar">
2019-04-22 17:42:10 +03:00
<!--End of weave-->
2020-03-19 02:11:25 +02:00
</main>
2019-03-17 14:40:57 +02:00
</body>
</html>