ifhub/inform7
1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 18:14:21 +03:00
Code Issues Projects Releases Wiki Activity
inform7/docs/core-module/22-prcd.html
Graham Nelson bb13993e92 Made template assimilation possible by inter alone
2019-08-31 13:56:36 +01:00

761 lines
75 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>22/pu</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
<link href="inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>
<body>
<!--Weave of '22/prcd' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">core</a></li><li><a href="index.html#22">Chapter 22: Phrases</a></li><li><b>Phrase Runtime Context Data</b></li></ul><p class="purpose">To store the circumstances in which a rule phrase should fire.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Definitions</a></li><li><a href="#SP4">&#167;4. Access</a></li><li><a href="#SP8">&#167;8. Specificity of phrase runtime contexts</a></li><li><a href="#SP9">&#167;9. Activity list on demand</a></li><li><a href="#SP10">&#167;10. Compiling the firing test</a></li><li><a href="#SP10_2">&#167;10.2. Scene test</a></li><li><a href="#SP10_3">&#167;10.3. Action test</a></li><li><a href="#SP10_4">&#167;10.4. Actor-is-player test</a></li><li><a href="#SP10_5">&#167;10.5. Activity-or-condition test</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Definitions. </b></p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>Runtime context data is the context in which a phrase is allowed to run,
though it's only used for rules. For example,
</p>
<blockquote>
<p>Before taking a container when the player is in the Box Room: ...</p>
</blockquote>
<p class="inwebparagraph">has the opportunity to fire when the "Before taking" rulebook gets to it.
But the rule only actually does so if the action is "taking a container"
and the condition about the location applies, and these two stipulations
form the PHRCD for the rule. For some simpler rules, like:
</p>
<blockquote>
<p>When play begins: ...</p>
</blockquote>
<p class="inwebparagraph">the PHRCD remains empty, because they are guaranteed to fire whenever their
rulebooks reach them.
</p>
<pre class="display">
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">ph_runtime_context_data</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">activity_context</span><span class="plain">; </span> <span class="comment">happens only while any activities go on?</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">activity_where</span><span class="plain">; </span> <span class="comment">and who says?</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">activity_list</span><span class="plain"> *</span><span class="identifier">avl</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">during_scene</span><span class="plain">; </span> <span class="comment">...happens only during a scene matching this?</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">action_pattern</span><span class="plain"> </span><span class="identifier">ap</span><span class="plain">; </span> <span class="comment">happens only if the action matches this pattern?</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">always_test_actor</span><span class="plain">; </span> <span class="comment">...even if no AP was given, test that actor is player?</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">never_test_actor</span><span class="plain">; </span> <span class="comment">...for instance, for a parametrised rather than action rulebook</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">marked_for_anyone</span><span class="plain">; </span> <span class="comment">any actor is allowed to perform this action</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">rulebook</span><span class="plain"> **</span><span class="identifier">compile_for_rulebook</span><span class="plain">; </span> <span class="comment">...used for the default outcome</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">permit_all_outcomes</span><span class="plain">; </span> <span class="comment">waive the usual restrictions on rule outcomes</span>
<span class="plain">} </span><span class="reserved">ph_runtime_context_data</span><span class="plain">;</span>
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">rule_context</span><span class="plain"> {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">action_name</span><span class="plain"> *</span><span class="identifier">action_context</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">scene</span><span class="plain"> *</span><span class="identifier">scene_context</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">#</span><span class="identifier">ifndef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">void</span><span class="plain"> *</span><span class="identifier">not_used</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">} </span><span class="reserved">rule_context</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure ph_runtime_context_data is accessed in 22/pu and here.</p>
<p class="endnote">The structure rule_context is accessed in 21/rl, 21/rb, 21/rl2.</p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>As we've seen, PHRCDs are really made by translating them from PHUDs, and
the following only blanks out a PHRCD structure ready for that to happen.
</p>
<pre class="display">
<span class="reserved">ph_runtime_context_data</span><span class="plain"> </span><span class="functiontext">Phrases::Context::new</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">ph_runtime_context_data</span><span class="plain"> </span><span class="identifier">phrcd</span><span class="plain">;</span>
<span class="identifier">phrcd</span><span class="element">.activity_context</span><span class="plain"> = </span><span class="identifier">EMPTY_WORDING</span><span class="plain">;</span>
<span class="identifier">phrcd</span><span class="element">.activity_where</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">phrcd</span><span class="element">.avl</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">phrcd</span><span class="element">.during_scene</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">phrcd</span><span class="element">.ap</span><span class="plain"> = </span><span class="identifier">PL::Actions::Patterns::new</span><span class="plain">();</span>
<span class="identifier">phrcd</span><span class="element">.always_test_actor</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="identifier">phrcd</span><span class="element">.never_test_actor</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="identifier">phrcd</span><span class="element">.marked_for_anyone</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="identifier">phrcd</span><span class="element">.permit_all_outcomes</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="identifier">phrcd</span><span class="element">.compile_for_rulebook</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">phrcd</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::new is used in 22/ph (<a href="22-ph.html#SP6_6">&#167;6.6</a>), 22/pu (<a href="22-pu.html#SP20">&#167;20</a>).</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. Access. </b>Some access routines: first, for actor testing.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Phrases::Context::set_always_test_actor</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;always_test_actor</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Phrases::Context::clear_always_test_actor</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;always_test_actor</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Phrases::Context::set_never_test_actor</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;never_test_actor</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Phrases::Context::set_marked_for_anyone</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">to</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;marked_for_anyone</span><span class="plain"> = </span><span class="identifier">to</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Phrases::Context::get_marked_for_anyone</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;marked_for_anyone</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">#</span><span class="identifier">ifndef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::set_always_test_actor is used in 21/rl (<a href="21-rl.html#SP26">&#167;26</a>).</p>
<p class="endnote">The function Phrases::Context::clear_always_test_actor is used in 21/rl (<a href="21-rl.html#SP26">&#167;26</a>).</p>
<p class="endnote">The function Phrases::Context::set_never_test_actor is used in 21/rl (<a href="21-rl.html#SP26">&#167;26</a>).</p>
<p class="endnote">The function Phrases::Context::set_marked_for_anyone is used in 21/rl (<a href="21-rl.html#SP26">&#167;26</a>).</p>
<p class="endnote">The function Phrases::Context::get_marked_for_anyone is used in 21/rl (<a href="21-rl.html#SP26">&#167;26</a>).</p>
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. </b>The required (or not) action:
</p>
<pre class="display">
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Phrases::Context::within_action_context</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">,</span>
<span class="identifier">action_name</span><span class="plain"> *</span><span class="identifier">an</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">PL::Actions::Patterns::within_action_context</span><span class="plain">(&amp;(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">), </span><span class="identifier">an</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">action_name</span><span class="plain"> *</span><span class="functiontext">Phrases::Context::required_action</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">PL::Actions::Patterns::is_valid</span><span class="plain">(&amp;(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">)))</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">PL::Actions::Patterns::required_action</span><span class="plain">(&amp;(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">));</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Phrases::Context::suppress_action_testing</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">PL::Actions::Patterns::suppress_action_testing</span><span class="plain">(&amp;(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">));</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::within_action_context is used in 21/rb (<a href="21-rb.html#SP18">&#167;18</a>).</p>
<p class="endnote">The function Phrases::Context::required_action is used in 21/rb (<a href="21-rb.html#SP25">&#167;25</a>), 21/rl2 (<a href="21-rl2.html#SP19">&#167;19</a>).</p>
<p class="endnote">The function Phrases::Context::suppress_action_testing is used in 21/rl (<a href="21-rl.html#SP26">&#167;26</a>).</p>
<p class="inwebparagraph"><a id="SP6"></a><b>&#167;6. </b>The reason we store a whole specification, rather than a scene constant,
here is that we sometimes want rules which happen during "a recurring scene",
or some other description of scenes in general. The following routine
extracts a single specified scene if there is one:
</p>
<pre class="display">
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">scene</span><span class="plain"> *</span><span class="functiontext">Phrases::Context::get_scene</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">ParseTreeUsage::is_rvalue</span><span class="plain">(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;during_scene</span><span class="plain">)) {</span>
<span class="reserved">instance</span><span class="plain"> *</span><span class="identifier">q</span><span class="plain"> = </span><span class="functiontext">Rvalues::to_instance</span><span class="plain">(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;during_scene</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">q</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">PL::Scenes::from_named_constant</span><span class="plain">(</span><span class="identifier">q</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="plain">#</span><span class="identifier">endif</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::get_scene is used in 21/rb (<a href="21-rb.html#SP18">&#167;18</a>), 21/rl2 (<a href="21-rl2.html#SP15">&#167;15</a>).</p>
<p class="inwebparagraph"><a id="SP7"></a><b>&#167;7. </b>This is to do with named outcomes of rules, whereby certain outcomes are
normally limited to the use of rules in particular rulebooks.
</p>
<pre class="display">
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Phrases::Context::outcome_restrictions_waived</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">phrase_being_compiled</span><span class="plain">) &amp;&amp;</span>
<span class="plain">(</span><span class="identifier">phrase_being_compiled</span><span class="plain">-</span><span class="element">&gt;runtime_context_data.permit_all_outcomes</span><span class="plain">))</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::outcome_restrictions_waived is used in 21/fao (<a href="21-fao.html#SP10">&#167;10</a>).</p>
<p class="inwebparagraph"><a id="SP8"></a><b>&#167;8. Specificity of phrase runtime contexts. </b>The following is one of Inform's standardised comparison routines, which
takes a pair of objects A, B and returns 1 if A makes a more specific
description than B, 0 if they seem equally specific, or -1 if B makes a
more specific description than A. This is transitive, and intended to be
used in sorting algorithms.
</p>
<p class="inwebparagraph">In this case, laws I to V are applied in turn until one is decisive. If
all of them fail to decide, we return 0.
</p>
<pre class="display">
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Phrases::Context::compare_specificity</span><span class="plain">(</span><span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">rcd1</span><span class="plain">,</span>
<span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">rcd2</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">action_pattern</span><span class="plain"> *</span><span class="identifier">ap1</span><span class="plain">, *</span><span class="identifier">ap2</span><span class="plain">;</span>
<span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">sc1</span><span class="plain">, *</span><span class="identifier">sc2</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="identifier">wording</span><span class="plain"> </span><span class="identifier">AL1W</span><span class="plain">, </span><span class="identifier">AL2W</span><span class="plain">;</span>
&lt;<span class="cwebmacro">Extract these from the PHRCDs under comparison</span> <span class="cwebmacronumber">8.1</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Apply comparison law I</span> <span class="cwebmacronumber">8.2</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Apply comparison law II</span> <span class="cwebmacronumber">8.3</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Apply comparison law III</span> <span class="cwebmacronumber">8.4</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Apply comparison law IV</span> <span class="cwebmacronumber">8.5</span>&gt;<span class="plain">;</span>
&lt;<span class="cwebmacro">Apply comparison law V</span> <span class="cwebmacronumber">8.6</span>&gt;<span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> 0;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::compare_specificity is used in 21/rl (<a href="21-rl.html#SP13">&#167;13</a>).</p>
<p class="inwebparagraph"><a id="SP8_1"></a><b>&#167;8.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Extract these from the PHRCDs under comparison</span> <span class="cwebmacronumber">8.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rcd1</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">sc1</span><span class="plain"> = </span><span class="identifier">rcd1</span><span class="plain">-</span><span class="element">&gt;during_scene</span><span class="plain">;</span>
<span class="identifier">ap1</span><span class="plain"> = &amp;(</span><span class="identifier">rcd1</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">);</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="identifier">AL1W</span><span class="plain"> = </span><span class="identifier">rcd1</span><span class="plain">-</span><span class="element">&gt;activity_context</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">sc1</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">ap1</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="identifier">AL1W</span><span class="plain"> = </span><span class="identifier">EMPTY_WORDING</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rcd2</span><span class="plain">) {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">sc2</span><span class="plain"> = </span><span class="identifier">rcd2</span><span class="plain">-</span><span class="element">&gt;during_scene</span><span class="plain">;</span>
<span class="identifier">ap2</span><span class="plain"> = &amp;(</span><span class="identifier">rcd2</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">);</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="identifier">AL2W</span><span class="plain"> = </span><span class="identifier">rcd2</span><span class="plain">-</span><span class="element">&gt;activity_context</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">sc2</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">ap2</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="identifier">AL2W</span><span class="plain"> = </span><span class="identifier">EMPTY_WORDING</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP8">&#167;8</a>.</p>
<p class="inwebparagraph"><a id="SP8_2"></a><b>&#167;8.2. </b>More constraints beats fewer.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Apply comparison law I</span> <span class="cwebmacronumber">8.2</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">c_s_stage_law</span><span class="plain"> = </span><span class="string">"I - Number of aspects constrained"</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">rct1</span><span class="plain"> = 0, </span><span class="identifier">rct2</span><span class="plain"> = 0;</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="identifier">rct1</span><span class="plain"> = </span><span class="identifier">PL::Actions::Patterns::count_aspects</span><span class="plain">(</span><span class="identifier">ap1</span><span class="plain">);</span>
<span class="identifier">rct2</span><span class="plain"> = </span><span class="identifier">PL::Actions::Patterns::count_aspects</span><span class="plain">(</span><span class="identifier">ap2</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">sc1</span><span class="plain">) </span><span class="identifier">rct1</span><span class="plain">++; </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">sc2</span><span class="plain">) </span><span class="identifier">rct2</span><span class="plain">++;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">AL1W</span><span class="plain">)) </span><span class="identifier">rct1</span><span class="plain">++; </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">AL2W</span><span class="plain">)) </span><span class="identifier">rct2</span><span class="plain">++;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rct1</span><span class="plain"> &gt; </span><span class="identifier">rct2</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> 1;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rct1</span><span class="plain"> &lt; </span><span class="identifier">rct2</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> -1;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP8">&#167;8</a>.</p>
<p class="inwebparagraph"><a id="SP8_3"></a><b>&#167;8.3. </b>If both have scene requirements, a narrow requirement beats a broad one.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Apply comparison law II</span> <span class="cwebmacronumber">8.3</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">sc1</span><span class="plain">) &amp;&amp; (</span><span class="identifier">sc2</span><span class="plain">)) {</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">rv</span><span class="plain"> = </span><span class="functiontext">Specifications::compare_specificity</span><span class="plain">(</span><span class="identifier">sc1</span><span class="plain">, </span><span class="identifier">sc2</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rv</span><span class="plain"> != 0) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">rv</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="plain">#</span><span class="identifier">endif</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP8">&#167;8</a>.</p>
<p class="inwebparagraph"><a id="SP8_4"></a><b>&#167;8.4. </b>More when/while conditions beats fewer.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Apply comparison law III</span> <span class="cwebmacronumber">8.4</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">c_s_stage_law</span><span class="plain"> = </span><span class="string">"III - When/while requirement"</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">AL1W</span><span class="plain">)) &amp;&amp; (</span><span class="identifier">Wordings::empty</span><span class="plain">(</span><span class="identifier">AL2W</span><span class="plain">))) </span><span class="reserved">return</span><span class="plain"> 1;</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">Wordings::empty</span><span class="plain">(</span><span class="identifier">AL1W</span><span class="plain">)) &amp;&amp; (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">AL2W</span><span class="plain">))) </span><span class="reserved">return</span><span class="plain"> -1;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">AL1W</span><span class="plain">)) {</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">n1</span><span class="plain"> = </span><span class="functiontext">Activities::count_list</span><span class="plain">(</span><span class="identifier">rcd1</span><span class="plain">-</span><span class="element">&gt;avl</span><span class="plain">);</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">n2</span><span class="plain"> = </span><span class="functiontext">Activities::count_list</span><span class="plain">(</span><span class="identifier">rcd2</span><span class="plain">-</span><span class="element">&gt;avl</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">n1</span><span class="plain"> &gt; </span><span class="identifier">n2</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> 1;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">n2</span><span class="plain"> &gt; </span><span class="identifier">n1</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> -1;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP8">&#167;8</a>.</p>
<p class="inwebparagraph"><a id="SP8_5"></a><b>&#167;8.5. </b>A more specific action (or parameter) beats a less specific one.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Apply comparison law IV</span> <span class="cwebmacronumber">8.5</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">c_s_stage_law</span><span class="plain"> = </span><span class="string">"IV - Action requirement"</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">rv</span><span class="plain"> = </span><span class="identifier">PL::Actions::Patterns::compare_specificity</span><span class="plain">(</span><span class="identifier">ap1</span><span class="plain">, </span><span class="identifier">ap2</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rv</span><span class="plain"> != 0) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">rv</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP8">&#167;8</a>.</p>
<p class="inwebparagraph"><a id="SP8_6"></a><b>&#167;8.6. </b>A rule with a scene requirement beats one without.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Apply comparison law V</span> <span class="cwebmacronumber">8.6</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">c_s_stage_law</span><span class="plain"> = </span><span class="string">"V - Scene requirement"</span><span class="plain">;</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">sc1</span><span class="plain"> != </span><span class="identifier">NULL</span><span class="plain">) &amp;&amp; (</span><span class="identifier">sc2</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">)) </span><span class="reserved">return</span><span class="plain"> 1;</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">sc1</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) &amp;&amp; (</span><span class="identifier">sc2</span><span class="plain"> != </span><span class="identifier">NULL</span><span class="plain">)) </span><span class="reserved">return</span><span class="plain"> -1;</span>
<span class="plain">#</span><span class="identifier">endif</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP8">&#167;8</a>.</p>
<p class="inwebparagraph"><a id="SP9"></a><b>&#167;9. Activity list on demand. </b>There's a tricky race condition here: the activity list has to be parsed
with the correct rulebook variables or it won't parse; but the rulebook
variables won't be known until the rule is booked; and in order to book
the rule, Inform needs to sort it into logical sequence with others
already in the same rulebook; and that requires knowledge of the
conditions of usage; which in turn requires the activity list. So the
following function is called at the last possible moment in the booking
process.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Phrases::Context::ensure_avl</span><span class="plain">(</span><span class="reserved">rule</span><span class="plain"> *</span><span class="identifier">R</span><span class="plain">) {</span>
<span class="reserved">phrase</span><span class="plain"> *</span><span class="identifier">ph</span><span class="plain"> = </span><span class="identifier">R</span><span class="plain">-</span><span class="element">&gt;defn_as_phrase</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ph</span><span class="plain">) {</span>
<span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">rcd</span><span class="plain"> = &amp;(</span><span class="identifier">ph</span><span class="plain">-</span><span class="element">&gt;runtime_context_data</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">rcd</span><span class="plain">-</span><span class="element">&gt;activity_context</span><span class="plain">)) {</span>
<span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">save_cs</span><span class="plain"> = </span><span class="identifier">current_sentence</span><span class="plain">;</span>
<span class="identifier">current_sentence</span><span class="plain"> = </span><span class="identifier">rcd</span><span class="plain">-</span><span class="element">&gt;activity_where</span><span class="plain">;</span>
<span class="reserved">ph_stack_frame</span><span class="plain"> *</span><span class="identifier">phsf</span><span class="plain"> = &amp;(</span><span class="identifier">ph</span><span class="plain">-</span><span class="element">&gt;stack_frame</span><span class="plain">);</span>
<span class="functiontext">Frames::make_current</span><span class="plain">(</span><span class="identifier">phsf</span><span class="plain">);</span>
<span class="functiontext">Frames::set_stvol</span><span class="plain">(</span><span class="identifier">phsf</span><span class="plain">, </span><span class="identifier">R</span><span class="plain">-</span><span class="element">&gt;listed_stv_owners</span><span class="plain">);</span>
<span class="identifier">rcd</span><span class="plain">-</span><span class="element">&gt;avl</span><span class="plain"> = </span><span class="functiontext">Activities::parse_list</span><span class="plain">(</span><span class="identifier">rcd</span><span class="plain">-</span><span class="element">&gt;activity_context</span><span class="plain">);</span>
<span class="identifier">current_sentence</span><span class="plain"> = </span><span class="identifier">save_cs</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::ensure_avl is used in 21/rl2 (<a href="21-rl2.html#SP19">&#167;19</a>).</p>
<p class="inwebparagraph"><a id="SP10"></a><b>&#167;10. Compiling the firing test. </b>Each rule compiles to a routine, and this routine is called whenever the
opportunity might exist for the rule to fire. The structure of this is
similar to:
</p>
<p class="inwebparagraph"></p>
<pre class="display">
<span class="plain">[ Rule;</span>
<span class="plain"> if (some-firing-condition) {</span>
<span class="plain"> ...</span>
<span class="plain"> return some-default-outcome;</span>
<span class="plain"> }</span>
<span class="plain">];</span>
</pre>
<p class="inwebparagraph">The "test head" is the "if" line here, and the "test tail" is the "}". The
return statement isn't necessarily reached, because even if the firing
condition holds, the "..." code may decide to return in some other way.
It provides only a default to cover rules which don't specify an outcome.
</p>
<p class="inwebparagraph">In general the test is more elaborate than a single "if", though not very
much.
</p>
<pre class="display">
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Phrases::Context::compile_test_head</span><span class="plain">(</span><span class="reserved">phrase</span><span class="plain"> *</span><span class="identifier">ph</span><span class="plain">, </span><span class="reserved">applicability_condition</span><span class="plain"> *</span><span class="identifier">acl</span><span class="plain">) {</span>
<span class="identifier">inter_name</span><span class="plain"> *</span><span class="identifier">identifier</span><span class="plain"> = </span><span class="functiontext">Phrases::iname</span><span class="plain">(</span><span class="identifier">ph</span><span class="plain">);</span>
<span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain"> = &amp;(</span><span class="identifier">ph</span><span class="plain">-</span><span class="element">&gt;runtime_context_data</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Rules::compile_constraint</span><span class="plain">(</span><span class="identifier">acl</span><span class="plain">) == </span><span class="identifier">TRUE</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">tests</span><span class="plain"> = 0;</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;during_scene</span><span class="plain">) </span>&lt;<span class="cwebmacro">Compile a scene test head</span> <span class="cwebmacronumber">10.2</span>&gt;<span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">PL::Actions::Patterns::is_valid</span><span class="plain">(&amp;(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">))) </span>&lt;<span class="cwebmacro">Compile an action test head</span> <span class="cwebmacronumber">10.3</span>&gt;
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;always_test_actor</span><span class="plain"> == </span><span class="identifier">TRUE</span><span class="plain">) </span>&lt;<span class="cwebmacro">Compile an actor-is-player test head</span> <span class="cwebmacronumber">10.4</span>&gt;<span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;activity_context</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Compile an activity or explicit condition test head</span> <span class="cwebmacronumber">10.5</span>&gt;<span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">tests</span><span class="plain"> &gt; 0) || (</span><span class="identifier">ph</span><span class="plain">-</span><span class="element">&gt;compile_with_run_time_debugging</span><span class="plain">)) {</span>
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">IF_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::val_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_number</span><span class="plain">, </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">DEBUG_RULES_HL</span><span class="plain">));</span>
<span class="identifier">Produce::code</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::inv_call_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">DB_RULE_HL</span><span class="plain">));</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::val_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_value</span><span class="plain">, </span><span class="identifier">identifier</span><span class="plain">);</span>
<span class="identifier">Produce::val</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_number</span><span class="plain">, </span><span class="identifier">LITERAL_IVAL</span><span class="plain">, (</span><span class="identifier">inter_t</span><span class="plain">) </span><span class="identifier">ph</span><span class="plain">-&gt;</span><span class="identifier">allocation_id</span><span class="plain">);</span>
<span class="identifier">Produce::val</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_number</span><span class="plain">, </span><span class="identifier">LITERAL_IVAL</span><span class="plain">, 0);</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="plain">}</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::compile_test_head is used in 25/cp (<a href="25-cp.html#SP3_3">&#167;3.3</a>).</p>
<p class="inwebparagraph"><a id="SP10_1"></a><b>&#167;10.1. </b>This is almost the up-down reflection of the head, but note that it begins
with the default outcome return (see above).
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Phrases::Context::compile_test_tail</span><span class="plain">(</span><span class="reserved">phrase</span><span class="plain"> *</span><span class="identifier">ph</span><span class="plain">, </span><span class="reserved">applicability_condition</span><span class="plain"> *</span><span class="identifier">acl</span><span class="plain">) {</span>
<span class="identifier">inter_name</span><span class="plain"> *</span><span class="identifier">identifier</span><span class="plain"> = </span><span class="functiontext">Phrases::iname</span><span class="plain">(</span><span class="identifier">ph</span><span class="plain">);</span>
<span class="reserved">ph_runtime_context_data</span><span class="plain"> *</span><span class="identifier">phrcd</span><span class="plain"> = &amp;(</span><span class="identifier">ph</span><span class="plain">-</span><span class="element">&gt;runtime_context_data</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;compile_for_rulebook</span><span class="plain">) {</span>
<span class="reserved">rulebook</span><span class="plain"> *</span><span class="identifier">rb</span><span class="plain"> = *(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;compile_for_rulebook</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rb</span><span class="plain">) </span><span class="functiontext">Rulebooks::Outcomes::compile_default_outcome</span><span class="plain">(</span><span class="functiontext">Rulebooks::get_outcomes</span><span class="plain">(</span><span class="identifier">rb</span><span class="plain">));</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::nonempty</span><span class="plain">(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;activity_context</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Compile an activity or explicit condition test tail</span> <span class="cwebmacronumber">10.1.4</span>&gt;<span class="plain">;</span>
<span class="plain">#</span><span class="identifier">ifdef</span><span class="plain"> </span><span class="identifier">IF_MODULE</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">PL::Actions::Patterns::is_valid</span><span class="plain">(&amp;(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">))) </span>&lt;<span class="cwebmacro">Compile an action test tail</span> <span class="cwebmacronumber">10.1.2</span>&gt;
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;always_test_actor</span><span class="plain"> == </span><span class="identifier">TRUE</span><span class="plain">) </span>&lt;<span class="cwebmacro">Compile an actor-is-player test tail</span> <span class="cwebmacronumber">10.1.3</span>&gt;<span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;during_scene</span><span class="plain">) </span>&lt;<span class="cwebmacro">Compile a scene test tail</span> <span class="cwebmacronumber">10.1.1</span>&gt;<span class="plain">;</span>
<span class="plain">#</span><span class="identifier">endif</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Phrases::Context::compile_test_tail is used in 25/cp (<a href="25-cp.html#SP3_3">&#167;3.3</a>).</p>
<p class="inwebparagraph"><a id="SP10_2"></a><b>&#167;10.2. Scene test. </b></p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Compile a scene test head</span> <span class="cwebmacronumber">10.2</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">IFELSE_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">PL::Scenes::emit_during_clause</span><span class="plain">(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;during_scene</span><span class="plain">);</span>
<span class="identifier">Produce::code</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">tests</span><span class="plain">++;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10">&#167;10</a>.</p>
<p class="inwebparagraph"><a id="SP10_1_1"></a><b>&#167;10.1.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Compile a scene test tail</span> <span class="cwebmacronumber">10.1.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">inter_t</span><span class="plain"> </span><span class="identifier">failure_code</span><span class="plain"> = 1;</span>
&lt;<span class="cwebmacro">Compile a generic test fail</span> <span class="cwebmacronumber">10.1.1.1</span>&gt;<span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10_1">&#167;10.1</a>.</p>
<p class="inwebparagraph"><a id="SP10_3"></a><b>&#167;10.3. Action test. </b></p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Compile an action test head</span> <span class="cwebmacronumber">10.3</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">IFELSE_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;never_test_actor</span><span class="plain">)</span>
<span class="identifier">PL::Actions::Patterns::emit_pattern_match</span><span class="plain">(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
<span class="reserved">else</span>
<span class="identifier">PL::Actions::Patterns::emit_pattern_match</span><span class="plain">(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Produce::code</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">tests</span><span class="plain">++;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">PL::Actions::Patterns::object_based</span><span class="plain">(&amp;(</span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;ap</span><span class="plain">))) {</span>
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">STORE_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::ref_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_object</span><span class="plain">, </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">SELF_HL</span><span class="plain">));</span>
<span class="identifier">Produce::val_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_object</span><span class="plain">, </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">NOUN_HL</span><span class="plain">));</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10">&#167;10</a>.</p>
<p class="inwebparagraph"><a id="SP10_1_2"></a><b>&#167;10.1.2. </b><code class="display">
&lt;<span class="cwebmacrodefn">Compile an action test tail</span> <span class="cwebmacronumber">10.1.2</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">inter_t</span><span class="plain"> </span><span class="identifier">failure_code</span><span class="plain"> = 2;</span>
&lt;<span class="cwebmacro">Compile a generic test fail</span> <span class="cwebmacronumber">10.1.1.1</span>&gt;<span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10_1">&#167;10.1</a>.</p>
<p class="inwebparagraph"><a id="SP10_4"></a><b>&#167;10.4. Actor-is-player test. </b></p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Compile an actor-is-player test head</span> <span class="cwebmacronumber">10.4</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">IFELSE_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">EQ_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::val_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_object</span><span class="plain">, </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">ACTOR_HL</span><span class="plain">));</span>
<span class="identifier">Produce::val_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_object</span><span class="plain">, </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">PLAYER_HL</span><span class="plain">));</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::code</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">tests</span><span class="plain">++;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10">&#167;10</a>.</p>
<p class="inwebparagraph"><a id="SP10_1_3"></a><b>&#167;10.1.3. </b><code class="display">
&lt;<span class="cwebmacrodefn">Compile an actor-is-player test tail</span> <span class="cwebmacronumber">10.1.3</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">inter_t</span><span class="plain"> </span><span class="identifier">failure_code</span><span class="plain"> = 3;</span>
&lt;<span class="cwebmacro">Compile a generic test fail</span> <span class="cwebmacronumber">10.1.1.1</span>&gt;<span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10_1">&#167;10.1</a>.</p>
<p class="inwebparagraph"><a id="SP10_5"></a><b>&#167;10.5. Activity-or-condition test. </b></p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Compile an activity or explicit condition test head</span> <span class="cwebmacronumber">10.5</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">IFELSE_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="reserved">activity_list</span><span class="plain"> *</span><span class="identifier">avl</span><span class="plain"> = </span><span class="identifier">phrcd</span><span class="plain">-</span><span class="element">&gt;avl</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">avl</span><span class="plain">) {</span>
<span class="functiontext">Activities::emit_activity_list</span><span class="plain">(</span><span class="identifier">avl</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
<span class="identifier">Problems::Issue::sentence_problem</span><span class="plain">(</span><span class="identifier">_p_</span><span class="plain">(</span><span class="identifier">PM_BadWhenWhile</span><span class="plain">),</span>
<span class="string">"I don't understand the 'when/while' clause"</span><span class="plain">,</span>
<span class="string">"which should name activities or conditions."</span><span class="plain">);</span>
<span class="identifier">Produce::val</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_truth_state</span><span class="plain">, </span><span class="identifier">LITERAL_IVAL</span><span class="plain">, 0);</span>
<span class="plain">}</span>
<span class="identifier">Produce::code</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="functiontext">Activities::annotate_list_for_cross_references</span><span class="plain">(</span><span class="identifier">avl</span><span class="plain">, </span><span class="identifier">ph</span><span class="plain">);</span>
<span class="identifier">tests</span><span class="plain">++;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10">&#167;10</a>.</p>
<p class="inwebparagraph"><a id="SP10_1_4"></a><b>&#167;10.1.4. </b><code class="display">
&lt;<span class="cwebmacrodefn">Compile an activity or explicit condition test tail</span> <span class="cwebmacronumber">10.1.4</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">inter_t</span><span class="plain"> </span><span class="identifier">failure_code</span><span class="plain"> = 4;</span>
&lt;<span class="cwebmacro">Compile a generic test fail</span> <span class="cwebmacronumber">10.1.1.1</span>&gt;<span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10_1">&#167;10.1</a>.</p>
<p class="inwebparagraph"><a id="SP10_1_1_1"></a><b>&#167;10.1.1.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Compile a generic test fail</span> <span class="cwebmacronumber">10.1.1.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::code</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">IF_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::inv_primitive</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">GT_BIP</span><span class="plain">);</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::val_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_number</span><span class="plain">, </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">DEBUG_RULES_HL</span><span class="plain">));</span>
<span class="identifier">Produce::val</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_number</span><span class="plain">, </span><span class="identifier">LITERAL_IVAL</span><span class="plain">, 1);</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::code</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::inv_call_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="functiontext">Hierarchy::find</span><span class="plain">(</span><span class="constant">DB_RULE_HL</span><span class="plain">));</span>
<span class="identifier">Produce::down</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::val_iname</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_value</span><span class="plain">, </span><span class="identifier">identifier</span><span class="plain">);</span>
<span class="identifier">Produce::val</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_number</span><span class="plain">, </span><span class="identifier">LITERAL_IVAL</span><span class="plain">, (</span><span class="identifier">inter_t</span><span class="plain">) </span><span class="identifier">ph</span><span class="plain">-&gt;</span><span class="identifier">allocation_id</span><span class="plain">);</span>
<span class="identifier">Produce::val</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">(), </span><span class="identifier">K_number</span><span class="plain">, </span><span class="identifier">LITERAL_IVAL</span><span class="plain">, </span><span class="identifier">failure_code</span><span class="plain">);</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
<span class="identifier">Produce::up</span><span class="plain">(</span><span class="functiontext">Emit::tree</span><span class="plain">());</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP10_1_1">&#167;10.1.1</a>, <a href="#SP10_1_2">&#167;10.1.2</a>, <a href="#SP10_1_3">&#167;10.1.3</a>, <a href="#SP10_1_4">&#167;10.1.4</a>.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="22-pu.html">Back to 'Phrase Usage'</a></li><li><a href="22-ptd.html">Continue with 'Phrase Type Data'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>
Reference in a new issue View git blame Copy permalink