2019-03-17 14:40:57 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
2020-04-14 19:56:54 +03:00
< title > Basics< / title >
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Breadcrumbs.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-03-19 02:11:25 +02:00
< meta name = "viewport" content = "width=device-width initial-scale=1" >
2019-03-17 14:40:57 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< meta http-equiv = "Content-Language" content = "en-gb" >
2020-05-03 03:01:21 +03:00
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Contents.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Progress.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Navigation.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Fonts.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Base.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-05-03 03:01:21 +03:00
< script >
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
< / script >
2020-05-03 03:20:55 +03:00
< link href = "../docs-assets/Popups.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
< link href = "../docs-assets/Colours.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2020-04-14 19:56:54 +03:00
2019-03-17 14:40:57 +02:00
< / head >
2020-05-03 03:01:21 +03:00
< body class = "commentary-font" >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
2020-04-14 19:56:54 +03:00
< h1 > < a href = "../index.html" >
2020-05-03 18:34:53 +03:00
< img src = "../docs-assets/Inform.png" height = 72" >
2020-04-14 19:56:54 +03:00
< / a > < / h1 >
< ul > < li > < a href = "../compiler.html" > compiler tools< / a > < / li >
< li > < a href = "../other.html" > other tools< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../extensions.html" > extensions and kits< / a > < / li >
< li > < a href = "../units.html" > unit test tools< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Other Tools< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../inblorb/index.html" > inblorb< / a > < / li >
2020-04-14 19:56:54 +03:00
< li > < a href = "index.html" > < span class = "selectedlink" > indoc< / span > < / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../inpolicy/index.html" > inpolicy< / a > < / li >
< li > < a href = "../inrtps/index.html" > inrtps< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Foundation< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../../../inweb/docs/foundation-module/index.html" > foundation< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul >
2020-03-19 02:11:25 +02:00
< / nav >
< main role = "main" >
2020-05-03 03:01:21 +03:00
<!-- Weave of 'Basics' generated by Inweb -->
< div class = "breadcrumbs" >
< 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 > < / div >
< p class = "purpose" > Some fundamental definitions.< / p >
2019-03-17 14:40:57 +02:00
2020-04-16 01:49:59 +03:00
< ul class = "toc" > < li > < a href = "1-bsc.html#SP1" > § 1. Who we are< / a > < / li > < li > < a href = "1-bsc.html#SP2" > § 2. Setting up the memory manager< / a > < / li > < li > < a href = "1-bsc.html#SP4" > § 4. The Unicode for section< / a > < / li > < / ul > < hr class = "tocbar" >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < 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
2019-03-17 14:40:57 +02:00
definition we need to make is:
< / p >
2020-05-03 03:01:21 +03:00
< pre class = "definitions code-font" > < span class = "definition-keyword" > define< / span > < span class = "constant-syntax" > PROGRAM_NAME< / span > < span class = "plain-syntax" > < / span > < span class = "string-syntax" > "indoc"< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-07-05 13:01:27 +03:00
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Basics::start< / span > < button class = "popup" onclick = "togglePopup('usagePopup1')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup1" > Usage of < span class = "code-font" > < span class = "function-syntax" > Basics::start< / span > < / span > :< br / > Main - < a href = "1-mn.html#SP1" > § 1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > int< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > argc< / span > < span class = "plain-syntax" > , < / span > < span class = "reserved-syntax" > char< / span > < span class = "plain-syntax" > **< / span > < span class = "identifier-syntax" > argv< / span > < span class = "plain-syntax" > ) {< / span >
2020-07-05 17:33:25 +03:00
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/docs/foundation-module/1-fm.html#SP8" class = "function-link" > < span class = "function-syntax" > Foundation::start< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "identifier-syntax" > argc< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > argv< / span > < span class = "plain-syntax" > );< / span >
2020-05-03 03:01:21 +03:00
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-bsc.html#SP1_2" class = "named-paragraph-link" > < span class = "named-paragraph" > Declare the debugging log aspects< / span > < span class = "named-paragraph-number" > 1.2< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > }< / span >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > Basics::end< / span > < button class = "popup" onclick = "togglePopup('usagePopup2')" > < span class = "comment-syntax" > ?< / span > < span class = "popuptext" id = "usagePopup2" > Usage of < span class = "code-font" > < span class = "function-syntax" > Basics::end< / span > < / span > :< br / > Main - < a href = "1-mn.html#SP1" > § 1< / a > < / span > < / button > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/docs/foundation-module/1-fm.html#SP9" class = "function-link" > < span class = "function-syntax" > Foundation::end< / span > < / a > < span class = "plain-syntax" > ();< / span >
< span class = "plain-syntax" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1_1" > < / a > < b > § 1.1. < / b > Just two logging aspects to add to the usual Foundation stock:
2019-03-17 14:40:57 +02:00
< / p >
2020-05-03 03:01:21 +03:00
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > SYMBOLS_DA< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > INSTRUCTIONS_DA< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < a id = "SP1_2" > < / a > < b > § 1.2. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Declare the debugging log aspects< / span > < span class = "named-paragraph-number" > 1.2< / span > < / span > < span class = "comment-syntax" > =< / span >
< / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/docs/foundation-module/2-dl.html#SP4" class = "function-link" > < span class = "function-syntax" > Log::declare_aspect< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > SYMBOLS_DA< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "symbols"< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < a href = "../../../inweb/docs/foundation-module/2-dl.html#SP4" class = "function-link" > < span class = "function-syntax" > Log::declare_aspect< / span > < / a > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > INSTRUCTIONS_DA< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "instructions"< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "constant-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< ul class = "endnotetexts" > < li > This code is used in < a href = "1-bsc.html#SP1" > § 1< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP2" > < / a > < b > § 2. Setting up the memory manager. < / b > We need to itemise the structures we'll want to allocate:
2019-03-17 14:40:57 +02:00
< / p >
2020-05-09 15:07:39 +03:00
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > settings_block_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > volume_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > chapter_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > section_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > formatted_file_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > indexing_category_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > index_lemma_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > example_index_data_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > image_source_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > image_usage_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > example_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > CSS_tweak_data_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > span_notation_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > dc_metadatum_CLASS< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > navigation_design_CLASS< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < a id = "SP3" > < / a > < b > § 3. < / b > And then expand:
2019-03-17 14:40:57 +02:00
< / p >
2020-05-03 03:01:21 +03:00
< pre class = "displayed-code all-displayed-code code-font" >
2020-05-09 15:07:39 +03:00
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > settings_block< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > volume< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > chapter< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > section< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > formatted_file< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > indexing_category< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > index_lemma< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > example_index_data< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > image_source< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > image_usage< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > example< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > CSS_tweak_data< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > span_notation< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > dc_metadatum< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > DECLARE_CLASS< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > navigation_design< / span > < span class = "plain-syntax" > )< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < 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
2019-03-17 14:40:57 +02:00
its Unicode number rather than placing the character in question in the
source code directly.
< / p >
2020-05-03 03:01:21 +03:00
< pre class = "definitions code-font" > < span class = "definition-keyword" > define< / span > < span class = "constant-syntax" > SECTION_SYMBOL< / span > < span class = "plain-syntax" > < / span > < span class = "constant-syntax" > 167< / span > < span class = "plain-syntax" > < / span > < span class = "comment-syntax" > Unicode for a section symbol< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprev" > < a href = "M-rc.html" > ❮ < / a > < / li > < li class = "progresschapter" > < a href = "M-iti.html" > M< / a > < / li > < li class = "progresscurrentchapter" > 1< / li > < li class = "progresscurrent" > bsc< / li > < li class = "progresssection" > < a href = "1-mn.html" > mn< / a > < / li > < li class = "progresssection" > < a href = "1-cnf.html" > cnf< / a > < / li > < li class = "progresssection" > < a href = "1-ins.html" > ins< / a > < / li > < li class = "progresssection" > < a href = "1-cs.html" > cs< / a > < / li > < li class = "progresschapter" > < a href = "2-ss.html" > 2< / a > < / li > < li class = "progresschapter" > < a href = "3-iu.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-nd.html" > 4< / a > < / li > < li class = "progressnext" > < a href = "1-mn.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
2020-04-14 19:56:54 +03:00
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >