mirror of
https://github.com/ganelson/inform.git
synced 2024-07-08 18:14:21 +03:00
220 lines
17 KiB
HTML
220 lines
17 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Bytecode Module</title>
|
|
<meta name="viewport" content="width=device-width initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta http-equiv="Content-Language" content="en-gb">
|
|
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
|
|
</head>
|
|
<body>
|
|
<nav role="navigation">
|
|
<h1><a href="../index.html">
|
|
<img src="../docs-src/Figures/Inform.png" height=72">
|
|
</a></h1>
|
|
<ul><li><a href="../compiler.html">compiler tools</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="../supervisor-module/index.html">supervisor</a></li>
|
|
</ul><h2>Inform7 Modules</h2><ul>
|
|
<li><a href="../core-module/index.html">core</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="../problems-module/index.html">problems</a></li>
|
|
<li><a href="../index-module/index.html">index</a></li>
|
|
</ul><h2>Inter Modules</h2><ul>
|
|
<li><a href="index.html"><span class="selectedlink">bytecode</span></a></li>
|
|
<li><a href="../building-module/index.html">building</a></li>
|
|
<li><a href="../codegen-module/index.html">codegen</a></li>
|
|
</ul><h2>Shared Modules</h2><ul>
|
|
<li><a href="../arch-module/index.html">arch</a></li>
|
|
<li><a href="../syntax-module/index.html">syntax</a></li>
|
|
<li><a href="../words-module/index.html">words</a></li>
|
|
<li><a href="../html-module/index.html">html</a></li>
|
|
<li><a href="../../../inweb/docs/foundation-module/index.html">foundation</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
<main role="main">
|
|
|
|
<!--Weave of 'Bytecode Module' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../compiler.html">Inter Modules</a></li><li><a href="index.html">bytecode</a></li><li><a href="index.html#1">Chapter 1: Setting Up</a></li><li><b>Bytecode Module</b></li></ul><p class="purpose">Setting up the use of this module.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. </b>This section simoly sets up the module in ways expected by <code class="display"><span class="extract">foundation</span></code>, and
|
|
contains no code of interest. The following constant exists only in tools
|
|
which use this module:
|
|
</p>
|
|
|
|
|
|
<pre class="definitions">
|
|
<span class="definitionkeyword">define</span> <span class="constant">BYTECODE_MODULE</span><span class="plain"> </span><span class="identifier">TRUE</span>
|
|
</pre>
|
|
<p class="inwebparagraph"><a id="SP2"></a><b>§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">, </span><span class="constant">1024</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">inter_tree_node</span><span class="plain">, </span><span class="constant">8192</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_IN_ARRAYS</span><span class="plain">(</span><span class="reserved">inter_annotation</span><span class="plain">, </span><span class="constant">8192</span><span class="plain">)</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3"></a><b>§3. </b>Like all modules, this one must define a <code class="display"><span class="extract">start</span></code> and <code class="display"><span class="extract">end</span></code> function:
|
|
</p>
|
|
|
|
<pre class="display">
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BytecodeModule::start<button class="popup" onclick="togglePopup('usagePopup0')">...<span class="popuptext" id="usagePopup0">Usage of <b>BytecodeModule::start</b>:<br>none</span></button></span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
|
|
<<span class="cwebmacro">Register this module's memory allocation reasons</span> <span class="cwebmacronumber">3.2</span>><span class="character">;</span>
|
|
<<span class="cwebmacro">Register this module's stream writers</span> <span class="cwebmacronumber">3.3</span>><span class="character">;</span>
|
|
<<span class="cwebmacro">Register this module's debugging log aspects</span> <span class="cwebmacronumber">3.5</span>><span class="character">;</span>
|
|
<<span class="cwebmacro">Register this module's debugging log writers</span> <span class="cwebmacronumber">3.6</span>><span class="character">;</span>
|
|
|
|
<span class="functiontext"><a href="3-dfn.html#SP3">Inter::Defn::create_language</a></span><span class="plain">();</span>
|
|
<span class="functiontext"><a href="3-idt.html#SP4">Inter::Types::create_all</a></span><span class="plain">();</span>
|
|
<span class="plain">}</span>
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">BytecodeModule::end<button class="popup" onclick="togglePopup('usagePopup1')">...<span class="popuptext" id="usagePopup1">Usage of <b>BytecodeModule::end</b>:<br>none</span></button></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="inwebparagraph"><a id="SP3_1"></a><b>§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>§3.2. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Register this module's memory allocation reasons</span> <span class="cwebmacronumber">3.2</span>> =
|
|
</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">§3</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_3"></a><b>§3.3. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Register this module's stream writers</span> <span class="cwebmacronumber">3.3</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="identifier">Writers::register_writer</span><span class="plain">(</span><span class="character">'t'</span><span class="plain">, &</span><span class="functiontext"><a href="3-iitf.html#SP2">Inter::Textual::writer</a></span><span class="plain">);</span>
|
|
<span class="identifier">Writers::register_writer</span><span class="plain">(</span><span class="character">'F'</span><span class="plain">, &</span><span class="functiontext"><a href="3-vi.html#SP1">Inter::Verify::writer</a></span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3">§3</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_4"></a><b>§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>§3.5. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Register this module's debugging log aspects</span> <span class="cwebmacronumber">3.5</span>> =
|
|
</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">§3</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP3_6"></a><b>§3.6. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Register this module's debugging log writers</span> <span class="cwebmacronumber">3.6</span>> =
|
|
</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"><a href="2-sym.html#SP2">Inter::Symbols::log</a></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"><a href="2-st.html#SP2">Inter::SymbolsTables::log</a></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"><a href="2-bkm.html#SP1">Inter::Bookmarks::log</a></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"><a href="2-pck.html#SP3">Inter::Packages::log</a></span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP3">§3</a>.</p>
|
|
|
|
<!--End of weave-->
|
|
<script>
|
|
function togglePopup(material_id) {
|
|
var popup = document.getElementById(material_id);
|
|
popup.classList.toggle("show");
|
|
}
|
|
</script>
|
|
|
|
<link href="Popups.css" rel="stylesheet" rev="stylesheet" type="text/css">
|
|
</main>
|
|
</body>
|
|
</html>
|
|
|