beamr 0.4.5

A Rust runtime with the BEAM's execution model, targeting Gleam
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

//! Exception BIFs — erlang:raise/3.

use crate::atom::{Atom, AtomTable};
use crate::native::{
    BifRegistryImpl, Capability, ExceptionClass, NativeFn, NativeRegistrationError, ProcessContext,
};
use crate::term::Term;

type ExceptionBif = (&'static str, u8, Capability, NativeFn);

const EXCEPTION_BIFS: &[ExceptionBif] = &[("raise", 3, Capability::Pure, bif_raise_3)];

/// Registers exception BIFs into the VM-owned BIF registry.
pub fn register_exception_bifs(
    registry: &BifRegistryImpl,
    atom_table: &AtomTable,
) -> Result<(), NativeRegistrationError> {
    let erlang = atom_table.intern("erlang");

    for &(function_name, arity, capability, native_function) in EXCEPTION_BIFS {
        let function = atom_table.intern(function_name);
        registry.register(erlang, function, arity, native_function, capability)?;
    }

    Ok(())
}

/// erlang:raise/3 — raises `Reason` with the supplied class and stacktrace.
pub fn bif_raise_3(args: &[Term], context: &mut ProcessContext) -> Result<Term, Term> {
    let [class, reason, stacktrace] = args else {
        return Err(badarg());
    };

    let exception_class = term_to_exception_class(*class).ok_or_else(badarg)?;

    context.set_exception_class(exception_class);
    context.set_exception_stacktrace(*stacktrace);
    Err(*reason)
}

fn term_to_exception_class(class: Term) -> Option<ExceptionClass> {
    if class == Term::atom(Atom::ERROR) {
        Some(ExceptionClass::Error)
    } else if class == Term::atom(Atom::THROW) {
        Some(ExceptionClass::Throw)
    } else if class == Term::atom(Atom::EXIT_CLASS) {
        Some(ExceptionClass::Exit)
    } else {
        None
    }
}

fn badarg() -> Term {
    Term::atom(Atom::BADARG)
}

#[cfg(test)]
mod tests {
    use super::{bif_raise_3, register_exception_bifs};
    use crate::atom::{Atom, AtomTable};
    use crate::native::{BifRegistryImpl, ExceptionClass, ProcessContext};
    use crate::term::Term;

    #[test]
    fn bif_raise_3_sets_exception_metadata_and_returns_reason_error() {
        let mut context = ProcessContext::new();
        let class = Term::atom(Atom::THROW);
        let reason = Term::atom(Atom::BADMATCH);
        let stacktrace = Term::small_int(123);

        assert_eq!(
            bif_raise_3(&[class, reason, stacktrace], &mut context),
            Err(reason)
        );
        assert_eq!(context.take_exception_class(), ExceptionClass::Throw);
        assert_eq!(context.take_exception_stacktrace(), stacktrace);
    }

    #[test]
    fn bif_raise_3_rejects_invalid_class() {
        let mut context = ProcessContext::new();

        assert_eq!(
            bif_raise_3(
                &[
                    Term::atom(Atom::OK),
                    Term::atom(Atom::BADARG),
                    Term::small_int(456)
                ],
                &mut context
            ),
            Err(Term::atom(Atom::BADARG))
        );
        assert_eq!(context.take_exception_class(), ExceptionClass::Error);
        assert_eq!(context.take_exception_stacktrace(), Term::NIL);
    }

    #[test]
    fn register_exception_bifs_registers_raise_3() {
        let registry = BifRegistryImpl::new();
        let atom_table = AtomTable::new();

        register_exception_bifs(&registry, &atom_table).expect("exception BIF registration");

        let erlang = atom_table.intern("erlang");
        let raise = atom_table.intern("raise");
        assert!(registry.lookup(erlang, raise, 3).is_some());
    }
}