1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 10:04:21 +03:00
inform7/docs/inblorb/1-bsc.html
2020-04-15 23:49:59 +01:00

115 lines
7 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="index.html"><span class="selectedlink">inblorb</span></a></li>
<li><a href="../indoc/index.html">indoc</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">inblorb</a></li><li><a href="index.html#1">Chapter 1: Blurbs</a></li><li><b>Basics</b></li></ul><p class="purpose">Some fundamental definitions.</p>
<ul class="toc"><li><a href="1-bsc.html#SP1">&#167;1. Build identity</a></li><li><a href="1-bsc.html#SP2">&#167;2. Setting up the memory manager</a></li><li><a href="1-bsc.html#SP4">&#167;4. Simple allocations</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Build identity. </b>This notation tangles out to the current build number as specified in the
contents section of this web.
</p>
<pre class="definitions">
<span class="definitionkeyword">define</span> <span class="constant">PROGRAM_NAME</span><span class="plain"> </span><span class="string">"inblorb"</span>
</pre>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;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">auxiliary_file_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">chunk_metadata_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">heading_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">placeholder_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">rdes_record_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">request_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">resource_number_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">segment_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">skein_node_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">table_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">template_MT</span>
<span class="definitionkeyword">enum</span> <span class="constant">template_path_MT</span>
</pre>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>And then expand:
</p>
<pre class="display">
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">auxiliary_file</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">skein_node</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">chunk_metadata</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">placeholder</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">heading</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">table</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">rdes_record</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">resource_number</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">segment</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">request</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">template</span><span class="plain">)</span>
<span class="identifier">ALLOCATE_INDIVIDUALLY</span><span class="plain">(</span><span class="reserved">template_path</span><span class="plain">)</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. Simple allocations. </b>Not all of our memory will be claimed in the form of structures: now and then
we need to use the equivalent of traditional <code class="display"><span class="extract">malloc</span></code> and <code class="display"><span class="extract">calloc</span></code> routines.
</p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">RDES_MREASON</span>
</pre>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Basics::register_mreasons<button class="popup" onclick="togglePopup('usagePopup0')">...<span class="popuptext" id="usagePopup0">Usage of <b>Basics::register_mreasons</b>:<br>Main - <a href="1-mn.html#SP3">&#167;3</a></span></button></span><span class="plain">(</span><span class="reserved">void</span><span class="plain">) {</span>
<span class="functiontext"><a href="../../../inweb/docs/foundation-module/2-mmr.html#SP23">Memory::reason_name</a></span><span class="plain">(</span><span class="constant">RDES_MREASON</span><span class="plain">, </span><span class="string">"resource descriptions"</span><span class="plain">);</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Chapter 1: Blurbs.)</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>