brink-ir 0.0.6

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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use crate::hir;

use super::context::TempMap;

/// Allocate temp slots for a scope (knot/function).
///
/// Params occupy slots `0..n-1` (knot params first, then each stitch's
/// params in order), then temp declarations are assigned sequentially.
#[expect(
    clippy::cast_possible_truncation,
    reason = "ink functions won't have >u16::MAX params/temps"
)]
pub fn alloc_temps(
    params: &[hir::Param],
    stitches: &[hir::Stitch],
    blocks: &[&hir::Block],
) -> TempMap {
    let mut map = TempMap::new();

    // Knot params first
    for (i, param) in params.iter().enumerate() {
        map.insert(param.name.text.clone(), i as u16);
    }

    let mut next_slot = params.len() as u16;

    // Stitch params get sequential slots after knot params
    for stitch in stitches {
        for param in &stitch.params {
            if map.get(&param.name.text).is_none() {
                map.insert(param.name.text.clone(), next_slot);
                next_slot += 1;
            }
        }
    }

    // Walk all blocks in the scope to find TempDecl
    for block in blocks {
        collect_temps_from_block(block, &mut map, &mut next_slot);
    }

    map
}

fn collect_temps_from_block(block: &hir::Block, map: &mut TempMap, next_slot: &mut u16) {
    for stmt in &block.stmts {
        collect_temps_from_stmt(stmt, map, next_slot);
    }
}

fn collect_temps_from_stmt(stmt: &hir::Stmt, map: &mut TempMap, next_slot: &mut u16) {
    match stmt {
        hir::Stmt::TempDecl(decl) if map.get(&decl.name.text).is_none() => {
            map.insert(decl.name.text.clone(), *next_slot);
            *next_slot += 1;
        }
        hir::Stmt::ChoiceSet(cs) => {
            for choice in &cs.choices {
                collect_temps_from_block(&choice.body, map, next_slot);
            }
            collect_temps_from_block(&cs.continuation, map, next_slot);
        }
        hir::Stmt::Conditional(cond) => {
            for branch in &cond.branches {
                collect_temps_from_block(&branch.body, map, next_slot);
            }
        }
        hir::Stmt::Sequence(seq) => {
            for branch in &seq.branches {
                collect_temps_from_block(branch, map, next_slot);
            }
        }
        hir::Stmt::LabeledBlock(block) => {
            collect_temps_from_block(block, map, next_slot);
        }
        _ => {}
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::hir::*;
    use rowan::TextRange;

    fn dummy_name(s: &str) -> Name {
        Name {
            text: s.to_string(),
            range: TextRange::default(),
        }
    }

    #[test]
    fn params_occupy_first_slots() {
        let params = vec![
            Param {
                name: dummy_name("a"),
                is_ref: false,
                is_divert: false,
            },
            Param {
                name: dummy_name("b"),
                is_ref: false,
                is_divert: false,
            },
        ];
        let empty_block = Block::default();
        let map = alloc_temps(&params, &[], &[&empty_block]);
        assert_eq!(map.get("a"), Some(0));
        assert_eq!(map.get("b"), Some(1));
        assert_eq!(map.total_slots(), 2);
    }
}