2021-02-20 17:45:46 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< title > Plugin Calls< / 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" >
2021-02-21 20:47:27 +02:00
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
< link href = "../docs-assets/Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2021-02-20 17:45:46 +02:00
< 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 = "index.html" > < span class = "selectedlink" > core< / span > < / 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 = "../codegen-module/index.html" > codegen< / 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 = "../linguistics-module/index.html" > linguistics< / 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 'Plugin Calls' generated by Inweb -->
< div class = "breadcrumbs" >
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../compiler.html" > Inform7< / a > < / li > < li > < a href = "index.html" > core< / a > < / li > < li > < a href = "index.html#3" > Chapter 3: Plugins< / a > < / li > < li > < b > Plugin Calls< / b > < / li > < / ul > < / div >
< p class = "purpose" > The interface between the main compiler and its plugins.< / p >
2021-03-04 18:40:14 +02:00
< ul class = "toc" > < li > < a href = "3-pc.html#SP2" > § 2. Influencing core< / a > < / li > < li > < a href = "3-pc.html#SP3" > § 3. Influencing assertions< / a > < / li > < li > < a href = "3-pc.html#SP14" > § 14. Influencing values< / a > < / li > < li > < a href = "3-pc.html#SP17" > § 17. Influencing knowledge< / a > < / li > < li > < a href = "3-pc.html#SP30" > § 30. Influencing index< / a > < / li > < / ul > < hr class = "tocbar" >
2021-02-20 17:45:46 +02:00
< p class = "commentary firstcommentary" > < a id = "SP1" class = "paragraph-anchor" > < / a > < b > § 1. < / b > The following set of functions is an API for the main compiler to consult
with the plugins; put another way, it is also an API for the plugins to
influence the main compiler. They do so by adding plugs to the relevant rulebooks:
2021-02-23 02:25:10 +02:00
see < a href = "3-pm.html#SP8" class = "internal" > PluginManager::plug< / a > .
2021-02-20 17:45:46 +02:00
< / p >
< p class = "commentary" > Nothing can prevent this from being a big old miscellany, so we take them by
compiler module, and within each module in alphabetical order.
< / p >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP2" class = "paragraph-anchor" > < / a > < b > § 2. Influencing core. < / b > Called from < a href = "1-wtc.html#SP5" class = "internal" > Task::advance_stage_to< / a > . This allows plugins to run additional
production-line steps in compilation, and that is done mostly at the Inter
generation stage, to add extra arrays or functions needed at run-time to
support whatever feature the plugin implements. For example, the mapping plugin
compiles an array to hold the map during stage < span class = "extract" > < span class = "extract-syntax" > INTER1_CSEQ< / span > < / span > .
< / p >
< p class = "commentary" > Because the following is called at the end of every main stage of compilation
except for < span class = "extract" > < span class = "extract-syntax" > FINISHED_CSEQ< / span > < / span > , it is called about 15 times in all, so it is
essential to check < span class = "extract" > < span class = "extract-syntax" > stage< / span > < / span > and act only on the right occasion. < span class = "extract" > < span class = "extract-syntax" > debugging< / span > < / span > is
< span class = "extract" > < span class = "extract-syntax" > TRUE< / span > < / span > if this is a debugging run, and allows a plugin to generate diagnostic
features if so.
< / p >
< p class = "commentary" > A function attached to this plug should then ideally divide its work up into
major subtasks and call each one with the < span class = "extract" > < span class = "extract-syntax" > BENCH< / span > < / span > macro, so that the time it
takes will (if appreciable) be included in the < a href = "../inform7/M-pm.html" class = "internal" > Performance Metrics (in inform7)< / a > .
< / p >
< p class = "commentary" > See < a href = "1-htc.html" class = "internal" > How To Compile< / a > for the stages and their < span class = "extract" > < span class = "extract-syntax" > *_CSEQ< / span > < / span > numbers.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > PRODUCTION_LINE_PLUG< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > from< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 1< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::production_line< / span > < button class = "popup" onclick = "togglePopup('usagePopup1')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup1" > Usage of < span class = "code-font" > < span class = "function-syntax" > PluginCalls::production_line< / span > < / span > :< br / > What To Compile - < a href = "1-wtc.html#SP5" > § 5< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > stage< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > debugging< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > stopwatch_timer< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > timer< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > PRODUCTION_LINE_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > stage< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > debugging< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > timer< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP3" class = "paragraph-anchor" > < / a > < b > § 3. Influencing assertions. < / b > Called from < a href = "../assertions-module/4-rpt.html" class = "internal" > Refine Parse Tree (in assertions)< / a > to ask if this node is a noun
2021-02-20 17:45:46 +02:00
phrase with special significance: for example, "below" is significant to the
mapping plugin. If so, the plugin should set the subject of the node to say
what it refers to, and return < span class = "extract" > < span class = "extract-syntax" > TRUE< / span > < / span > .
< / p >
2021-02-23 13:10:22 +02:00
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > ACT_ON_SPECIAL_NPS_PLUG< / span >
2021-02-20 17:45:46 +02:00
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::act_on_special_NPs< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > ACT_ON_SPECIAL_NPS_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP4" class = "paragraph-anchor" > < / a > < b > § 4. < / b > Called from < a href = "../assertions-module/4-ass2.html" class = "internal" > Assemblies (in assertions)< / a > . Body-snatching is used only by the
2021-02-20 17:45:46 +02:00
"player" plugin, and is explained there; it handles the consequences of sentences
like "The player is Lord Collingwood".
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > DETECT_BODYSNATCHING_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::detect_bodysnatching< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > inference_subject< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > body< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > snatcher< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > inference_subject< / span > < span class = "plain-syntax" > **< / span > < span class = "identifier-syntax" > counterpart< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > DETECT_BODYSNATCHING_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > body< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > snatcher< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > counterpart< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP5" class = "paragraph-anchor" > < / a > < b > § 5. < / b > Called from < a href = "../assertions-module/4-ass.html" class = "internal" > Assertions (in assertions)< / a > to see if any plugin wants to
2021-02-20 17:45:46 +02:00
intepret a sentence its own way, either taking direct action or issuing a
more nuanced problem message than the usual machinery would have issued.
If so, the plugin should return < span class = "extract" > < span class = "extract-syntax" > TRUE< / span > < / span > , which both ensures that no other
plugin intervenes, and also tells < a href = "../assertions-module/index.html" class = "internal" > assertions< / a > not to proceed further
with the sentence.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > INTERVENE_IN_ASSERTION_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::intervene_in_assertion< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > px< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > py< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > INTERVENE_IN_ASSERTION_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > px< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > py< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP6" class = "paragraph-anchor" > < / a > < b > § 6. < / b > Called from < a href = "../assertions-module/4-tc.html" class = "internal" > The Creator (in assertions)< / a > when an instance is being made in
2021-02-20 17:45:46 +02:00
an assembly, and its name may involve a genitive. For example, if the
assembly says "every person has a nose", then normally this would be called
something like "Mr Rogers's nose"; but the player plugin uses the following
to have "your nose" in the case of the player instance.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > IRREGULAR_GENITIVE_IN_ASSEMBLY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::irregular_genitive< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > inference_subject< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > genitive< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > propriety< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > IRREGULAR_GENITIVE_IN_ASSEMBLY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > genitive< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > propriety< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP7" class = "paragraph-anchor" > < / a > < b > § 7. < / b > Called from < a href = "../assertions-module/2-bv.html" class = "internal" > Booting Verbs (in assertions)< / a > to give each plugin a chance to
2021-02-21 02:03:29 +02:00
create any special sentence meanings it would like to. For example, the
sounds plugin defines a special form of assertion sentence this way. The
plugin should always return < span class = "extract" > < span class = "extract-syntax" > FALSE< / span > < / span > , since otherwise it may gazump other
plugins and cause them to stop working.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > MAKE_SPECIAL_MEANINGS_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::make_special_meanings< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALLV< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > MAKE_SPECIAL_MEANINGS_PLUG< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP8" class = "paragraph-anchor" > < / a > < b > § 8. < / b > Called from < a href = "../assertions-module/4-ass.html" class = "internal" > Assertions (in assertions)< / a > when it seems that the author wants
2021-02-20 17:45:46 +02:00
to create a property of something with a sentence like "A container has a
number called security rating." A plugin can intervene and act on that,
returning < span class = "extract" > < span class = "extract-syntax" > TRUE< / span > < / span > to stop the usual machinery. For example, the actions
plugin does this so that "The going action has a number called celerity"
can be intercepted to create an action variable, not a property.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > OFFERED_PROPERTY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::offered_property< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > K< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > what< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > OFFERED_PROPERTY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > K< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > what< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP9" class = "paragraph-anchor" > < / a > < b > § 9. < / b > Called from < a href = "../assertions-module/4-ass.html" class = "internal" > Assertions (in assertions)< / a > when the specification pseudo-variable
2021-02-20 17:45:46 +02:00
is about to be set for something; the plugin can then intercept this.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > OFFERED_SPECIFICATION_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::offered_specification< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > OFFERED_SPECIFICATION_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > owner< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-23 13:10:22 +02:00
< p class = "commentary firstcommentary" > < a id = "SP10" class = "paragraph-anchor" > < / a > < b > § 10. < / b > Called from < a href = "../assertions-module/4-rpt.html" class = "internal" > Refine Parse Tree (in assertions)< / a > to ask plugins if a noun phrase
2021-02-20 17:45:46 +02:00
has a noun implicit within it, even though none is explicitly given. For
example, the player plugin uses this to say that "initially carried" means
"...by the player", and sets the subject of the node to be the player character
instance.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > REFINE_IMPLICIT_NOUN_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::refine_implicit_noun< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > REFINE_IMPLICIT_NOUN_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP11" class = "paragraph-anchor" > < / a > < b > § 11. < / b > Called from < a href = "../assertions-module/2-cs.html" class = "internal" > Classifying Sentences (in assertions)< / a > to give plugins the chance
of an early look at a newly-read assertion. For example, the map plugin uses
this to spot that a sentence will create a new direction.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NEW_ASSERTION_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::new_assertion_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NEW_ASSERTION_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > p< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< p class = "commentary firstcommentary" > < a id = "SP12" class = "paragraph-anchor" > < / a > < b > § 12. < / b > Called from < a href = "../assertions-module/6-terr.html" class = "internal" > The Equality Relation Revisited (in assertions)< / a > when we have
2021-02-20 17:45:46 +02:00
to decide if it's valid to ask or declare that two things are the same.
Returning < span class = "extract" > < span class = "extract-syntax" > TRUE< / span > < / span > says that it is always valid; returning < span class = "extract" > < span class = "extract-syntax" > FALSE< / span > < / span > leaves
it to the regular machinery. This plug can therefore only be used to permit
additional usages, not to restrict existing ones.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > TYPECHECK_EQUALITY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::typecheck_equality< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > K1< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > K2< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > TYPECHECK_EQUALITY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > K1< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > K2< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP13" class = "paragraph-anchor" > < / a > < b > § 13. < / b > Called from < a href = "../assertions-module/4-ass.html" class = "internal" > Assertions (in assertions)< / a > to warn plugins that a variable
2021-02-20 17:45:46 +02:00
is now being assigned a value by an explicit assertion sentence.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > VARIABLE_VALUE_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::variable_set_warning< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > nonlocal_variable< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > q< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > val< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > VARIABLE_VALUE_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > q< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > val< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP14" class = "paragraph-anchor" > < / a > < b > § 14. Influencing values. < / b > Called from < a href = "../values-module/2-rvl.html" class = "internal" > Rvalues (in values)< / a > to allow plugins to compile rvalues in
2021-02-20 17:45:46 +02:00
eccentric ways of their own: not in fact just for the whimsy of it, but to
make it possible for plugins to support base kinds of their own. For example,
the "actions" plugin needs this to deal with the "stored action" kind.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > COMPILE_CONSTANT_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::compile_constant< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > value_holster< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > VH< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > K< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > spec< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > COMPILE_CONSTANT_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > VH< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > K< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > spec< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP15" class = "paragraph-anchor" > < / a > < b > § 15. < / b > Called from < a href = "../values-module/2-spc.html" class = "internal" > Specifications (in values)< / a > to ask if there is some reason why
2021-02-20 17:45:46 +02:00
a rule about < span class = "extract" > < span class = "extract-syntax" > I1< / span > < / span > should be thought broader in scope than one about < span class = "extract" > < span class = "extract-syntax" > I2< / span > < / span > . This
is used by the regions plugin when one is a sub-region of the other. This is
expected to behave as a < span class = "extract" > < span class = "extract-syntax" > strcmp< / span > < / span > -like sorting function, with a positive
return value saying < span class = "extract" > < span class = "extract-syntax" > I1< / span > < / span > is broader, negative < span class = "extract" > < span class = "extract-syntax" > I2< / span > < / span > , or zero that they are equal.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > MORE_SPECIFIC_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::more_specific< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > instance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > I1< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > instance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > I2< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > MORE_SPECIFIC_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I1< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I2< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP16" class = "paragraph-anchor" > < / a > < b > § 16. < / b > Called from < a href = "../values-module/4-cad.html" class = "internal" > Constants and Descriptions (in values)< / a > to give plugins a chance
2021-02-20 17:45:46 +02:00
to parse text which might otherwise be meaningless (or mean something different)
and make it a "composite noun-quantifier" such as "everywhere" or "nothing".
The main compiler does not recognise "everywhere" because it has no concept
of space, but the spatial plugin does, and this is how.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > PARSE_COMPOSITE_NQS_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::parse_composite_NQs< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > DW< / span > < span class = "plain-syntax" > ,< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > quantifier< / span > < span class = "plain-syntax" > **< / span > < span class = "identifier-syntax" > quantifier_used< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > **< / span > < span class = "identifier-syntax" > some_kind< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > PARSE_COMPOSITE_NQS_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > DW< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > quantifier_used< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > some_kind< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP17" class = "paragraph-anchor" > < / a > < b > § 17. Influencing knowledge. < / b > Called from < a href = "../knowledge-module/5-tmw.html" class = "internal" > The Model World (in knowledge)< / a > to invite the plugin to participate
2021-02-20 17:45:46 +02:00
in stages I to V of the completion process. This may involve using contextual
reasoning to draw further inferences.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > COMPLETE_MODEL_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::complete_model< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > stage< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > COMPLETE_MODEL_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > stage< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP18" class = "paragraph-anchor" > < / a > < b > § 18. < / b > Called from < a href = "../knowledge-module/4-is.html" class = "internal" > Inference Subjects (in knowledge)< / a > to invite the plugin to
2021-02-20 17:45:46 +02:00
create any additional inference subjects it might want to reason about. In
practice, this tends to be used to create preliminary subjects to stand in
for significant kinds before those kinds are ready to be created.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > CREATE_INFERENCE_SUBJECTS_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::create_inference_subjects< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALLV< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > CREATE_INFERENCE_SUBJECTS_PLUG< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP19" class = "paragraph-anchor" > < / a > < b > § 19. < / b > Called from < a href = "../knowledge-module/5-ia.html" class = "internal" > Indefinite Appearance (in knowledge)< / a > to ask the plugins what
2021-02-20 17:45:46 +02:00
inferences, if any, to draw from a double-quoted text standing as an entire
sentence. The < span class = "extract" > < span class = "extract-syntax" > infs< / span > < / span > is the subject which was being talked about at the time
the text was quoted, and therefore presumably is what the text should describe.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > DEFAULT_APPEARANCE_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::default_appearance< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > inference_subject< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > infs< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > parse_node< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > txt< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > DEFAULT_APPEARANCE_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > infs< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > txt< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP20" class = "paragraph-anchor" > < / a > < b > § 20. < / b > Called from < a href = "../knowledge-module/5-inf.html" class = "internal" > Inferences (in knowledge)< / a > when an inference is drawn about
2021-02-20 17:45:46 +02:00
something. This does not, of course, necessarily mean that this will actually
be the property of something: the inference might turn out to be mistaken. The
mapping plugin uses this to infer further that if something is said to be a
map connection to somewhere else, then it is probably a room.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > INFERENCE_DRAWN_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::inference_drawn< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > inference< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > inference_subject< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > subj< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > INFERENCE_DRAWN_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > subj< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP21" class = "paragraph-anchor" > < / a > < b > § 21. < / b > Called from < a href = "../knowledge-module/4-ks.html" class = "internal" > Kind Subjects (in knowledge)< / a > . Early in the run, before some kinds
2021-02-20 17:45:46 +02:00
are created, placeholder inference subjects are created to stand in for them;
this call enables plugins to recognise certain texts as referring to those.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NAME_TO_EARLY_INFS_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::name_to_early_infs< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > inference_subject< / span > < span class = "plain-syntax" > **< / span > < span class = "identifier-syntax" > infs< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NAME_TO_EARLY_INFS_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > infs< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP22" class = "paragraph-anchor" > < / a > < b > § 22. < / b > Called from < a href = "../knowledge-module/4-ks.html" class = "internal" > Kind Subjects (in knowledge)< / a > to warn plugins about a new kind,
2021-02-20 17:45:46 +02:00
which in practice enables them to spot from the name that it is actually a kind
they want to provide built-in support for: thus the actions plugin reacts to
the name "stored action", for example. < span class = "extract" > < span class = "extract-syntax" > K< / span > < / span > is the newcomer, < span class = "extract" > < span class = "extract-syntax" > super< / span > < / span > its super-kind,
if any; < span class = "extract" > < span class = "extract-syntax" > d< / span > < / span > and < span class = "extract" > < span class = "extract-syntax" > W< / span > < / span > are alternate forms of that name — < span class = "extract" > < span class = "extract-syntax" > d< / span > < / span > will be useful if the
kind was created by a kit (such as "number"), < span class = "extract" > < span class = "extract-syntax" > W< / span > < / span > if it came from Inform 7
source text (such as "container").
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NEW_BASE_KIND_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::new_base_kind_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > K< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > super< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > text_stream< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > d< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > wording< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NEW_BASE_KIND_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > K< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > d< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > W< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP23" class = "paragraph-anchor" > < / a > < b > § 23. < / b > Called from < a href = "../knowledge-module/2-ins.html" class = "internal" > Instances (in knowledge)< / a > to warn plugins that a new instance has
2021-02-20 17:45:46 +02:00
been created. For example, the figures plugin needs to know this so that it
can see when a new illustration has been created.
< / p >
< p class = "commentary" > At the time this is called, the exact kind of an instance may not be knowm,
if that instance is an object: so beware of relying on the kind unless you're
sure you're not dealing with an object.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NEW_INSTANCE_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::new_named_instance_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > instance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > nc< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NEW_INSTANCE_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > nc< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP24" class = "paragraph-anchor" > < / a > < b > § 24. < / b > Called from < a href = "../knowledge-module/4-pp.html" class = "internal" > Property Permissions (in knowledge)< / a > to warn plugins that a subject
2021-02-20 17:45:46 +02:00
has been given permission to hold a property; the parsing plugin, for example,
uses this to attach a visibility flag.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NEW_PERMISSION_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::new_permission_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > property_permission< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > pp< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NEW_PERMISSION_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > pp< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP25" class = "paragraph-anchor" > < / a > < b > § 25. < / b > Called from < a href = "../knowledge-module/3-prp.html" class = "internal" > Properties (in knowledge)< / a > to warn plugins that a property has
2021-02-20 17:45:46 +02:00
been created, which they can use to spot properties with special significance
to them.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NEW_PROPERTY_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::new_property_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > property< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > prn< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NEW_PROPERTY_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > prn< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP26" class = "paragraph-anchor" > < / a > < b > § 26. < / b > Called from < a href = "../knowledge-module/4-is.html" class = "internal" > Inference Subjects (in knowledge)< / a > to warn plugins that a subject
2021-02-20 17:45:46 +02:00
has been created, which they can use to spot subjects with special significance
to them.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NEW_SUBJECT_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::new_subject_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > inference_subject< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > subj< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NEW_SUBJECT_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > subj< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP27" class = "paragraph-anchor" > < / a > < b > § 27. < / b > Called from < a href = "../knowledge-module/2-nv.html" class = "internal" > Nonlocal Variables (in knowledge)< / a > to warn plugins that a new
2021-02-20 17:45:46 +02:00
variable has been created, which they can use to spot variables with special
significance to them.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > NEW_VARIABLE_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::new_variable_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > nonlocal_variable< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > q< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > NEW_VARIABLE_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > q< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP28" class = "paragraph-anchor" > < / a > < b > § 28. < / b > Called from < a href = "../knowledge-module/2-ins.html" class = "internal" > Instances (in knowledge)< / a > to warn plugins that the kind of an
2021-02-20 17:45:46 +02:00
instance is about to be set. This happens most often when the instance is
created, but can also happen again, refining the kind to a subkind, when
the instance is an object.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > SET_KIND_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::set_kind_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > instance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > k< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > SET_KIND_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > I< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > k< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-02-25 16:09:17 +02:00
< p class = "commentary firstcommentary" > < a id = "SP29" class = "paragraph-anchor" > < / a > < b > § 29. < / b > Called from < a href = "../knowledge-module/4-ks.html" class = "internal" > Kind Subjects (in knowledge)< / a > when one kind of object is made a
2021-02-20 17:45:46 +02:00
subkind of another, as for example when "container" is a made a subkind of
"thing". The plugin should return < span class = "extract" > < span class = "extract-syntax" > TRUE< / span > < / span > if it wishes to forbid this,
and if so, it had better throw a problem message, or the user will be
mystified.
< / p >
< p class = "commentary" > This can be used to forbid certain kinds having subkinds, as for example the
regions plugin does with the "region" kind.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > SET_SUBKIND_NOTIFY_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::set_subkind_notify< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > sub< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > kind< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > super< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > SET_SUBKIND_NOTIFY_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > sub< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > super< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-03-04 18:40:14 +02:00
< p class = "commentary firstcommentary" > < a id = "SP30" class = "paragraph-anchor" > < / a > < b > § 30. Influencing index. < / b > Called from < a href = "../index-module/2-ipw.html" class = "internal" > Index Physical World (in index)< / a > to add something (if it wishes)
2021-02-20 17:45:46 +02:00
to the index description of an instance in the spatial model. For example,
the regions plugin uses this to put colour chips next to names of regions.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > ADD_TO_WORLD_INDEX_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::add_to_World_index< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUTPUT_STREAM< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > instance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > O< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > ADD_TO_WORLD_INDEX_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > O< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
2021-03-04 18:40:14 +02:00
< p class = "commentary firstcommentary" > < a id = "SP31" class = "paragraph-anchor" > < / a > < b > § 31. < / b > Called from < a href = "../index-module/2-ipw.html" class = "internal" > Index Physical World (in index)< / a > to add something (if it wishes)
2021-02-20 17:45:46 +02:00
to the textual description of an instance in the spatial model. For example,
the mapping plugin uses this to say where a door leads.
< / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > ANNOTATE_IN_WORLD_INDEX_PLUG< / span >
< / pre >
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > PluginCalls::annotate_in_World_index< / span > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > OUTPUT_STREAM< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > instance< / span > < span class = "plain-syntax" > *< / span > < span class = "identifier-syntax" > O< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > PLUGINS_CALL< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > ANNOTATE_IN_WORLD_INDEX_PLUG< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > OUT< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > O< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > }< / span >
< / pre >
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "3-pm.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "P-wtmd.html" > P< / a > < / li > < li class = "progresschapter" > < a href = "1-cm.html" > 1< / a > < / li > < li class = "progresschapter" > < a href = "2-up.html" > 2< / a > < / li > < li class = "progresscurrentchapter" > 3< / li > < li class = "progresssection" > < a href = "3-pm.html" > pm< / a > < / li > < li class = "progresscurrent" > pc< / li > < li class = "progressnextoff" > ❯ < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
< / main >
< / body >
< / html >
