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 > Codegen Module< / 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" >
< 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 >
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 >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Compiler Webs< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< 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 >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inbuild Modules< / h2 > < ul >
< li > < a href = "../supervisor-module/index.html" > supervisor< / a > < / li >
< / ul > < h2 > Inform7 Modules< / h2 > < ul >
2020-03-19 02:11:25 +02:00
< li > < a href = "../core-module/index.html" > core< / 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 >
2020-04-14 19:56:54 +03:00
< li > < a href = "../problems-module/index.html" > problems< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../index-module/index.html" > index< / a > < / li >
2020-04-14 19:56:54 +03:00
< / ul > < h2 > Inter Modules< / h2 > < ul >
< li > < a href = "../bytecode-module/index.html" > bytecode< / a > < / li >
2020-03-19 02:11:25 +02:00
< li > < a href = "../building-module/index.html" > building< / a > < / li >
2020-04-14 19:56:54 +03:00
< li > < a href = "index.html" > < span class = "selectedlink" > codegen< / span > < / a > < / li >
< / ul > < h2 > Shared Modules< / h2 > < ul >
< li > < a href = "../arch-module/index.html" > arch< / a > < / li >
< li > < a href = "../syntax-module/index.html" > syntax< / a > < / li >
< li > < a href = "../words-module/index.html" > words< / a > < / li >
< li > < a href = "../html-module/index.html" > html< / a > < / li >
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 'Codegen Module' generated by Inweb -->
< div class = "breadcrumbs" >
< ul class = "crumbs" > < li > < a href = "../index.html" > Home< / a > < / li > < li > < a href = "../compiler.html" > Inter Modules< / a > < / li > < li > < a href = "index.html" > codegen< / a > < / li > < li > < a href = "index.html#1" > Chapter 1: Setting Up< / a > < / li > < li > < b > Codegen Module< / b > < / li > < / ul > < / div >
< p class = "purpose" > Setting up the use of this module.< / p >
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. < / b > This section simoly sets up the module in ways expected by < span class = "extract" > < span class = "extract-syntax" > foundation< / span > < / span > , and
2020-03-28 17:00:33 +02:00
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
2020-05-03 03:01:21 +03:00
< pre class = "definitions code-font" > < span class = "definition-keyword" > define< / span > < span class = "constant-syntax" > CODEGEN_MODULE< / span > < span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > TRUE< / span >
2019-03-17 14:40:57 +02:00
< / pre >
2020-05-03 03:01:21 +03:00
< p class = "commentary firstcommentary" > < a id = "SP2" > < / a > < b > § 2. < / b > To begin with, this module needs to allocate memory:
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" > I6T_intervention_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > codegen_pipeline_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > pipeline_step_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > uniqueness_count_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > text_literal_holder_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > routine_body_request_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > pipeline_stage_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > code_generation_target_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > code_generation_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > generated_segment_MT< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > link_instruction_MT< / 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" >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > I6T_intervention< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > codegen_pipeline< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > pipeline_step< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > uniqueness_count< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > text_literal_holder< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > routine_body_request< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > pipeline_stage< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > code_generation_target< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > code_generation< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > generated_segment< / span > < span class = "plain-syntax" > )< / span >
< span class = "identifier-syntax" > ALLOCATE_INDIVIDUALLY< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > link_instruction< / 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 = "SP3" > < / a > < b > § 3. < / b > Like all modules, this one must define a < span class = "extract" > < span class = "extract-syntax" > start< / span > < / span > and < span class = "extract" > < span class = "extract-syntax" > end< / span > < / span > function:
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" >
< span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > < / span > < span class = "function-syntax" > CodegenModule::start< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < span class = "plain-syntax" > ) {< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-cm.html#SP3_2" class = "named-paragraph-link" > < span class = "named-paragraph" > Register this module's memory allocation reasons< / span > < span class = "named-paragraph-number" > 3.2< / span > < / a > < / span > < span class = "character-syntax" > ;< / span >
< span class = "character-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-cm.html#SP3_3" class = "named-paragraph-link" > < span class = "named-paragraph" > Register this module's stream writers< / span > < span class = "named-paragraph-number" > 3.3< / span > < / a > < / span > < span class = "plain-syntax" > ;< / span >
< span class = "plain-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-cm.html#SP3_5" class = "named-paragraph-link" > < span class = "named-paragraph" > Register this module's debugging log aspects< / span > < span class = "named-paragraph-number" > 3.5< / span > < / a > < / span > < span class = "character-syntax" > ;< / span >
< span class = "character-syntax" > < / span > < span class = "named-paragraph-container code-font" > < a href = "1-cm.html#SP3_6" class = "named-paragraph-link" > < span class = "named-paragraph" > Register this module's debugging log writers< / span > < span class = "named-paragraph-number" > 3.6< / 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" > CodegenModule::end< / span > < span class = "plain-syntax" > (< / span > < span class = "reserved-syntax" > void< / span > < 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 = "SP3_1" > < / a > < b > § 3.1. < / b > < / p >
2019-03-17 14:40:57 +02:00
2020-05-03 03:01:21 +03:00
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > CODE_GENERATION_MREASON< / 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_2" > < / a > < b > § 3.2. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Register this module's memory allocation reasons< / span > < span class = "named-paragraph-number" > 3.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 > < span class = "identifier-syntax" > Memory::reason_name< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > CODE_GENERATION_MREASON< / span > < span class = "plain-syntax" > , < / span > < span class = "string-syntax" > "code generation workspace for objects"< / 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-cm.html#SP3" > § 3< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP3_3" > < / a > < b > § 3.3. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Register this module's stream writers< / span > < span class = "named-paragraph-number" > 3.3< / 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 >
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-cm.html#SP3" > § 3< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP3_4" > < / a > < b > § 3.4. < / b > < / p >
< pre class = "definitions code-font" > < span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > TEMPLATE_READING_DA< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > RESOLVING_CONDITIONAL_COMPILATION_DA< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > EXTERNAL_SYMBOL_RESOLUTION_DA< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > ELIMINATION_DA< / span >
< span class = "definition-keyword" > enum< / span > < span class = "constant-syntax" > CONSTANT_DEPTH_CALCULATION_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 = "SP3_5" > < / a > < b > § 3.5. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Register this module's debugging log aspects< / span > < span class = "named-paragraph-number" > 3.5< / 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 > < span class = "identifier-syntax" > Log::declare_aspect< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > TEMPLATE_READING_DA< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "template reading"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Log::declare_aspect< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > RESOLVING_CONDITIONAL_COMPILATION_DA< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "resolving conditional compilation"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Log::declare_aspect< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > EXTERNAL_SYMBOL_RESOLUTION_DA< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "external symbol resolution"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Log::declare_aspect< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > ELIMINATION_DA< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "code elimination"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > );< / span >
< span class = "plain-syntax" > < / span > < span class = "identifier-syntax" > Log::declare_aspect< / span > < span class = "plain-syntax" > (< / span > < span class = "constant-syntax" > CONSTANT_DEPTH_CALCULATION_DA< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > L< / span > < span class = "string-syntax" > "constant depth calculation"< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-syntax" > FALSE< / span > < span class = "plain-syntax" > , < / span > < span class = "identifier-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-cm.html#SP3" > § 3< / a > .< / li > < / ul >
< p class = "commentary firstcommentary" > < a id = "SP3_6" > < / a > < b > § 3.6. < / b > < span class = "named-paragraph-container code-font" > < span class = "named-paragraph-defn" > Register this module's debugging log writers< / span > < span class = "named-paragraph-number" > 3.6< / 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 >
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-cm.html#SP3" > § 3< / a > .< / li > < / ul >
< nav role = "progress" > < div class = "progresscontainer" >
< ul class = "progressbar" > < li class = "progressprevoff" > ❮ < / li > < li class = "progresscurrentchapter" > 1< / li > < li class = "progresscurrent" > cm< / li > < li class = "progresssection" > < a href = "1-stg.html" > stg< / a > < / li > < li class = "progresssection" > < a href = "1-arc.html" > arc< / a > < / li > < li class = "progresssection" > < a href = "1-li.html" > li< / a > < / li > < li class = "progresssection" > < a href = "1-ppl.html" > ppl< / a > < / li > < li class = "progresschapter" > < a href = "2-mt.html" > 2< / a > < / li > < li class = "progresschapter" > < a href = "3-cg.html" > 3< / a > < / li > < li class = "progresschapter" > < a href = "4-ft.html" > 4< / a > < / li > < li class = "progressnext" > < a href = "1-stg.html" > ❯ < / a > < / li > < / ul > < / div >
< / nav > <!-- End of weave -->
2019-03-17 14:40:57 +02:00
2020-03-19 02:11:25 +02:00
< / main >
2019-03-17 14:40:57 +02:00
< / body >
< / html >
