mirror of
https://github.com/ganelson/inform.git
synced 2024-07-03 07:24:58 +03:00
186 lines
14 KiB
HTML
186 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>How To Include This Module</title>
|
|
<link href="../docs-assets/Breadcrumbs.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<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="../docs-assets/Contents.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Progress.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Navigation.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Fonts.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Base.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
<link href="../docs-assets/Colours.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
|
|
</head>
|
|
<body class="commentary-font">
|
|
<nav role="navigation">
|
|
<h1><a href="../index.html">
|
|
<img src="../docs-assets/Inform.png" height=72">
|
|
</a></h1>
|
|
<ul><li><a href="../compiler.html">compiler tools</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="../supervisor-module/index.html">supervisor</a></li>
|
|
</ul><h2>Inform7 Modules</h2><ul>
|
|
<li><a href="../core-module/index.html">core</a></li>
|
|
<li><a href="../assertions-module/index.html">assertions</a></li>
|
|
<li><a href="../values-module/index.html">values</a></li>
|
|
<li><a href="../knowledge-module/index.html">knowledge</a></li>
|
|
<li><a href="../imperative-module/index.html">imperative</a></li>
|
|
<li><a href="../runtime-module/index.html">runtime</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="../bytecode-module/index.html">bytecode</a></li>
|
|
<li><a href="../building-module/index.html">building</a></li>
|
|
<li><a href="../pipeline-module/index.html">pipeline</a></li>
|
|
<li><a href="../final-module/index.html">final</a></li>
|
|
</ul><h2>Services</h2><ul>
|
|
<li><a href="../arch-module/index.html">arch</a></li>
|
|
<li><a href="../calculus-module/index.html">calculus</a></li>
|
|
<li><a href="../html-module/index.html">html</a></li>
|
|
<li><a href="../inflections-module/index.html">inflections</a></li>
|
|
<li><a href="../kinds-module/index.html">kinds</a></li>
|
|
<li><a href="index.html"><span class="selectedlink">linguistics</span></a></li>
|
|
<li><a href="../problems-module/index.html">problems</a></li>
|
|
<li><a href="../syntax-module/index.html">syntax</a></li>
|
|
<li><a href="../words-module/index.html">words</a></li>
|
|
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
<main role="main">
|
|
<!--Weave of 'How To Include This Module' generated by Inweb-->
|
|
<div class="breadcrumbs">
|
|
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../compiler.html">Services</a></li><li><a href="index.html">linguistics</a></li><li><a href="index.html#P">Preliminaries</a></li><li><b>How To Include This Module</b></li></ul></div>
|
|
<p class="purpose">What to do to make use of the linguistics module in a new command-line tool.</p>
|
|
|
|
<ul class="toc"><li><a href="P-htitm.html#SP1">§1. Status</a></li><li><a href="P-htitm.html#SP2">§2. Importing the module</a></li><li><a href="P-htitm.html#SP3">§3. Meaning types</a></li><li><a href="P-htitm.html#SP4">§4. Using callbacks</a></li></ul><hr class="tocbar">
|
|
|
|
<p class="commentary firstcommentary"><a id="SP1" class="paragraph-anchor"></a><b>§1. Status. </b>The linguistics module is provided as one of the "services" suite of modules,
|
|
which means that it was built with a view to potential incorporation in
|
|
multiple tools. It can be found, for example, in <a href="../inform7/index.html" class="internal">inform7</a> and
|
|
<a href="../linguistics-test/index.html" class="internal">linguistics-test</a>.
|
|
</p>
|
|
|
|
<p class="commentary">By convention, the modules considered as "services" have no dependencies on
|
|
other modules except for <a href="../../../inweb/docs/foundation-module/index.html" class="internal">foundation</a> and other "services" modules.
|
|
</p>
|
|
|
|
<p class="commentary">A tool can import <a href="index.html" class="internal">linguistics</a> only if it also imports <a href="../../../inweb/docs/foundation-module/index.html" class="internal">foundation</a>,
|
|
<a href="../words-module/index.html" class="internal">words</a>, <a href="../syntax-module/index.html" class="internal">syntax</a>, <a href="../inflections-module/index.html" class="internal">inflections</a> and <a href="../lexicon-module/index.html" class="internal">lexicon</a>.
|
|
</p>
|
|
|
|
<p class="commentary firstcommentary"><a id="SP2" class="paragraph-anchor"></a><b>§2. Importing the module. </b>We'll use the term "parent" to mean the tool which is importing <a href="index.html" class="internal">linguistics</a>,
|
|
that is, which will include its code and be able to use it. As with any
|
|
imported module,
|
|
</p>
|
|
|
|
<ul class="items"><li>● The contents page of the parent's web must identify and locate the
|
|
module:
|
|
</li></ul>
|
|
<pre class="displayed-code all-displayed-code code-font">
|
|
<span class="element-syntax">Import</span><span class="plain-syntax">:</span><span class="string-syntax"> somepath/linguistics</span>
|
|
</pre>
|
|
<ul class="items"><li>● The parent must call <span class="extract"><span class="extract-syntax">InflectionsModule::start()</span></span> just after it starts up, and
|
|
<span class="extract"><span class="extract-syntax">InflectionsModule::end()</span></span> just before it shuts down. (But just after, and just
|
|
before, the corresponding calls to <a href="../../../inweb/docs/foundation-module/index.html" class="internal">foundation</a>.)
|
|
</li></ul>
|
|
<p class="commentary firstcommentary"><a id="SP3" class="paragraph-anchor"></a><b>§3. Meaning types. </b>This module tries to be agnostic about the actual meanings of words: it knows
|
|
about verbs, but not about what any specific verb means. The idea is that the
|
|
parent tool specifies that, with some type of its own. The constant
|
|
<span class="extract"><span class="extract-syntax">VERB_MEANING_LINGUISTICS_TYPE</span></span> should be defined to what this actually is;
|
|
it should be the name of a class of objects. (If it isn't defined, then no
|
|
meaning is attached to verbs at all.)
|
|
</p>
|
|
|
|
<p class="commentary">For example, the <a href="../core-module/index.html" class="internal">core</a> module sets:
|
|
</p>
|
|
|
|
<pre class="displayed-code all-displayed-code code-font">
|
|
<span class="plain-syntax"> </span><span class="function-syntax">@d</span><span class="plain-syntax"> VERB_MEANING_LINGUISTICS_TYPE struct binary_predicate</span>
|
|
</pre>
|
|
<p class="commentary">The parent may also want to define <span class="extract"><span class="extract-syntax">VERB_MEANING_UNIVERSAL_CALCULUS_RELATION</span></span>,
|
|
which should be a value of this type, and represents the "to relate" verb which
|
|
can assert any verb meaning — for example, "X relates to Y by R". See <a href="3-vu.html" class="internal">Verb Usages</a>.
|
|
</p>
|
|
|
|
<p class="commentary firstcommentary"><a id="SP4" class="paragraph-anchor"></a><b>§4. Using callbacks. </b>Shared modules like this one are tweaked in behaviour by defining "callback
|
|
functions". This means that the parent might provide a function of its own
|
|
which would answer a question put to it by the module, or take some action
|
|
on behalf of the module: it's a callback in the sense that the parent is
|
|
normally calling the module, but then the module calls the parent back to
|
|
ask for data or action.
|
|
</p>
|
|
|
|
<p class="commentary">The parent must indicate which function to use by defining a constant with
|
|
a specific name as being equal to that function's name. A fictional example
|
|
would be
|
|
</p>
|
|
|
|
<pre class="displayed-code all-displayed-code code-font">
|
|
<span class="plain-syntax"> </span><span class="function-syntax">@d</span><span class="plain-syntax"> EXPRESS_SURPRISE_LINGUISTICS_CALLBACK Emotions::gosh</span>
|
|
|
|
<span class="plain-syntax"> =</span>
|
|
<span class="plain-syntax"> </span><span class="element-syntax">void Emotions:</span><span class="plain-syntax">:</span><span class="string-syntax">gosh(text_stream *OUT) {</span>
|
|
<span class="plain-syntax"> WRITE("Good gracious!\n");</span>
|
|
<span class="plain-syntax"> }</span>
|
|
</pre>
|
|
<p class="commentary">The linguistics module has many callbacks, but they are all optional. The
|
|
following alphabetical list has references to fuller explanations:
|
|
</p>
|
|
|
|
<ul class="items"><li>● <span class="extract"><span class="extract-syntax">ADAPTIVE_PERSON_LINGUISTICS_CALLBACK</span></span> returns the default person for adaptive
|
|
text generation; in Inform, this tends to be the value of the adaptive text viewpoint
|
|
property for the natural language of play. Similarly, <span class="extract"><span class="extract-syntax">ADAPTIVE_NUMBER_LINGUISTICS_CALLBACK</span></span>
|
|
returns the number (singular or plural). See <a href="3-vu.html#SP24" class="internal">VerbUsages::adaptive_person</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">ADJECTIVE_NAME_VETTING_LINGUISTICS_CALLBACK</span></span> should return <span class="extract"><span class="extract-syntax">TRUE</span></span> if the given
|
|
name is acceptable as an adjective, and should otherwise print some sort of
|
|
error message and return <span class="extract"><span class="extract-syntax">FALSE</span></span>. If this callback is not provided, all non-empty
|
|
names are acceptable. See <a href="2-adj.html#SP3" class="internal">Adjectives::declare</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">ALLOW_VERB_IN_ASSERTIONS_LINGUISTICS_CALLBACK</span></span> and <span class="extract"><span class="extract-syntax">ALLOW_VERB_LINGUISTICS_CALLBACK</span></span>
|
|
give the parent control over which forms of verbs are allowed: for examole, <a href="../core-module/index.html" class="internal">core</a>
|
|
allows them in assertions only in the third person (singular or plural), whereas
|
|
it allows them in any form in non-assertion contexts. See
|
|
<a href="3-vu.html#SP7" class="internal">VerbUsages::register_voices_of_verb</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">ADJECTIVE_COMPILATION_LINGUISTICS_CALLBACK</span></span>, if provided, should accompany a
|
|
declaration of a structure called <span class="extract"><span class="extract-syntax">adjecttve_compilation_data</span></span>; this function should
|
|
then set up that data for the given adjective — see <a href="2-adj.html#SP3" class="internal">Adjectives::declare</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">ADJECTIVE_MEANING_LINGUISTICS_CALLBACK</span></span>, if provided, should accompany a
|
|
declaration of a structure called <span class="extract"><span class="extract-syntax">adjective_meaning_data</span></span>; this function should
|
|
then set up that data for the given adjective — see <a href="2-adj.html#SP3" class="internal">Adjectives::declare</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">NOUN_COMPILATION_LINGUISTICS_CALLBACK</span></span>, if provided, should accompany a
|
|
declaration of a structure called <span class="extract"><span class="extract-syntax">name_compilation_data</span></span>; this function should
|
|
then set up that data for the given noun — see <a href="2-nns.html#SP8" class="internal">Nouns::new_inner</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">NOUN_DISAMBIGUATION_LINGUISTICS_CALLBACK</span></span>, if provided, should accompany a
|
|
declaration of a structure called <span class="extract"><span class="extract-syntax">name_resolution_data</span></span>; this function should
|
|
decide which possible reading of the meaning of a noun makes the best sense in
|
|
context — see <a href="2-nns.html#SP14" class="internal">Nouns::disambiguate</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">TRACING_LINGUISTICS_CALLBACK</span></span>, if provided, can return <span class="extract"><span class="extract-syntax">TRUE</span></span> to allow
|
|
extensive details of verb parsing to be copied to the debugging log. See
|
|
<a href="4-vp.html#SP3" class="internal">VerbPhrases::tracing</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">VERB_COMPILATION_LINGUISTICS_CALLBACK</span></span>, if provided, allows the <span class="extract"><span class="extract-syntax">compilation_data</span></span>
|
|
part of a <span class="extract"><span class="extract-syntax">verb</span></span> to be initialised. See <a href="3-vrb.html#SP3" class="internal">Verbs::new_verb</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">VERB_MEANING_REVERSAL_LINGUISTICS_CALLBACK</span></span> reverses the meaning of a verb:
|
|
in the sense that the reversal of "A knows B" would be "A is known by B",
|
|
or in other words "B knows A". See <a href="3-vm.html#SP2" class="internal">VerbMeanings::reverse_VMT</a>.
|
|
</li></ul>
|
|
<nav role="progress"><div class="progresscontainer">
|
|
<ul class="progressbar"><li class="progressprev"><a href="P-asd.html">❮</a></li><li class="progresscurrentchapter">P</li><li class="progresssection"><a href="P-wtmd.html">wtmd</a></li><li class="progresssection"><a href="P-asd.html">asd</a></li><li class="progresscurrent">htitm</li><li class="progresschapter"><a href="1-lm.html">1</a></li><li class="progresschapter"><a href="2-adj.html">2</a></li><li class="progresschapter"><a href="3-vrb.html">3</a></li><li class="progresschapter"><a href="4-np.html">4</a></li><li class="progressnext"><a href="1-lm.html">❯</a></li></ul></div>
|
|
</nav><!--End of weave-->
|
|
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|