34. Mental model of the compiler

Level: intermediate · Reading time: 20 min · Prerequisite: book/chapters/33-suggested-chapters.html · Track: supplemental · Maturity: draft · Last review: 2026-05-09

TL;DR (5 lines)

Every chapter needs one concrete engineering story.
The contract matters more than the token list.
An invalid example should isolate the chapter's real lesson.
Global explanation beats line-by-line commentary.
The page should leave one reusable rule behind.

Frequent mistakes

Explaining abstractions with no anchored scenario.
Repeating template prose without changing the engineering point.
Using invalid examples that do not isolate the chapter's real topic.

Prerequisites: book/chapters/33-suggested-chapters.html. See also: book/chapters/33-suggested-chapters.html, book/chapters/27-grammar.html, book/chapters/31-build-errors.html.

Concrete Problem

Generic chapters without a stable scenario produce repetition and weak retention.

Red Thread (Single Project)

One small service module is used to explain the topic through input, validation, transformation, and output.

For what

This chapter helps the reader connect the topic to one concrete engineering use.

Work in this chapter

You will inspect one coherent example, then one invalid variant, and extract the rule that the chapter is really teaching.

Coherent example

space demo/generic

proc run(value: int) -> int {
  if value < 0 { give 11 }
  give value
}

export *

Complete examples

Each block below is a complete reading unit with its own boundary, data shape, and observable result.

Primary coherent example

This is the compact chapter anchor used by the surrounding explanation.

space demo/generic

proc run(value: int) -> int {
  if value < 0 { give 11 }
  give value
}

export *

Complete service flow

This example anchors the chapter in a full input, validation, and result path.

space examples/generic/service

form Request {
  name: string
  value: int
}

proc validate(req: Request) -> int {
  if req.name == "" { give 11 }
  if req.value < 0 { give 12 }
  give 0
}

proc main(args: list[string]) -> int {
  let req: Request = Request { name: "demo", value: 1 }
  give validate(req)
}

export *

Explicit result flow

This variant names the result so later refactors keep the same contract.

space examples/generic/result

pick Result {
  case Ok(code: int),
  case Failed(code: int),
}

proc run(value: int) -> Result {
  if value < 0 { give Result.Failed(11) }
  give Result.Ok(value)
}

proc main(args: list[string]) -> int {
  let result: Result = run(3)
  give 0
}

export *

Immediate work for this chapter

Anchor the page in a complete service-style flow.
Use the chapter title to specialize the generic rule.
Keep the result contract stable across refactors.
Keep the first code block complete and aligned with current Vitte docs syntax.
Keep the invalid block focused on one broken contract only.
Replace generic prose with one concrete rule visible in the code.
Keep every example small enough to review from top to bottom.

Chapter override: 34-compiler-mental-model.html

Dedicated problem

34. Mental model of the compiler needs a concrete production-grade anchor around input, transformation, and result. The page should keep the examples, diagnostics, and review rules tied to that exact boundary instead of drifting back to generic tutorial prose.

Specific complete examples

34. Mental model of the compiler chapter anchor

The primary example is promoted here as the first chapter-specific production reading unit.

space demo/generic

proc run(value: int) -> int {
  if value < 0 { give 11 }
  give value
}

export *

Complete service flow

This example anchors the chapter in a full input, validation, and result path.

space examples/generic/service

form Request {
  name: string
  value: int
}

proc validate(req: Request) -> int {
  if req.name == "" { give 11 }
  if req.value < 0 { give 12 }
  give 0
}

proc main(args: list[string]) -> int {
  let req: Request = Request { name: "demo", value: 1 }
  give validate(req)
}

export *

Explicit result flow

This variant names the result so later refactors keep the same contract.

space examples/generic/result

pick Result {
  case Ok(code: int),
  case Failed(code: int),
}

proc run(value: int) -> Result {
  if value < 0 { give Result.Failed(11) }
  give Result.Ok(value)
}

proc main(args: list[string]) -> int {
  let result: Result = run(3)
  give 0
}

export *

Risks and diagnostics

Risk	Diagnostic signal	Action
Boundary drift	The chapter loses sight of input, transformation, and result.	Restate the boundary beside the first code block and every invalid case.
Generic prose	A paragraph would still be true in another chapter.	Replace it with a code-specific rule from this page.
Weak diagnostic	The failure does not point back to the chapter contract.	Reduce the invalid case until one failure explains the rule.

Review checklist

The first example is complete and aligned with Vitte docs syntax.
The production section names where this construct belongs in real code.
The risk table connects each failure to a diagnostic or review action.
The avoid list rejects broad misuse without adding quiz-like prompts.

Production use

Use this chapter when a code review needs to preserve input, transformation, and result.
Keep examples small enough to copy into fixtures or docs smoke tests.
Treat the invalid case as regression material for future docs checks.

What to avoid

Do not add a second topic that hides the chapter's main contract.
Do not expand examples by adding unrelated subsystems.
Do not rely on prose when a small Vitte block can show the rule.

Global explanation

The chapter should always return to the same core contract carried by the construct in the full block. That is the reason every page still needs one complete, testable example.

Invalid case

proc broken(value: int) -> int {
  if value { give 11 }
  give value
}

This invalid case is intentionally small. It exists to isolate the contract failure that the chapter is trying to teach.

Common pitfalls

Explaining abstractions with no anchored scenario.
Repeating template prose without changing the engineering point.
Using invalid examples that do not isolate the chapter's real topic.

Short exercise

Take the coherent example and rewrite one line so that the chapter's central contract becomes even more explicit.

Summary in 5 points

Every chapter needs one concrete engineering story.
The contract matters more than the token list.
An invalid example should isolate the chapter's real lesson.
Global explanation beats line-by-line commentary.
The page should leave one reusable rule behind.

Next best action

Extend the coherent example by one small, justified step and keep the same contract visible from input to output.

Chapter deep dive

34. Mental model of the compiler anchors the chapter in one concrete contract. The chapter is written for a reader extracting one reusable engineering rule.

The practical boundary is: input, transformation, and result. Keep that boundary in view while reading the example, the invalid case, and the exercise.

Role in the learning path

Generic chapters without a stable scenario produce repetition and weak retention.

One small service module is used to explain the topic through input, validation, transformation, and output.

This chapter helps the reader connect the topic to one concrete engineering use.

Profile-specific deep dive

Contract to expose

Name the input shape before the first branch.
Keep transformation local and observable.
Return a result that preserves the chapter's main rule.

Review focus

The public name should explain the contract.
The example should remain executable as a small standalone module.
The invalid case should break the same contract the text explains.

Diagnostics to expect

Mismatched type or result shape.
Missing boundary around a value that later code depends on.
A broad claim that no concrete code line supports.

Reading the valid example

space demo/generic: names the ownership boundary before any behavior appears.
proc run(value: int) -> int {: states the callable contract: inputs first, result shape last.
if value < 0 { give 11 }: guards a failure or edge case before the nominal result.
give value: ends the local path with an explicit result.
}: supports the chapter contract without adding hidden behavior.
export *: supports the chapter contract without adding hidden behavior.

Lesson from the invalid example

proc broken(value: int) -> int {: this line helps isolate the failure because it states the callable contract: inputs first, result shape last.
if value { give 11 }: this line helps isolate the failure because it guards a failure or edge case before the nominal result.
give value: this line helps isolate the failure because it ends the local path with an explicit result.
}: this line helps isolate the failure because it supports the chapter contract without adding hidden behavior.

Engineering decisions to preserve

Name the boundary before changing code: Every chapter needs one concrete engineering story.
Keep the smallest example executable: The contract matters more than the token list.
Make the invalid path explain one failure only: An invalid example should isolate the chapter's real lesson.
Prefer a visible contract over an implied convention: Global explanation beats line-by-line commentary.
Leave a review anchor that another maintainer can verify: The page should leave one reusable rule behind.

Context-specific review criteria

The page makes the input, transformation, and result boundary visible before the first code block.
The intended reader, a reader extracting one reusable engineering rule, can follow the valid example through named contracts instead of memorized tokens.
The invalid example fails for the same reason the prose discusses.
The exercise extends the same contract instead of introducing an unrelated concept.
The next chapter can reuse the vocabulary introduced here without redefining it.
The chapter stays specific enough that its title materially changes the meaning of the page.
Every warning connects to a concrete code shape.
The summary leaves one durable engineering rule behind.

Contract matrix

Concern	Chapter rule	Evidence to keep
Ownership	Code belongs behind the boundary named by the chapter.	The chapter keeps ownership visible through input, transformation, and result.
Input contract	The procedure receives a shape that is named before branching.	The valid example names the accepted shape before branching.
Nominal path	The clean path remains readable without hidden state.	The successful result can be found without reading hidden state.
Failure path	The invalid case isolates one failure reason.	The broken example has one main reason to fail.
Naming	Names explain the domain rather than only the mechanism.	Names remain tied to the chapter goal.
Types	Types remove ambiguity from values and results.	Fields and return values carry domain meaning.
Control flow	Branches stay traceable from guard to result.	Guards appear before the result they protect.
Module boundary	The public surface stays smaller than implementation detail.	The public surface remains smaller than the implementation detail.
Diagnostic value	The failure path points back to the exact contract.	The invalid example points back to the exact contract.
Test value	Regression evidence covers one passing path and one failing path.	One passing case and one failing case cover the lesson.
Refactor value	Implementation cleanup preserves the result shape.	The result shape stays stable during local cleanup.
Publication value	The chapter leaves one concrete engineering rule.	The chapter leaves one concrete engineering rule.

Rewrite path for this chapter

Rewrite the opening paragraph so it names input, transformation, and result before naming syntax.
Keep the valid example small enough that the full contract fits on screen.
Move any broad claim back to a specific line in the example.
Preserve one invalid case that fails for the chapter's main reason.
Add one sentence explaining why the invalid case is not a random error.
Make every pitfall actionable by naming the code shape it damages.
Keep the exercise inside the same domain as the example.
Avoid introducing a second unrelated project just to show variety.
Use the summary to restate the chapter rule, not the table of contents.
Check that the next chapter can build on this vocabulary.
Remove any sentence that would still be true in every other chapter.
Keep the last action small, local, and testable.

Diagnostic anchors

The first inspected line is the one that declares the chapter's main contract.
The central type, field, procedure, or branch carries the chapter's main idea.
The invalid example includes a sentence-level explanation of its failure.
Refactors preserve the detail that would otherwise mislead a future reader.
The behavior that must stay stable is named before implementation changes begin.
Vague names are replaced before they become review friction.
Regression coverage protects the chapter's main contract.
Implementation details stay out of public API unless the chapter explicitly teaches that surface.
Beginner-facing diagnostics point to the contract, not to a random syntax detail.
The next chapter can assume one clearly named concept from this page.

When extending this chapter

Extend toward a reader extracting one reusable engineering rule, not toward a broader catalog of features.
Add a second example only if it sharpens the same contract.
Prefer a small variant over a new subsystem.
Keep prose close to code; every abstract claim should point to a visible shape.
Do not hide a new concept in the exercise.
If a paragraph explains policy, add the concrete code boundary it protects.
If a paragraph explains syntax, add the semantic reason the syntax matters.
If a paragraph explains architecture, identify the owner of each boundary.
If a paragraph explains failure, keep the failing line close to the explanation.
Stop expanding when the chapter has one complete, testable lesson.

Failure modes to avoid

Explaining abstractions with no anchored scenario.
Repeating template prose without changing the engineering point.
Using invalid examples that do not isolate the chapter's real topic.

Practice scenario

Start from the coherent example in 34. Mental model of the compiler. Change one identifier, one guard, and one returned value. After each change, write down whether the public contract is still the same contract or a new one.

If the contract changed, update the type or result shape first. If only the implementation changed, keep the external name stable and add one regression note explaining what should not change again.

Before moving on

You can state the chapter role: anchors the chapter in one concrete contract.
You can point to the main boundary: input, transformation, and result.
You can connect the invalid case to the problem statement: Generic chapters without a stable scenario produce repetition and weak retention.
You can perform the exercise: Take the coherent example and rewrite one line so that the chapter's central contract becomes even more explicit.