savvy_macro/
lib.rs

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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
use proc_macro::TokenStream;
use quote::quote;

use savvy_bindgen::{SavvyEnum, SavvyFn, SavvyImpl, SavvyStruct};
use syn::parse_quote;

#[proc_macro_attribute]
pub fn savvy(_args: TokenStream, input: TokenStream) -> TokenStream {
    let result = if let Ok(mut item_fn) = syn::parse::<syn::ItemFn>(input.clone()) {
        savvy_fn(&mut item_fn, false)
    } else if let Ok(mut item_struct) = syn::parse::<syn::ItemStruct>(input.clone()) {
        savvy_struct(&mut item_struct)
    } else if let Ok(mut item_impl) = syn::parse::<syn::ItemImpl>(input.clone()) {
        savvy_impl(&mut item_impl)
    } else if let Ok(mut item_enum) = syn::parse::<syn::ItemEnum>(input.clone()) {
        savvy_enum(&mut item_enum)
    } else {
        // TODO: how can I convert TokenStream to Span?
        let parse_result = syn::parse::<syn::ItemImpl>(input.clone());
        return proc_macro::TokenStream::from(
            syn::Error::new(
                parse_result.unwrap_err().span(),
                "#[savvy] macro only accepts `fn`, `struct`, or `impl`",
            )
            .into_compile_error(),
        );
    };

    match result {
        Ok(token_stream) => token_stream,
        Err(e) => e.into_compile_error().into(),
    }
}

#[proc_macro_attribute]
pub fn savvy_init(_args: TokenStream, input: TokenStream) -> TokenStream {
    let result = if let Ok(mut item_fn) = syn::parse::<syn::ItemFn>(input.clone()) {
        savvy_fn(&mut item_fn, true)
    } else {
        // TODO: how can I convert TokenStream to Span?
        let parse_result = syn::parse::<syn::ItemImpl>(input.clone());
        return proc_macro::TokenStream::from(
            syn::Error::new(
                parse_result.unwrap_err().span(),
                "#[savvy_init] macro only accepts `fn`",
            )
            .into_compile_error(),
        );
    };

    match result {
        Ok(token_stream) => token_stream,
        Err(e) => e.into_compile_error().into(),
    }
}

fn savvy_fn(orig: &mut syn::ItemFn, as_init_fn: bool) -> syn::Result<TokenStream> {
    let savvy_fn = SavvyFn::from_fn(orig, as_init_fn)?;

    let item_fn_inner = savvy_fn.generate_inner_fn();
    let item_fn_ffi = savvy_fn.generate_ffi_fn();

    // Make public in order to make it easy to test
    orig.vis = syn::Visibility::Public(parse_quote!(pub));

    Ok(quote! {
        #orig

        #item_fn_inner
        #item_fn_ffi
    }
    .into())
}

fn savvy_impl(orig: &mut syn::ItemImpl) -> syn::Result<TokenStream> {
    let savvy_impl = SavvyImpl::new(orig)?;

    let list_fn_inner = savvy_impl.generate_inner_fns();
    let list_fn_ffi = savvy_impl.generate_ffi_fns();

    // Make public in order to make it easy to test
    for i in orig.items.iter_mut() {
        match i {
            syn::ImplItem::Const(c) => {
                c.vis = syn::Visibility::Public(parse_quote!(pub));
            }
            syn::ImplItem::Fn(f) => {
                f.vis = syn::Visibility::Public(parse_quote!(pub));
            }
            syn::ImplItem::Type(t) => {
                t.vis = syn::Visibility::Public(parse_quote!(pub));
            }
            _ => {}
        }
    }

    Ok(quote! {
        #orig

        #(#list_fn_inner)*
        #(#list_fn_ffi)*
    }
    .into())
}

fn savvy_struct(orig: &mut syn::ItemStruct) -> syn::Result<TokenStream> {
    let savvy_struct = SavvyStruct::new(orig)?;
    let try_from_impls = savvy_struct.generate_try_from_impls();

    // Make public in order to make it easy to test
    orig.vis = syn::Visibility::Public(parse_quote!(pub));

    Ok(quote!(
        #orig

        #(#try_from_impls)*
    )
    .into())
}

fn savvy_enum(orig: &mut syn::ItemEnum) -> syn::Result<TokenStream> {
    let savvy_enum = SavvyEnum::new(orig)?;
    let enum_with_discriminant = savvy_enum.generate_enum_with_discriminant();
    let try_from_impls = savvy_enum.generate_try_from_impls();

    // Make public in order to make it easy to test
    orig.vis = syn::Visibility::Public(parse_quote!(pub));

    Ok(quote!(
        #enum_with_discriminant

        #(#try_from_impls)*
    )
    .into())
}

#[cfg(test)]
mod tests {
    use super::*;
    use prettyplease::unparse;
    use syn::parse_quote;

    fn assert_snapshot_inner(orig: syn::ItemFn) {
        let result = SavvyFn::from_fn(&orig, false)
            .expect("Failed to parse a function")
            .generate_inner_fn();
        let formatted = unparse(&parse_quote!(#result));
        let lines = formatted.lines().collect::<Vec<&str>>();
        insta::assert_yaml_snapshot!(lines);
    }

    #[test]
    fn test_generate_inner_fn() {
        assert_snapshot_inner(parse_quote!(
            #[savvy]
            fn foo() -> savvy::Result<savvy::Sexp> {
                bar()
            }
        ));

        assert_snapshot_inner(parse_quote!(
            #[savvy]
            fn foo() -> savvy::Result<()> {
                bar();
                Ok(())
            }
        ));

        assert_snapshot_inner(
            // The qualified form (with `savvy::`) and non-qualified form is
            // kept between conversions.
            parse_quote!(
                #[savvy]
                fn foo(x: RealSexp, y: savvy::IntegerSexp) -> savvy::Result<savvy::Sexp> {
                    bar()
                }
            ),
        );

        assert_snapshot_inner(parse_quote!(
            #[savvy]
            fn foo(x: f64) -> savvy::Result<savvy::Sexp> {
                bar()
            }
        ));
    }

    fn assert_snapshot_ffi(orig: syn::ItemFn) {
        let result = SavvyFn::from_fn(&orig, false)
            .expect("Failed to parse an impl")
            .generate_ffi_fn();
        let formatted = unparse(&parse_quote!(#result));
        let lines = formatted.lines().collect::<Vec<&str>>();
        insta::assert_yaml_snapshot!(lines);
    }

    #[test]
    fn test_generate_ffi_fn() {
        assert_snapshot_ffi(parse_quote!(
            #[savvy]
            fn foo() -> savvy::Result<savvy::Sexp> {
                bar()
            }
        ));

        assert_snapshot_ffi(parse_quote!(
            #[savvy]
            fn foo() -> savvy::Result<()> {
                bar();
                Ok(())
            }
        ));

        assert_snapshot_ffi(parse_quote!(
            #[savvy]
            fn foo(x: RealSexp, y: savvy::RealSexp) -> savvy::Result<savvy::Sexp> {
                bar()
            }
        ));
    }

    fn assert_snapshot_ffi_impl(orig: &syn::ItemImpl) {
        for item_fn in SavvyImpl::new(orig).expect("Failed to parse an impl").fns {
            let result = item_fn.generate_ffi_fn();
            let formatted = unparse(&parse_quote!(#result));
            let lines = formatted.lines().collect::<Vec<&str>>();
            insta::assert_yaml_snapshot!(lines);
        }
    }

    #[test]
    fn test_generate_ffi_fn_impl() {
        assert_snapshot_ffi_impl(&parse_quote!(
            #[savvy]
            impl Person {
                fn new() -> Self {
                    Self {}
                }
                fn new2() -> Person {
                    Person {}
                }
                fn name(&self) -> savvy::Result<savvy::Sexp> {
                    Ok(out.into())
                }
                fn set_name(&self, name: StringSexp) -> Result<()> {
                    Ok(())
                }
            }
        ));
    }
}