alef 0.85.15

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
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
163
164
165
166
167
168
169
170
171

//! Fallible unit returns keep a public void API but carry an int32 native status.

use super::wrappers::{gen_wrapper_function, gen_wrapper_method};
use crate::backends::csharp::gen_bindings::pinvoke::{gen_pinvoke_for_func, gen_pinvoke_for_method};
use crate::core::ir::{FunctionDef, MethodDef, ReceiverKind, TypeRef};
use std::collections::{HashMap, HashSet};

fn function(fallible: bool, asynchronous: bool) -> FunctionDef {
    FunctionDef {
        name: "validate".into(),
        rust_path: "sample_core::validate".into(),
        return_type: TypeRef::Unit,
        error_type: fallible.then(|| "SampleError".into()),
        is_async: asynchronous,
        ..Default::default()
    }
}

fn method(fallible: bool, asynchronous: bool, instance: bool) -> MethodDef {
    MethodDef {
        name: "validate".into(),
        return_type: TypeRef::Unit,
        error_type: fallible.then(|| "SampleError".into()),
        is_async: asynchronous,
        is_static: !instance,
        receiver: instance.then_some(ReceiverKind::Ref),
        ..Default::default()
    }
}

#[test]
fn fallible_void_pinvoke_preserves_status_for_functions_and_methods() {
    for fallible in [false, true] {
        let expected = if fallible { "int" } else { "void" };
        let declarations = [
            gen_pinvoke_for_func(
                "sample_validate",
                &function(fallible, false),
                &HashSet::new(),
                &HashSet::new(),
                &HashMap::new(),
                &Default::default(),
            ),
            gen_pinvoke_for_method(
                "sample_settings_validate",
                "Validate",
                &method(fallible, false, true),
                &HashMap::new(),
                &Default::default(),
            ),
            gen_pinvoke_for_method(
                "sample_settings_validate",
                "Validate",
                &method(fallible, false, false),
                &HashMap::new(),
                &Default::default(),
            ),
        ];
        for declaration in declarations {
            assert!(
                declaration.contains(&format!("extern {expected} Validate(")),
                "{declaration}"
            );
        }
    }
}

fn wrap_function(fallible: bool, asynchronous: bool) -> String {
    let empty = HashSet::new();
    gen_wrapper_function(
        &function(fallible, asynchronous),
        "SampleException",
        "sample",
        &empty,
        &empty,
        &empty,
        &empty,
        &empty,
        &empty,
        false,
        &[],
    )
}

fn wrap_method(fallible: bool, asynchronous: bool, instance: bool) -> String {
    let empty = HashSet::new();
    gen_wrapper_method(
        &method(fallible, asynchronous, instance),
        "SampleException",
        "sample",
        "Settings",
        &empty,
        &empty,
        &empty,
        &empty,
        &empty,
        &empty,
        &[],
    )
}

#[test]
fn fallible_void_wrappers_check_status_without_changing_public_return_type() {
    for asynchronous in [false, true] {
        for fallible in [false, true] {
            for code in [
                wrap_function(fallible, asynchronous),
                wrap_method(fallible, asynchronous, true),
                wrap_method(fallible, asynchronous, false),
            ] {
                let public_return = if asynchronous {
                    "public static async Task "
                } else {
                    "public static void "
                };
                assert!(code.contains(public_return), "{code}");
                assert_eq!(code.contains("var nativeResult = NativeMethods."), fallible, "{code}");
                assert_eq!(code.contains("if (nativeResult != 0)"), fallible, "{code}");
                assert_eq!(code.contains("throw GetLastError();"), fallible, "{code}");
            }
        }
    }
}

fn wrap_bridge_function(fallible: bool) -> String {
    use crate::codegen::generators::trait_bridge::BridgeFieldMatch;
    use crate::core::config::TraitBridgeConfig;
    use crate::core::ir::{FieldDef, ParamDef};
    let bridge = TraitBridgeConfig {
        trait_name: "Visitor".into(),
        ..Default::default()
    };
    let field = FieldDef {
        name: "visitor".into(),
        ..Default::default()
    };
    let matched = BridgeFieldMatch {
        param_index: 0,
        param_name: "options".into(),
        options_type: "Options".into(),
        param_is_optional: false,
        field_name: "visitor".into(),
        field: &field,
        bridge: &bridge,
    };
    let empty = HashSet::new();
    let mut func = function(fallible, false);
    func.params.push(ParamDef {
        name: "options".into(),
        ty: TypeRef::Named("Options".into()),
        ..Default::default()
    });
    super::bridge_fields::gen_bridge_field_wrapper_function(&func, &matched, "SampleException", &empty, &empty, &empty)
}

#[test]
fn fallible_void_bridge_wrappers_check_both_native_call_paths() {
    for fallible in [false, true] {
        let code = wrap_bridge_function(fallible);
        assert_eq!(
            code.matches("var nativeResult = NativeMethods.Validate(").count(),
            if fallible { 2 } else { 0 },
            "{code}"
        );
        assert_eq!(
            code.matches("if (nativeResult != 0)").count(),
            if fallible { 2 } else { 0 },
            "{code}"
        );
    }
}