2020-05-11 22:49:36 +03:00
<!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" >
2022-04-28 19:37:28 +03:00
< h1 > < a href = "../index.html" >
2020-05-11 22:49:36 +03:00
< img src = "../docs-assets/Inform.png" height = 72" >
< / a > < / h1 >
2022-04-28 19:37:28 +03:00
< ul > < li > < a href = "../index.html" > home< / a > < / li >
2022-04-04 20:31:44 +03:00
< / 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 >
2022-04-18 17:46:46 +03:00
< li > < a href = "../secrets.html" > secrets< / a > < / li >
2022-04-04 20:31:44 +03:00
< / 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 >
2022-04-15 01:14:14 +03:00
< / ul > < h2 > Resources< / h2 > < ul >
< li > < a href = "../extensions.html" > extensions< / a > < / li >
< li > < a href = "../kits.html" > kits< / a > < / li >
2022-04-04 20:31:44 +03:00
< / 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 >
2022-04-28 19:20:06 +03:00
< li > < a href = "../../../inweb/index.html" > inweb< / a > < / li >
< li > < a href = "../../../intest/index.html" > intest< / a > < / li >
2020-05-11 22:49:36 +03:00
< / ul >
< / nav >
< main role = "main" >
<!-- Weave of 'How To Include This Module' generated by Inweb -->
< div class = "breadcrumbs" >
2022-04-28 19:37:28 +03:00
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../services.html" > Services< / a > < / li > < li > < a href = "index.html" > words< / a > < / li > < li > < a href = "index.html#P" > Preliminaries< / a > < / li > < li > < b > How To Include This Module< / b > < / li > < / ul > < / div >
2020-05-11 22:49:36 +03:00
< p class = "purpose" > What to do to make use of the words 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. Using callbacks< / a > < / li > < / ul > < hr class = "tocbar" >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. Status. < / b > The words module provided as one of the "services" suite of modules, which means
2020-05-11 22:49:36 +03:00
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 > , < a href = "../inbuild/index.html" class = "internal" > inbuild< / a > and < a href = "../words-test/index.html" class = "internal" > words-test< / a > ,
among others. < a href = "../words-test/index.html" class = "internal" > words-test< / a > may be useful as a minimal example of a tool
using < a href = "index.html" class = "internal" > words< / a > .
< / p >
2020-05-20 02:02:28 +03:00
< p class = "commentary" > By convention, the modules considered as "services" have no dependencies on
2022-04-28 19:20:06 +03:00
other modules except for < a href = "../../../inweb/foundation-module/index.html" class = "internal" > foundation< / a > and other "services" modules.
2020-05-11 22:49:36 +03:00
< / p >
2022-04-28 19:20:06 +03:00
< p class = "commentary" > A tool can import < a href = "index.html" class = "internal" > words< / a > only if it also imports < a href = "../../../inweb/foundation-module/index.html" class = "internal" > foundation< / a > .
2020-05-11 22:49:36 +03:00
< / p >
2020-08-27 17:50:24 +03:00
< 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" > words< / a > ,
2020-05-11 22:49:36 +03:00
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/words< / span >
< / pre >
< ul class = "items" > < li > ● The parent must call < span class = "extract" > < span class = "extract-syntax" > WordsModule::start()< / span > < / span > just after it starts up, and
< span class = "extract" > < span class = "extract-syntax" > WordsModule::end()< / span > < / span > just before it shuts down. (But just after, and just
2022-04-28 19:20:06 +03:00
before, the corresponding calls to < a href = "../../../inweb/foundation-module/index.html" class = "internal" > foundation< / a > .)
2020-05-11 22:49:36 +03:00
< / li > < / ul >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. Using callbacks. < / b > Shared modules like this one are tweaked in behaviour by defining "callback
2020-05-11 22:49:36 +03:00
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_WORDS_CALLBACK Emotions::wow< / 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" > wow(text_stream *OUT) {< / span >
< span class = "plain-syntax" > WRITE("My word!\n");< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary" > The words module has only a few callbacks, and they are all optional. The
following alphabetical list has references to fuller explanations:
< / p >
2020-05-19 18:36:50 +03:00
< ul class = "items" > < li > ● < span class = "extract" > < span class = "extract-syntax" > MORE_PREFORM_OPTIMISER_WORDS_CALLBACK< / span > < / span > and < span class = "extract" > < span class = "extract-syntax" > PREFORM_OPTIMISER_WORDS_CALLBACK< / span > < / span >
2020-05-19 13:46:13 +03:00
have the opportunity to flag certain Preform nonterminals in ways which will
help < a href = "4-to.html" class = "internal" > The Optimiser< / a > .
2020-05-22 11:38:17 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > PREFORM_ERROR_WORDS_CALLBACK< / span > < / span > allows the parent to issue errors about
Preform definitions in its own way; they will otherwise by default be standard
command-line error message written to < span class = "extract" > < span class = "extract-syntax" > STDERR< / span > < / span > .
2020-05-19 13:46:13 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > PROBLEM_WORDS_CALLBACK< / span > < / span > is called when a lexical error is found, and can
2020-05-11 22:49:36 +03:00
prevent this from being issued to the terminal as an error message: see
2023-07-18 00:54:02 +03:00
< a href = "3-lxr.html#SP31" class = "internal" > Lexer::lexer_problem_handler< / a > .
2020-05-27 01:02:00 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > VOCABULARY_MEANING_INITIALISER_WORDS_CALLBACK< / span > < / span > is called to attach a
meaning object to a single < a href = "2-vcb.html#SP1" class = "internal" > vocabulary_entry< / a > . In this module, meanings are
not our concern: all we provide is the opportunity for our parent tool to
attach such meanings to words. See < a href = "2-vcb.html#SP5" class = "internal" > Vocabulary::vocab_entry_new< / a > .
2020-05-11 22:49:36 +03:00
< / li > < / ul >
2020-08-27 17:50:24 +03:00
< p class = "commentary firstcommentary" > < a id = "SP4" class = "paragraph-anchor" > < / a > < b > § 4. < / b > If the selection of a natural language is a meaningful thing to the parent,
2020-05-13 01:33:17 +03:00
it can define < span class = "extract" > < span class = "extract-syntax" > NATURAL_LANGUAGE_WORDS_TYPE< / span > < / span > to tell the Preform parser how
to refer to these. For example, the < a href = "../supervisor-module/index.html" class = "internal" > supervisor< / a > module has:
< / 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" > NATURAL_LANGUAGE_WORDS_TYPE struct inform_language< / span >
< / pre >
2020-05-11 22:49:36 +03:00
< nav role = "progress" > < div class = "progresscontainer" >
2020-05-13 01:33:17 +03:00
< 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-wm.html" > 1< / a > < / li > < li class = "progresschapter" > < a href = "2-vcb.html" > 2< / a > < / li > < li class = "progresschapter" > < a href = "3-lxr.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-ap.html" > 4< / a > < / li > < li class = "progressnext" > < a href = "1-wm.html" > ❯ < / a > < / li > < / ul > < / div >
2020-05-11 22:49:36 +03:00
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >