602 lines
82 KiB
HTML
602 lines
82 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>6/bf2</title>
|
|
<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">
|
|
</head>
|
|
<body>
|
|
<nav role="navigation">
|
|
<h1><a href="../webs.html">Sources</a></h1>
|
|
<ul>
|
|
<li><a href="../inweb/index.html">inweb</a></li>
|
|
</ul>
|
|
<h2>Foundation</h2>
|
|
<ul>
|
|
<li><a href="../foundation-module/index.html">foundation-module</a></li>
|
|
<li><a href="../foundation-test/index.html">foundation-test</a></li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
<main role="main">
|
|
|
|
<!--Weave of '6/rw' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../webs.html">Source</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>
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§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">
|
|
<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>
|
|
<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</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>
|
|
<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 --> %f\</span><span class="plain">n</span><span class="string">"</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="element">.current_definition</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="identifier">ws</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>
|
|
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain"> = </span><span class="functiontext">Readme::new_macro</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>
|
|
<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="element">.known_macros</span><span class="plain">);</span>
|
|
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain"> = </span><span class="functiontext">Readme::new_macro</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>
|
|
<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="element">.known_macros</span><span class="plain">);</span>
|
|
<span class="reserved">macro</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = </span><span class="functiontext">Readme::new_macro</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>
|
|
<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="element">.known_macros</span><span class="plain">);</span>
|
|
<span class="identifier">ws</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>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Streams::open_to_file</span><span class="plain">(&</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">Errors::fatal_with_file</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>
|
|
<span class="identifier">ws</span><span class="element">.OUT</span><span class="plain"> = &</span><span class="identifier">file_to</span><span class="plain">;</span>
|
|
<span class="functiontext">TextFiles::read</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">&</span><span class="functiontext">Readme::write_helper</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, (</span><span class="reserved">void</span><span class="plain"> *) &</span><span class="identifier">ws</span><span class="plain">);</span>
|
|
<span class="functiontext">Streams::close</span><span class="plain">(&</span><span class="identifier">file_to</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::write is used in 1/pc (<a href="1-pc.html#SP7_1">§7.1</a>).</p>
|
|
|
|
<p class="endnote">The structure write_state is private to this section.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP2"></a><b>§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</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>
|
|
<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">-</span><span class="element">>OUT</span><span class="plain">;</span>
|
|
|
|
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext">Regexp::create_mr</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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>
|
|
<span class="reserved">if</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="functiontext">Errors::in_text_file</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>
|
|
<span class="reserved">else</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="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">-</span><span class="element">>current_definition</span><span class="plain">) {</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::len</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="element">>content</span><span class="plain">) > 0)</span>
|
|
<span class="identifier">WRITE_TO</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="element">>content</span><span class="plain">, </span><span class="string">"\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
|
|
<span class="identifier">WRITE_TO</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="element">>content</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><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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>
|
|
<span class="reserved">if</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="functiontext">Errors::in_text_file</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>
|
|
<span class="reserved">else</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="functiontext">Readme::new_macro</span><span class="plain">(</span><span class="identifier">mr</span><span class="element">.exp</span><span class="plain">[0], </span><span class="identifier">mr</span><span class="element">.exp</span><span class="plain">[1], </span><span class="identifier">tfp</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">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">-</span><span class="element">>known_macros</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
|
|
<span class="functiontext">Readme::expand_material</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">Readme::expand_material</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">"\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="functiontext">Regexp::dispose_of</span><span class="plain">(&</span><span class="identifier">mr</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::write_helper is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3"></a><b>§3. </b>The "content" of a macro is its definition, and the tokens are named
|
|
parameters.
|
|
</p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">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</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>
|
|
<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>
|
|
<span class="identifier">M</span><span class="plain">-</span><span class="element">>name</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">name</span><span class="plain">);</span>
|
|
<span class="identifier">M</span><span class="plain">-</span><span class="element">>tokens</span><span class="plain"> = </span><span class="functiontext">Readme::parse_token_list</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">-</span><span class="element">>content</span><span class="plain"> = </span><span class="functiontext">Str::new</span><span class="plain">();</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">M</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">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>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::new_macro is used in <a href="#SP1">§1</a>, <a href="#SP2">§2</a>.</p>
|
|
|
|
<p class="endnote">The structure macro is private to this section.</p>
|
|
|
|
<p class="endnote">The structure macro_tokens is private to this section.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP4"></a><b>§4. </b></p>
|
|
|
|
|
|
<pre class="display">
|
|
<span class="reserved">macro_tokens</span><span class="plain"> </span><span class="functiontext">Readme::parse_token_list</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>
|
|
<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="element">.no_pars</span><span class="plain"> = 0;</span>
|
|
<span class="identifier">mt</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="element">.bound_to</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::get_first_char</span><span class="plain">(</span><span class="identifier">chunk</span><span class="plain">) == </span><span class="character">'('</span><span class="plain">) {</span>
|
|
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">x</span><span class="plain"> = 1, </span><span class="identifier">bl</span><span class="plain"> = 1, </span><span class="identifier">from</span><span class="plain"> = 1, </span><span class="identifier">quoted</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
|
|
<span class="reserved">while</span><span class="plain"> ((</span><span class="identifier">bl</span><span class="plain"> > 0) && (</span><span class="functiontext">Str::get_at</span><span class="plain">(</span><span class="identifier">chunk</span><span class="plain">, </span><span class="identifier">x</span><span class="plain">) != 0)) {</span>
|
|
<span class="identifier">wchar_t</span><span class="plain"> </span><span class="identifier">c</span><span class="plain"> = </span><span class="functiontext">Str::get_at</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="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="character">'</span><span class="plain">) {</span>
|
|
<span class="identifier">quoted</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="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">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>
|
|
<span class="identifier">bl</span><span class="plain">--;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">bl</span><span class="plain"> == 0) </span><<span class="cwebmacro">Recognise token</span> <span class="cwebmacronumber">4.1</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">c</span><span class="plain"> == </span><span class="character">','</span><span class="plain">) && (</span><span class="identifier">bl</span><span class="plain"> == 1)) </span><<span class="cwebmacro">Recognise token</span> <span class="cwebmacronumber">4.1</span>><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
<span class="identifier">x</span><span class="plain">++;</span>
|
|
<span class="plain">}</span>
|
|
<span class="functiontext">Str::delete_n_characters</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="plain">}</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">mt</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::parse_token_list is used in <a href="#SP3">§3</a>, <a href="#SP5">§5</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP4_1"></a><b>§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">
|
|
<<span class="cwebmacrodefn">Recognise token</span> <span class="cwebmacronumber">4.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<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="element">.no_pars</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">n</span><span class="plain"> >= 8) </span><span class="functiontext">Errors::in_text_file</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>
|
|
<span class="reserved">else</span><span class="plain"> {</span>
|
|
<span class="identifier">mt</span><span class="element">.pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">] = </span><span class="functiontext">Str::new</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"><</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="element">.pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">], </span><span class="functiontext">Str::get_at</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">Str::trim_white_space</span><span class="plain">(</span><span class="identifier">mt</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">Str::get_first_char</span><span class="plain">(</span><span class="identifier">mt</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="character">'</span><span class="plain">) &&</span>
|
|
<span class="plain">(</span><span class="functiontext">Str::get_last_char</span><span class="plain">(</span><span class="identifier">mt</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="character">'</span><span class="plain">)) {</span>
|
|
<span class="functiontext">Str::delete_first_character</span><span class="plain">(</span><span class="identifier">mt</span><span class="element">.pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">]);</span>
|
|
<span class="functiontext">Str::delete_last_character</span><span class="plain">(</span><span class="identifier">mt</span><span class="element">.pars</span><span class="plain">[</span><span class="identifier">n</span><span class="plain">]);</span>
|
|
<span class="plain">}</span>
|
|
<span class="identifier">mt</span><span class="element">.no_pars</span><span class="plain">++;</span>
|
|
<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>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP4">§4</a> (twice).</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP5"></a><b>§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</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>
|
|
<span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
|
|
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext">Regexp::create_mr</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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">Readme::expand_material</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="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">Readme::parse_token_list</span><span class="plain">(</span><span class="identifier">mr</span><span class="element">.exp</span><span class="plain">[2], </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="identifier">mt</span><span class="element">.down</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">ws</span><span class="plain">-</span><span class="element">>stack_frame</span><span class="plain"> = &</span><span class="identifier">mt</span><span class="plain">;</span>
|
|
<span class="functiontext">Readme::expand_at</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="element">.exp</span><span class="plain">[1], </span><span class="identifier">tfp</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">mt</span><span class="element">.down</span><span class="plain">;</span>
|
|
<span class="functiontext">Readme::expand_material</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="element">.exp</span><span class="plain">[2], </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="plain">} </span><span class="reserved">else</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">text</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="functiontext">Regexp::dispose_of</span><span class="plain">(&</span><span class="identifier">mr</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::expand_material is used in <a href="#SP2">§2</a>, <a href="#SP6">§6</a>, <a href="#SP7">§7</a>, <a href="#SP7_1">§7.1</a>, <a href="#SP7_2">§7.2</a>, <a href="#SP7_3">§7.3</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP6"></a><b>§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</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>
|
|
<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">-</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">-</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"> = 0; </span><span class="identifier">n</span><span class="plain"> < </span><span class="identifier">in</span><span class="plain">-</span><span class="element">>tokens.no_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">Str::eq</span><span class="plain">(</span><span class="identifier">in</span><span class="plain">-</span><span class="element">>tokens.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>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">n</span><span class="plain"> < </span><span class="identifier">stack</span><span class="plain">-</span><span class="element">>no_pars</span><span class="plain">) {</span>
|
|
<span class="functiontext">Readme::expand_material</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">-</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>
|
|
<span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
<span class="plain">}</span>
|
|
<span class="identifier">stack</span><span class="plain"> = </span><span class="identifier">stack</span><span class="plain">-</span><span class="element">>down</span><span class="plain">;</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="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">-</span><span class="element">>known_macros</span><span class="plain">)</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::eq</span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-</span><span class="element">>name</span><span class="plain">, </span><span class="identifier">macro_name</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="element">>bound_to</span><span class="plain"> = </span><span class="identifier">M</span><span class="plain">;</span>
|
|
<span class="functiontext">Readme::expand_macro</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>
|
|
<span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
<span class="functiontext">Errors::in_text_file</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>
|
|
<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')\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">macro_name</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::expand_at is used in <a href="#SP5">§5</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP7"></a><b>§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</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>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::eq</span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-</span><span class="element">>name</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"version"</span><span class="plain">)) </span><<span class="cwebmacro">Perform built-in expansion of version macro</span> <span class="cwebmacronumber">7.1</span>>
|
|
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::eq</span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-</span><span class="element">>name</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"purpose"</span><span class="plain">)) </span><<span class="cwebmacro">Perform built-in expansion of purpose macro</span> <span class="cwebmacronumber">7.2</span>>
|
|
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::eq</span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-</span><span class="element">>name</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"var"</span><span class="plain">)) </span><<span class="cwebmacro">Perform built-in expansion of var macro</span> <span class="cwebmacronumber">7.3</span>>
|
|
<span class="reserved">else</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="element">>bound_to</span><span class="plain"> = </span><span class="identifier">M</span><span class="plain">;</span>
|
|
<span class="functiontext">Readme::expand_material</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="element">>content</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::expand_macro is used in <a href="#SP6">§6</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP7_1"></a><b>§7.1. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Perform built-in expansion of version macro</span> <span class="cwebmacronumber">7.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</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="element">>no_pars</span><span class="plain"> != 1)</span>
|
|
<span class="functiontext">Errors::in_text_file</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>
|
|
<span class="reserved">else</span><span class="plain"> {</span>
|
|
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
|
|
<span class="functiontext">Readme::expand_material</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">-</span><span class="element">>stack_frame</span><span class="plain">-</span><span class="element">>pars</span><span class="plain">[0], </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="functiontext">Readme::write_var</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">program</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Version Number"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<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>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP7">§7</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP7_2"></a><b>§7.2. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Perform built-in expansion of purpose macro</span> <span class="cwebmacronumber">7.2</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</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="element">>no_pars</span><span class="plain"> != 1)</span>
|
|
<span class="functiontext">Errors::in_text_file</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>
|
|
<span class="reserved">else</span><span class="plain"> {</span>
|
|
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
|
|
<span class="functiontext">Readme::expand_material</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">-</span><span class="element">>stack_frame</span><span class="plain">-</span><span class="element">>pars</span><span class="plain">[0], </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="functiontext">Readme::write_var</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">program</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"Purpose"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<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>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP7">§7</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP7_3"></a><b>§7.3. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Perform built-in expansion of var macro</span> <span class="cwebmacronumber">7.3</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</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="element">>no_pars</span><span class="plain"> != 2)</span>
|
|
<span class="functiontext">Errors::in_text_file</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>
|
|
<span class="reserved">else</span><span class="plain"> {</span>
|
|
<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>
|
|
<span class="functiontext">Readme::expand_material</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">-</span><span class="element">>stack_frame</span><span class="plain">-</span><span class="element">>pars</span><span class="plain">[0], </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="functiontext">Readme::expand_material</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">-</span><span class="element">>stack_frame</span><span class="plain">-</span><span class="element">>pars</span><span class="plain">[1], </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<span class="functiontext">Readme::write_var</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">program</span><span class="plain">, </span><span class="identifier">bibv</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
|
|
<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>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP7">§7</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP8"></a><b>§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">
|
|
<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</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</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">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><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">) {</span>
|
|
<span class="reserved">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain"> = </span><span class="functiontext">Readme::find_asset</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">-</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">Bibliographic::get_datum</span><span class="plain">(</span><span class="identifier">A</span><span class="plain">-</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">Str::eq</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">-</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">Str::eq</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">-</span><span class="element">>version</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::write_var is used in <a href="#SP7_1">§7.1</a>, <a href="#SP7_2">§7.2</a>, <a href="#SP7_3">§7.3</a>.</p>
|
|
|
|
<p class="endnote">The structure writeme_asset is private to this section.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP9"></a><b>§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</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">writeme_asset</span><span class="plain"> *</span><span class="identifier">A</span><span class="plain">;</span>
|
|
<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">Str::eq</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">-</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>
|
|
<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>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>name</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">);</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>if_web</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>date</span><span class="plain"> = </span><span class="functiontext">Str::new</span><span class="plain">();</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>version</span><span class="plain"> = </span><span class="functiontext">Str::new</span><span class="plain">();</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>next_is_version</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
|
|
<<span class="cwebmacro">Read in the asset</span> <span class="cwebmacronumber">9.1</span>><span class="plain">;</span>
|
|
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">A</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::find_asset is used in <a href="#SP8">§8</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP9_1"></a><b>§9.1. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Read in the asset</span> <span class="cwebmacronumber">9.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::ends_with_wide_string</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>
|
|
<<span class="cwebmacro">Read in the extension file</span> <span class="cwebmacronumber">9.1.1</span>><span class="plain">;</span>
|
|
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
|
|
<span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain"> = </span><span class="functiontext">Filenames::in_folder</span><span class="plain">(</span><span class="functiontext">Pathnames::from_text</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="identifier">I</span><span class="string">"Contents.w"</span><span class="plain">);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">TextFiles::exists</span><span class="plain">(</span><span class="identifier">F</span><span class="plain">)) {</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>if_web</span><span class="plain"> = </span><span class="functiontext">Reader::load_web</span><span class="plain">(</span><span class="functiontext">Pathnames::from_text</span><span class="plain">(</span><span class="identifier">program</span><span class="plain">), </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">,</span>
|
|
<span class="constant">V2_SYNTAX</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">);</span>
|
|
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
|
|
<span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">I6_vn</span><span class="plain"> = </span><span class="functiontext">Filenames::in_folder</span><span class="plain">(</span>
|
|
<span class="functiontext">Pathnames::subfolder</span><span class="plain">(</span><span class="functiontext">Pathnames::from_text</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">TextFiles::exists</span><span class="plain">(</span><span class="identifier">I6_vn</span><span class="plain">)) </span><<span class="cwebmacro">Read in I6 source header file</span> <span class="cwebmacronumber">9.1.2</span>><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">Filenames::in_folder</span><span class="plain">(</span><span class="functiontext">Pathnames::from_text</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">TextFiles::exists</span><span class="plain">(</span><span class="identifier">template_vn</span><span class="plain">)) </span><<span class="cwebmacro">Read in template manifest file</span> <span class="cwebmacronumber">9.1.3</span>><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">Filenames::in_folder</span><span class="plain">(</span><span class="functiontext">Pathnames::from_text</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">TextFiles::exists</span><span class="plain">(</span><span class="identifier">rmt_vn</span><span class="plain">)) </span><<span class="cwebmacro">Read in README file</span> <span class="cwebmacronumber">9.1.4</span>><span class="plain">;</span>
|
|
<span class="identifier">rmt_vn</span><span class="plain"> = </span><span class="functiontext">Filenames::in_folder</span><span class="plain">(</span><span class="functiontext">Pathnames::from_text</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">TextFiles::exists</span><span class="plain">(</span><span class="identifier">rmt_vn</span><span class="plain">)) </span><<span class="cwebmacro">Read in README file</span> <span class="cwebmacronumber">9.1.4</span>><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP9">§9</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP9_1_1"></a><b>§9.1.1. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Read in the extension file</span> <span class="cwebmacronumber">9.1.1</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="functiontext">TextFiles::read</span><span class="plain">(</span><span class="functiontext">Filenames::from_text</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">&</span><span class="functiontext">Readme::extension_harvester</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP9_1">§9.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP9_1_2"></a><b>§9.1.2. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Read in I6 source header file</span> <span class="cwebmacronumber">9.1.2</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="functiontext">TextFiles::read</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">&</span><span class="functiontext">Readme::header_harvester</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP9_1">§9.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP9_1_3"></a><b>§9.1.3. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Read in template manifest file</span> <span class="cwebmacronumber">9.1.3</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="functiontext">TextFiles::read</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">&</span><span class="functiontext">Readme::template_harvester</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP9_1">§9.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP9_1_4"></a><b>§9.1.4. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Read in README file</span> <span class="cwebmacronumber">9.1.4</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="functiontext">TextFiles::read</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">&</span><span class="functiontext">Readme::readme_harvester</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">A</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP9_1">§9.1</a> (twice).</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP10"></a><b>§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</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>
|
|
<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>
|
|
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext">Regexp::create_mr</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::len</span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == 0) </span><span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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">-</span><span class="element">>version</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">mr</span><span class="element">.exp</span><span class="plain">[0]);</span>
|
|
<span class="functiontext">Regexp::dispose_of</span><span class="plain">(&</span><span class="identifier">mr</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::extension_harvester is used in <a href="#SP9_1_1">§9.1.1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP11"></a><b>§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</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>
|
|
<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>
|
|
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext">Regexp::create_mr</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::len</span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == 0) </span><span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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">-</span><span class="element">>version</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">mr</span><span class="element">.exp</span><span class="plain">[0]);</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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 \</span><span class="plain">"</span><span class="string">(%c*?)\</span><span class="plain">"</span><span class="string"> *"</span><span class="plain">))</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>date</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">mr</span><span class="element">.exp</span><span class="plain">[0]);</span>
|
|
<span class="functiontext">Regexp::dispose_of</span><span class="plain">(&</span><span class="identifier">mr</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::header_harvester is used in <a href="#SP9_1_2">§9.1.2</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP12"></a><b>§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</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>
|
|
<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>
|
|
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext">Regexp::create_mr</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::len</span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == 0) </span><span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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>
|
|
<span class="identifier">A</span><span class="plain">-</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">-</span><span class="element">>next_is_version</span><span class="plain">) {</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>version</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">text</span><span class="plain">);</span>
|
|
<span class="identifier">A</span><span class="plain">-</span><span class="element">>next_is_version</span><span class="plain"> = </span><span class="constant">FALSE</span><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
<span class="functiontext">Regexp::dispose_of</span><span class="plain">(&</span><span class="identifier">mr</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::template_harvester is used in <a href="#SP9_1_3">§9.1.3</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP13"></a><b>§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</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>
|
|
<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>
|
|
<span class="reserved">match_results</span><span class="plain"> </span><span class="identifier">mr</span><span class="plain"> = </span><span class="functiontext">Regexp::create_mr</span><span class="plain">();</span>
|
|
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext">Str::len</span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == 0) </span><span class="reserved">return</span><span class="plain">;</span>
|
|
<span class="reserved">if</span><span class="plain"> ((</span><span class="functiontext">Regexp::match</span><span class="plain">(&</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">Regexp::match</span><span class="plain">(&</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">-</span><span class="element">>version</span><span class="plain"> = </span><span class="functiontext">Str::duplicate</span><span class="plain">(</span><span class="identifier">mr</span><span class="element">.exp</span><span class="plain">[0]);</span>
|
|
<span class="functiontext">Regexp::dispose_of</span><span class="plain">(&</span><span class="identifier">mr</span><span class="plain">);</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">The function Readme::readme_harvester is used in <a href="#SP9_1_4">§9.1.4</a>.</p>
|
|
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><a href="6-bf2.html">Back to 'Build Files'</a></li><li><i>(This section ends Chapter 6: Extras.)</i></li></ul><hr class="tocbar">
|
|
<!--End of weave-->
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|