ifhub/inform7
1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-06-01 07:48:35 +03:00
Code Issues Projects Releases Wiki Activity
inform7/docs/multimedia-module/2-ef.html
Graham Nelson fd4a46ddd8 Modernised use of extracts
2020-04-07 01:06:09 +01:00

505 lines
62 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>2/se</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="../compiler.html"><b>compiler tools</b></a></li>
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Compiler Webs</h2>
<ul>
<li><a href="../inbuild/index.html">inbuild</a></li>
<li><a href="../inform7/index.html">inform7</a></li>
<li><a href="../inter/index.html">inter</a></li>
</ul>
<h2>Inbuild Modules</h2>
<ul>
<li><a href="../inbuild-module/index.html">inbuild</a></li>
<li><a href="../arch-module/index.html">arch</a></li>
<li><a href="../words-module/index.html">words</a></li>
<li><a href="../syntax-module/index.html">syntax</a></li>
<li><a href="../html-module/index.html">html</a></li>
</ul>
<h2>Inform7 Modules</h2>
<ul>
<li><a href="../core-module/index.html">core</a></li>
<li><a href="../problems-module/index.html">problems</a></li>
<li><a href="../inflections-module/index.html">inflections</a></li>
<li><a href="../linguistics-module/index.html">linguistics</a></li>
<li><a href="../kinds-module/index.html">kinds</a></li>
<li><a href="../if-module/index.html">if</a></li>
<li><a href="../multimedia-module/index.html">multimedia</a></li>
<li><a href="../index-module/index.html">index</a></li>
</ul>
<h2>Inter Modules</h2>
<ul>
<li><a href="../inter-module/index.html">inter</a></li>
<li><a href="../building-module/index.html">building</a></li>
<li><a href="../codegen-module/index.html">codegen</a></li>
</ul>
<h2>Foundation</h2>
<ul>
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
</ul>
</nav>
<main role="main">
<!--Weave of '2/ef' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="../compiler.html">Compiler Modules</a></li><li><a href="index.html">multimedia</a></li><li><a href="index.html#2">Chapter 2: Multimedia Features</a></li><li><b>External Files</b></li></ul><p class="purpose">To register the names associated with external files, and build the small I6 arrays associated with each.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Definitions</a></li><li><a href="#SP11">&#167;11. I6 arrays of file structures</a></li><li><a href="#SP12">&#167;12. External Files Index</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Definitions. </b></p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>Each file can be text or binary, has a name, and can be owned by a this
project, by an unspecified other project, or by a project named by IFID.
</p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">OWNED_BY_THIS_PROJECT</span><span class="plain"> </span><span class="constant">1</span>
<span class="definitionkeyword">define</span> <span class="constant">OWNED_BY_ANOTHER_PROJECT</span><span class="plain"> </span><span class="constant">2</span>
<span class="definitionkeyword">define</span> <span class="constant">OWNED_BY_SPECIFIC_PROJECT</span><span class="plain"> </span><span class="constant">3</span>
</pre>
<pre class="display">
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">external_file</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">name</span><span class="plain">; </span><span class="comment">text of name</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">unextended_filename</span><span class="plain">; </span><span class="comment">word number of text like <code class="display"><span class="extract">"bones"</span></code></span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">exf_I6_identifier</span><span class="plain">; </span><span class="comment">an I6 identifier</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">file_is_binary</span><span class="plain">; </span><span class="comment">true or false</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">file_ownership</span><span class="plain">; </span><span class="comment">one of the above</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">IFID_of_owner</span><span class="plain">; </span><span class="comment">an I6 identifier</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">inter_name</span><span class="plain"> *</span><span class="identifier">exf_iname</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">inter_name</span><span class="plain"> *</span><span class="identifier">IFID_array_iname</span><span class="plain">;</span>
<span class="identifier">MEMORY_MANAGEMENT</span>
<span class="plain">} </span><span class="reserved">external_file</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure external_file is accessed in 2/fgr, 2/se and here.</p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>A <code class="display"><span class="extract">--&gt;</span></code> array to a run-time data structure associated
with an external file, read or written by the story file during play.
</p>
<pre class="display">
<span class="identifier">kind</span><span class="plain"> *</span><span class="identifier">K_external_file</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. </b></p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Files::start</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="identifier">PLUGIN_REGISTER</span><span class="plain">(</span><span class="identifier">PLUGIN_NEW_BASE_KIND_NOTIFY</span><span class="plain">, </span><span class="functiontext">PL::Files::files_new_base_kind_notify</span><span class="plain">);</span>
<span class="identifier">PLUGIN_REGISTER</span><span class="plain">(</span><span class="identifier">PLUGIN_NEW_INSTANCE_NOTIFY</span><span class="plain">, </span><span class="functiontext">PL::Files::files_new_named_instance_notify</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function PL::Files::start appears nowhere else.</p>
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. </b></p>
<pre class="display">
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">PL::Files::files_new_base_kind_notify</span><span class="plain">(</span><span class="identifier">kind</span><span class="plain"> *</span><span class="identifier">new_base</span><span class="plain">, </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">name</span><span class="plain">, </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">W</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Str::eq_wide_string</span><span class="plain">(</span><span class="identifier">name</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"EXTERNAL_FILE_TY"</span><span class="plain">)) {</span>
<span class="identifier">K_external_file</span><span class="plain"> = </span><span class="identifier">new_base</span><span class="plain">; </span><span class="reserved">return</span><span class="plain"> </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">allow_exf_creations</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">PL::Files::files_new_named_instance_notify</span><span class="plain">(</span><span class="identifier">instance</span><span class="plain"> *</span><span class="identifier">nc</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">K_external_file</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">FALSE</span><span class="plain">;</span>
<span class="identifier">kind</span><span class="plain"> *</span><span class="identifier">K</span><span class="plain"> = </span><span class="identifier">Instances::to_kind</span><span class="plain">(</span><span class="identifier">nc</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Kinds::Compare::eq</span><span class="plain">(</span><span class="identifier">K</span><span class="plain">, </span><span class="identifier">K_external_file</span><span class="plain">)) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">allow_exf_creations</span><span class="plain"> == </span><span class="identifier">FALSE</span><span class="plain">)</span>
<span class="identifier">Problems::Issue::sentence_problem</span><span class="plain">(</span><span class="identifier">Task::syntax_tree</span><span class="plain">(), </span><span class="identifier">_p_</span><span class="plain">(</span><span class="identifier">PM_BackdoorFileCreation</span><span class="plain">),</span>
<span class="string">"this is not the way to create a new external file"</span><span class="plain">,</span>
<span class="string">"which should be done with a special 'The File ... is called ...' "</span>
<span class="string">"sentence."</span><span class="plain">);</span>
<span class="identifier">Instances::set_connection</span><span class="plain">(</span><span class="identifier">nc</span><span class="plain">,</span>
<span class="identifier">STORE_POINTER_external_file</span><span class="plain">(</span><span class="functiontext">PL::Files::new_external_file</span><span class="plain">(</span><span class="identifier">nc</span><span class="plain">)));</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function PL::Files::files_new_base_kind_notify is used in <a href="#SP4">&#167;4</a>.</p>
<p class="endnote">The function PL::Files::files_new_named_instance_notify is used in <a href="#SP4">&#167;4</a>.</p>
<p class="inwebparagraph"><a id="SP6"></a><b>&#167;6. </b></p>
<pre class="display">
<span class="reserved">external_file</span><span class="plain"> *</span><span class="functiontext">PL::Files::new_external_file</span><span class="plain">(</span><span class="identifier">instance</span><span class="plain"> *</span><span class="identifier">nc</span><span class="plain">) {</span>
<span class="reserved">external_file</span><span class="plain"> *</span><span class="identifier">exf</span><span class="plain"> = </span><span class="identifier">CREATE</span><span class="plain">(</span><span class="reserved">external_file</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">exf</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function PL::Files::new_external_file is used in <a href="#SP5">&#167;5</a>.</p>
<p class="inwebparagraph"><a id="SP7"></a><b>&#167;7. </b>External files are created with a special sentence:
</p>
<blockquote>
<p>The File of Wisdom (owned by another project) is called "wisdom".</p>
</blockquote>
<p class="inwebparagraph">Here is the subject:
</p>
<pre class="display">
<span class="plain">&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">subject</span><span class="plain">&gt; ::=</span>
<span class="plain">&lt;</span><span class="identifier">definite</span><span class="plain">-</span><span class="identifier">article</span><span class="plain">&gt; &lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">subject</span><span class="plain">&gt; | ==&gt; </span><span class="identifier">R</span><span class="plain">[2]</span>
<span class="identifier">text</span><span class="plain"> &lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">name</span><span class="plain">&gt; | ==&gt; </span><span class="identifier">FALSE</span><span class="plain">; &lt;&lt;</span><span class="identifier">ownership</span><span class="plain">&gt;&gt; = </span><span class="identifier">R</span><span class="plain">[1]</span>
<span class="identifier">binary</span><span class="plain"> &lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">name</span><span class="plain">&gt; | ==&gt; </span><span class="identifier">TRUE</span><span class="plain">; &lt;&lt;</span><span class="identifier">ownership</span><span class="plain">&gt;&gt; = </span><span class="identifier">R</span><span class="plain">[1]</span>
<span class="plain">&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">name</span><span class="plain">&gt; ==&gt; </span><span class="identifier">FALSE</span><span class="plain">; &lt;&lt;</span><span class="identifier">ownership</span><span class="plain">&gt;&gt; = </span><span class="identifier">R</span><span class="plain">[1]</span>
<span class="plain">&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">name</span><span class="plain">&gt; ::=</span>
<span class="plain">{</span><span class="identifier">file</span><span class="plain"> ...} ( </span><span class="identifier">owned</span><span class="plain"> </span><span class="identifier">by</span><span class="plain"> &lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">owner</span><span class="plain">&gt; ) | ==&gt; </span><span class="identifier">R</span><span class="plain">[1]</span>
<span class="plain">{</span><span class="identifier">file</span><span class="plain"> ...} ==&gt; </span><span class="identifier">NOT_APPLICABLE</span>
<span class="plain">&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">owner</span><span class="plain">&gt; ::=</span>
<span class="identifier">another</span><span class="plain"> </span><span class="identifier">project</span><span class="plain"> | ==&gt; </span><span class="identifier">FALSE</span>
<span class="identifier">project</span><span class="plain"> {&lt;</span><span class="identifier">quoted</span><span class="plain">-</span><span class="identifier">text</span><span class="plain">-</span><span class="identifier">without</span><span class="plain">-</span><span class="identifier">subs</span><span class="plain">&gt;} | ==&gt; </span><span class="identifier">TRUE</span>
<span class="plain">... ==&gt; </span>&lt;<span class="cwebmacro">Issue PM_BadFileOwner problem</span> <span class="cwebmacronumber">7.1</span>&gt;
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP7_1"></a><b>&#167;7.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Issue PM_BadFileOwner problem</span> <span class="cwebmacronumber">7.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="plain">*</span><span class="identifier">X</span><span class="plain"> = </span><span class="identifier">NOT_APPLICABLE</span><span class="plain">;</span>
<span class="identifier">Problems::Issue::sentence_problem</span><span class="plain">(</span><span class="identifier">Task::syntax_tree</span><span class="plain">(), </span><span class="identifier">_p_</span><span class="plain">(</span><span class="identifier">PM_BadFileOwner</span><span class="plain">),</span>
<span class="string">"the owner of this file is wrongly specified"</span><span class="plain">,</span>
<span class="string">"since it is not one of the three possibilities - "</span>
<span class="string">"(1) Specify nothing: making the file belong to this "</span>
<span class="string">"project. (2) Specify only that it belongs to someone, "</span>
<span class="string">"without saying whom: 'The File of Wisdom (owned by "</span>
<span class="string">"another project) is called \"wisdom\".' (3) Specify "</span>
<span class="string">"that it belongs to a project with a given double-quoted "</span>
<span class="string">"IFID: 'The File of Wisdom (owned by project "</span>
<span class="string">"\"4122DDA8-A153-46BC-8F57-42220F9D8795\") "</span>
<span class="string">"is called \"wisdom\".'"</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP7">&#167;7</a>.</p>
<p class="inwebparagraph"><a id="SP8"></a><b>&#167;8. </b>The object NP is simply quoted text. Although the Preform grammar doesn't
go into this level of detail, it's actually required to have 3 to 23 English
letters or digits, with the first being a letter.
</p>
<pre class="display">
<span class="plain">&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">object</span><span class="plain">&gt; ::=</span>
<span class="plain">&lt;</span><span class="identifier">quoted</span><span class="plain">-</span><span class="identifier">text</span><span class="plain">&gt; | ==&gt; </span><span class="identifier">R</span><span class="plain">[1]</span>
<span class="plain">... ==&gt; </span>&lt;<span class="cwebmacro">Issue PM_FilenameNotTextual problem</span> <span class="cwebmacronumber">8.1</span>&gt;
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP8_1"></a><b>&#167;8.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Issue PM_FilenameNotTextual problem</span> <span class="cwebmacronumber">8.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="plain">*</span><span class="identifier">X</span><span class="plain"> = -1;</span>
<span class="identifier">Problems::Issue::sentence_problem</span><span class="plain">(</span><span class="identifier">Task::syntax_tree</span><span class="plain">(), </span><span class="identifier">_p_</span><span class="plain">(</span><span class="identifier">PM_FilenameNotTextual</span><span class="plain">),</span>
<span class="string">"a file can only be called with a single quoted piece of text"</span><span class="plain">,</span>
<span class="string">"as in: 'The File of Wisdom is called \"wisdom\".'"</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP8">&#167;8</a>.</p>
<p class="inwebparagraph"><a id="SP9"></a><b>&#167;9. </b>This handles the special meaning "File... is the file...".
</p>
<pre class="display">
<span class="plain">&lt;</span><span class="identifier">new</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">object</span><span class="plain">&gt; ::=</span>
<span class="plain">&lt;</span><span class="identifier">indefinite</span><span class="plain">-</span><span class="identifier">article</span><span class="plain">&gt; &lt;</span><span class="identifier">new</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">object</span><span class="plain">-</span><span class="identifier">unarticled</span><span class="plain">&gt; | ==&gt; </span><span class="identifier">R</span><span class="plain">[2]; *</span><span class="identifier">XP</span><span class="plain"> = </span><span class="identifier">RP</span><span class="plain">[2]</span>
<span class="plain">&lt;</span><span class="identifier">new</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">object</span><span class="plain">-</span><span class="identifier">unarticled</span><span class="plain">&gt; ==&gt; </span><span class="identifier">R</span><span class="plain">[1]; *</span><span class="identifier">XP</span><span class="plain"> = </span><span class="identifier">RP</span><span class="plain">[1]</span>
<span class="plain">&lt;</span><span class="identifier">new</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">object</span><span class="plain">-</span><span class="identifier">unarticled</span><span class="plain">&gt; ::=</span>
<span class="identifier">called</span><span class="plain"> &lt;</span><span class="identifier">nounphrase</span><span class="plain">&gt; ==&gt; </span><span class="identifier">TRUE</span><span class="plain">; *</span><span class="identifier">XP</span><span class="plain"> = </span><span class="identifier">RP</span><span class="plain">[1];</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP10"></a><b>&#167;10. </b></p>
<pre class="display">
<span class="reserved">int</span><span class="plain"> </span><span class="functiontext">PL::Files::new_file_SMF</span><span class="plain">(</span><span class="reserved">int</span><span class="plain"> </span><span class="identifier">task</span><span class="plain">, </span><span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">wording</span><span class="plain"> *</span><span class="identifier">NPs</span><span class="plain">) {</span>
<span class="identifier">wording</span><span class="plain"> </span><span class="identifier">SW</span><span class="plain"> = (</span><span class="identifier">NPs</span><span class="plain">)?(</span><span class="identifier">NPs</span><span class="plain">[0]):</span><span class="identifier">EMPTY_WORDING</span><span class="plain">;</span>
<span class="identifier">wording</span><span class="plain"> </span><span class="identifier">OW</span><span class="plain"> = (</span><span class="identifier">NPs</span><span class="plain">)?(</span><span class="identifier">NPs</span><span class="plain">[1]):</span><span class="identifier">EMPTY_WORDING</span><span class="plain">;</span>
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">task</span><span class="plain">) { </span><span class="comment">"File... is the file..."</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">ACCEPT_SMFT:</span>
<span class="reserved">if</span><span class="plain"> ((&lt;</span><span class="identifier">nounphrase</span><span class="plain">-</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">&gt;(</span><span class="identifier">SW</span><span class="plain">)) &amp;&amp; (&lt;</span><span class="identifier">new</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">object</span><span class="plain">&gt;(</span><span class="identifier">OW</span><span class="plain">))) {</span>
<span class="identifier">ParseTree::annotate_int</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">, </span><span class="identifier">verb_id_ANNOT</span><span class="plain">, </span><span class="identifier">SPECIAL_MEANING_VB</span><span class="plain">);</span>
<span class="identifier">parse_node</span><span class="plain"> *</span><span class="identifier">O</span><span class="plain"> = &lt;&lt;</span><span class="identifier">rp</span><span class="plain">&gt;&gt;;</span>
<span class="plain">&lt;</span><span class="identifier">nounphrase</span><span class="plain">&gt;(</span><span class="identifier">SW</span><span class="plain">);</span>
<span class="identifier">V</span><span class="plain">-&gt;</span><span class="identifier">next</span><span class="plain"> = &lt;&lt;</span><span class="identifier">rp</span><span class="plain">&gt;&gt;;</span>
<span class="identifier">V</span><span class="plain">-&gt;</span><span class="identifier">next</span><span class="plain">-&gt;</span><span class="identifier">next</span><span class="plain"> = </span><span class="identifier">O</span><span class="plain">;</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">TRAVERSE1_SMFT:</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Plugins::Manage::plugged_in</span><span class="plain">(</span><span class="identifier">files_plugin</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">)</span>
<span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"Files plugin inactive"</span><span class="plain">);</span>
<span class="functiontext">PL::Files::register_file</span><span class="plain">(</span><span class="identifier">ParseTree::get_text</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">-&gt;</span><span class="identifier">next</span><span class="plain">),</span>
<span class="identifier">ParseTree::get_text</span><span class="plain">(</span><span class="identifier">V</span><span class="plain">-&gt;</span><span class="identifier">next</span><span class="plain">-&gt;</span><span class="identifier">next</span><span class="plain">));</span>
<span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">return</span><span class="plain"> </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Files::register_file</span><span class="plain">(</span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">F</span><span class="plain">, </span><span class="identifier">wording</span><span class="plain"> </span><span class="identifier">FN</span><span class="plain">) {</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">bad_filename</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="plain">&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">object</span><span class="plain">&gt;(</span><span class="identifier">FN</span><span class="plain">);</span>
<span class="identifier">FN</span><span class="plain"> = </span><span class="identifier">Wordings::from</span><span class="plain">(</span><span class="identifier">FN</span><span class="plain">, &lt;&lt;</span><span class="identifier">r</span><span class="plain">&gt;&gt;);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wordings::empty</span><span class="plain">(</span><span class="identifier">FN</span><span class="plain">)) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="identifier">wchar_t</span><span class="plain"> *</span><span class="identifier">p</span><span class="plain"> = </span><span class="identifier">Lexer::word_text</span><span class="plain">(</span><span class="identifier">Wordings::first_wn</span><span class="plain">(</span><span class="identifier">FN</span><span class="plain">));</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Wide::len</span><span class="plain">(</span><span class="identifier">p</span><span class="plain">) &lt; </span><span class="constant">5</span><span class="plain">) </span><span class="identifier">bad_filename</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Characters::isalpha</span><span class="plain">(</span><span class="identifier">p</span><span class="plain">[1]) == </span><span class="identifier">FALSE</span><span class="plain">) </span><span class="identifier">bad_filename</span><span class="plain"> = </span><span class="identifier">TRUE</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">i</span><span class="plain">=0; </span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">i</span><span class="plain">]; </span><span class="identifier">i</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="identifier">i</span><span class="plain">] == </span><span class="character">'"'</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">i</span><span class="plain">==0) || (</span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">i</span><span class="plain">+1] == </span><span class="constant">0</span><span class="plain">)) </span><span class="reserved">continue</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">i</span><span class="plain">&gt;24) </span><span class="identifier">bad_filename</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">isalpha</span><span class="plain">(</span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">i</span><span class="plain">])) || (</span><span class="identifier">Characters::isdigit</span><span class="plain">(</span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">i</span><span class="plain">]))) </span><span class="reserved">continue</span><span class="plain">;</span>
<span class="identifier">LOG</span><span class="plain">(</span><span class="string">"Objected to character %c\n"</span><span class="plain">, </span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">i</span><span class="plain">]);</span>
<span class="identifier">bad_filename</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">bad_filename</span><span class="plain">) {</span>
<span class="identifier">LOG</span><span class="plain">(</span><span class="string">"Filename: %s\n"</span><span class="plain">, </span><span class="identifier">p</span><span class="plain">);</span>
<span class="identifier">Problems::Issue::sentence_problem</span><span class="plain">(</span><span class="identifier">Task::syntax_tree</span><span class="plain">(), </span><span class="identifier">_p_</span><span class="plain">(</span><span class="identifier">PM_FilenameUnsafe</span><span class="plain">),</span>
<span class="string">"filenames must be very conservatively chosen"</span><span class="plain">,</span>
<span class="string">"in order to be viable on a wide range of computers. They must "</span>
<span class="string">"consist of 3 to 23 English letters or digits, with the first being "</span>
<span class="string">"a letter. Spaces are not allowed, and nor are periods. (A file "</span>
<span class="string">"extension, such as '.glkdata', may be added on some platforms "</span>
<span class="string">"automatically: this is invisible to Inform.)"</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">ownership</span><span class="plain"> = </span><span class="constant">OWNED_BY_THIS_PROJECT</span><span class="plain">;</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">ifid_of_file</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">sentence</span><span class="plain">-</span><span class="identifier">subject</span><span class="plain">&gt;(</span><span class="identifier">F</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">) </span><span class="identifier">internal_error</span><span class="plain">(</span><span class="string">"bad ef grammar"</span><span class="plain">);</span>
<span class="identifier">F</span><span class="plain"> = </span><span class="identifier">GET_RW</span><span class="plain">(&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">name</span><span class="plain">&gt;, </span><span class="constant">1</span><span class="plain">);</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">binary</span><span class="plain"> = &lt;&lt;</span><span class="identifier">r</span><span class="plain">&gt;&gt;;</span>
<span class="reserved">if</span><span class="plain"> (&lt;&lt;</span><span class="identifier">ownership</span><span class="plain">&gt;&gt; == </span><span class="identifier">TRUE</span><span class="plain">) {</span>
<span class="identifier">wording</span><span class="plain"> </span><span class="identifier">OW</span><span class="plain"> = </span><span class="identifier">GET_RW</span><span class="plain">(&lt;</span><span class="identifier">external</span><span class="plain">-</span><span class="identifier">file</span><span class="plain">-</span><span class="identifier">owner</span><span class="plain">&gt;, </span><span class="constant">1</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">invalid</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="identifier">p</span><span class="plain"> = </span><span class="identifier">Lexer::word_text</span><span class="plain">(</span><span class="identifier">Wordings::last_wn</span><span class="plain">(</span><span class="identifier">OW</span><span class="plain">));</span>
<span class="reserved">for</span><span class="plain"> (</span><span class="identifier">j</span><span class="plain">=1; (</span><span class="identifier">j</span><span class="plain">&lt;47) &amp;&amp; (</span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">j</span><span class="plain">]); </span><span class="identifier">j</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="identifier">j</span><span class="plain">] == </span><span class="character">'"'</span><span class="plain">) &amp;&amp; (</span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">j</span><span class="plain">+1] == </span><span class="constant">0</span><span class="plain">)) </span><span class="reserved">break</span><span class="plain">;</span>
<span class="identifier">PUT_TO</span><span class="plain">(</span><span class="identifier">ifid_of_file</span><span class="plain">, </span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">j</span><span class="plain">]);</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">isalpha</span><span class="plain">(</span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">j</span><span class="plain">])) || (</span><span class="identifier">Characters::isdigit</span><span class="plain">(</span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">j</span><span class="plain">]))) </span><span class="reserved">continue</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="identifier">j</span><span class="plain">] == </span><span class="character">'-'</span><span class="plain">) </span><span class="reserved">continue</span><span class="plain">;</span>
<span class="identifier">invalid</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="identifier">LOG</span><span class="plain">(</span><span class="string">"Objected to character %c\n"</span><span class="plain">, </span><span class="identifier">p</span><span class="plain">[</span><span class="identifier">j</span><span class="plain">]);</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">invalid</span><span class="plain">) || (</span><span class="identifier">j</span><span class="plain">==47)) {</span>
<span class="identifier">Problems::Issue::sentence_problem</span><span class="plain">(</span><span class="identifier">Task::syntax_tree</span><span class="plain">(), </span><span class="identifier">_p_</span><span class="plain">(</span><span class="identifier">PM_BadFileIFID</span><span class="plain">),</span>
<span class="string">"the owner of the file should be specified "</span>
<span class="string">"using a valid double-quoted IFID"</span><span class="plain">,</span>
<span class="string">"as in: 'The File of Wisdom (owned by project "</span>
<span class="string">"\"4122DDA8-A153-46BC-8F57-42220F9D8795\") "</span>
<span class="string">"is called \"wisdom\".'"</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span>
<span class="identifier">ownership</span><span class="plain"> = </span><span class="constant">OWNED_BY_SPECIFIC_PROJECT</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">if</span><span class="plain"> (&lt;&lt;</span><span class="identifier">ownership</span><span class="plain">&gt;&gt; == </span><span class="identifier">FALSE</span><span class="plain">) {</span>
<span class="identifier">ownership</span><span class="plain"> = </span><span class="constant">OWNED_BY_ANOTHER_PROJECT</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">Assertions::Creator::vet_name_for_noun</span><span class="plain">(</span><span class="identifier">F</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> ((&lt;</span><span class="identifier">s</span><span class="plain">-</span><span class="identifier">value</span><span class="plain">&gt;(</span><span class="identifier">F</span><span class="plain">)) &amp;&amp;</span>
<span class="plain">(</span><span class="identifier">Rvalues::is_CONSTANT_of_kind</span><span class="plain">(&lt;&lt;</span><span class="identifier">rp</span><span class="plain">&gt;&gt;, </span><span class="identifier">K_external_file</span><span class="plain">))) {</span>
<span class="identifier">Problems::Issue::sentence_problem</span><span class="plain">(</span><span class="identifier">Task::syntax_tree</span><span class="plain">(), </span><span class="identifier">_p_</span><span class="plain">(</span><span class="identifier">PM_FilenameDuplicate</span><span class="plain">),</span>
<span class="string">"this is already the name of a file"</span><span class="plain">,</span>
<span class="string">"so there must be some duplication somewhere."</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">allow_exf_creations</span><span class="plain"> = </span><span class="identifier">TRUE</span><span class="plain">;</span>
<span class="identifier">pcalc_prop</span><span class="plain"> *</span><span class="identifier">prop</span><span class="plain"> = </span><span class="identifier">Calculus::Propositions::Abstract::to_create_something</span><span class="plain">(</span>
<span class="identifier">K_external_file</span><span class="plain">, </span><span class="identifier">F</span><span class="plain">);</span>
<span class="identifier">Calculus::Propositions::Assert::assert_true</span><span class="plain">(</span><span class="identifier">prop</span><span class="plain">, </span><span class="identifier">CERTAIN_CE</span><span class="plain">);</span>
<span class="identifier">allow_exf_creations</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="reserved">external_file</span><span class="plain"> *</span><span class="identifier">exf</span><span class="plain"> = </span><span class="identifier">RETRIEVE_POINTER_external_file</span><span class="plain">(</span>
<span class="identifier">Instances::get_connection</span><span class="plain">(</span><span class="identifier">latest_instance</span><span class="plain">));</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain"> = </span><span class="identifier">F</span><span class="plain">;</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">unextended_filename</span><span class="plain"> = </span><span class="identifier">Wordings::first_wn</span><span class="plain">(</span><span class="identifier">FN</span><span class="plain">);</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">file_is_binary</span><span class="plain"> = </span><span class="identifier">binary</span><span class="plain">;</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">file_ownership</span><span class="plain"> = </span><span class="identifier">ownership</span><span class="plain">;</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">IFID_of_owner</span><span class="plain"> = </span><span class="identifier">Str::duplicate</span><span class="plain">(</span><span class="identifier">ifid_of_file</span><span class="plain">);</span>
<span class="identifier">package_request</span><span class="plain"> *</span><span class="identifier">P</span><span class="plain"> = </span><span class="identifier">Hierarchy::local_package</span><span class="plain">(</span><span class="identifier">EXTERNAL_FILES_HAP</span><span class="plain">);</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">exf_iname</span><span class="plain"> = </span><span class="identifier">Hierarchy::make_iname_with_memo</span><span class="plain">(</span><span class="identifier">FILE_HL</span><span class="plain">, </span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">);</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">IFID_array_iname</span><span class="plain"> = </span><span class="identifier">Hierarchy::make_iname_with_memo</span><span class="plain">(</span><span class="identifier">IFID_HL</span><span class="plain">, </span><span class="identifier">P</span><span class="plain">, </span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">);</span>
<span class="identifier">LOGIF</span><span class="plain">(</span><span class="identifier">FIGURE_CREATIONS</span><span class="plain">, </span><span class="string">"Created external file &lt;%W&gt; = filename '%N'\n"</span><span class="plain">,</span>
<span class="identifier">F</span><span class="plain">, </span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">unextended_filename</span><span class="plain">);</span>
<span class="identifier">DISCARD_TEXT</span><span class="plain">(</span><span class="identifier">ifid_of_file</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function PL::Files::new_file_SMF appears nowhere else.</p>
<p class="endnote">The function PL::Files::register_file appears nowhere else.</p>
<p class="inwebparagraph"><a id="SP11"></a><b>&#167;11. I6 arrays of file structures. </b>External files are written in I6 as their array names:
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Files::arrays</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Plugins::Manage::plugged_in</span><span class="plain">(</span><span class="identifier">files_plugin</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="identifier">inter_name</span><span class="plain"> *</span><span class="identifier">iname</span><span class="plain"> = </span><span class="identifier">Hierarchy::find</span><span class="plain">(</span><span class="identifier">NO_EXTERNAL_FILES_HL</span><span class="plain">);</span>
<span class="identifier">Emit::named_numeric_constant</span><span class="plain">(</span><span class="identifier">iname</span><span class="plain">, (</span><span class="identifier">inter_t</span><span class="plain">) (</span><span class="identifier">NUMBER_CREATED</span><span class="plain">(</span><span class="reserved">external_file</span><span class="plain">)));</span>
<span class="identifier">Hierarchy::make_available</span><span class="plain">(</span><span class="identifier">Emit::tree</span><span class="plain">(), </span><span class="identifier">iname</span><span class="plain">);</span>
<span class="reserved">external_file</span><span class="plain"> *</span><span class="identifier">exf</span><span class="plain">;</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">exf</span><span class="plain">, </span><span class="reserved">external_file</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">file_ownership</span><span class="plain"> == </span><span class="constant">OWNED_BY_SPECIFIC_PROJECT</span><span class="plain">) {</span>
<span class="identifier">packaging_state</span><span class="plain"> </span><span class="identifier">save</span><span class="plain"> = </span><span class="identifier">Emit::named_string_array_begin</span><span class="plain">(</span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">IFID_array_iname</span><span class="plain">, </span><span class="identifier">K_value</span><span class="plain">);</span>
<span class="identifier">TEMPORARY_TEXT</span><span class="plain">(</span><span class="identifier">II</span><span class="plain">);</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">II</span><span class="plain">, </span><span class="string">"//%S</span><span class="comment">", exf-&gt;IFID_of_owner);</span>
<span class="string">Emit::array_text_entry(II);</span>
<span class="string">DISCARD_TEXT(II);</span>
<span class="string">Emit::array_end(save);</span>
<span class="string">}</span>
<span class="string">}</span>
<span class="string">LOOP_OVER(exf, external_file) {</span>
<span class="string">packaging_state save = Emit::named_array_begin(exf-&gt;exf_iname, K_value);</span>
<span class="string">Emit::array_iname_entry(Hierarchy::find(AUXF_MAGIC_VALUE_HL));</span>
<span class="string">Emit::array_iname_entry(Hierarchy::find(AUXF_STATUS_IS_CLOSED_HL));</span>
<span class="string">if (exf-&gt;file_is_binary) Emit::array_numeric_entry(1);</span>
<span class="string">else Emit::array_numeric_entry(0);</span>
<span class="string">Emit::array_numeric_entry(0);</span>
<span class="string">TEMPORARY_TEXT(WW);</span>
<span class="string">WRITE_TO(WW, "</span><span class="plain">%</span><span class="identifier">w</span><span class="string">", Lexer::word_raw_text(exf-&gt;unextended_filename));</span>
<span class="string">Str::delete_first_character(WW);</span>
<span class="string">Str::delete_last_character(WW);</span>
<span class="string">Emit::array_text_entry(WW);</span>
<span class="string">DISCARD_TEXT(WW);</span>
<span class="string">switch (exf-&gt;file_ownership) {</span>
<span class="string">case OWNED_BY_THIS_PROJECT: Emit::array_iname_entry(PL::Bibliographic::IFID::UUID()); break;</span>
<span class="string">case OWNED_BY_ANOTHER_PROJECT: Emit::array_null_entry(); break;</span>
<span class="string">case OWNED_BY_SPECIFIC_PROJECT: Emit::array_iname_entry(exf-&gt;IFID_array_iname); break;</span>
<span class="string">}</span>
<span class="string">Emit::array_end(save);</span>
<span class="string">}</span>
<span class="string">iname = Hierarchy::find(TABLEOFEXTERNALFILES_HL);</span>
<span class="string">packaging_state save = Emit::named_array_begin(iname, K_value);</span>
<span class="string">Emit::array_numeric_entry(0);</span>
<span class="string">LOOP_OVER(exf, external_file) Emit::array_iname_entry(exf-&gt;exf_iname);</span>
<span class="string">Emit::array_numeric_entry(0);</span>
<span class="string">Emit::array_end(save);</span>
<span class="string">Hierarchy::make_available(Emit::tree(), iname);</span>
<span class="string">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function PL::Files::arrays appears nowhere else.</p>
<p class="inwebparagraph"><a id="SP12"></a><b>&#167;12. External Files Index. </b>More or less perfunctory, but still of some use, if only as a list.
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">PL::Files::index_all</span><span class="plain">(</span><span class="identifier">OUTPUT_STREAM</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">Plugins::Manage::plugged_in</span><span class="plain">(</span><span class="identifier">files_plugin</span><span class="plain">) == </span><span class="identifier">FALSE</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="reserved">external_file</span><span class="plain"> *</span><span class="identifier">exf</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">NUMBER_CREATED</span><span class="plain">(</span><span class="reserved">external_file</span><span class="plain">) == </span><span class="constant">0</span><span class="plain">) {</span>
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"This project doesn't read or write external files."</span><span class="plain">);</span>
<span class="identifier">HTML_CLOSE</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="reserved">return</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"&lt;b&gt;List of External Files&lt;/b&gt;"</span><span class="plain">);</span>
<span class="identifier">HTML_CLOSE</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="identifier">HTML::begin_html_table</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="string">"#ffffff"</span><span class="plain">, </span><span class="identifier">TRUE</span><span class="plain">, </span><span class="constant">0</span><span class="plain">, </span><span class="constant">0</span><span class="plain">, </span><span class="constant">0</span><span class="plain">, </span><span class="constant">0</span><span class="plain">, </span><span class="constant">0</span><span class="plain">);</span>
<span class="identifier">LOOP_OVER</span><span class="plain">(</span><span class="identifier">exf</span><span class="plain">, </span><span class="reserved">external_file</span><span class="plain">) {</span>
<span class="identifier">HTML::first_html_column</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="constant">THUMBNAIL_WIDTH</span><span class="plain">+10);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">file_is_binary</span><span class="plain">) {</span>
<span class="identifier">HTML_TAG_WITH</span><span class="plain">(</span><span class="string">"img"</span><span class="plain">, </span><span class="string">"border=\"0\" src=\"inform:/doc_images/exf_binary.png\""</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
<span class="identifier">HTML_TAG_WITH</span><span class="plain">(</span><span class="string">"img"</span><span class="plain">, </span><span class="string">"border=\"0\" src=\"inform:/doc_images/exf_text.png\""</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"&amp;nbsp;"</span><span class="plain">);</span>
<span class="identifier">HTML::next_html_column</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="constant">0</span><span class="plain">);</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"%+W"</span><span class="plain">, </span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">);</span>
<span class="identifier">Index::link</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">, </span><span class="identifier">Wordings::first_wn</span><span class="plain">(</span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">name</span><span class="plain">));</span>
<span class="identifier">HTML_TAG</span><span class="plain">(</span><span class="string">"br"</span><span class="plain">);</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"Filename: %s %N- owned by "</span><span class="plain">,</span>
<span class="plain">(</span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">file_is_binary</span><span class="plain">)?</span><span class="string">"- binary "</span><span class="plain">:</span><span class="string">""</span><span class="plain">,</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">unextended_filename</span><span class="plain">);</span>
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">file_ownership</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">OWNED_BY_THIS_PROJECT:</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"this project"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">OWNED_BY_ANOTHER_PROJECT:</span><span class="plain"> </span><span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"another project"</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">OWNED_BY_SPECIFIC_PROJECT:</span>
<span class="identifier">WRITE</span><span class="plain">(</span><span class="string">"project with IFID number &lt;b&gt;%S&lt;/b&gt;"</span><span class="plain">,</span>
<span class="identifier">exf</span><span class="plain">-&gt;</span><span class="element">IFID_of_owner</span><span class="plain">);</span>
<span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">HTML::end_html_row</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="identifier">HTML::end_html_table</span><span class="plain">(</span><span class="identifier">OUT</span><span class="plain">);</span>
<span class="identifier">HTML_OPEN</span><span class="plain">(</span><span class="string">"p"</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function PL::Files::index_all appears nowhere else.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="2-se.html">Back to 'Sound Effects'</a></li><li><i>(This section ends Chapter 2: Multimedia Features.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>
Reference in a new issue View git blame Copy permalink