🏡 Back Home

Compilation Flow

• A vague overview of the flow because it’s too many links back and forth.

Build setup

• Main is the entry point.
  • Maybe there’s some stuff with foundation.
  • This then goes to Inbuild Control for the setup of the project.
    • Which creates objects from Project File Manager and Project Bundle Manager.
    • And all the various build skill/step modules.
  • The Inform7 Skill is the final part of supervisor we use for now, which goes to core via Task::carry_out in What To Compile and then How To Compile which has the actual passes.

Reading and Lexing

• In Project Services there is Projects::read_source_text_for which does the lexing and sentence breaking.
  • The lexing is through Source Text → Text From Files → Lexer.
    • After this, we have:
      • A source_file with a bunch of individual words (with location metadata) and some file-level metadata.
      • A “vocabulary map” of some kind, though at this point we haven’t done any meaning analysis (other than checking if it’s an ING_MC and some basic numeric parsing).
  • The sentence breaking is just Sentences directly. This has some rudimentary parsing.
    • The docs call this now a syntax tree, even though it’s just a tree of SENTENCE_NT nodes arranged under their respective Headings.
    • Syntax Trees has the actual tree structure (it seems to be different to the norm with the “budding” and amending other trees to each other).
• Technically this is all before the Inform7 Skill.

Passes

• At this point we have sentences, but with a few minor exceptions they are all unparsed. There’s 3 major passes, all of which are in Passes through Major Nodes in assertions.
  • • It’s a lot of Classifying Sentences under the hood.
  • Things which are SMF - special meaning functions - are all hooked in in assertions → Booting Verbs.
• After the second pass there is traverse_to_stock in Tables (assertions) and some Dialogue stuff.
• I think at this point the parsing is primarily done and we have a list of assertions about the world.

Model World Building

• Base kinds are made; apparently this is in Kind Declarations in runtime which seems awfully late? Maybe by building it means building it in inter?
• We go back to assertions for the “late namings” in Translation Requests. I have no idea what this is yet.
  • This seems to just be checking if we have an INTER_NAMING_SMFT to pay attention to (Special Meanings) for nouns defined in I6.
• OrderingInstances::objects_in_definition_sequence is in knowledge → Ordering Instances.
• For some reason there simply isn’t a Stage I of the world building in this part, and Stage II and III are put together. Oh, and Stage V is later on.
• Stages II, III, and IV are in (whoever could guess this) knowledge → The Model World.
  • I need to work out what these actually are.

Tables and Grammar

• Measurements::validate_definitions is in knowledge → Measurements.
• BinaryPredicateFamilies::second_stock is in calculus → Binary Predicate Families.
• Tables::check_tables_for_kind_clashes is in assertions → Tables (assertions).

We then have a couple more model world checks which need to come after the tables for…whatever reason? I guess because we need some predicates before we can do the last stage?

• World::stage_V is in knowledge → The Model World.
• MappingHints::traverse_for_map_parameters is in if → Mapping Hint Requests.

Phrases and Rules

• LiteralPatterns::define_named_phrases is in values → Literal Patterns (values).
• ImperativeDefinitions::assess_all is in assertions → Imperative Definitions.
• Equations::traverse_to_stock is in assertions → Equations (assertions).
• Another call to Tables::traverse_to_stock because I guess we have more information than the second pass? Tables (assertions).
• RTRulebooks::RulebookOutcomePrintingRule is in runtime → Rulebooks (runtime).

This is the end of the actual compiler, I think. At this point we have a fully stocked AST and other various symbol tables and the like.

Inter

Why does part 4 do literally nothing?

Part 1

• RTUseOptions::compile is in runtime → Use Options (runtime).
• RTCommandGrammars::compile_non_generic_constants is in runtime → Command Grammars.
• Interventions::make_all is in runtime → Interventions.
• RTKindConstructors::compile is in runtime → Kind Constructors.
• RTLiteralPatterns::compile is in runtime → Literal Patterns (runtime).

Part 2

• CompletionModule::compile is in runtime → Completion Module.
• RTProperties::compile is in runtime → Properties (runtime)
• RTKindConstructors::compile_permissions is in runtime → Kind Constructors.
• InferenceSubjects::emit_all is in knowledge → Inference Subjects.
• Tables::complete is in assertions → Tables (assertions).
• RTTables::compile is in runtime → Tables (runtime).
• RTTableColumns::compile is in runtime → Table Columns (runtime).
• RTEquations::compile is in runtime → Equations (runtime).
• ImperativeDefinitions::compile_first_block is in assertions → Imperative Definitions.
• RTDialogueBeats::compile - Dialogue.
• RTDialogueLines::compile - Dialogue.
• RTDialogueChoices::compile - Dialogue.
• RTRules::compile is in runtime → Rules (runtime).
• RTRulebooks::compile is in runtime → Rulebooks (runtime).
• RTRulebooks::compile_nros is also in runtime → Rulebooks (runtime).
• RTActivities::compile is in runtime → Activities (runtime).
• RTVerbs::compile_conjugations is in runtime → Conjugations.
• RTVerbs::compile_forms is in runtime → Conjugations too.
• CompilationUnits::complete_metadata - Inform TODO list.

Parts 3 and 5

• PhraseRequests::invoke_to_begin is in imperative → Phrase Requests.
• Closures::compile_closures is in imperative → Closures.
• RTRelations::compile is in runtime → Relations (runtime).
• RTAdjectives::compile_mdef_test_functions is in runtime → Adjectives (linguistics).
• RTPhrasebook::compile_entries is in runtime → Phrasebook Index.
• RTMappingHints::compile is in runtime → Mapping Hints.
• RTKindIDs::compile_structures is in runtime → Kind IDs.
• TheHeap::compile_configuration is in runtime → The Heap.
• Rules::check_response_usages is in assertions → Rules (assertions).
• LocalParking::compile_array is in imperative → Local Parking.
• RTBibliographicData::IFID_text is in runtime → Bibliographic Data.

I’ve dropped the many calls to Sequence::undertake_queued_tasks.

Index

We’re finally done. Inform TODO list