1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-05 08:34:22 +03:00
inform7/docs/if-module/4-nap.html
2019-04-15 09:58:27 +01:00

168 lines
23 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>4/los</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 '4/nap' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">if</a></li><li><a href="index.html#4">Chapter 4: Actions</a></li><li><b>Named Action Patterns</b></li></ul><p class="purpose">A named action pattern is a named categorisation of actions, such as "acting suspiciously", which is a disjunction of action patterns (stored in a linked list).</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Definitions</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Definitions. </b></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">named_action_pattern</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">noun</span><span class="plain"> *</span><span class="identifier">name</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">action_pattern</span><span class="plain"> *</span><span class="identifier">first</span><span class="plain">; </span> <span class="comment">list of APs defining this NAP</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">text_of_declaration</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">inter_name</span><span class="plain"> *</span><span class="identifier">nap_iname</span><span class="plain">; </span> <span class="comment">for an I6 routine to test this NAP</span>
<span class="identifier">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">named_action_pattern</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure named_action_pattern is accessed in 2/bd, 3/tnt, 3/sm, 3/tp, 3/bck, 3/rgn, 3/tm, 3/em, 3/sc, 3/scn, 4/act, 4/anl, 5/gp, 5/gv, 5/gpr and here.</p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b></p>
<pre class="display">
<span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="functiontext">PL::Actions::Patterns::Named::nap_new</span><span class="plain">(</span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">W</span><span class="plain">) {</span>
<span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="identifier">nap</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">named_action_pattern</span><span class="plain">);</span>
<span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;first</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;text_of_declaration</span><span class="plain"> = </span><span class="identifier">W</span><span class="plain">;</span>
<span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;name</span><span class="plain"> = </span><span class="identifier">Nouns::new_proper_noun</span><span class="plain">(</span><span class="identifier">W</span><span class="plain">, </span><span class="identifier">NEUTER_GENDER</span><span class="plain">,</span>
<span class="identifier">REGISTER_SINGULAR_NTOPT</span><span class="plain"> + </span><span class="identifier">PARSE_EXACTLY_NTOPT</span><span class="plain">,</span>
<span class="identifier">NAMED_AP_MC</span><span class="plain">, </span><span class="identifier">Rvalues::from_named_action_pattern</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">));</span>
<span class="identifier">package_request</span><span class="plain"> *</span><span class="identifier">PR</span><span class="plain"> = </span><span class="identifier">Hierarchy::local_package</span><span class="plain">(</span><span class="identifier">NAMED_ACTION_PATTERNS_HAP</span><span class="plain">);</span>
<span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;nap_iname</span><span class="plain"> = </span><span class="identifier">Hierarchy::make_iname_in</span><span class="plain">(</span><span class="identifier">NAP_FN_HL</span><span class="plain">, </span><span class="identifier">PR</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">nap</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="functiontext">PL::Actions::Patterns::Named::by_name</span><span class="plain">(</span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">W</span><span class="plain">) {</span>
<span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">p</span><span class="plain"> = </span><span class="identifier">ExParser::parse_excerpt</span><span class="plain">(</span><span class="identifier">NAMED_AP_MC</span><span class="plain">, </span><span class="identifier">W</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">p</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">Rvalues::to_named_action_pattern</span><span class="plain">(</span><span class="identifier">p</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="identifier">inter_name</span><span class="plain"> *</span><span class="functiontext">PL::Actions::Patterns::Named::identifier</span><span class="plain">(</span><span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="identifier">nap</span><span class="plain">) {</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;nap_iname</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Actions::Patterns::Named::add</span><span class="plain">(</span><span class="reserved">action_pattern</span><span class="plain"> *</span><span class="identifier">app</span><span class="plain">, </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">W</span><span class="plain">) {</span>
<span class="identifier">app</span><span class="plain">-</span><span class="element">&gt;entered_into_NAP_here</span><span class="plain"> = </span><span class="identifier">current_sentence</span><span class="plain">;</span>
<span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="identifier">nap</span><span class="plain">;</span>
<span class="identifier">nap</span><span class="plain"> = </span><span class="functiontext">PL::Actions::Patterns::Named::by_name</span><span class="plain">(</span><span class="identifier">W</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">nap</span><span class="plain">) {</span>
<span class="reserved">action_pattern</span><span class="plain"> *</span><span class="identifier">list</span><span class="plain">;</span>
<span class="identifier">list</span><span class="plain"> = </span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;first</span><span class="plain">; </span><span class="reserved">while</span><span class="plain"> (</span><span class="identifier">list</span><span class="plain">-</span><span class="element">&gt;next</span><span class="plain">) </span><span class="identifier">list</span><span class="plain"> = </span><span class="identifier">list</span><span class="plain">-</span><span class="element">&gt;next</span><span class="plain">;</span>
<span class="identifier">list</span><span class="plain">-</span><span class="element">&gt;next</span><span class="plain"> = </span><span class="identifier">app</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">nap</span><span class="plain"> = </span><span class="functiontext">PL::Actions::Patterns::Named::nap_new</span><span class="plain">(</span><span class="identifier">W</span><span class="plain">);</span>
<span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;first</span><span class="plain"> = </span><span class="identifier">app</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">PL::Actions::Patterns::Named::within_action_context</span><span class="plain">(</span><span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="identifier">nap</span><span class="plain">, </span><span class="reserved">action_name</span><span class="plain"> *</span><span class="identifier">an</span><span class="plain">) {</span>
<span class="reserved">action_pattern</span><span class="plain"> *</span><span class="identifier">ap</span><span class="plain">;</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="identifier">ap</span><span class="plain"> = </span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;first</span><span class="plain">; </span><span class="identifier">ap</span><span class="plain">; </span><span class="identifier">ap</span><span class="plain"> = </span><span class="identifier">ap</span><span class="plain">-</span><span class="element">&gt;next</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">PL::Actions::Patterns::within_action_context</span><span class="plain">(</span><span class="identifier">ap</span><span class="plain">, </span><span class="identifier">an</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>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Actions::Patterns::Named::index</span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">) {</span>
<span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="identifier">nap</span><span class="plain">;</span>
<span class="reserved">action_pattern</span><span class="plain"> *</span><span class="identifier">ap</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">num_naps</span><span class="plain"> = </span><span class="identifier">NUMBER_CREATED</span><span class="plain">(</span><span class="reserved">named_action_pattern</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">num_naps</span><span class="plain"> == 0) {</span>
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"No names for kinds of action have yet been defined."</span><span class="plain">);</span>
<span class="identifier">HTML_CLOSE</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">, </span><span class="reserved">named_action_pattern</span><span class="plain">) {</span>
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">); </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"&lt;b&gt;%+W&lt;/b&gt;"</span><span class="plain">, </span><span class="identifier">Nouns::nominative</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;name</span><span class="plain">));</span>
<span class="identifier">Index::link</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">Wordings::first_wn</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;text_of_declaration</span><span class="plain">));</span>
<span class="identifier">HTML_TAG</span><span class="plain">(</span><span class="string">"br"</span><span class="plain">);</span>
<span class="identifier">ap</span><span class="plain"> = </span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;first</span><span class="plain">;</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"&amp;nbsp;&amp;nbsp;&lt;i&gt;defined as any of the following acts:&lt;/i&gt;\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
<span class="reserved">while</span><span class="plain"> (</span><span class="identifier">ap</span><span class="plain"> != </span><span class="identifier">NULL</span><span class="plain">) {</span>
<span class="identifier">HTML_TAG</span><span class="plain">(</span><span class="string">"br"</span><span class="plain">);</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;%+W"</span><span class="plain">, </span><span class="identifier">ap</span><span class="plain">-</span><span class="element">&gt;text_of_pattern</span><span class="plain">);</span>
<span class="identifier">Index::link</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">Wordings::first_wn</span><span class="plain">(</span><span class="identifier">ap</span><span class="plain">-</span><span class="element">&gt;text_of_pattern</span><span class="plain">));</span>
<span class="identifier">ap</span><span class="plain"> = </span><span class="identifier">ap</span><span class="plain">-</span><span class="element">&gt;next</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">HTML_CLOSE</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Actions::Patterns::Named::compile</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="identifier">nap</span><span class="plain">;</span>
<span class="reserved">action_pattern</span><span class="plain"> *</span><span class="identifier">ap</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">, </span><span class="reserved">named_action_pattern</span><span class="plain">) {</span>
<span class="identifier">packaging_state</span><span class="plain"> </span><span class="identifier">save</span><span class="plain"> = </span><span class="identifier">Routines::begin</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;nap_iname</span><span class="plain">);</span>
<span class="identifier">ap</span><span class="plain"> = </span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;first</span><span class="plain">;</span>
<span class="reserved">while</span><span class="plain"> (</span><span class="identifier">ap</span><span class="plain"> != </span><span class="identifier">NULL</span><span class="plain">) {</span>
<span class="identifier">current_sentence</span><span class="plain"> = </span><span class="identifier">ap</span><span class="plain">-</span><span class="element">&gt;entered_into_NAP_here</span><span class="plain">;</span>
<span class="identifier">Emit::inv_primitive</span><span class="plain">(</span><span class="identifier">if_interp</span><span class="plain">);</span>
<span class="identifier">Emit::down</span><span class="plain">();</span>
<span class="functiontext">PL::Actions::Patterns::emit_pattern_match</span><span class="plain">(*</span><span class="identifier">ap</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">);</span>
<span class="identifier">Emit::code</span><span class="plain">();</span>
<span class="identifier">Emit::down</span><span class="plain">();</span>
<span class="identifier">Emit::rtrue</span><span class="plain">();</span>
<span class="identifier">Emit::up</span><span class="plain">();</span>
<span class="identifier">Emit::up</span><span class="plain">();</span>
<span class="identifier">ap</span><span class="plain"> = </span><span class="identifier">ap</span><span class="plain">-</span><span class="element">&gt;next</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">Emit::rfalse</span><span class="plain">();</span>
<span class="identifier">Routines::end</span><span class="plain">(</span><span class="identifier">save</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Actions::Patterns::Named::index_for_extension</span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">, </span><span class="identifier">source_file</span><span class="plain"> *</span><span class="identifier">sf</span><span class="plain">, </span><span class="identifier">extension_file</span><span class="plain"> *</span><span class="identifier">ef</span><span class="plain">) {</span>
<span class="reserved">named_action_pattern</span><span class="plain"> *</span><span class="identifier">nap</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">kc</span><span class="plain"> = 0;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">, </span><span class="reserved">named_action_pattern</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Lexer::file_of_origin</span><span class="plain">(</span><span class="identifier">Wordings::first_wn</span><span class="plain">(</span><span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;text_of_declaration</span><span class="plain">)) == </span><span class="identifier">ef</span><span class="plain">-&gt;</span><span class="identifier">read_into_file</span><span class="plain">)</span>
<span class="identifier">kc</span><span class="plain"> = </span><span class="identifier">Extensions::Documentation::document_headword</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">kc</span><span class="plain">, </span><span class="identifier">ef</span><span class="plain">, </span><span class="string">"Kinds of action"</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"kind of action"</span><span class="plain">,</span>
<span class="identifier">nap</span><span class="plain">-</span><span class="element">&gt;text_of_declaration</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">kc</span><span class="plain"> != 0) </span><span class="identifier">HTML_CLOSE</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function PL::Actions::Patterns::Named::nap_new appears nowhere else.</p>
<p class="endnote">The function PL::Actions::Patterns::Named::by_name is used in 4/anl (<a href="4-anl.html#SP6">&#167;6</a>).</p>
<p class="endnote">The function PL::Actions::Patterns::Named::identifier is used in 4/anl (<a href="4-anl.html#SP9">&#167;9</a>).</p>
<p class="endnote">The function PL::Actions::Patterns::Named::add is used in 4/ap (<a href="4-ap.html#SP6">&#167;6</a>).</p>
<p class="endnote">The function PL::Actions::Patterns::Named::within_action_context is used in 4/ap (<a href="4-ap.html#SP5">&#167;5</a>).</p>
<p class="endnote">The function PL::Actions::Patterns::Named::index appears nowhere else.</p>
<p class="endnote">The function PL::Actions::Patterns::Named::compile appears nowhere else.</p>
<p class="endnote">The function PL::Actions::Patterns::Named::index_for_extension appears nowhere else.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="4-los.html">Back to 'Looping Over Scope'</a></li><li><a href="4-ai.html">Continue with 'Actions Index'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>