inweb-bootstrap/docs/foundation-module/3-drc.html
2020-04-08 23:41:00 +01:00

92 lines
8.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Directories</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 'Directories' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="index.html">foundation</a></li><li><a href="index.html#3">Chapter 3: The Operating System</a></li><li><b>Directories</b></li></ul><p class="purpose">Scanning directories on the host filing system.</p>
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b>All of this abstracts the code already found in the platform definitions.
</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">scan_directory</span><span class="plain"> {</span>
<span class="reserved">void</span><span class="plain"> *</span><span class="identifier">directory_handle</span><span class="plain">;</span>
<span class="reserved">char</span><span class="plain"> </span><span class="identifier">directory_name_written_out</span><span class="plain">[4*</span><span class="constant">MAX_FILENAME_LENGTH</span><span class="plain">];</span>
<span class="constant">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">scan_directory</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure scan_directory is private to this section.</p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>The directory name going out has to be transcoded from flat Unicode to
whatever the locale encoding is; the filenames coming back have to be
transcoded the other way.
</p>
<pre class="display">
<span class="reserved">scan_directory</span><span class="plain"> *</span><span class="functiontext">Directories::open</span><span class="plain">(</span><span class="reserved">pathname</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain">) {</span>
<span class="reserved">scan_directory</span><span class="plain"> *</span><span class="identifier">D</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">scan_directory</span><span class="plain">);</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">pn</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">pn</span><span class="plain">, </span><span class="string">"%p"</span><span class="plain">, </span><span class="identifier">P</span><span class="plain">);</span>
<span class="functiontext">Str::copy_to_locale_string</span><span class="plain">(</span><span class="identifier">D</span><span class="plain">-&gt;</span><span class="element">directory_name_written_out</span><span class="plain">, </span><span class="identifier">pn</span><span class="plain">, </span><span class="constant">4</span><span class="plain">*</span><span class="constant">MAX_FILENAME_LENGTH</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">pn</span><span class="plain">);</span>
<span class="identifier">D</span><span class="plain">-&gt;</span><span class="element">directory_handle</span><span class="plain"> = </span><span class="functiontext">Platform::opendir</span><span class="plain">(</span><span class="identifier">D</span><span class="plain">-&gt;</span><span class="element">directory_name_written_out</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">D</span><span class="plain">-&gt;</span><span class="element">directory_handle</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">D</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">Directories::next</span><span class="plain">(</span><span class="reserved">scan_directory</span><span class="plain"> *</span><span class="identifier">D</span><span class="plain">, </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">leafname</span><span class="plain">) {</span>
<span class="reserved">char</span><span class="plain"> </span><span class="identifier">leafname_Cs</span><span class="plain">[</span><span class="constant">MAX_FILENAME_LENGTH</span><span class="plain">];</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">rv</span><span class="plain"> = </span><span class="constant">TRUE</span><span class="plain">;</span>
<span class="reserved">while</span><span class="plain"> (</span><span class="identifier">rv</span><span class="plain">) {</span>
<span class="identifier">rv</span><span class="plain"> = </span><span class="functiontext">Platform::readdir</span><span class="plain">(</span><span class="identifier">D</span><span class="plain">-&gt;</span><span class="element">directory_handle</span><span class="plain">, </span><span class="identifier">D</span><span class="plain">-&gt;</span><span class="element">directory_name_written_out</span><span class="plain">, </span><span class="identifier">leafname_Cs</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">leafname_Cs</span><span class="plain">[0] != </span><span class="character">'.'</span><span class="plain">) </span><span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="functiontext">Str::clear</span><span class="plain">(</span><span class="identifier">leafname</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">rv</span><span class="plain">) </span><span class="functiontext">Streams::write_locale_string</span><span class="plain">(</span><span class="identifier">leafname</span><span class="plain">, </span><span class="identifier">leafname_Cs</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">rv</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Directories::close</span><span class="plain">(</span><span class="reserved">scan_directory</span><span class="plain"> *</span><span class="identifier">D</span><span class="plain">) {</span>
<span class="functiontext">Platform::closedir</span><span class="plain">(</span><span class="identifier">D</span><span class="plain">-&gt;</span><span class="element">directory_handle</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Directories::open appears nowhere else.</p>
<p class="endnote">The function Directories::next appears nowhere else.</p>
<p class="endnote">The function Directories::close appears nowhere else.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="3-shl.html">Back to 'Shell'</a></li><li><a href="3-tm.html">Continue with 'Time'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>