brink-ir 0.0.17

Intermediate representations for inkle's ink narrative scripting language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! Low-level IR: resolved, container-centric program representation.
//!
//! The LIR is the output of HIR + analysis (`SymbolIndex`, `ResolutionMap`).
//! All references are resolved to `DefinitionId`s or temp slot indices,
//! container boundaries are decided, and the program is organized as a
//! flat list of containers.
//!
//! Two backends consume the LIR:
//! - **Bytecode backend:** linearizes to opcodes + line tables → `.inkb`
//! - **JSON backend:** serializes to `.ink.json` (inklecate-compatible)
//!
//! ## Design properties
//!
//! - **Flat container list.** Every knot, stitch, gather, and choice target
//!   is a separate `Container` with its own `DefinitionId`. Container
//!   boundaries are decided during HIR → LIR lowering, not by backends.
//!
//! - **Structured statements.** Conditionals, sequences, and choice sets
//!   keep their branch structure within each container. Each backend
//!   serializes this structure into its output format (jump offsets for
//!   bytecode, nested arrays for JSON). This avoids committing to a
//!   bytecode-specific linearization that the JSON backend can't use.
//!
//! - **Fully resolved.** No unresolved `Path` nodes. Every reference is
//!   a `DefinitionId` (globals, containers, list items, externals) or a
//!   temp slot index (`u16`). The LIR never needs the `SymbolIndex` or
//!   `ResolutionMap` — all lookups are done during lowering.

pub mod lower;
mod types;

pub use lower::recognize::{
    VARIANT_CAP, VariantAlt, VariantCapExceeded, VariantEnumeration, enumerate_variant_contents,
};
pub use lower::{
    AnalyzerTables, ChunkLoweringCtx, CoalesceLookup, CoalesceShape, LirPrelude, PreludeDecls,
    ScopeChunk, StructShapeData, TypeMode, UfcsLookup, UfcsVerdict, assemble_prelude,
    assemble_program, build_prelude, build_prelude_decls, build_struct_shape_data,
    is_builtin_function, is_t1b_stdlib_name, lower_knot_chunk_incremental,
    lower_root_content_for_prelude, lower_to_program, lower_to_program_with_type_mode,
};
pub use types::*;