2020-08-09 20:39:31 +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-08-09 20:39:31 +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 >
< li > < a href = "../inrtpsn.html" > inrtps< / a > < / li >
2022-04-11 00:28:24 +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-08-09 20:39:31 +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" > kinds< / a > < / li > < li > < a href = "index.html#P" > Preliminaries< / a > < / li > < li > < b > How To Include This Module< / b > < / li > < / ul > < / div >
2020-08-09 20:39:31 +03:00
< p class = "purpose" > What to do to make use of the kinds 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-18 00:57:45 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. Status. < / b > The kinds module is provided as one of the "services" suite of modules,
2020-08-09 20:39:31 +03:00
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 = "../kinds-test/index.html" class = "internal" > kinds-test< / a > .
< / p >
< 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-08-09 20:39:31 +03:00
< / p >
2022-04-28 19:20:06 +03:00
< p class = "commentary" > A tool can import < a href = "index.html" class = "internal" > kinds< / a > only if it also imports < a href = "../../../inweb/foundation-module/index.html" class = "internal" > foundation< / a > ,
2020-08-09 20:39:31 +03:00
< 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 = "../linguistics-module/index.html" class = "internal" > linguistics< / a > .
< / p >
2020-08-18 00:57:45 +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" > kinds< / a > ,
2020-08-09 20:39:31 +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/kinds< / span >
< / pre >
< ul class = "items" > < li > ● The parent must call < a href = "1-km.html#SP3" class = "internal" > KindsModule::start< / a > just after it starts up, and
< a href = "1-km.html#SP3" class = "internal" > KindsModule::end< / a > 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-08-09 20:39:31 +03:00
< / li > < / ul >
2020-08-18 00:57:45 +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-08-09 20:39:31 +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_KINDS_CALLBACK Emotions::whoa< / 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" > whoa(text_stream *OUT) {< / span >
< span class = "plain-syntax" > WRITE("Great heavens!\n");< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary" > The following alphabetical list has references to fuller explanations:
< / p >
2021-02-06 20:00:34 +02:00
< ul class = "items" > < li > ● < span class = "extract" > < span class = "extract-syntax" > DETERMINE_SCALE_FACTOR_KINDS_CALLBACK< / span > < / span > , if provided, is called to give
the "scale factor" for a kind. See < a href = "../values-module/3-lp.html" class = "internal" > Literal Patterns (in values)< / a > for the
2021-05-15 01:28:50 +03:00
use of this; here, it appears in < a href = "2-uk.html#SP17" class = "internal" > Kinds::Behaviour::scale_factor< / a > .
2021-02-06 20:00:34 +02:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > HIERARCHY_GET_SUPER_KINDS_CALLBACK< / span > < / span > is called to ask what the superkind
2020-08-12 15:05:44 +03:00
of a kind is. See < a href = "2-tlok.html#SP6" class = "internal" > Latticework::super< / a > .
2020-08-12 01:59:29 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > HIERARCHY_ALLOWS_SOMETIMES_MATCH_KINDS_CALLBACK< / span > < / span > is called to ask if q
kind can contain sometimes-matching subkind instances. See
2021-04-03 16:32:59 +03:00
< a href = "2-tlok.html#SP13" class = "internal" > Latticework::order_relation< / a > .
2020-08-11 13:55:39 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > HIERARCHY_MOVE_KINDS_CALLBACK< / span > < / span > is called to ask us to put make one
2020-08-12 15:05:44 +03:00
kind a subkind of another. See < a href = "2-knd.html#SP21" class = "internal" > Kinds::make_subkind< / a > and
< a href = "2-knd.html#SP20" class = "internal" > Kinds::new_base< / a > — there are two ways this can happen.
2020-08-11 13:55:39 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > HIERARCHY_VETO_MOVE_KINDS_CALLBACK< / span > < / span > is called to give the parent tool a
chance to veto any proposed subkind. (Inform uses this, for example, to catch
the case of somebody making "region" a subkind of some other kind of object.)
2020-08-12 15:05:44 +03:00
See < a href = "2-knd.html#SP21" class = "internal" > Kinds::make_subkind< / a > .
2020-08-11 13:55:39 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > NEW_BASE_KINDS_CALLBACK< / span > < / span > is called when a new base kind (properly
2020-08-12 15:05:44 +03:00
speaking, a new arity-0 kind constructor) is made. See < a href = "2-knd.html#SP20" class = "internal" > Kinds::new_base< / a >
2020-08-18 20:59:08 +03:00
and < a href = "4-nf.html#SP1" class = "internal" > NeptuneFiles::read_command< / a > — there are two ways this can happen.
2020-08-11 13:55:39 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > NOTIFY_NATURAL_LANGUAGE_KINDS_CALLBACK< / span > < / span > is called when the kind "natural
2020-08-12 15:05:44 +03:00
language" is created (if it is): see < a href = "2-fk.html#SP13" class = "internal" > FamiliarKinds::notice_new_kind< / a > .
2020-08-09 20:39:31 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > PROBLEM_KINDS_CALLBACK< / span > < / span > is called when a syntax error is found, and can
prevent this from being issued to the terminal as an error message: see
< a href = "1-km.html#SP5" class = "internal" > KindsModule::problem_handler< / a > .
2020-08-11 13:55:39 +03:00
< / li > < li > ● < span class = "extract" > < span class = "extract-syntax" > REGISTER_NOUN_KINDS_CALLBACK< / span > < / span > , if provided, can register a common noun
2020-08-12 15:05:44 +03:00
for a new base kind with the lexicon itself. See < a href = "2-knd.html#SP20" class = "internal" > Kinds::new_base< / a > .
2020-08-09 20:39:31 +03:00
< / li > < / ul >
< nav role = "progress" > < div class = "progresscontainer" >
2020-08-19 20:32:30 +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-km.html" > 1< / a > < / li > < li class = "progresschapter" > < a href = "2-knd.html" > 2< / a > < / li > < li class = "progresschapter" > < a href = "3-dmn.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-abgtn.html" > 4< / a > < / li > < li class = "progressnext" > < a href = "1-km.html" > ❯ < / a > < / li > < / ul > < / div >
2020-08-09 20:39:31 +03:00
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >