inweb-bootstrap/docs/inweb/6-rw.html

577 lines
90 KiB
HTML
Raw Normal View History

2020-03-23 21:39:27 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
2020-04-08 22:41:00 +00:00
<title>Readme Writeme</title>
2020-03-23 21:39:27 +00:00
<meta name="viewport" content="width=device-width initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
2020-04-10 20:29:28 +00:00
2020-03-23 21:39:27 +00:00
</head>
<body>
<nav role="navigation">
2020-04-13 16:06:45 +00:00
<h1><a href="../index.html">
2020-04-14 17:36:42 +00:00
<img src="../docs-src/Figures/Octagram184x184.png" width=72 height=72">
2020-04-13 16:06:45 +00:00
</a></h1>
<ul><li><a href="index.html"><span class="selectedlink">inweb</span></a></li>
</ul><h2>Foundation Module</h2><ul>
<li><a href="../foundation-module/index.html">foundation</a></li>
2020-03-23 21:39:27 +00:00
<li><a href="../foundation-test/index.html">foundation-test</a></li>
2020-04-13 16:06:45 +00:00
</ul><h2>Example Webs</h2><ul>
2020-04-12 16:24:23 +00:00
<li><a href="../goldbach/index.html">goldbach</a></li>
<li><a href="../twinprimes/twinprimes.html">twinprimes</a></li>
2020-04-15 22:45:08 +00:00
<li><a href="../eastertide/index.html">eastertide</a></li>
2020-04-14 17:36:42 +00:00
</ul><h2>Repository</h2><ul>
2020-04-14 19:29:03 +00:00
<li><a href="https://github.com/ganelson/inweb"><img src="../github.png" height=18> github</a></li>
2020-04-14 17:36:42 +00:00
</ul><h2>Related Projects</h2><ul>
<li><a href="../../../inform/docs/index.html">inform</a></li>
<li><a href="../../../intest/docs/index.html">intest</a></li>
2020-03-23 21:39:27 +00:00
2020-04-13 16:06:45 +00:00
</ul>
2020-03-23 21:39:27 +00:00
</nav>
<main role="main">
2020-04-16 22:51:03 +00:00
<!--Weave of 'Readme Writeme' generated by Inweb-->
2020-04-13 16:06:45 +00:00
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="index.html">inweb</a></li><li><a href="index.html#6">Chapter 6: Extras</a></li><li><b>Readme Writeme</b></li></ul><p class="purpose">To construct Readme and similar files.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b>This is a very simple generator for <code class="display"><span class="extract">README.md</span></code> files, written in Markdown
syntax, but with a few macro expansions of our own. The prototype file, which
uses these extra macros, is expanded to the final file, which does not.
</p>
<p class="inwebparagraph">As we scan through the prototype file, we keep track of this:
</p>
<pre class="display">
2020-04-06 11:26:10 +00:00
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">write_state</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">linked_list</span><span class="plain"> *</span><span class="identifier">known_macros</span><span class="plain">; </span><span class="comment"> of <code class="display"><span class="extract">macro</span></code></span>
2020-04-06 11:26:10 +00:00
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">current_definition</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">macro_tokens</span><span class="plain"> *</span><span class="identifier">stack_frame</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">write_state</span><span class="plain">;</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::write<button class="popup" onclick="togglePopup('usagePopup349')">...<span class="popuptext" id="usagePopup349">Usage of <b>Readme::write</b>:<br>Program Control - <a href="1-pc.html#SP7_1">&#167;7.1</a></span></button></span><span class="plain">(</span><span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">from</span><span class="plain">, </span><span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">to</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="constant">STDOUT</span><span class="plain">, </span><span class="string">"write-me: %f --&gt; %f\n"</span><span class="plain">, </span><span class="identifier">from</span><span class="plain">, </span><span class="identifier">to</span><span class="plain">);</span>
<span class="reserved">write_state</span><span class="plain"> </span><span class="identifier">ws</span><span class="plain">;</span>
<span class="identifier">ws</span><span class="plain">.</span><span class="element">current_definition</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">ws</span><span class="plain">.</span><span class="element">known_macros</span><span class="plain"> = </span><span class="identifier">NEW_LINKED_LIST</span><span class="plain">(</span><span class="reserved">macro</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain"> = </span><span class="functiontext"><a href="6-rw.html#SP3">Readme::new_macro</a></span><span class="plain">(</span><span class="identifier">I</span><span class="string">"version"</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">ADD_TO_LINKED_LIST</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="reserved">macro</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">.</span><span class="element">known_macros</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain"> = </span><span class="functiontext"><a href="6-rw.html#SP3">Readme::new_macro</a></span><span class="plain">(</span><span class="identifier">I</span><span class="string">"purpose"</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">ADD_TO_LINKED_LIST</span><span class="plain">(</span><span class="identifier">P</span><span class="plain">, </span><span class="reserved">macro</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">.</span><span class="element">known_macros</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = </span><span class="functiontext"><a href="6-rw.html#SP3">Readme::new_macro</a></span><span class="plain">(</span><span class="identifier">I</span><span class="string">"var"</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">ADD_TO_LINKED_LIST</span><span class="plain">(</span><span class="identifier">A</span><span class="plain">, </span><span class="reserved">macro</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">.</span><span class="element">known_macros</span><span class="plain">);</span>
<span class="identifier">ws</span><span class="plain">.</span><span class="element">stack_frame</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">text_stream</span><span class="plain"> </span><span class="identifier">file_to</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/2-str.html#SP24">Streams::open_to_file</a></span><span class="plain">(&amp;</span><span class="identifier">file_to</span><span class="plain">, </span><span class="identifier">to</span><span class="plain">, </span><span class="constant">UTF8_ENC</span><span class="plain">) == </span><span class="constant">FALSE</span><span class="plain">)</span>
<span class="functiontext"><a href="../foundation-module/3-em.html#SP2">Errors::fatal_with_file</a></span><span class="plain">(</span><span class="string">"can't write readme file"</span><span class="plain">, </span><span class="identifier">to</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">ws</span><span class="plain">.</span><span class="element">OUT</span><span class="plain"> = &amp;</span><span class="identifier">file_to</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-tf.html#SP5">TextFiles::read</a></span><span class="plain">(</span><span class="identifier">from</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="string">"unable to read template file"</span><span class="plain">, </span><span class="constant">TRUE</span><span class="plain">,</span>
<span class="plain">&amp;</span><span class="functiontext"><a href="6-rw.html#SP2">Readme::write_helper</a></span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, (</span><span class="reserved">void</span><span class="plain"> *) &amp;</span><span class="identifier">ws</span><span class="plain">);</span>
<span class="functiontext"><a href="../foundation-module/2-str.html#SP34">Streams::close</a></span><span class="plain">(&amp;</span><span class="identifier">file_to</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure write_state is private to this section.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>The file consists of definitions of macros, made one at a time, and
starting with <code class="display"><span class="extract">@define</span></code> and finishing with <code class="display"><span class="extract">@end</span></code>, and actual material.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::write_helper<button class="popup" onclick="togglePopup('usagePopup350')">...<span class="popuptext" id="usagePopup350">Usage of <b>Readme::write_helper</b>:<br><a href="6-rw.html#SP1">&#167;1</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">text</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">state</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">write_state</span><span class="plain"> *</span><span class="identifier">ws</span><span class="plain"> = (</span><span class="reserved">write_state</span><span class="plain"> *) </span><span class="identifier">state</span><span class="plain">;</span>
<span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</span><span class="plain"> = </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">OUT</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::create_mr</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">" *@end *"</span><span class="plain">)) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">)</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"@end without @define"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">else</span><span class="plain"> </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain">) {</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP8">Str::len</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain">-&gt;</span><span class="element">content</span><span class="plain">) &gt; </span><span class="constant">0</span><span class="plain">)</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain">-&gt;</span><span class="identifier">content</span><span class="plain">, </span><span class="string">"\n"</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain">-&gt;</span><span class="identifier">content</span><span class="plain">, </span><span class="string">"%S"</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">" *@define (%i+)(%c*)"</span><span class="plain">)) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain">)</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"@define without @end"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">else</span><span class="plain"> {</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">M</span><span class="plain"> = </span><span class="functiontext"><a href="6-rw.html#SP3">Readme::new_macro</a></span><span class="plain">(</span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[0], </span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[1], </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">current_definition</span><span class="plain"> = </span><span class="identifier">M</span><span class="plain">;</span>
<span class="identifier">ADD_TO_LINKED_LIST</span><span class="plain">(</span><span class="identifier">M</span><span class="plain">, </span><span class="reserved">macro</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="identifier">known_macros</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-06 11:26:10 +00:00
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"\n"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::dispose_of</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>The "content" of a macro is its definition, and the tokens are named
parameters.
</p>
<pre class="display">
2020-04-06 11:26:10 +00:00
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">macro</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</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">text_stream</span><span class="plain"> *</span><span class="identifier">content</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">macro_tokens</span><span class="plain"> </span><span class="identifier">tokens</span><span class="plain">;</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">macro</span><span class="plain">;</span>
<span class="reserved">macro</span><span class="plain"> *</span><span class="functiontext">Readme::new_macro<button class="popup" onclick="togglePopup('usagePopup351')">...<span class="popuptext" id="usagePopup351">Usage of <b>Readme::new_macro</b>:<br><a href="6-rw.html#SP1">&#167;1</a>, <a href="6-rw.html#SP2">&#167;2</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">name</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">tokens</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">M</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">macro</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">name</span><span class="plain">);</span>
<span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">tokens</span><span class="plain"> = </span><span class="functiontext"><a href="6-rw.html#SP4">Readme::parse_token_list</a></span><span class="plain">(</span><span class="identifier">tokens</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">content</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP2">Str::new</a></span><span class="plain">();</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">M</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">macro_tokens</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">bound_to</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">pars</span><span class="plain">[8];</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">no_pars</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">macro_tokens</span><span class="plain"> *</span><span class="identifier">down</span><span class="plain">;</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">macro_tokens</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure macro is accessed in 2/trs, 6/cln and here.</p>
2020-03-23 21:39:27 +00:00
<p class="endnote">The structure macro_tokens is private to this section.</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. </b></p>
<pre class="display">
<span class="reserved">macro_tokens</span><span class="plain"> </span><span class="functiontext">Readme::parse_token_list<button class="popup" onclick="togglePopup('usagePopup352')">...<span class="popuptext" id="usagePopup352">Usage of <b>Readme::parse_token_list</b>:<br><a href="6-rw.html#SP3">&#167;3</a>, <a href="6-rw.html#SP5">&#167;5</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">chunk</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">macro_tokens</span><span class="plain"> </span><span class="identifier">mt</span><span class="plain">;</span>
<span class="identifier">mt</span><span class="plain">.</span><span class="element">no_pars</span><span class="plain"> = </span><span class="constant">0</span><span class="plain">;</span>
<span class="identifier">mt</span><span class="plain">.</span><span class="element">down</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">mt</span><span class="plain">.</span><span class="element">bound_to</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP13">Str::get_first_char</a></span><span class="plain">(</span><span class="identifier">chunk</span><span class="plain">) == </span><span class="character">'('</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">x</span><span class="plain"> = </span><span class="constant">1</span><span class="plain">, </span><span class="identifier">bl</span><span class="plain"> = </span><span class="constant">1</span><span class="plain">, </span><span class="identifier">from</span><span class="plain"> = </span><span class="constant">1</span><span class="plain">, </span><span class="identifier">quoted</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">while</span><span class="plain"> ((</span><span class="identifier">bl</span><span class="plain"> &gt; </span><span class="constant">0</span><span class="plain">) &amp;&amp; (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP13">Str::get_at</a></span><span class="plain">(</span><span class="identifier">chunk</span><span class="plain">, </span><span class="identifier">x</span><span class="plain">) != </span><span class="constant">0</span><span class="plain">)) {</span>
<span class="identifier">wchar_t</span><span class="plain"> </span><span class="identifier">c</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP13">Str::get_at</a></span><span class="plain">(</span><span class="identifier">chunk</span><span class="plain">, </span><span class="identifier">x</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">c</span><span class="plain"> == </span><span class="character">'\''</span><span class="plain">) {</span>
2020-04-04 19:46:43 +00:00
<span class="identifier">quoted</span><span class="plain"> = </span><span class="identifier">quoted</span><span class="plain">?</span><span class="identifier">FALSE:TRUE</span><span class="plain">;</span>
2020-04-06 11:26:10 +00:00
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">quoted</span><span class="plain"> == </span><span class="constant">FALSE</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">c</span><span class="plain"> == </span><span class="character">'('</span><span class="plain">) </span><span class="identifier">bl</span><span class="plain">++;</span>
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">c</span><span class="plain"> == </span><span class="character">')'</span><span class="plain">) {</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">bl</span><span class="plain">--;</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">bl</span><span class="plain"> == </span><span class="constant">0</span><span class="plain">) </span>&lt;<span class="cwebmacro">Recognise token</span> <span class="cwebmacronumber">4.1</span>&gt;<span class="plain">;</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">c</span><span class="plain"> == </span><span class="character">','</span><span class="plain">) &amp;&amp; (</span><span class="identifier">bl</span><span class="plain"> == </span><span class="constant">1</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Recognise token</span> <span class="cwebmacronumber">4.1</span>&gt;<span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
<span class="identifier">x</span><span class="plain">++;</span>
<span class="plain">}</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-sm.html#SP24">Str::delete_n_characters</a></span><span class="plain">(</span><span class="identifier">chunk</span><span class="plain">, </span><span class="identifier">x</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">mt</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP4_1"></a><b>&#167;4.1. </b>Quotes can be used in token lists so that literal commas and brackets can
be used without breaking the flow.
</p>
<p class="macrodefinition"><code class="display">
&lt;<span class="cwebmacrodefn">Recognise token</span> <span class="cwebmacronumber">4.1</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-06 11:26:10 +00:00
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">n</span><span class="plain"> = </span><span class="identifier">mt</span><span class="plain">.</span><span class="identifier">no_pars</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">n</span><span class="plain"> &gt;= </span><span class="constant">8</span><span class="plain">) </span><span class="functiontext"><a href="../foundation-module/3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"too many parameters"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">else</span><span class="plain"> {</span>
2020-04-15 22:45:08 +00:00
<span class="identifier">mt</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">] = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP2">Str::new</a></span><span class="plain">();</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">j</span><span class="plain">=</span><span class="identifier">from</span><span class="plain">; </span><span class="identifier">j</span><span class="plain">&lt;</span><span class="identifier">x</span><span class="plain">; </span><span class="identifier">j</span><span class="plain">++) </span><span class="identifier">PUT_TO</span><span class="plain">(</span><span class="identifier">mt</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">], </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP13">Str::get_at</a></span><span class="plain">(</span><span class="identifier">chunk</span><span class="plain">, </span><span class="identifier">j</span><span class="plain">));</span>
<span class="functiontext"><a href="../foundation-module/4-sm.html#SP23">Str::trim_white_space</a></span><span class="plain">(</span><span class="identifier">mt</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">]);</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP13">Str::get_first_char</a></span><span class="plain">(</span><span class="identifier">mt</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">]) == </span><span class="character">'\''</span><span class="plain">) &amp;&amp;</span>
<span class="plain">(</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP13">Str::get_last_char</a></span><span class="plain">(</span><span class="identifier">mt</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">]) == </span><span class="character">'\''</span><span class="plain">)) {</span>
<span class="functiontext"><a href="../foundation-module/4-sm.html#SP24">Str::delete_first_character</a></span><span class="plain">(</span><span class="identifier">mt</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">]);</span>
<span class="functiontext"><a href="../foundation-module/4-sm.html#SP24">Str::delete_last_character</a></span><span class="plain">(</span><span class="identifier">mt</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">]);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">mt</span><span class="plain">.</span><span class="element">no_pars</span><span class="plain">++;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
<span class="identifier">from</span><span class="plain"> = </span><span class="identifier">x</span><span class="plain">+1;</span>
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP4">&#167;4</a> (twice).</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. </b>So much for creating macros. Now we can write the actual expander. As can
be seen, it passes material straight through, except for instances of the
notation <code class="display"><span class="extract">@name</span></code>, possibly followed by a bracketed list of parameters.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::expand_material<button class="popup" onclick="togglePopup('usagePopup353')">...<span class="popuptext" id="usagePopup353">Usage of <b>Readme::expand_material</b>:<br><a href="6-rw.html#SP2">&#167;2</a>, <a href="6-rw.html#SP6">&#167;6</a>, <a href="6-rw.html#SP7">&#167;7</a>, <a href="6-rw.html#SP7_1">&#167;7.1</a>, <a href="6-rw.html#SP7_2">&#167;7.2</a>, <a href="6-rw.html#SP7_3">&#167;7.3</a></span></button></span><span class="plain">(</span><span class="reserved">write_state</span><span class="plain"> *</span><span class="identifier">ws</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">text</span><span class="plain">,</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::create_mr</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"(%c*?)@(%i+)(%c*)"</span><span class="plain">)) {</span>
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[0], </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="reserved">macro_tokens</span><span class="plain"> </span><span class="identifier">mt</span><span class="plain"> = </span><span class="functiontext"><a href="6-rw.html#SP4">Readme::parse_token_list</a></span><span class="plain">(</span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[2], </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">mt</span><span class="plain">.</span><span class="element">down</span><span class="plain"> = </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">;</span>
<span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain"> = &amp;</span><span class="identifier">mt</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP6">Readme::expand_at</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[1], </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain"> = </span><span class="identifier">mt</span><span class="plain">.</span><span class="element">down</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[2], </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%S"</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">);</span>
<span class="plain">}</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::dispose_of</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP6"></a><b>&#167;6. </b>If we run into the notation <code class="display"><span class="extract">@something</span></code>, it's possible that <code class="display"><span class="extract">something</span></code> is
the name of a parameter somewhere in the current stack, either on the top
frame or on frames lower down. The first match wins... and if there are no
matches, then it must be a macro name.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::expand_at<button class="popup" onclick="togglePopup('usagePopup354')">...<span class="popuptext" id="usagePopup354">Usage of <b>Readme::expand_at</b>:<br><a href="6-rw.html#SP5">&#167;5</a></span></button></span><span class="plain">(</span><span class="reserved">write_state</span><span class="plain"> *</span><span class="identifier">ws</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">macro_name</span><span class="plain">,</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
<span class="reserved">macro_tokens</span><span class="plain"> *</span><span class="identifier">stack</span><span class="plain"> = </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">;</span>
<span class="reserved">while</span><span class="plain"> (</span><span class="identifier">stack</span><span class="plain">) {</span>
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">in</span><span class="plain"> = </span><span class="identifier">stack</span><span class="plain">-&gt;</span><span class="element">bound_to</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">in</span><span class="plain">)</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">n</span><span class="plain"> = </span><span class="constant">0</span><span class="plain">; </span><span class="identifier">n</span><span class="plain"> &lt; </span><span class="identifier">in</span><span class="plain">-&gt;</span><span class="element">tokens</span><span class="plain">.</span><span class="element">no_pars</span><span class="plain">; </span><span class="identifier">n</span><span class="plain">++)</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">in</span><span class="plain">-&gt;</span><span class="element">tokens</span><span class="plain">.</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">], </span><span class="identifier">macro_name</span><span class="plain">)) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">n</span><span class="plain"> &lt; </span><span class="identifier">stack</span><span class="plain">-&gt;</span><span class="element">no_pars</span><span class="plain">) {</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">stack</span><span class="plain">-&gt;</span><span class="element">pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">], </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">return</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
<span class="plain">}</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">stack</span><span class="plain"> = </span><span class="identifier">stack</span><span class="plain">-&gt;</span><span class="element">down</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">M</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER_LINKED_LIST</span><span class="plain">(</span><span class="identifier">M</span><span class="plain">, </span><span class="reserved">macro</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">known_macros</span><span class="plain">)</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">, </span><span class="identifier">macro_name</span><span class="plain">)) {</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">bound_to</span><span class="plain"> = </span><span class="identifier">M</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP7">Readme::expand_macro</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">M</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">return</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"no such @-command"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="constant">STDERR</span><span class="plain">, </span><span class="string">"(command is '%S')\n"</span><span class="plain">, </span><span class="identifier">macro_name</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP7"></a><b>&#167;7. </b>So, then: suppose we have to expand <code class="display"><span class="extract">@example(5, gold rings)</span></code>. Then the
<code class="display"><span class="extract">macro_name</span></code> below is set to <code class="display"><span class="extract">example</span></code>, and the current stack frame contains the
values <code class="display"><span class="extract">5</span></code> and <code class="display"><span class="extract">gold rings</span></code>.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::expand_macro<button class="popup" onclick="togglePopup('usagePopup355')">...<span class="popuptext" id="usagePopup355">Usage of <b>Readme::expand_macro</b>:<br><a href="6-rw.html#SP6">&#167;6</a></span></button></span><span class="plain">(</span><span class="reserved">write_state</span><span class="plain"> *</span><span class="identifier">ws</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">M</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"version"</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Perform built-in expansion of version macro</span> <span class="cwebmacronumber">7.1</span>&gt;
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"purpose"</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Perform built-in expansion of purpose macro</span> <span class="cwebmacronumber">7.2</span>&gt;
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"var"</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Perform built-in expansion of var macro</span> <span class="cwebmacronumber">7.3</span>&gt;
2020-04-06 11:26:10 +00:00
<span class="reserved">else</span><span class="plain"> {</span>
<span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">bound_to</span><span class="plain"> = </span><span class="identifier">M</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">content</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP7_1"></a><b>&#167;7.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Perform built-in expansion of version macro</span> <span class="cwebmacronumber">7.1</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">no_pars</span><span class="plain"> != </span><span class="constant">1</span><span class="plain">)</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"@version takes 1 parameter"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">else</span><span class="plain"> {</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">pars</span><span class="plain">[0], </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="functiontext"><a href="6-rw.html#SP8">Readme::write_var</a></span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Version Number"</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP7">&#167;7</a>.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP7_2"></a><b>&#167;7.2. </b><code class="display">
&lt;<span class="cwebmacrodefn">Perform built-in expansion of purpose macro</span> <span class="cwebmacronumber">7.2</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">no_pars</span><span class="plain"> != </span><span class="constant">1</span><span class="plain">)</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"@purpose takes 1 parameter"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">else</span><span class="plain"> {</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">pars</span><span class="plain">[0], </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="functiontext"><a href="6-rw.html#SP8">Readme::write_var</a></span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Purpose"</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP7">&#167;7</a>.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP7_3"></a><b>&#167;7.3. </b><code class="display">
&lt;<span class="cwebmacrodefn">Perform built-in expansion of var macro</span> <span class="cwebmacronumber">7.3</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-06 11:26:10 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">no_pars</span><span class="plain"> != </span><span class="constant">2</span><span class="plain">)</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"@var takes 2 parameters"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">else</span><span class="plain"> {</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">bibv</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">pars</span><span class="plain">[0], </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="functiontext"><a href="6-rw.html#SP5">Readme::expand_material</a></span><span class="plain">(</span><span class="identifier">ws</span><span class="plain">, </span><span class="identifier">bibv</span><span class="plain">, </span><span class="identifier">ws</span><span class="plain">-&gt;</span><span class="element">stack_frame</span><span class="plain">-&gt;</span><span class="element">pars</span><span class="plain">[1], </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="functiontext"><a href="6-rw.html#SP8">Readme::write_var</a></span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">bibv</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">bibv</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP7">&#167;7</a>.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP8"></a><b>&#167;8. </b>An "asset" here is something for which we might want to write the version
number of, or some similar metadata for. Assets are usually webs, but can
also be a few other rather Inform-specific things; those have a more limited
range of bibliographic data, just the version and date (and we will not
assume that the version complies with any format).
</p>
<pre class="display">
2020-04-06 11:26:10 +00:00
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">writeme_asset</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</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">web_md</span><span class="plain"> *</span><span class="identifier">if_web</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">date</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">version</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">next_is_version</span><span class="plain">;</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">writeme_asset</span><span class="plain">;</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::write_var<button class="popup" onclick="togglePopup('usagePopup356')">...<span class="popuptext" id="usagePopup356">Usage of <b>Readme::write_var</b>:<br><a href="6-rw.html#SP7_1">&#167;7.1</a>, <a href="6-rw.html#SP7_2">&#167;7.2</a>, <a href="6-rw.html#SP7_3">&#167;7.3</a>, The Indexer - <a href="3-ti.html#SP7">&#167;7</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">OUT</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">program</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">datum</span><span class="plain">) {</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = </span><span class="functiontext"><a href="6-rw.html#SP9">Readme::find_asset</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">if_web</span><span class="plain">) </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%S"</span><span class="plain">, </span><span class="functiontext"><a href="../foundation-module/8-bdfw.html#SP6">Bibliographic::get_datum</a></span><span class="plain">(</span><span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">if_web</span><span class="plain">, </span><span class="identifier">datum</span><span class="plain">));</span>
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">datum</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Build Date"</span><span class="plain">)) </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%S"</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">date</span><span class="plain">);</span>
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">datum</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Version Number"</span><span class="plain">)) </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%S"</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure writeme_asset is accessed in 2/trs, 6/cln and here.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP9"></a><b>&#167;9. </b>That just leaves the business of inspecting assets to obtain their metadata.
</p>
<pre class="display">
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="functiontext">Readme::find_asset<button class="popup" onclick="togglePopup('usagePopup357')">...<span class="popuptext" id="usagePopup357">Usage of <b>Readme::find_asset</b>:<br><a href="6-rw.html#SP8">&#167;8</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">program</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">A</span><span class="plain">, </span><span class="reserved">writeme_asset</span><span class="plain">) </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">)) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">A</span><span class="plain">;</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">A</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">writeme_asset</span><span class="plain">);</span>
2020-04-15 22:45:08 +00:00
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">if_web</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">date</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP2">Str::new</a></span><span class="plain">();</span>
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP2">Str::new</a></span><span class="plain">();</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">next_is_version</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
&lt;<span class="cwebmacro">Read in the asset</span> <span class="cwebmacronumber">9.1</span>&gt;<span class="plain">;</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">A</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP9_1"></a><b>&#167;9.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Read in the asset</span> <span class="cwebmacronumber">9.1</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP20">Str::ends_with_wide_string</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">L</span><span class="string">".i7x"</span><span class="plain">)) {</span>
2020-03-23 21:39:27 +00:00
&lt;<span class="cwebmacro">Read in the extension file</span> <span class="cwebmacronumber">9.1.1</span>&gt;<span class="plain">;</span>
2020-04-06 11:26:10 +00:00
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/8-ws.html#SP8">WebMetadata::directory_looks_like_a_web</a></span><span class="plain">(</span><span class="functiontext"><a href="../foundation-module/3-pth.html#SP5">Pathnames::from_text</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">))) {</span>
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">if_web</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/8-ws.html#SP5">WebMetadata::get_without_modules</a></span><span class="plain">(</span><span class="functiontext"><a href="../foundation-module/3-pth.html#SP5">Pathnames::from_text</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="identifier">NULL</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">I6_vn</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/3-fln.html#SP2">Filenames::in</a></span><span class="plain">(</span>
<span class="functiontext"><a href="../foundation-module/3-pth.html#SP4">Pathnames::down</a></span><span class="plain">(</span><span class="functiontext"><a href="../foundation-module/3-pth.html#SP5">Pathnames::from_text</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="identifier">I</span><span class="string">"inform6"</span><span class="plain">), </span><span class="identifier">I</span><span class="string">"header.h"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-tf.html#SP1">TextFiles::exists</a></span><span class="plain">(</span><span class="identifier">I6_vn</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Read in I6 source header file</span> <span class="cwebmacronumber">9.1.2</span>&gt;<span class="plain">;</span>
<span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">template_vn</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/3-fln.html#SP2">Filenames::in</a></span><span class="plain">(</span><span class="functiontext"><a href="../foundation-module/3-pth.html#SP5">Pathnames::from_text</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="identifier">I</span><span class="string">"(manifest).txt"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-tf.html#SP1">TextFiles::exists</a></span><span class="plain">(</span><span class="identifier">template_vn</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Read in template manifest file</span> <span class="cwebmacronumber">9.1.3</span>&gt;<span class="plain">;</span>
<span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">rmt_vn</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/3-fln.html#SP2">Filenames::in</a></span><span class="plain">(</span><span class="functiontext"><a href="../foundation-module/3-pth.html#SP5">Pathnames::from_text</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="identifier">I</span><span class="string">"README.txt"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-tf.html#SP1">TextFiles::exists</a></span><span class="plain">(</span><span class="identifier">rmt_vn</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Read in README file</span> <span class="cwebmacronumber">9.1.4</span>&gt;<span class="plain">;</span>
<span class="identifier">rmt_vn</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/3-fln.html#SP2">Filenames::in</a></span><span class="plain">(</span><span class="functiontext"><a href="../foundation-module/3-pth.html#SP5">Pathnames::from_text</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="identifier">I</span><span class="string">"README.md"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-tf.html#SP1">TextFiles::exists</a></span><span class="plain">(</span><span class="identifier">rmt_vn</span><span class="plain">)) </span>&lt;<span class="cwebmacro">Read in README file</span> <span class="cwebmacronumber">9.1.4</span>&gt;<span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP9">&#167;9</a>.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP9_1_1"></a><b>&#167;9.1.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Read in the extension file</span> <span class="cwebmacronumber">9.1.1</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-tf.html#SP5">TextFiles::read</a></span><span class="plain">(</span><span class="functiontext"><a href="../foundation-module/3-fln.html#SP3">Filenames::from_text</a></span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="constant">FALSE</span><span class="plain">, </span><span class="string">"unable to read extension"</span><span class="plain">, </span><span class="constant">TRUE</span><span class="plain">,</span>
<span class="plain">&amp;</span><span class="functiontext"><a href="6-rw.html#SP10">Readme::extension_harvester</a></span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP9_1">&#167;9.1</a>.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP9_1_2"></a><b>&#167;9.1.2. </b><code class="display">
&lt;<span class="cwebmacrodefn">Read in I6 source header file</span> <span class="cwebmacronumber">9.1.2</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-tf.html#SP5">TextFiles::read</a></span><span class="plain">(</span><span class="identifier">I6_vn</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="string">"unable to read header file from I6 source"</span><span class="plain">, </span><span class="constant">TRUE</span><span class="plain">,</span>
<span class="plain">&amp;</span><span class="functiontext"><a href="6-rw.html#SP11">Readme::header_harvester</a></span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP9_1">&#167;9.1</a>.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP9_1_3"></a><b>&#167;9.1.3. </b><code class="display">
&lt;<span class="cwebmacrodefn">Read in template manifest file</span> <span class="cwebmacronumber">9.1.3</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-tf.html#SP5">TextFiles::read</a></span><span class="plain">(</span><span class="identifier">template_vn</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="string">"unable to read manifest file from website template"</span><span class="plain">, </span><span class="constant">TRUE</span><span class="plain">,</span>
<span class="plain">&amp;</span><span class="functiontext"><a href="6-rw.html#SP12">Readme::template_harvester</a></span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP9_1">&#167;9.1</a>.</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP9_1_4"></a><b>&#167;9.1.4. </b><code class="display">
&lt;<span class="cwebmacrodefn">Read in README file</span> <span class="cwebmacronumber">9.1.4</span>&gt; =
</code></p>
<pre class="displaydefn">
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-tf.html#SP5">TextFiles::read</a></span><span class="plain">(</span><span class="identifier">rmt_vn</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="string">"unable to read README file from website template"</span><span class="plain">, </span><span class="constant">TRUE</span><span class="plain">,</span>
<span class="plain">&amp;</span><span class="functiontext"><a href="6-rw.html#SP13">Readme::readme_harvester</a></span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
</pre>
<p class="inwebparagraph"></p>
2020-04-15 22:45:08 +00:00
<p class="endnote">This code is used in <a href="6-rw.html#SP9_1">&#167;9.1</a> (twice).</p>
2020-03-23 21:39:27 +00:00
<p class="inwebparagraph"><a id="SP10"></a><b>&#167;10. </b>The format for the contents section of a web is documented in Inweb.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::extension_harvester<button class="popup" onclick="togglePopup('usagePopup358')">...<span class="popuptext" id="usagePopup358">Usage of <b>Readme::extension_harvester</b>:<br><a href="6-rw.html#SP9_1_1">&#167;9.1.1</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">text</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">state</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = (</span><span class="reserved">writeme_asset</span><span class="plain"> *) </span><span class="identifier">state</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::create_mr</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP8">Str::len</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == </span><span class="constant">0</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">" *Version (%c*?) of %c*begins here. *"</span><span class="plain">))</span>
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[0]);</span>
<span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::dispose_of</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP11"></a><b>&#167;11. </b>Explicit code to read from <code class="display"><span class="extract">header.h</span></code> in the Inform 6 repository.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::header_harvester<button class="popup" onclick="togglePopup('usagePopup359')">...<span class="popuptext" id="usagePopup359">Usage of <b>Readme::header_harvester</b>:<br><a href="6-rw.html#SP9_1_2">&#167;9.1.2</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">text</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">state</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = (</span><span class="reserved">writeme_asset</span><span class="plain"> *) </span><span class="identifier">state</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::create_mr</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP8">Str::len</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == </span><span class="constant">0</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"#define RELEASE_NUMBER (%c*?) *"</span><span class="plain">))</span>
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[0]);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"#define RELEASE_DATE \"(%c*?)\" *"</span><span class="plain">))</span>
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">date</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[0]);</span>
<span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::dispose_of</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP12"></a><b>&#167;12. </b>Explicit code to read from the manifest file of a website template.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::template_harvester<button class="popup" onclick="togglePopup('usagePopup360')">...<span class="popuptext" id="usagePopup360">Usage of <b>Readme::template_harvester</b>:<br><a href="6-rw.html#SP9_1_3">&#167;9.1.3</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">text</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">state</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = (</span><span class="reserved">writeme_asset</span><span class="plain"> *) </span><span class="identifier">state</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::create_mr</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP8">Str::len</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == </span><span class="constant">0</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"%[INTERPRETERVERSION%]"</span><span class="plain">)) {</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">next_is_version</span><span class="plain"> = </span><span class="constant">TRUE</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">next_is_version</span><span class="plain">) {</span>
2020-04-15 22:45:08 +00:00
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">);</span>
2020-04-06 11:26:10 +00:00
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">next_is_version</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
2020-04-15 22:45:08 +00:00
<span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::dispose_of</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP13"></a><b>&#167;13. </b>And this is needed for <code class="display"><span class="extract">cheapglk</span></code> and <code class="display"><span class="extract">glulxe</span></code> in the Inform repository.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Readme::readme_harvester<button class="popup" onclick="togglePopup('usagePopup361')">...<span class="popuptext" id="usagePopup361">Usage of <b>Readme::readme_harvester</b>:<br><a href="6-rw.html#SP9_1_4">&#167;9.1.4</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">text</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">state</span><span class="plain">) {</span>
2020-04-06 11:26:10 +00:00
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = (</span><span class="reserved">writeme_asset</span><span class="plain"> *) </span><span class="identifier">state</span><span class="plain">;</span>
2020-04-15 22:45:08 +00:00
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::create_mr</a></span><span class="plain">();</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP8">Str::len</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == </span><span class="constant">0</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"CheapGlk Library: version (%c*?) *"</span><span class="plain">)) ||</span>
<span class="plain">(</span><span class="functiontext"><a href="../foundation-module/4-pm.html#SP10">Regexp::match</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"- Version (%c*?) *"</span><span class="plain">)))</span>
<span class="identifier">A</span><span class="plain">-&gt;</span><span class="element">version</span><span class="plain"> = </span><span class="functiontext"><a href="../foundation-module/4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">mr</span><span class="plain">.</span><span class="element">exp</span><span class="plain">[0]);</span>
<span class="functiontext"><a href="../foundation-module/4-pm.html#SP9">Regexp::dispose_of</a></span><span class="plain">(&amp;</span><span class="identifier">mr</span><span class="plain">);</span>
2020-03-23 21:39:27 +00:00
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<hr class="tocbar">
2020-04-12 16:24:23 +00:00
<ul class="toc"><li><a href="6-gs.html">Back to 'Git Support'</a></li><li><a href="6-cln.html">Continue with 'Colonies'</a></li></ul><hr class="tocbar">
2020-03-23 21:39:27 +00:00
<!--End of weave-->
2020-04-11 20:39:43 +00:00
<script>
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
</script>
<link href="Popups.css" rel="stylesheet" rev="stylesheet" type="text/css">
2020-03-23 21:39:27 +00:00
</main>
</body>
</html>