ifhub/inform7
1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-05 16:44:21 +03:00
Code Issues Projects Releases Wiki Activity
inform7/docs/inter-module/1-im.html
Graham Nelson 1ddf852361 Further work on independent assimilation
2019-09-01 11:50:12 +01:00

201 lines
15 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>Booklet Title</title>
<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>
<!--Weave of '1/im' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">inter</a></li><li><a href="index.html#1">Chapter 1: Setting Up</a></li><li><b>Inter Module</b></li></ul><p class="purpose">Setting up the use of this module.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Introduction</a></li><li><a href="#SP3">&#167;3. The beginning</a></li><li><a href="#SP4">&#167;4. The end</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Introduction. </b></p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">INTER_MODULE</span><span class="plain"> </span><span class="identifier">TRUE</span>
</pre>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b>To begin with, this module needs to allocate memory:
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">inter_tree_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_tree_node_array_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_warehouse_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_warehouse_room_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_symbols_table_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_symbol_array_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_annotation_array_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_data_type_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_construct_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_annotation_form_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_error_location_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_error_message_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_error_stash_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_package_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_node_list_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">inter_node_list_entry_MT</span>
</pre>
<pre class="display">
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_tree</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_warehouse</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_warehouse_room</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_symbols_table</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_data_type</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_construct</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_annotation_form</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_error_location</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_error_message</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_error_stash</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_package</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_node_list</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">inter_node_list_entry</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">inter_symbol</span><span class="plain">, 1024)</span>
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">inter_tree_node</span><span class="plain">, 8192)</span>
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">inter_annotation</span><span class="plain">, 8192)</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. The beginning. </b>(The client doesn't need to call the start and end routines, because the
foundation module does that automatically.)
</p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">InterModule::start</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
&lt;<span class="cwebmacro">Register this module's memory allocation reasons</span> <span class="cwebmacronumber">3.2</span>&gt;<span class="character">;</span>
&lt;<span class="cwebmacro">Register this module's stream writers</span> <span class="cwebmacronumber">3.3</span>&gt;<span class="character">;</span>
&lt;<span class="cwebmacro">Register this module's debugging log aspects</span> <span class="cwebmacronumber">3.5</span>&gt;<span class="character">;</span>
&lt;<span class="cwebmacro">Register this module's debugging log writers</span> <span class="cwebmacronumber">3.6</span>&gt;<span class="character">;</span>
&lt;<span class="cwebmacro">Register this module's command line switches</span> <span class="cwebmacronumber">3.7</span>&gt;<span class="character">;</span>
<span class="functiontext">Inter::Defn::create_language</span><span class="plain">();</span>
<span class="functiontext">Inter::Types::create_all</span><span class="plain">();</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function InterModule::start appears nowhere else.</p>
<p class="inwebparagraph"><a id="SP3_1"></a><b>&#167;3.1. </b></p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">INTER_SYMBOLS_MREASON</span>
<span class="definitionkeyword">enum</span> <span class="constant">INTER_BYTECODE_MREASON</span>
<span class="definitionkeyword">enum</span> <span class="constant">INTER_LINKS_MREASON</span>
</pre>
<p class="inwebparagraph"><a id="SP3_2"></a><b>&#167;3.2. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's memory allocation reasons</span> <span class="cwebmacronumber">3.2</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Memory::reason_name</span><span class="plain">(</span><span class="constant">INTER_SYMBOLS_MREASON</span><span class="plain">, </span><span class="string">"inter symbols storage"</span><span class="plain">);</span>
<span class="identifier">Memory::reason_name</span><span class="plain">(</span><span class="constant">INTER_BYTECODE_MREASON</span><span class="plain">, </span><span class="string">"inter bytecode storage"</span><span class="plain">);</span>
<span class="identifier">Memory::reason_name</span><span class="plain">(</span><span class="constant">INTER_LINKS_MREASON</span><span class="plain">, </span><span class="string">"inter links storage"</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP3_3"></a><b>&#167;3.3. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's stream writers</span> <span class="cwebmacronumber">3.3</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Writers::register_writer</span><span class="plain">(</span><span class="character">'t'</span><span class="plain">, &amp;</span><span class="functiontext">Inter::Textual::writer</span><span class="plain">);</span>
<span class="identifier">Writers::register_writer</span><span class="plain">(</span><span class="character">'F'</span><span class="plain">, &amp;</span><span class="functiontext">Inter::Verify::writer</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP3_4"></a><b>&#167;3.4. </b></p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">INTER_FILE_READ_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">INTER_MEMORY_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">INTER_BINARY_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">INTER_SYMBOLS_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">INTER_FRAMES_DA</span>
<span class="definitionkeyword">enum</span> <span class="constant">INTER_CONNECTORS_DA</span>
</pre>
<p class="inwebparagraph"><a id="SP3_5"></a><b>&#167;3.5. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's debugging log aspects</span> <span class="cwebmacronumber">3.5</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">INTER_MEMORY_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"inter memory usage"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">INTER_FILE_READ_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"intermediate file reading"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">INTER_BINARY_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"inter binary"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">INTER_SYMBOLS_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"inter symbols"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">INTER_FRAMES_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"inter frames"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
<span class="identifier">Log::declare_aspect</span><span class="plain">(</span><span class="constant">INTER_CONNECTORS_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"inter connectors"</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">, </span><span class="identifier">FALSE</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP3_6"></a><b>&#167;3.6. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's debugging log writers</span> <span class="cwebmacronumber">3.6</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'3'</span><span class="plain">, </span><span class="functiontext">Inter::Symbols::log</span><span class="plain">);</span>
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'4'</span><span class="plain">, </span><span class="functiontext">Inter::SymbolsTables::log</span><span class="plain">);</span>
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'5'</span><span class="plain">, </span><span class="functiontext">Inter::Bookmarks::log</span><span class="plain">);</span>
<span class="identifier">Writers::register_logger</span><span class="plain">(</span><span class="character">'6'</span><span class="plain">, </span><span class="functiontext">Inter::Packages::log</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP3_7"></a><b>&#167;3.7. </b><code class="display">
&lt;<span class="cwebmacrodefn">Register this module's command line switches</span> <span class="cwebmacronumber">3.7</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="plain">;</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP3">&#167;3</a>.</p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. The end. </b></p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">InterModule::end</span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The function InterModule::end appears nowhere else.</p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Chapter 1: Setting Up.)</i></li><li><i>(This section ends Chapter 1: Setting Up.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>
Reference in a new issue View git blame Copy permalink