inweb-bootstrap/docs/foundation-module/2-trs.html
2020-04-17 19:18:40 +01:00

340 lines
47 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Trees</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="../index.html">
<img src="../docs-src/Figures/Octagram184x184.png" width=72 height=72">
</a></h1>
<ul><li><a href="../inweb/index.html">inweb</a></li>
</ul><h2>Foundation Module</h2><ul>
<li><a href="index.html"><span class="selectedlink">foundation</span></a></li>
<li><a href="../foundation-test/index.html">foundation-test</a></li>
</ul><h2>Example Webs</h2><ul>
<li><a href="../goldbach/index.html">goldbach</a></li>
<li><a href="../twinprimes/twinprimes.html">twinprimes</a></li>
<li><a href="../eastertide/index.html">eastertide</a></li>
</ul><h2>Repository</h2><ul>
<li><a href="https://github.com/ganelson/inweb"><img src="../github.png" height=18> github</a></li>
</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>
</ul>
</nav>
<main role="main">
<!--Weave of 'Trees' generated by Inweb-->
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="index.html">foundation</a></li><li><a href="index.html#2">Chapter 2: Memory, Streams and Collections</a></li><li><b>Trees</b></li></ul><p class="purpose">To provide heterogeneous tree structures, where a node can be any structure known to the Foundation memory manager.</p>
<ul class="toc"><li><a href="2-trs.html#SP1">&#167;1. Trees and nodes</a></li><li><a href="2-trs.html#SP6">&#167;6. Types</a></li><li><a href="2-trs.html#SP10">&#167;10. Hierarchy</a></li><li><a href="2-trs.html#SP13">&#167;13. Traversals</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Trees and nodes. </b>The tree itself is really just a root node, which is initially null, so that
a tree can be empty.
</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">heterogeneous_tree</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_type</span><span class="plain"> *</span><span class="identifier">type</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">root</span><span class="plain">;</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">heterogeneous_tree</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure heterogeneous_tree is private to this section.</p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b></p>
<pre class="display">
<span class="reserved">heterogeneous_tree</span><span class="plain"> *</span><span class="functiontext">Trees::new<button class="popup" onclick="togglePopup('usagePopup150')">...<span class="popuptext" id="usagePopup150">Usage of <b>Trees::new</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">tree_type</span><span class="plain"> *</span><span class="identifier">type</span><span class="plain">) {</span>
<span class="reserved">heterogeneous_tree</span><span class="plain"> *</span><span class="identifier">T</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">heterogeneous_tree</span><span class="plain">);</span>
<span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">type</span><span class="plain"> = </span><span class="identifier">type</span><span class="plain">;</span>
<span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">T</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b></p>
<pre class="display">
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_node</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">heterogeneous_tree</span><span class="plain"> *</span><span class="identifier">owner</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_node_type</span><span class="plain"> *</span><span class="identifier">type</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">general_pointer</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">tree_node</span><span class="plain"> *</span><span class="identifier">next</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">parent</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">child</span><span class="plain">;</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">tree_node</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure tree_node is accessed in 2/mmr, 4/taa and here.</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. </b>A node is created in limbo, removed from its tree, but it is still somehow
owned by it.
</p>
<pre class="display">
<span class="reserved">tree_node</span><span class="plain"> *</span><span class="functiontext">Trees::new_node<button class="popup" onclick="togglePopup('usagePopup151')">...<span class="popuptext" id="usagePopup151">Usage of <b>Trees::new_node</b>:<br><a href="2-trs.html#SP5">&#167;5</a></span></button></span><span class="plain">(</span><span class="reserved">heterogeneous_tree</span><span class="plain"> *</span><span class="identifier">T</span><span class="plain">, </span><span class="reserved">tree_node_type</span><span class="plain"> *</span><span class="identifier">type</span><span class="plain">, </span><span class="reserved">general_pointer</span><span class="plain"> </span><span class="identifier">wrapping</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">T</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no tree"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">wrapping</span><span class="plain">.</span><span class="element">run_time_type_code</span><span class="plain"> == -1)</span>
<span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no reference given"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">type</span><span class="plain">-&gt;</span><span class="identifier">required_MT</span><span class="plain"> &gt;= </span><span class="constant">0</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">wrapping</span><span class="plain">.</span><span class="element">run_time_type_code</span><span class="plain"> != </span><span class="identifier">type</span><span class="plain">-&gt;</span><span class="element">required_MT</span><span class="plain">)</span>
<span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"wrong reference type"</span><span class="plain">);</span>
<span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">N</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">tree_node</span><span class="plain">);</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">content</span><span class="plain"> = </span><span class="identifier">wrapping</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain"> = </span><span class="identifier">T</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">type</span><span class="plain"> = </span><span class="identifier">type</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">N</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. </b>A convenient abbreviation for a common manoeuvre:
</p>
<pre class="display">
<span class="reserved">tree_node</span><span class="plain"> *</span><span class="functiontext">Trees::new_child<button class="popup" onclick="togglePopup('usagePopup152')">...<span class="popuptext" id="usagePopup152">Usage of <b>Trees::new_child</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">of</span><span class="plain">, </span><span class="reserved">tree_node_type</span><span class="plain"> *</span><span class="identifier">type</span><span class="plain">, </span><span class="reserved">general_pointer</span><span class="plain"> </span><span class="identifier">wrapping</span><span class="plain">) {</span>
<span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">N</span><span class="plain"> = </span><span class="functiontext"><a href="2-trs.html#SP4">Trees::new_node</a></span><span class="plain">(</span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">, </span><span class="identifier">type</span><span class="plain">, </span><span class="identifier">wrapping</span><span class="plain">);</span>
<span class="functiontext"><a href="2-trs.html#SP11">Trees::make_child</a></span><span class="plain">(</span><span class="identifier">N</span><span class="plain">, </span><span class="identifier">of</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">N</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP6"></a><b>&#167;6. Types. </b>The above will provide for multiple different types of tree to be used for
different purposes. Heterogeneous trees allow the coder to make dangerously
type-unsafe structures, so we want to hedge them in with self-imposed
constraints:
</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">tree_type</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">int</span><span class="plain"> (*</span><span class="identifier">verify_root</span><span class="plain">)(</span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_node</span><span class="plain"> *); </span><span class="comment"> function to vet the root node</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">tree_type</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure tree_type is private to this section.</p>
<p class="inwebparagraph"><a id="SP7"></a><b>&#167;7. </b></p>
<pre class="display">
<span class="reserved">tree_type</span><span class="plain"> *</span><span class="functiontext">Trees::new_type<button class="popup" onclick="togglePopup('usagePopup153')">...<span class="popuptext" id="usagePopup153">Usage of <b>Trees::new_type</b>:<br>none</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">int</span><span class="plain"> (*</span><span class="identifier">verifier</span><span class="plain">)(</span><span class="reserved">tree_node</span><span class="plain"> *)) {</span>
<span class="reserved">tree_type</span><span class="plain"> *</span><span class="identifier">T</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">tree_type</span><span class="plain">);</span>
<span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain"> = </span><span class="functiontext"><a href="4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">name</span><span class="plain">);</span>
<span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">verify_root</span><span class="plain"> = </span><span class="identifier">verifier</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">T</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP8"></a><b>&#167;8. </b>Each node in a tree also has a type. Whenever the children of a node change,
they are re-verified by the <code class="display"><span class="extract">verify_children</span></code>.
</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">tree_node_type</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">node_type_name</span><span class="plain">; </span><span class="comment"> text such as <code class="display"><span class="extract">I"INVOCATION"</span></code></span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">required_MT</span><span class="plain">; </span><span class="comment"> if any; or negative for no restriction</span>
<span class="reserved">int</span><span class="plain"> (*</span><span class="identifier">verify_children</span><span class="plain">)(</span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">tree_node</span><span class="plain"> *); </span><span class="comment"> function to vet the children</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">tree_node_type</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure tree_node_type is private to this section.</p>
<p class="inwebparagraph"><a id="SP9"></a><b>&#167;9. </b></p>
<pre class="display">
<span class="reserved">tree_node_type</span><span class="plain"> *</span><span class="functiontext">Trees::new_node_type<button class="popup" onclick="togglePopup('usagePopup154')">...<span class="popuptext" id="usagePopup154">Usage of <b>Trees::new_node_type</b>:<br>none</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">int</span><span class="plain"> </span><span class="identifier">req</span><span class="plain">,</span>
<span class="reserved">int</span><span class="plain"> (*</span><span class="identifier">verifier</span><span class="plain">)(</span><span class="reserved">tree_node</span><span class="plain"> *)) {</span>
<span class="reserved">tree_node_type</span><span class="plain"> *</span><span class="identifier">NT</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">tree_node_type</span><span class="plain">);</span>
<span class="identifier">NT</span><span class="plain">-&gt;</span><span class="element">node_type_name</span><span class="plain"> = </span><span class="functiontext"><a href="4-sm.html#SP3">Str::duplicate</a></span><span class="plain">(</span><span class="identifier">name</span><span class="plain">);</span>
<span class="identifier">NT</span><span class="plain">-&gt;</span><span class="element">required_MT</span><span class="plain"> = </span><span class="identifier">req</span><span class="plain">;</span>
<span class="identifier">NT</span><span class="plain">-&gt;</span><span class="element">verify_children</span><span class="plain"> = </span><span class="identifier">verifier</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">NT</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP10"></a><b>&#167;10. Hierarchy. </b>A special function is needed to choose the root node; and note that this is
verified.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::make_root<button class="popup" onclick="togglePopup('usagePopup155')">...<span class="popuptext" id="usagePopup155">Usage of <b>Trees::make_root</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">heterogeneous_tree</span><span class="plain"> *</span><span class="identifier">T</span><span class="plain">, </span><span class="reserved">tree_node</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="identifier">T</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no tree"</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">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</span><span class="plain">);</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain"> = </span><span class="identifier">T</span><span class="plain">;</span>
<span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">type</span><span class="plain">-&gt;</span><span class="element">verify_root</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> ((*(</span><span class="identifier">T</span><span class="plain">-&gt;</span><span class="identifier">type</span><span class="plain">-&gt;</span><span class="element">verify_root</span><span class="plain">))(</span><span class="identifier">N</span><span class="plain">) == </span><span class="constant">FALSE</span><span class="plain">)</span>
<span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"disallowed node as root"</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::remove_root<button class="popup" onclick="togglePopup('usagePopup156')">...<span class="popuptext" id="usagePopup156">Usage of <b>Trees::remove_root</b>:<br><a href="2-trs.html#SP11">&#167;11</a>, <a href="2-trs.html#SP12">&#167;12</a></span></button></span><span class="plain">(</span><span class="reserved">heterogeneous_tree</span><span class="plain"> *</span><span class="identifier">T</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">T</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no tree"</span><span class="plain">);</span>
<span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP11"></a><b>&#167;11. </b>Otherwise, nodes are placed in a tree with respect to other nodes:
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::make_child<button class="popup" onclick="togglePopup('usagePopup157')">...<span class="popuptext" id="usagePopup157">Usage of <b>Trees::make_child</b>:<br><a href="2-trs.html#SP5">&#167;5</a></span></button></span><span class="plain">(</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">N</span><span class="plain">, </span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">of</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">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">of</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</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">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain">) </span><span class="functiontext"><a href="2-trs.html#SP10">Trees::remove_root</a></span><span class="plain">(</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">);</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">)</span>
<span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">;</span>
<span class="reserved">else</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain">; </span><span class="identifier">S</span><span class="plain">; </span><span class="identifier">S</span><span class="plain"> = </span><span class="identifier">S</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">S</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) {</span>
<span class="identifier">S</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">; </span><span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="functiontext"><a href="2-trs.html#SP12">Trees::verify_children</a></span><span class="plain">(</span><span class="identifier">of</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::make_eldest_child<button class="popup" onclick="togglePopup('usagePopup158')">...<span class="popuptext" id="usagePopup158">Usage of <b>Trees::make_eldest_child</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">N</span><span class="plain">, </span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">of</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">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">of</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</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">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain">) </span><span class="functiontext"><a href="2-trs.html#SP10">Trees::remove_root</a></span><span class="plain">(</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">);</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain">;</span>
<span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">;</span>
<span class="functiontext"><a href="2-trs.html#SP12">Trees::verify_children</a></span><span class="plain">(</span><span class="identifier">of</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::make_sibling<button class="popup" onclick="togglePopup('usagePopup159')">...<span class="popuptext" id="usagePopup159">Usage of <b>Trees::make_sibling</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">N</span><span class="plain">, </span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">of</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">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">of</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</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">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain">) </span><span class="functiontext"><a href="2-trs.html#SP10">Trees::remove_root</a></span><span class="plain">(</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">of</span><span class="plain"> == </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain">)</span>
<span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"nodes cannot be siblings of the root"</span><span class="plain">);</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain">;</span>
<span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">next</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="identifier">of</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain">) </span><span class="functiontext"><a href="2-trs.html#SP12">Trees::verify_children</a></span><span class="plain">(</span><span class="identifier">of</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP12"></a><b>&#167;12. </b>Removing a node from a tree does not change its ownership &mdash; it still belongs
to that tree.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::remove<button class="popup" onclick="togglePopup('usagePopup160')">...<span class="popuptext" id="usagePopup160">Usage of <b>Trees::remove</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">tree_node</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="identifier">N</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</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">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain">) { </span><span class="functiontext"><a href="2-trs.html#SP10">Trees::remove_root</a></span><span class="plain">(</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">owner</span><span class="plain">); </span><span class="reserved">return</span><span class="plain">; }</span>
<span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">p</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain"> == </span><span class="identifier">N</span><span class="plain">)</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain">-&gt;</span><span class="identifier">child</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain">;</span>
<span class="reserved">else</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain">; </span><span class="identifier">S</span><span class="plain">; </span><span class="identifier">S</span><span class="plain"> = </span><span class="identifier">S</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain">)</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">S</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> == </span><span class="identifier">N</span><span class="plain">)</span>
<span class="identifier">S</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">parent</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">next</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">p</span><span class="plain">) </span><span class="functiontext"><a href="2-trs.html#SP12">Trees::verify_children</a></span><span class="plain">(</span><span class="identifier">p</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Trees::verify_children<button class="popup" onclick="togglePopup('usagePopup161')">...<span class="popuptext" id="usagePopup161">Usage of <b>Trees::verify_children</b>:<br><a href="2-trs.html#SP11">&#167;11</a></span></button></span><span class="plain">(</span><span class="reserved">tree_node</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="identifier">N</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no node"</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">type</span><span class="plain">-&gt;</span><span class="element">verify_children</span><span class="plain">)</span>
<span class="reserved">return</span><span class="plain"> (*(</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">type</span><span class="plain">-&gt;</span><span class="element">verify_children</span><span class="plain">))(</span><span class="identifier">N</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain"> </span><span class="constant">TRUE</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP13"></a><b>&#167;13. Traversals. </b>These two functions allow us to traverse the tree, visiting each node along
the way and carrying a state as we do. The distinction is that <a href="2-trs.html#SP13" class="internal">Trees::traverse_from</a>
iterates from and then below the given node, but doesn't go through its siblings,
whereas <a href="2-trs.html#SP13" class="internal">Trees::traverse</a> does.
</p>
<p class="inwebparagraph">Note that it is legal to traverse the empty node, and does nothing.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::traverse_tree<button class="popup" onclick="togglePopup('usagePopup162')">...<span class="popuptext" id="usagePopup162">Usage of <b>Trees::traverse_tree</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">heterogeneous_tree</span><span class="plain"> *</span><span class="identifier">T</span><span class="plain">,</span>
<span class="reserved">void</span><span class="plain"> (*</span><span class="identifier">visitor</span><span class="plain">)(</span><span class="reserved">tree_node</span><span class="plain"> *, </span><span class="reserved">void</span><span class="plain"> *, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">L</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">if</span><span class="plain"> (</span><span class="identifier">T</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"no tree"</span><span class="plain">);</span>
<span class="functiontext"><a href="2-trs.html#SP13">Trees::traverse_from</a></span><span class="plain">(</span><span class="identifier">T</span><span class="plain">-&gt;</span><span class="element">root</span><span class="plain">, </span><span class="identifier">visitor</span><span class="plain">, </span><span class="identifier">state</span><span class="plain">, </span><span class="constant">0</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::traverse_from<button class="popup" onclick="togglePopup('usagePopup163')">...<span class="popuptext" id="usagePopup163">Usage of <b>Trees::traverse_from</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">N</span><span class="plain">,</span>
<span class="reserved">void</span><span class="plain"> (*</span><span class="identifier">visitor</span><span class="plain">)(</span><span class="reserved">tree_node</span><span class="plain"> *, </span><span class="reserved">void</span><span class="plain"> *, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">L</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">int</span><span class="plain"> </span><span class="identifier">L</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="plain">(*</span><span class="identifier">visitor</span><span class="plain">)(</span><span class="identifier">N</span><span class="plain">, </span><span class="identifier">state</span><span class="plain">, </span><span class="identifier">L</span><span class="plain">);</span>
<span class="functiontext"><a href="2-trs.html#SP13">Trees::traverse</a></span><span class="plain">(</span><span class="identifier">N</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain">, </span><span class="identifier">visitor</span><span class="plain">, </span><span class="identifier">state</span><span class="plain">, </span><span class="identifier">L</span><span class="plain">+1);</span>
<span class="plain">}</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Trees::traverse<button class="popup" onclick="togglePopup('usagePopup164')">...<span class="popuptext" id="usagePopup164">Usage of <b>Trees::traverse</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">N</span><span class="plain">,</span>
<span class="reserved">void</span><span class="plain"> (*</span><span class="identifier">visitor</span><span class="plain">)(</span><span class="reserved">tree_node</span><span class="plain"> *, </span><span class="reserved">void</span><span class="plain"> *, </span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">L</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">int</span><span class="plain"> </span><span class="identifier">L</span><span class="plain">) {</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="reserved">tree_node</span><span class="plain"> *</span><span class="identifier">M</span><span class="plain"> = </span><span class="identifier">N</span><span class="plain">; </span><span class="identifier">M</span><span class="plain">; </span><span class="identifier">M</span><span class="plain"> = </span><span class="identifier">M</span><span class="plain">-&gt;</span><span class="identifier">next</span><span class="plain">) {</span>
<span class="plain">(*</span><span class="identifier">visitor</span><span class="plain">)(</span><span class="identifier">M</span><span class="plain">, </span><span class="identifier">state</span><span class="plain">, </span><span class="identifier">L</span><span class="plain">);</span>
<span class="functiontext"><a href="2-trs.html#SP13">Trees::traverse</a></span><span class="plain">(</span><span class="identifier">M</span><span class="plain">-&gt;</span><span class="element">child</span><span class="plain">, </span><span class="identifier">visitor</span><span class="plain">, </span><span class="identifier">state</span><span class="plain">, </span><span class="identifier">L</span><span class="plain">+1);</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<hr class="tocbar">
<ul class="toc"><li><a href="2-dct.html">Back to 'Dictionaries'</a></li><li><i>(This section ends Chapter 2: Memory, Streams and Collections.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
<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">
</main>
</body>
</html>