mirror of
https://github.com/ganelson/inform.git
synced 2024-07-08 10:04:21 +03:00
149 lines
9.8 KiB
HTML
149 lines
9.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<title>Basics</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>Other Tools</h2><ul>
|
|
<li><a href="../inblorb/index.html">inblorb</a></li>
|
|
<li><a href="index.html"><span class="selectedlink">indoc</span></a></li>
|
|
<li><a href="../inpolicy/index.html">inpolicy</a></li>
|
|
<li><a href="../inrtps/index.html">inrtps</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 'Basics' generated by 7-->
|
|
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../other.html">Other Tools</a></li><li><a href="index.html">indoc</a></li><li><a href="index.html#1">Chapter 1: Setting Up</a></li><li><b>Basics</b></li></ul><p class="purpose">Some fundamental definitions.</p>
|
|
|
|
<ul class="toc"><li><a href="#SP1">§1. Who we are</a></li><li><a href="#SP2">§2. Setting up the memory manager</a></li><li><a href="#SP4">§4. The Unicode for section</a></li></ul><hr class="tocbar">
|
|
|
|
<p class="inwebparagraph"><a id="SP1"></a><b>§1. Who we are. </b>This is a command-line tool built on top of the Foundation module. The first
|
|
definition we need to make is:
|
|
</p>
|
|
|
|
|
|
<pre class="definitions">
|
|
<span class="definitionkeyword">define</span> <span class="constant">INTOOL_NAME</span><span class="plain"> </span><span class="string">"indoc"</span>
|
|
</pre>
|
|
|
|
<pre class="display">
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Basics::start<button class="popup" onclick="togglePopup('usagePopup0')">...<span class="popuptext" id="usagePopup0">Usage of <b>Basics::start</b>:<br>Main - <a href="1-mn.html#SP1">§1</a></span></button></span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
|
|
<span class="functiontext"><a href="1-fm.html#SP8">Foundation::start</a></span><span class="plain">();</span>
|
|
<<span class="cwebmacro">Declare the debugging log aspects</span> <span class="cwebmacronumber">1.2</span>><span class="plain">;</span>
|
|
<span class="plain">}</span>
|
|
|
|
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Basics::end<button class="popup" onclick="togglePopup('usagePopup1')">...<span class="popuptext" id="usagePopup1">Usage of <b>Basics::end</b>:<br>Main - <a href="1-mn.html#SP1">§1</a></span></button></span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
|
|
<span class="functiontext"><a href="1-fm.html#SP9">Foundation::end</a></span><span class="plain">();</span>
|
|
<span class="plain">}</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="inwebparagraph"><a id="SP1_1"></a><b>§1.1. </b>Just two logging aspects to add to the usual Foundation stock:
|
|
</p>
|
|
|
|
|
|
<pre class="definitions">
|
|
<span class="definitionkeyword">enum</span> <span class="constant">SYMBOLS_DA</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">INSTRUCTIONS_DA</span>
|
|
</pre>
|
|
<p class="inwebparagraph"><a id="SP1_2"></a><b>§1.2. </b><code class="display">
|
|
<<span class="cwebmacrodefn">Declare the debugging log aspects</span> <span class="cwebmacronumber">1.2</span>> =
|
|
</code></p>
|
|
|
|
|
|
<pre class="displaydefn">
|
|
<span class="functiontext"><a href="2-dl.html#SP4">Log::declare_aspect</a></span><span class="plain">(</span><span class="constant">SYMBOLS_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"symbols"</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">);</span>
|
|
<span class="functiontext"><a href="2-dl.html#SP4">Log::declare_aspect</a></span><span class="plain">(</span><span class="constant">INSTRUCTIONS_DA</span><span class="plain">, </span><span class="identifier">L</span><span class="string">"instructions"</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">);</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="endnote">This code is used in <a href="#SP1">§1</a>.</p>
|
|
|
|
<p class="inwebparagraph"><a id="SP2"></a><b>§2. Setting up the memory manager. </b>We need to itemise the structures we'll want to allocate:
|
|
</p>
|
|
|
|
|
|
<pre class="definitions">
|
|
<span class="definitionkeyword">enum</span> <span class="constant">settings_block_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">volume_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">chapter_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">section_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">formatted_file_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">indexing_category_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">index_lemma_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">example_index_data_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">image_source_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">image_usage_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">example_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">CSS_tweak_data_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">span_notation_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">dc_metadatum_MT</span>
|
|
<span class="definitionkeyword">enum</span> <span class="constant">navigation_design_MT</span>
|
|
</pre>
|
|
<p class="inwebparagraph"><a id="SP3"></a><b>§3. </b>And then expand:
|
|
</p>
|
|
|
|
<pre class="display">
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">settings_block</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">volume</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">chapter</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">section</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">formatted_file</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">indexing_category</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">index_lemma</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">example_index_data</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">image_source</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">image_usage</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">example</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">CSS_tweak_data</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">span_notation</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">dc_metadatum</span><span class="plain">)</span>
|
|
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">navigation_design</span><span class="plain">)</span>
|
|
</pre>
|
|
|
|
<p class="inwebparagraph"></p>
|
|
|
|
<p class="inwebparagraph"><a id="SP4"></a><b>§4. The Unicode for section. </b>Since this doesn't lie in the ASCII character range, I'll refer to it by
|
|
its Unicode number rather than placing the character in question in the
|
|
source code directly.
|
|
</p>
|
|
|
|
|
|
<pre class="definitions">
|
|
<span class="definitionkeyword">define</span> <span class="constant">SECTION_SYMBOL</span><span class="plain"> </span><span class="constant">167</span><span class="plain"> </span><span class="comment"> Unicode for a section symbol</span>
|
|
</pre>
|
|
<hr class="tocbar">
|
|
<ul class="toc"><li><i>(This section begins Chapter 1: Setting Up.)</i></li><li><a href="1-mn.html">Continue with 'Main'</a></li></ul><hr class="tocbar">
|
|
<!--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>
|
|
|