Stdlib module compiler/backends/context/backend_context.vit

This page is a wiki-style reference for one concrete stdlib file. It explains what the file owns, where it fits in the family, and how to decide whether this is the right surface to depend on.

Visual portrait of compiler/backends/context/backend_context.vit
Wiki-style portrait for compiler/backends/context/backend_context.vit.

Family: compiler

Kind: compiler-facing or orchestrator module

Page style: this reference follows the same “encyclopedic card + portrait + usage contract” logic as the keyword pages, but for stdlib modules.

Summary

Overview

FieldValue
Pathcompiler/backends/context/backend_context.vit
Familycompiler
Kindcompiler-facing or orchestrator module
Line count91
Declared procedures17
Declared forms/picks4

`compiler/backends/context/backend_context.vit` is a compiler-facing or orchestrator module inside the `compiler` family. It should be read as one focused slice of the broader family responsibility: Compiler-owned stdlib surfaces that support self-hosted compiler and driver integration.

Purpose

This file should be chosen because of responsibility, not because its name “sounds close enough”. Inside the compiler family, it carries one focused part of the contract and keeps that responsibility separate from neighboring concerns.

  • A self-hosted compiler flow can reuse structured helpers without pretending they are general stdlib entry points.
  • A driver surface can depend on this family while still keeping its public contract documented elsewhere.

Taxonomy

Think of this page as a generated encyclopedia entry rather than a hand-written tutorial. The goal is to show what kind of module this is, how dense it is, and what reading strategy makes sense before depending on it.

  • Medium procedure surface: this file groups several related operations behind one namespace.
  • Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
  • Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.

Implementation profile

This profile is inferred directly from the source text. It does not replace reading the file, but it tells you quickly whether the module is mostly declarative, loop-heavy, branch-heavy, or organized around many small exits.

SignalCountWhat it suggests
if0Branching density and local decision-making.
while0Loop-heavy or iterative implementation style.
for0Collection-style traversal at source level.
match0Variant-driven branching or grammar-style decoding.
let0Local state and intermediate value density.
give17Number of explicit exit points and result shaping.

Top-level API inventory

SurfaceItems
Proceduresnew_context, push_namespace, pop_namespace, current_namespace, register_symbol, has_symbol, resolve_symbol, register_type, has_type, resolve_type, safe_ident, mangle
FormsSymbolBinding, TypeBinding, BackendContext
PicksEntryMode
Constantsnone declared at top level
Exportsnone declared at top level

Imported surfaces

This file does not advertise a top-level `use` surface in its opening declarations. That often means it is either self-contained or an aggregation layer.

Position in family

This file is module 6 of 27 in the compiler family when ordered by path. By procedure count it ranks 1, and by line count it ranks 3. Those ranks are useful as rough signals of breadth, not as quality judgments.

Declaration map

The declaration map turns raw source into a scan-friendly catalog. It is useful when the file is large enough that a reader wants to orient by kinds of surfaces first.

LineNameKindRole
1vitte/stdlib_checked/compiler_backends_context_backend_contextspaceDeclares the namespace that anchors this file in the stdlib tree.
9SymbolBindingformIntroduces a structured data shape that other procedures can exchange.
13TypeBindingformIntroduces a structured data shape that other procedures can exchange.
17EntryModepickIntroduces a tagged variant type used to model distinct outcomes.
21BackendContextformIntroduces a structured data shape that other procedures can exchange.
25new_contextprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
29push_namespaceprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
33pop_namespaceprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
37current_namespaceprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
41register_symbolprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
45has_symbolprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
49resolve_symbolprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
53register_typeprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
57has_typeprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
61resolve_typeprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
65safe_identprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
69mangleprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
73add_includeprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
77set_debugprocOwns a concrete data shape or the operations that maintain it.
81set_optimizeprocOwns a concrete data shape or the operations that maintain it.
85set_repro_strictprocOwns a concrete data shape or the operations that maintain it.
89set_entry_modeprocOwns a concrete data shape or the operations that maintain it.

The table is exhaustive for top-level declarations of the selected kinds. This file declares 22 matching surfaces.

Representative signatures

These signatures are shown in source order so the page keeps the feel of a reference manual, not just a keyword cloud.

  • form SymbolBinding { (line 9)
  • form TypeBinding { (line 13)
  • pick EntryMode { (line 17)
  • form BackendContext { (line 21)
  • proc new_context() -> int { (line 25)
  • proc push_namespace() -> int { (line 29)
  • proc pop_namespace() -> int { (line 33)
  • proc current_namespace() -> int { (line 37)
  • proc register_symbol() -> int { (line 41)
  • proc has_symbol() -> int { (line 45)
  • proc resolve_symbol() -> int { (line 49)
  • proc register_type() -> int { (line 53)
  • proc has_type() -> int { (line 57)
  • proc resolve_type() -> int { (line 61)
  • proc safe_ident() -> int { (line 65)
  • proc mangle() -> int { (line 69)
  • proc add_include() -> int { (line 73)
  • proc set_debug() -> int { (line 77)

The list is intentionally capped here; the source file declares 21 matching signatures in total.

How to use this module

Start by reading the file as an ownership boundary. Ask three questions: what enters this module, what stable types or procedures it exports, and what adjacent module should stay outside of it.

  1. Read space and top-level imports first so the ownership boundary of compiler/backends/context/backend_context.vit is explicit.
  2. Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
  3. Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
  4. Only after that compare neighbor modules, because the right boundary choice matters more than memorizing one helper name.

User example

This example is generated from the actual stdlib module surface. Its job is not to be the smallest snippet possible; its job is to show a realistic consumer-shaped file that exercises the module and mirrors the language keywords the module itself relies on.

space demo/compiler_backends_context_backend_context
form UserReport {
  label: string,
  ready: bool
}
pick UserOutcome {
  case Ready(message: string)
  case Empty(reason: string)
}
proc run_example() -> UserOutcome {
    give UserOutcome.Ready("ok")
}

Keyword coverage

This table makes the “all keywords of the module” requirement auditable. It compares the detected Vitte keywords in the source file with the generated consumer example above.

KeywordPresent in module sourceUsed in generated user example
spaceyesyes
formyesyes
pickyesyes
procyesyes
giveyesyes

The generated snippet exercises every detected Vitte keyword used by this module.

Source shape

space vitte/stdlib_checked/compiler_backends_context_backend_context
form SymbolBinding {
  value: int
}
form TypeBinding {
  value: int
}
pick EntryMode {
  Ok
}

The excerpt is not meant to replace the file. It exists to make the module recognizable at first glance, the same way a Wikipedia infobox helps the reader orient before reading the whole article.

Source landmarks

Large files are easier to retain when they have visible landmarks. When the source contains explicit section banners, they are surfaced here; otherwise the first major declarations are used as anchors.

  • Line 1: space vitte/stdlib_checked/compiler_backends_context_backend_context
  • Line 9: form SymbolBinding {
  • Line 13: form TypeBinding {
  • Line 17: pick EntryMode {
  • Line 21: form BackendContext {
  • Line 25: proc new_context() -> int {
  • Line 29: proc push_namespace() -> int {
  • Line 33: proc pop_namespace() -> int {

Source organization

When a file carries its own internal chaptering, those chapters usually reveal the intended reading order better than a flat symbol list. This section reconstructs that organization from the source itself.

File surfaces

Top-level items: 22. Procedures: 17. Data surfaces: 4. Constants: 0.

First visible names: vitte/stdlib_checked/compiler_backends_context_backend_context, SymbolBinding, TypeBinding, EntryMode, BackendContext, new_context, push_namespace, pop_namespace, current_namespace, register_symbol

Complete API catalog

This catalog is the exhaustive file-level index for the module. It is intentionally closer to a generated encyclopedia appendix than to a tutorial summary.

Data surfaces

LineNameSignatureRole
9SymbolBindingform SymbolBinding {Introduces a structured data shape that other procedures can exchange.
13TypeBindingform TypeBinding {Introduces a structured data shape that other procedures can exchange.
17EntryModepick EntryMode {Introduces a tagged variant type used to model distinct outcomes.
21BackendContextform BackendContext {Introduces a structured data shape that other procedures can exchange.

Procedures

LineNameSignatureRole
25new_contextproc new_context() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
29push_namespaceproc push_namespace() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
33pop_namespaceproc pop_namespace() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
37current_namespaceproc current_namespace() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
41register_symbolproc register_symbol() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
45has_symbolproc has_symbol() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
49resolve_symbolproc resolve_symbol() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
53register_typeproc register_type() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
57has_typeproc has_type() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
61resolve_typeproc resolve_type() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
65safe_identproc safe_ident() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
69mangleproc mangle() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
73add_includeproc add_include() -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
77set_debugproc set_debug() -> int {Owns a concrete data shape or the operations that maintain it.
81set_optimizeproc set_optimize() -> int {Owns a concrete data shape or the operations that maintain it.
85set_repro_strictproc set_repro_strict() -> int {Owns a concrete data shape or the operations that maintain it.
89set_entry_modeproc set_entry_mode() -> int {Owns a concrete data shape or the operations that maintain it.

Integration boundaries

Within compiler, this file should remain focused. If a future helper changes the host boundary, scheduling boundary, or data-shape boundary, it probably belongs in a neighbor module instead of being added here by convenience.

  • Family responsibility: Compiler-owned stdlib surfaces that support self-hosted compiler and driver integration.
  • Family architecture role: This family is not general-purpose business code. It exists to support compiler-owned flows where the compiler and stdlib need a shared contract.

Composition guidance

Choose this module when

  • Choose compiler/backends/context/backend_context.vit when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
  • A self-hosted compiler flow can reuse structured helpers without pretending they are general stdlib entry points.
  • A driver surface can depend on this family while still keeping its public contract documented elsewhere.

Pause before extending it when

  • Avoid extending this file when the new helper mostly changes the boundary to host I/O, runtime coordination, or foreign integration instead of staying inside compiler.
  • Check nearby modules such as compiler/backends/ast/target_decl.vit, compiler/backends/ast/target_expr.vit, compiler/backends/ast/target_stmt.vit before adding convenience wrappers here.

Relationship table

This table keeps the page closer to a real encyclopedia entry: a module is easier to understand when compared with its nearest alternatives in the same family.

NeighborProceduresData surfacesWhy compare it
compiler/backends/ast/target_decl.vit210Shares the same family boundary but carries a distinct slice of responsibility.
compiler/backends/ast/target_expr.vit101Shares the same family boundary but carries a distinct slice of responsibility.
compiler/backends/ast/target_stmt.vit61Shares the same family boundary but carries a distinct slice of responsibility.
compiler/backends/ast/target_type.vit93Shares the same family boundary but carries a distinct slice of responsibility.
compiler/backends/backend.vit82Shares the same family boundary but carries a distinct slice of responsibility.
compiler/backends/emit/emit.vit110Shares the same family boundary but carries a distinct slice of responsibility.
compiler/backends/lower/lower_mir.vit76Shares the same family boundary but carries a distinct slice of responsibility.
compiler/backends/mod.vit61Shares the same family boundary but carries a distinct slice of responsibility.

Neighbor modules