alef 0.82.2

Opinionated polyglot binding generator for Rust libraries
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

use alef::backends::java::JavaBackend;
use alef::core::backend::Backend;
use alef::core::config::NewAlefConfig;
use alef::core::ir::ApiSurface;

#[test]
fn required_symbols_are_emitted_one_per_line() {
    let config: NewAlefConfig = toml::from_str(
        r#"
[workspace]
languages = ["java", "ffi"]

[[crates]]
name = "sample_core"
sources = ["src/lib.rs"]

[crates.ffi]
prefix = "sample"

[crates.java]
package = "org.example.sample"
"#,
    )
    .unwrap();
    let resolved = config.resolve().unwrap().remove(0);
    let api = ApiSurface {
        crate_name: "sample_core".into(),
        version: "1.0.0".into(),
        ..Default::default()
    };

    let files = JavaBackend.generate_bindings(&api, &resolved).unwrap();
    let native_lib = files
        .iter()
        .find(|file| file.path.ends_with("NativeLib.java"))
        .expect("NativeLib.java");
    let required_symbols = native_lib
        .content
        .lines()
        .skip_while(|line| !line.contains("REQUIRED_SYMBOLS = {"))
        .skip(1)
        .take_while(|line| !line.trim().starts_with("};"))
        .collect::<Vec<_>>();

    assert!(required_symbols.len() > 1, "{}", native_lib.content);
    assert!(required_symbols.iter().all(|line| line.trim().starts_with('"')));
    assert!(required_symbols.iter().all(|line| line.len() <= 200));
}

/// Regression: `[crates.java].exclude_functions` must hide a function from the Java surface
/// while leaving `[crates.ffi].exclude_functions` — and therefore the C ABI and every other
/// binding — untouched. Before this key existed, xberg's `alef.toml` named
/// `embed_sparse_async` under `[crates.java]`, the key was rejected outright, and the
/// function shipped in `Xberg.java`/`XbergRs.java` anyway. Mirrors
/// `GoConfig::exclude_functions`.
#[test]
fn java_exclude_functions_hides_the_function_without_touching_the_ffi_list() {
    use alef::core::ir::{FunctionDef, TypeRef};

    let config: NewAlefConfig = toml::from_str(
        r#"
[workspace]
languages = ["java", "ffi"]

[[crates]]
name = "sample_core"
sources = ["src/lib.rs"]

[crates.ffi]
prefix = "sample"

[crates.java]
package = "org.example.sample"
exclude_functions = ["embed_sparse_async"]
"#,
    )
    .unwrap();
    let resolved = config.resolve().unwrap().remove(0);

    let make_fn = |name: &str| FunctionDef {
        name: name.to_string(),
        return_type: TypeRef::Unit,
        ..Default::default()
    };
    let api = ApiSurface {
        crate_name: "sample_core".into(),
        version: "1.0.0".into(),
        functions: vec![make_fn("embed_sparse_async"), make_fn("other_func")],
        ..Default::default()
    };

    let files = JavaBackend.generate_bindings(&api, &resolved).unwrap();
    let joined = files
        .iter()
        .map(|file| file.content.as_str())
        .collect::<Vec<_>>()
        .join("\n");

    assert!(
        !joined.contains("embedSparseAsync"),
        "JavaConfig::exclude_functions must drop the function from every generated Java file:\n{joined}"
    );
    assert!(
        joined.contains("otherFunc"),
        "a function named in neither exclude list must still be generated:\n{joined}"
    );
}