alef 0.79.0

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

use crate::backends::rustler::gen_bindings::helpers::elixir_safe_param_name;
use crate::backends::rustler::gen_bindings::public_api_args::{
    json_encode_param_indices, method_deserialization_introduces_result, nif_arg,
};
use crate::backends::rustler::template_env;
use crate::core::config::ResolvedCrateConfig;
use crate::core::ir::{ApiSurface, MethodDef, TypeDef, TypeRef};
use ahash::{AHashMap, AHashSet};
use heck::ToSnakeCase;

#[allow(clippy::too_many_arguments)]
pub(super) fn append_top_level_opaque_methods(
    content: &mut String,
    api: &ApiSurface,
    config: &ResolvedCrateConfig,
    exclude_functions: &AHashSet<String>,
    exclude_types: &AHashSet<&str>,
    opaque_types: &AHashSet<String>,
    default_types: &AHashSet<String>,
    native_mod: &str,
    app_module: &str,
) {
    let type_names: AHashSet<&str> = api
        .types
        .iter()
        .filter(|typ| typ.is_opaque && !typ.is_trait && !exclude_types.contains(typ.name.as_str()))
        .map(|typ| typ.name.as_str())
        .collect();
    let streaming_methods: AHashSet<String> = config
        .adapters
        .iter()
        .filter(|adapter| matches!(adapter.pattern, crate::core::config::AdapterPattern::Streaming))
        .filter_map(|adapter| {
            adapter
                .owner_type
                .as_deref()
                .map(|owner| format!("{owner}.{}", adapter.name))
        })
        .collect();

    for opaque_type in api.types.iter().filter(|typ| type_names.contains(typ.name.as_str())) {
        append_type_methods(
            content,
            opaque_type,
            &streaming_methods,
            exclude_functions,
            opaque_types,
            default_types,
            native_mod,
            app_module,
        );
    }
}

#[allow(clippy::too_many_arguments)]
fn append_type_methods(
    content: &mut String,
    opaque_type: &TypeDef,
    streaming_methods: &AHashSet<String>,
    exclude_functions: &AHashSet<String>,
    opaque_types: &AHashSet<String>,
    default_types: &AHashSet<String>,
    native_mod: &str,
    app_module: &str,
) {
    for method in opaque_type
        .methods
        .iter()
        .filter(|method| !exclude_functions.contains(method.name.as_str()))
        .filter(|method| !streaming_methods.contains(&format!("{}.{}", opaque_type.name, method.name)))
    {
        append_method_wrapper(
            content,
            opaque_type,
            method,
            opaque_types,
            default_types,
            native_mod,
            app_module,
        );
    }
}

#[allow(clippy::too_many_arguments)]
fn append_method_wrapper(
    content: &mut String,
    opaque_type: &TypeDef,
    method: &MethodDef,
    opaque_types: &AHashSet<String>,
    default_types: &AHashSet<String>,
    native_mod: &str,
    app_module: &str,
) {
    let type_lower = opaque_type.name.to_lowercase();
    let method_name = method.name.to_snake_case();
    let nif_function = if method.is_async && !method.name.ends_with("_async") {
        format!("{type_lower}_{method_name}_async")
    } else {
        format!("{type_lower}_{method_name}")
    };
    let (definition_arguments, call_arguments) = method_arguments(method, opaque_types, default_types);
    let doc_first = method.doc.lines().next().unwrap_or("").replace('"', "\\\"");
    let returns_self = matches!(&method.return_type, TypeRef::Named(name) if name == &opaque_type.name);
    let unwrap_result = method_deserialization_introduces_result(method, true, opaque_types, default_types);
    content.push_str(&template_env::render(
        "elixir_top_level_opaque_method_wrapper.ex.jinja",
        minijinja::context! {
            doc_first => &doc_first,
            func_name => &nif_function,
            def_args => &definition_arguments.join(", "),
            call_args => &call_arguments.join(", "),
            native_mod => native_mod,
            unwrap_result => unwrap_result,
            preserve_result => method.is_async || method.error_type.is_some(),
            returns_self => returns_self,
            app_module => app_module,
            type_name => &opaque_type.name,
        },
    ));
    content.push('\n');
}

fn method_arguments(
    method: &MethodDef,
    opaque_types: &AHashSet<String>,
    default_types: &AHashSet<String>,
) -> (Vec<String>, Vec<String>) {
    let mut definitions = Vec::new();
    let mut calls = Vec::new();
    if method.receiver.is_some() {
        definitions.push("obj".to_string());
        calls.push("obj.ref".to_string());
    }
    let json_params = json_encode_param_indices(&method.params, opaque_types, default_types);
    let tagged_params = AHashMap::new();
    for (index, parameter) in method.params.iter().enumerate() {
        let safe_name = elixir_safe_param_name(&parameter.name);
        definitions.push(safe_name.clone());
        calls.push(nif_arg(index, &safe_name, &json_params, &tagged_params));
    }
    (definitions, calls)
}