Stdlib module compiler/backends/toolchain/vitte_toolchain.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/toolchain/vitte_toolchain.vit
Wiki-style portrait for compiler/backends/toolchain/vitte_toolchain.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/toolchain/vitte_toolchain.vit
Familycompiler
Kindcompiler-facing or orchestrator module
Line count114
Declared procedures5
Declared forms/picks2

`compiler/backends/toolchain/vitte_toolchain.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.

  • Compact procedure surface: this file is small enough to read end-to-end before depending on it.
  • Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
  • Has tuning constants: part of the module behavior is controlled by named constants that document default precision, limits, or policy.
  • Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.
  • Explicit export surface: the file ends with visible export declarations instead of relying only on implicit namespace discovery.

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
if7Branching density and local decision-making.
while2Loop-heavy or iterative implementation style.
for0Collection-style traversal at source level.
match0Variant-driven branching or grammar-style decoding.
let6Local state and intermediate value density.
give5Number of explicit exit points and result shaping.

Top-level API inventory

SurfaceItems
Proceduressystem, default_options, _append_joined, build_vitte_command, invoke_vitte
FormsVitteToolchainOptions, VitteToolchainInvocation
Picksnone declared at top level
ConstantsOK
Exports*

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 13 of 27 in the compiler family when ordered by path. By procedure count it ranks 12, and by line count it ranks 2. 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/compiler/backends/toolchain/vitte_toolchainspaceDeclares the namespace that anchors this file in the stdlib tree.
10VitteToolchainOptionsformIntroduces a structured data shape that other procedures can exchange.
28VitteToolchainInvocationformIntroduces a structured data shape that other procedures can exchange.
34OKconstDefines a named constant reused across the module.
36systemprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
40default_optionsprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
60_append_joinedprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
70build_vitte_commandprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.
108invoke_vitteprocSupports compiler-facing orchestration, lowering, diagnostics, or backend work.

The table is exhaustive for top-level declarations of the selected kinds. This file declares 9 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 VitteToolchainOptions { (line 10)
  • form VitteToolchainInvocation { (line 28)
  • const OK: int = 0 (line 34)
  • proc system(command: string) -> int { (line 36)
  • proc default_options() -> VitteToolchainOptions { (line 40)
  • proc _append_joined(cmd: string, prefix: string, values: [string]) -> string { (line 60)
  • proc build_vitte_command(input_source: string, output: string, opts: VitteToolchainOptions) -> string { (line 70)
  • proc invoke_vitte(input_source: string, output: string, opts: VitteToolchainOptions) -> VitteToolchainInvocation { (line 108)

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/toolchain/vitte_toolchain.vit is explicit.
  2. Scan constants before procedures; they often encode precision, limits, or policy assumptions that explain later behavior.
  3. Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
  4. Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
  5. Use the source landmarks section below as a table of contents when the file is large.

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_toolchain_vitte_toolchain
const SAMPLE_LABEL: string = "demo"
form UserReport {
  label: string,
  ready: bool
}
proc run_example() -> UserReport {
  let result = system("sample")
  let failed: bool = false
  let idx: int = 0
  while idx < 1 {
    set idx = idx + 1
  }
  if not ready {
    give UserReport { label: "not-ready", ready: false }
  }
    give UserReport { label: "ok", ready: true }
  let copies: f64 = 1 as f64
}
export run_example

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
constyesyes
formyesyes
procyesyes
letyesyes
setyesyes
ifyesyes
whileyesyes
giveyesyes
exportyesyes
trueyesyes
falseyesyes
notyesyes
asyesyes

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

Source shape

space vitte/compiler/backends/toolchain/vitte_toolchain
form VitteToolchainOptions {
  std: string,
  target: string,
  debug: bool,
  optimize: bool,
  opt_level: int,
  warnings: bool,
  verbose: bool,
  freestanding: bool,

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.

  • package: vitte.compiler.backends.toolchain.vitte_toolchain / role: bootstrap-vitte-backend-toolchain / source_of_truth: src/vitte/compiler/backends/toolchain/vitte_toolchain.vit / status: bootstrap-vitte

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.

Opening declarations

Top-level items: 1. Procedures: 0. Data surfaces: 0. Constants: 0.

First visible names: vitte/compiler/backends/toolchain/vitte_toolchain

package: vitte.compiler.backends.toolchain.vitte_toolchain / role: bootstrap-vitte-backend-toolchain / source_of_truth: src/vitte/compiler/backends/toolchain/vitte_toolchain.vit / status: bootstrap-vitte

Top-level items: 9. Procedures: 5. Data surfaces: 2. Constants: 1.

First visible names: VitteToolchainOptions, VitteToolchainInvocation, OK, system, default_options, _append_joined, build_vitte_command, invoke_vitte, *

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.

Constants

LineNameSignatureRole
34OKconst OK: int = 0Defines a named constant reused across the module.

Data surfaces

LineNameSignatureRole
10VitteToolchainOptionsform VitteToolchainOptions {Introduces a structured data shape that other procedures can exchange.
28VitteToolchainInvocationform VitteToolchainInvocation {Introduces a structured data shape that other procedures can exchange.

Procedures

LineNameSignatureRole
36systemproc system(command: string) -> int {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
40default_optionsproc default_options() -> VitteToolchainOptions {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
60_append_joinedproc _append_joined(cmd: string, prefix: string, values: [string]) -> string {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
70build_vitte_commandproc build_vitte_command(input_source: string, output: string, opts: VitteToolchainOptions) -> string {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.
108invoke_vitteproc invoke_vitte(input_source: string, output: string, opts: VitteToolchainOptions) -> VitteToolchainInvocation {Supports compiler-facing orchestration, lowering, diagnostics, or backend work.

Exports

LineNameSignatureRole
114*export *Re-exports surfaces that the module wants to expose as part of its public boundary.

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/toolchain/vitte_toolchain.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/context/backend_context.vit174Shares 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.

Neighbor modules