Skip to main content

Crate brink_compiler

Crate brink_compiler 

Source
Expand description

Compiler for inkle’s ink narrative scripting language.

Orchestrates the full compilation pipeline: file discovery, parsing (brink-syntax), HIR lowering (brink-ir), semantic analysis (brink-analyzer), and codegen into the brink-format binary representation consumed by brink-runtime.

Structs§

AnalysisOptions
Tooling options for analysis: the registered host manifest and the severity policy for its external checks. Defaults to no manifest.
CompileOutput
Successful compilation output, including any non-fatal warnings.
FileId
Opaque identifier for a source file within a multi-file project.
LirOutput
Successful LIR compilation output, including any non-fatal warnings.

Enums§

CompileError
Errors that can occur during compilation.

Functions§

compile
Compile an ink story with caller-provided file reading.
compile_path
Compile an ink story from an entry-point file path.
compile_string_to_json
Compile ink source from a string to the ink.json format.
compile_to_json
Compile an ink story to the ink.json format (same as inklecate output).
compile_with_options
Compile with explicit analysis options — e.g. a registered host-capability manifest and external-check severity (the “compiler flag, error by default”). Manifest-driven diagnostics are surfaced as compile warnings or errors per the severity policy.