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 > Booklet Title< / title >
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-03-19 02:11:25 +02:00
< link href = "../inweb.css" rel = "stylesheet" rev = "stylesheet" type = "text/css" >
2019-03-17 14:40:57 +02:00
< / head >
< body >
2020-03-19 02:11:25 +02:00
< nav role = "navigation" >
< h1 > < a href = "../webs.html" > Sources< / a > < / h1 >
< ul >
2020-03-28 21:42:53 +02:00
< li > < a href = "../compiler.html" > < b > compiler tools< / b > < / a > < / li >
2020-03-19 02:11:25 +02:00
< 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 = "../inbuild-module/index.html" > inbuild< / a > < / li >
< li > < a href = "../arch-module/index.html" > arch< / a > < / li >
< li > < a href = "../words-module/index.html" > words< / a > < / li >
< li > < a href = "../syntax-module/index.html" > syntax< / a > < / li >
< li > < a href = "../html-module/index.html" > html< / a > < / li >
< / ul >
< h2 > Inform7 Modules< / h2 >
< ul >
< li > < a href = "../core-module/index.html" > core< / a > < / li >
< li > < a href = "../problems-module/index.html" > problems< / 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 = "../index-module/index.html" > index< / a > < / li >
< / ul >
< h2 > Inter Modules< / h2 >
< ul >
< li > < a href = "../inter-module/index.html" > inter< / a > < / li >
< li > < a href = "../building-module/index.html" > building< / a > < / li >
< li > < a href = "../codegen-module/index.html" > codegen< / a > < / li >
< / ul >
< h2 > Foundation< / h2 >
< ul >
< li > < a href = "../../../inweb/docs/foundation-module/index.html" > foundation< / a > < / li >
< / ul >
< / nav >
< main role = "main" >
2019-03-17 14:40:57 +02:00
<!-- Weave of '1/wm' generated by 7 -->
2020-03-22 12:50:19 +02:00
< ul class = "crumbs" > < li > < a href = "../webs.html" > Source< / a > < / li > < li > < a href = "../compiler.html" > Compiler Modules< / a > < / li > < li > < a href = "index.html" > words< / a > < / li > < li > < a href = "index.html#1" > Chapter 1: Setting Up< / a > < / li > < li > < b > Words Module< / b > < / li > < / ul > < p class = "purpose" > Setting up the use of this module.< / p >
2019-03-17 14:40:57 +02:00
2020-03-28 17:00:33 +02:00
< 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 >
2019-03-17 14:40:57 +02:00
< pre class = "definitions" >
< span class = "definitionkeyword" > define< / span > < span class = "constant" > WORDS_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" > LEXER_TEXT_MREASON< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > LEXER_WORDS_MREASON< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > source_file_MT< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > vocabulary_entry_array_MT< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > nonterminal_MT< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > production_MT< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > production_list_MT< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > ptoken_MT< / span >
< / pre >
< pre class = "display" >
< span class = "identifier" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain" > (< / span > < span class = "reserved" > source_file< / span > < span class = "plain" > )< / span >
2020-04-07 03:06:09 +03:00
< span class = "identifier" > ALLOCATE_IN_ARRAYS< / span > < span class = "plain" > (< / span > < span class = "reserved" > vocabulary_entry< / span > < span class = "plain" > , < / span > < span class = "constant" > 100< / span > < span class = "plain" > )< / span >
2019-03-17 14:40:57 +02:00
< span class = "identifier" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain" > (< / span > < span class = "reserved" > nonterminal< / span > < span class = "plain" > )< / span >
< span class = "identifier" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain" > (< / span > < span class = "reserved" > production_list< / span > < span class = "plain" > )< / span >
< span class = "identifier" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain" > (< / span > < span class = "reserved" > production< / span > < span class = "plain" > )< / span >
< span class = "identifier" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain" > (< / span > < span class = "reserved" > ptoken< / span > < span class = "plain" > )< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
2020-03-28 17:00:33 +02:00
< 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:
2019-03-17 14:40:57 +02:00
< / p >
< pre class = "display" >
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > WordsModule::start< / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
< span class = "identifier" > Memory::reason_name< / span > < span class = "plain" > (< / span > < span class = "constant" > LEXER_TEXT_MREASON< / span > < span class = "plain" > , < / span > < span class = "string" > "source text"< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Memory::reason_name< / span > < span class = "plain" > (< / span > < span class = "constant" > LEXER_WORDS_MREASON< / span > < span class = "plain" > , < / span > < span class = "string" > "source text details"< / span > < span class = "plain" > );< / span >
2020-03-28 17:00:33 +02:00
< < span class = "cwebmacro" > Register this module's memory allocation reasons< / span > < span class = "cwebmacronumber" > 3.1< / span > > < span class = "character" > ;< / span >
< < span class = "cwebmacro" > Register this module's stream writers< / span > < span class = "cwebmacronumber" > 3.2< / span > > < span class = "character" > ;< / span >
< < span class = "cwebmacro" > Register this module's debugging log aspects< / span > < span class = "cwebmacronumber" > 3.4< / span > > < span class = "character" > ;< / span >
< < span class = "cwebmacro" > Register this module's debugging log writers< / span > < span class = "cwebmacronumber" > 3.5< / span > > < span class = "character" > ;< / span >
2019-03-17 14:40:57 +02:00
< span class = "functiontext" > Lexer::start< / span > < span class = "plain" > ();< / span >
< span class = "functiontext" > Vocabulary::create_punctuation< / span > < span class = "plain" > ();< / span >
< span class = "functiontext" > Preform::begin< / span > < span class = "plain" > ();< / span >
< span class = "plain" > }< / span >
2020-03-28 17:00:33 +02:00
< span class = "reserved" > void< / span > < span class = "plain" > < / span > < span class = "functiontext" > WordsModule::end< / span > < span class = "plain" > (< / span > < span class = "reserved" > void< / span > < span class = "plain" > ) {< / span >
< span class = "plain" > }< / span >
2019-03-17 14:40:57 +02:00
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > The function WordsModule::start appears nowhere else.< / p >
2020-03-28 17:00:33 +02:00
< p class = "endnote" > The function WordsModule::end appears nowhere else.< / p >
2019-03-17 14:40:57 +02:00
< p class = "inwebparagraph" > < a id = "SP3_1" > < / a > < b > § 3.1. < / b > < code class = "display" >
2020-03-28 17:00:33 +02:00
< < span class = "cwebmacrodefn" > Register this module's memory allocation reasons< / span > < span class = "cwebmacronumber" > 3.1< / span > > =
< / code > < / p >
< pre class = "displaydefn" >
< 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_2" > < / a > < b > § 3.2. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Register this module's stream writers< / span > < span class = "cwebmacronumber" > 3.2< / span > > =
2019-03-17 14:40:57 +02:00
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > Writers::register_writer< / span > < span class = "plain" > (< / span > < span class = "character" > 'A'< / span > < span class = "plain" > , & < / span > < span class = "functiontext" > WordAssemblages::writer< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Writers::register_writer_I< / span > < span class = "plain" > (< / span > < span class = "character" > 'N'< / span > < span class = "plain" > , & < / span > < span class = "functiontext" > Lexer::writer< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Writers::register_writer< / span > < span class = "plain" > (< / span > < span class = "character" > 'V'< / span > < span class = "plain" > , & < / span > < span class = "functiontext" > Vocabulary::writer< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Writers::register_writer_W< / span > < span class = "plain" > (< / span > < span class = "character" > 'W'< / span > < span class = "plain" > , & < / span > < span class = "functiontext" > Wordings::writer< / span > < span class = "plain" > );< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP3" > § 3< / a > .< / p >
2020-03-28 17:00:33 +02:00
< p class = "inwebparagraph" > < a id = "SP3_3" > < / a > < b > § 3.3. < / b > < / p >
2019-03-17 14:40:57 +02:00
< pre class = "definitions" >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > LEXICAL_OUTPUT_DA< / span >
< span class = "definitionkeyword" > enum< / span > < span class = "constant" > VOCABULARY_DA< / span >
< / pre >
2020-03-28 17:00:33 +02:00
< p class = "inwebparagraph" > < a id = "SP3_4" > < / a > < b > § 3.4. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Register this module's debugging log aspects< / span > < span class = "cwebmacronumber" > 3.4< / span > > =
2019-03-17 14:40:57 +02:00
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > Log::declare_aspect< / span > < span class = "plain" > (< / span > < span class = "constant" > LEXICAL_OUTPUT_DA< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "lexical output"< / 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" > VOCABULARY_DA< / span > < span class = "plain" > , < / span > < span class = "identifier" > L< / span > < span class = "string" > "vocabulary"< / 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 >
2020-03-28 17:00:33 +02:00
< p class = "inwebparagraph" > < a id = "SP3_5" > < / a > < b > § 3.5. < / b > < code class = "display" >
< < span class = "cwebmacrodefn" > Register this module's debugging log writers< / span > < span class = "cwebmacronumber" > 3.5< / span > > =
2019-03-17 14:40:57 +02:00
< / code > < / p >
< pre class = "displaydefn" >
< span class = "identifier" > Writers::register_logger< / span > < span class = "plain" > (< / span > < span class = "character" > 'f'< / span > < span class = "plain" > , < / span > < span class = "functiontext" > WordAssemblages::log< / span > < span class = "plain" > );< / span >
< span class = "identifier" > Writers::register_logger< / span > < span class = "plain" > (< / span > < span class = "character" > 'v'< / span > < span class = "plain" > , < / span > < span class = "functiontext" > Vocabulary::log< / span > < span class = "plain" > );< / span >
< / pre >
< p class = "inwebparagraph" > < / p >
< p class = "endnote" > This code is used in < a href = "#SP3" > § 3< / a > .< / p >
< hr class = "tocbar" >
2019-04-22 17:42:10 +03:00
<!-- End of weave -->
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >