mirror of
https://github.com/ganelson/inform.git
synced 2024-05-19 09:28:51 +03:00
146 lines
9.7 KiB
HTML
146 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>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="../index.html">home</a></li>
|
|
</ul><h2>Compiler</h2><ul>
|
|
<li><a href="../structure.html">structure</a></li>
|
|
<li><a href="../inbuildn.html">inbuild</a></li>
|
|
<li><a href="../inform7n.html">inform7</a></li>
|
|
<li><a href="../intern.html">inter</a></li>
|
|
<li><a href="../services.html">services</a></li>
|
|
<li><a href="../secrets.html">secrets</a></li>
|
|
</ul><h2>Other Tools</h2><ul>
|
|
<li><a href="../inblorbn.html">inblorb</a></li>
|
|
<li><a href="../indocn.html">indoc</a></li>
|
|
<li><a href="../inform6.html">inform6</a></li>
|
|
<li><a href="../inpolicyn.html">inpolicy</a></li>
|
|
</ul><h2>Resources</h2><ul>
|
|
<li><a href="../extensions.html">extensions</a></li>
|
|
<li><a href="../kits.html">kits</a></li>
|
|
</ul><h2>Repository</h2><ul>
|
|
<li><a href="https://github.com/ganelson/inform"><img src="../docs-assets/github.png" height=18> github</a></li>
|
|
</ul><h2>Related Projects</h2><ul>
|
|
<li><a href="../../../inweb/index.html">inweb</a></li>
|
|
<li><a href="../../../intest/index.html">intest</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="../services.html">Services</a></li><li><a href="index.html">lexicon</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 lexicon 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. Defining parsing methods</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 lexicon 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/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">lexicon</a> only if it also imports <a href="../../../inweb/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> and <a href="../inflections-module/index.html" class="internal">inflections</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">lexicon</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/lexicon</span>
|
|
</pre>
|
|
<ul class="items"><li>● The parent must call <span class="extract"><span class="extract-syntax">LexiconModule::start()</span></span> just after it starts up, and
|
|
<span class="extract"><span class="extract-syntax">LexiconModule::end()</span></span> just before it shuts down. (But just after, and just
|
|
before, the corresponding calls to <a href="../../../inweb/foundation-module/index.html" class="internal">foundation</a>.)
|
|
</li></ul>
|
|
<p class="commentary firstcommentary"><a id="SP3" class="paragraph-anchor"></a><b>§3. Defining parsing methods. </b>When lexicon entries are registered (see <a href="1-lxc.html" class="internal">Lexicon (in lexicon)</a>), they are
|
|
assigned "meaning codes", and these affect the way that parsing is done.
|
|
The user should define <span class="extract"><span class="extract-syntax">EXACT_PARSING_BITMAP</span></span>, <span class="extract"><span class="extract-syntax">SUBSET_PARSING_BITMAP</span></span>
|
|
and <span class="extract"><span class="extract-syntax">PARAMETRISED_PARSING_BITMAP</span></span> to be sums of the meaning codes for
|
|
which these methods are used — see <a href="2-pe.html" class="internal">Parse Excerpts</a>.
|
|
</p>
|
|
|
|
<p class="commentary">For example, the parent could define <span class="extract"><span class="extract-syntax">INGREDIENTS_MC</span></span> and <span class="extract"><span class="extract-syntax">RECIPES_MC</span></span> to
|
|
have two different namespaces, and then define <span class="extract"><span class="extract-syntax">EXACT_PARSING_BITMAP</span></span> to
|
|
be <span class="extract"><span class="extract-syntax">INGREDIENTS_MC + RECIPES_MC</span></span> to make both of them parsed exactly.
|
|
</p>
|
|
|
|
<p class="commentary">Minimal default settings are made if the parent doesn't create these
|
|
constants.
|
|
</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_LEXICON_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("Zowie!\n");</span>
|
|
<span class="plain-syntax"> }</span>
|
|
</pre>
|
|
<p class="commentary">The lexicon 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">EM_CASE_SENSITIVITY_TEST_LEXICON_CALLBACK</span></span>, <span class="extract"><span class="extract-syntax">EM_ALLOW_BLANK_TEST_LEXICON_CALLBACK</span></span>
|
|
and <span class="extract"><span class="extract-syntax">EM_IGNORE_DEFINITE_ARTICLE_TEST_LEXICON_CALLBACK</span></span> can all make excerpts
|
|
parse in slightly different ways. <a href="../core-module/index.html" class="internal">core</a> sets all of these to return <span class="extract"><span class="extract-syntax">TRUE</span></span>
|
|
for say phrases, and <span class="extract"><span class="extract-syntax">FALSE</span></span> for everything else. See <a href="1-lxc.html#SP3" class="internal">Lexicon::retrieve</a>
|
|
and <a href="1-lxc.html#SP1" class="internal">Lexicon::register</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">PARSE_EXACTLY_LEXICON_CALLBACK</span></span> is called when an excerpt is about to be
|
|
parsed in "subset mode" — allowing just a subset of its words to be used,
|
|
i.e., not requiring exact wording. This function can refuse to allow that in
|
|
certain cases. See <a href="1-lxc.html#SP3" class="internal">Lexicon::retrieve</a>.
|
|
</li><li>● <span class="extract"><span class="extract-syntax">PROBLEM_LEXICON_CALLBACK</span></span> is called when an error is found, and can
|
|
prevent this from being issued to the terminal as an error message: see
|
|
<a href="2-em.html#SP13" class="internal">ExcerptMeanings::problem_handler</a>.
|
|
</li></ul>
|
|
<nav role="progress"><div class="progresscontainer">
|
|
<ul class="progressbar"><li class="progressprev"><a href="P-wtmd.html">❮</a></li><li class="progresscurrentchapter">P</li><li class="progresssection"><a href="P-wtmd.html">wtmd</a></li><li class="progresscurrent">htitm</li><li class="progresschapter"><a href="1-lm.html">1</a></li><li class="progresschapter"><a href="2-em.html">2</a></li><li class="progressnext"><a href="1-lm.html">❯</a></li></ul></div>
|
|
</nav><!--End of weave-->
|
|
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|