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 >
< title > P/dm< / 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/bsc' generated by 7 -->
< ul class = "crumbs" > < li > < a href = "../webs.html" > ★ < / a > < / li > < li > < a href = "index.html" > indoc 4< / 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< / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
< span class = "functiontext" > Foundation::start< / 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< / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
< span class = "functiontext" > Foundation::end< / span > < span class = "plain" > ();< / span >
< span class = "plain" > }< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function Basics::start is used in 1/mn (< a href = "1-mn.html#SP1" > § 1< / a > ).< / p >
< p class = "endnote" > The function Basics::end is used in 1/mn (< a href = "1-mn.html#SP1" > § 1< / a > ).< / 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" > Log::declare_aspect< / 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" > Log::declare_aspect< / 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" > 167 < / 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" >
2019-04-22 17:42:10 +03:00
<!-- End of weave -->
2019-03-17 14:40:57 +02:00
< / body >
< / html >