brink-ir 0.0.3

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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! Content and body lowering phase.
//!
//! Defines rich output types for content lines and logic lines, the
//! [`LowerBody`] trait, the [`BodyBackend`] trait, and the
//! [`ContentAccumulator`] that ties everything together.

mod accumulator;
mod content_line;
mod divert_node;
mod helpers;
mod inline_logic;
mod logic_line;
mod multiline_block;
mod tag_line;

pub use accumulator::ContentAccumulator;
pub use content_line::ContentLineOutput;
pub use helpers::{lower_content_node_children, lower_tags};
pub use logic_line::LogicLineOutput;

use super::context::{LowerScope, LowerSink, Lowered};

// ─── LowerBody trait ────────────────────────────────────────────────

/// Extension trait for AST nodes that contribute statements to a body.
pub trait LowerBody {
    type Output;
    fn lower_body(&self, scope: &LowerScope, sink: &mut impl LowerSink) -> Lowered<Self::Output>;
}

// ─── BodyBackend trait ──────────────────────────────────────────────

/// Backend for the [`ContentAccumulator`]. Determines where flushed
/// statements go — directly into a `Vec<Stmt>`, or into weave items.
pub trait BodyBackend {
    fn push_stmt(&mut self, stmt: crate::Stmt);
    fn finish(self) -> crate::Block;
}

/// Direct backend: collects statements into a `Block`. For branch bodies.
#[derive(Default)]
pub struct DirectBackend {
    stmts: Vec<crate::Stmt>,
}

impl DirectBackend {
    pub fn new() -> Self {
        Self::default()
    }
}

impl BodyBackend for DirectBackend {
    fn push_stmt(&mut self, stmt: crate::Stmt) {
        self.stmts.push(stmt);
    }

    fn finish(self) -> crate::Block {
        crate::Block {
            label: None,
            stmts: self.stmts,
            container_id: None,
        }
    }
}

// ─── HandleResult ───────────────────────────────────────────────────

/// Indicates whether a handled node produced block-level output or inline
/// content. Used by branch bodies for whitespace tracking.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum HandleResult {
    /// Output produced block-level statement(s).
    Block,
    /// Output produced inline content parts (or nothing).
    Inline,
}

// ─── Integrate trait ────────────────────────────────────────────────

/// Tells the [`ContentAccumulator`] how to consume a typed output from
/// [`LowerBody`]. Returns [`HandleResult`] indicating the nature of the output.
pub trait Integrate<T> {
    fn integrate(&mut self, output: T) -> HandleResult;
}