diplomat_core 0.15.0

Shared utilities between Diplomat macros and code generation
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

use serde::Serialize;
use syn::ItemFn;

use crate::ast::{Attrs, Docs, Ident, LifetimeEnv, Param, PathType, TypeName};

#[derive(Clone, PartialEq, Eq, Hash, Serialize, Debug)]
#[non_exhaustive]
/// Represents a free function not associated with any types.
pub struct Function {
    pub name: Ident,
    pub abi_name: Ident,
    // corresponds to the types in Function(Vec<Box<TypeName>>, Box<TypeName>)
    // the callback type; except here the params aren't anonymous
    pub params: Vec<Param>,
    pub output_type: Option<TypeName>,
    pub lifetimes: LifetimeEnv,
    pub attrs: Attrs,
    pub docs: Docs,
}

impl Function {
    pub(crate) fn from_syn(f: &ItemFn, parent_attrs: &Attrs) -> Function {
        let ident: Ident = (&f.sig.ident).into();
        if f.sig.receiver().is_some() {
            panic!("Cannot use self parameter in free function {ident:?}")
        }

        let mut attrs = parent_attrs.clone();
        attrs.add_attrs(&f.attrs);

        let concat_func_ident = if attrs.abi_rename.is_empty() {
            format!("diplomat_external_{ident}")
        } else {
            attrs.abi_rename.apply(ident.as_str().into()).to_string()
        };

        let extern_ident = syn::Ident::new(&concat_func_ident, f.sig.ident.span());

        let path_type = PathType::from(&f.sig);

        let all_params = f
            .sig
            .inputs
            .iter()
            .filter_map(|a| match a {
                syn::FnArg::Receiver(_) => None,
                syn::FnArg::Typed(ref t) => Some(Param::from_syn(t, path_type.clone())),
            })
            .collect::<Vec<_>>();

        let output_type = match &f.sig.output {
            syn::ReturnType::Type(_, return_typ) => Some(TypeName::from_syn(
                return_typ.as_ref(),
                Some(path_type.clone()),
            )),
            syn::ReturnType::Default => None,
        };

        let lifetimes = LifetimeEnv::from_function_item(f, &all_params[..], output_type.as_ref());

        Self {
            name: ident,
            abi_name: (&extern_ident).into(),
            params: all_params,
            output_type,
            lifetimes,
            attrs,
            docs: Docs::from_attrs(&f.attrs),
        }
    }
}

#[cfg(test)]
mod tests {
    use insta;

    use syn;

    use crate::ast::{Attrs, Function};

    #[test]
    fn test_free_function() {
        insta::assert_yaml_snapshot!(Function::from_syn(
            &syn::parse_quote! {
                fn some_func(a : f32, b: f64) {

                }
            },
            &Attrs::default()
        ));
    }

    #[test]
    fn test_free_function_output() {
        insta::assert_yaml_snapshot!(Function::from_syn(
            &syn::parse_quote! {
                fn some_func(a : SomeType) -> Option<()> {

                }
            },
            &Attrs::default()
        ));
    }

    #[test]
    fn test_free_function_lifetimes() {
        insta::assert_yaml_snapshot!(Function::from_syn(
            &syn::parse_quote! {
                fn some_func<'a>(a : &'a SomeType) -> Option<&'a SomeType> {

                }
            },
            &Attrs::default()
        ));
    }
}