1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-05 08:34:22 +03:00
inform7/docs/building-module/1-trn.html
2020-04-07 01:06:09 +01:00

158 lines
14 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>1/hl</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 '1/trn' 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">building</a></li><li><a href="index.html#1">Chapter 1: Architecture</a></li><li><b>Translation</b></li></ul><p class="purpose">A way to express rules for how to translate names from the Inter namespace into the target language's namespace.</p>
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b>This section of code is pleasingly simple: it has no functionality, and exists as
a stand-alone section just to give these functions legible names.
</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">name_translation</span><span class="plain"> {</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">translate_to</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">then_make_unique</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inter_name_generator</span><span class="plain"> *</span><span class="identifier">name_generator</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">derive</span><span class="plain">;</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">by_imposition</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">name_translation</span><span class="plain">;</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::same</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain">;</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">translate_to</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">then_make_unique</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">name_generator</span><span class="plain"> = </span><span class="identifier">NULL</span><span class="plain">;</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">derive</span><span class="plain"> = </span><span class="identifier">FALSE</span><span class="plain">;</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">by_imposition</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">nt</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::uniqued</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain"> = </span><span class="functiontext">Translation::same</span><span class="plain">();</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">then_make_unique</span><span class="plain"> = </span><span class="identifier">TRUE</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>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::imposed</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain"> = </span><span class="functiontext">Translation::same</span><span class="plain">();</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">by_imposition</span><span class="plain"> = </span><span class="identifier">TRUE</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>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::to</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain"> = </span><span class="functiontext">Translation::same</span><span class="plain">();</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">translate_to</span><span class="plain"> = </span><span class="identifier">S</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>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::to_uniqued</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain"> = </span><span class="functiontext">Translation::same</span><span class="plain">();</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">translate_to</span><span class="plain"> = </span><span class="identifier">S</span><span class="plain">;</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">then_make_unique</span><span class="plain"> = </span><span class="identifier">TRUE</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>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::prefix</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain"> = </span><span class="functiontext">Translation::same</span><span class="plain">();</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">name_generator</span><span class="plain"> = </span><span class="functiontext">InterNames::multiple_use_generator</span><span class="plain">(</span><span class="identifier">S</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">derive</span><span class="plain"> = </span><span class="identifier">TRUE</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>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::suffix</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain"> = </span><span class="functiontext">Translation::same</span><span class="plain">();</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">name_generator</span><span class="plain"> = </span><span class="functiontext">InterNames::multiple_use_generator</span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">S</span><span class="plain">);</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">derive</span><span class="plain"> = </span><span class="identifier">TRUE</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>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="functiontext">Translation::generate</span><span class="plain">(</span><span class="identifier">text_stream</span><span class="plain"> *</span><span class="identifier">S</span><span class="plain">) {</span>
<span class="reserved">name_translation</span><span class="plain"> </span><span class="identifier">nt</span><span class="plain"> = </span><span class="functiontext">Translation::same</span><span class="plain">();</span>
<span class="identifier">nt</span><span class="plain">.</span><span class="element">name_generator</span><span class="plain"> = </span><span class="functiontext">InterNames::multiple_use_generator</span><span class="plain">(</span><span class="identifier">NULL</span><span class="plain">, </span><span class="identifier">S</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">nt</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function Translation::same is used in 1/hl (<a href="1-hl.html#SP3">&#167;3</a>), 3/pi (<a href="3-pi.html#SP3">&#167;3</a>).</p>
<p class="endnote">The function Translation::uniqued appears nowhere else.</p>
<p class="endnote">The function Translation::imposed appears nowhere else.</p>
<p class="endnote">The function Translation::to appears nowhere else.</p>
<p class="endnote">The function Translation::to_uniqued appears nowhere else.</p>
<p class="endnote">The function Translation::prefix appears nowhere else.</p>
<p class="endnote">The function Translation::suffix appears nowhere else.</p>
<p class="endnote">The function Translation::generate appears nowhere else.</p>
<p class="endnote">The structure name_translation is accessed in 1/hl and here.</p>
<hr class="tocbar">
<ul class="toc"><li><a href="1-hl.html">Back to 'Hierarchy Locations'</a></li><li><a href="1-pck.html">Continue with 'Packaging'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>