geam 0.1.1

Experimental Rust-embedded execution runtime for typed Gleam programs
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use crate::plan::PanicSite;
use crate::plan::execution::explain::{Explain, ExplainContext};
use crate::plan::execution::graph::StringLocalId;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum SourceStopKind {
    Panic,
    Todo,
    Assert,
    EmptyFunction,
    EmptyBlock,
    IncompleteUse,
}

pub(crate) struct SourceStop {
    kind: SourceStopKind,
    message: Option<StringLocalId>,
    site: PanicSite,
}

impl SourceStop {
    pub(in crate::plan::execution) fn new(
        kind: SourceStopKind,
        message: Option<StringLocalId>,
        site: PanicSite,
    ) -> Self {
        Self {
            kind,
            message,
            site,
        }
    }

    pub(crate) fn kind(&self) -> SourceStopKind {
        self.kind
    }

    pub(crate) fn message(&self) -> Option<StringLocalId> {
        self.message
    }

    pub(crate) fn site(&self) -> &PanicSite {
        &self.site
    }
}

impl Explain for SourceStop {
    fn write_explanation(&self, context: &mut ExplainContext<'_, '_>) {
        context.push_str("source_stop kind=");
        context.push_str(source_stop_kind(self.kind()));
        context.push_str(" message=");
        match self.message() {
            Some(message) => context.write(&message),
            None => context.push_str("none"),
        }
    }
}

fn source_stop_kind(kind: SourceStopKind) -> &'static str {
    match kind {
        SourceStopKind::Panic => "panic",
        SourceStopKind::Todo => "todo",
        SourceStopKind::Assert => "assert",
        SourceStopKind::EmptyFunction => "empty_function",
        SourceStopKind::EmptyBlock => "empty_block",
        SourceStopKind::IncompleteUse => "incomplete_use",
    }
}

#[cfg(test)]
mod explain_tests {
    use super::super::Terminator;
    use super::{SourceStop, SourceStopKind};
    use crate::plan::execution::explain;
    use crate::plan::execution::function::IntFunctionId;

    #[test]
    fn writes_source_stop() {
        let source = r#"
pub fn main() -> Int {
  panic as "stopped"
}
"#;
        let expected = "source_stop kind=panic message=%string#0";

        assert_explanation(source, expected);
    }

    #[test]
    fn writes_every_source_stop_kind_token() {
        let cases = [
            (SourceStopKind::Panic, "panic"),
            (SourceStopKind::Todo, "todo"),
            (SourceStopKind::Assert, "assert"),
            (SourceStopKind::EmptyFunction, "empty_function"),
            (SourceStopKind::EmptyBlock, "empty_block"),
            (SourceStopKind::IncompleteUse, "incomplete_use"),
        ];

        for (kind, expected) in cases {
            explain::assert_written(expected, |output| {
                output.push_str(super::source_stop_kind(kind));
            });
        }
    }

    #[test]
    #[should_panic(expected = "source should lower one source-stop terminator")]
    fn source_stop_shape_guard_is_visible() {
        explain::with_execution_plan("pub fn main() { 1 }", |plan| {
            source_stop(&terminators(plan));
        });
    }

    #[test]
    #[should_panic(expected = "source should lower one source-stop terminator")]
    fn source_stop_uniqueness_guard_is_visible() {
        explain::with_execution_plan("pub fn main() -> Int { panic }", |plan| {
            let stop = source_stop(&terminators(plan));
            source_stop_from_nodes(&[stop, stop]);
        });
    }

    fn terminators(
        plan: &crate::plan::execution::ExecutionPlan,
    ) -> Vec<&crate::plan::execution::graph::Terminator> {
        plan.int_function(IntFunctionId(0))
            .body()
            .block_graph()
            .blocks()
            .iter()
            .map(|block| block.terminator())
            .collect()
    }

    fn source_stop<'a>(terminators: &[&'a Terminator]) -> &'a SourceStop {
        let stops = terminators
            .iter()
            .copied()
            .filter_map(|terminator| match terminator {
                Terminator::SourceStop(stop) => Some(stop),
                _ => None,
            })
            .collect::<Vec<_>>();
        source_stop_from_nodes(&stops)
    }

    fn source_stop_from_nodes<'a>(stops: &[&'a SourceStop]) -> &'a SourceStop {
        let [stop] = stops else {
            panic!("source should lower one source-stop terminator");
        };
        stop
    }

    fn assert_explanation(source: &str, expected: &str) {
        explain::assert_rendered(source, expected, |plan, output| {
            let stop = source_stop(&terminators(plan));
            let mut context = explain::ExplainContext::new(plan, output);
            context.write(stop);
        });
    }
}