esp-hal-procmacros 0.22.0

Procedural macros for esp-hal
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

#![deny(warnings)]

use proc_macro2::{Span, TokenStream};
use syn::{
    ItemFn,
    parse::{self},
};

/// Marks the firmware entry point.
pub fn main(args: TokenStream, f: ItemFn) -> TokenStream {
    if f.sig.asyncness.is_some() {
        return parse::Error::new(
            Span::call_site(),
            "If you want to use `async` please use `esp-rtos`'s `#[esp_rtos::main]` macro instead.",
        )
        .to_compile_error();
    }

    if !args.is_empty() {
        return parse::Error::new(Span::call_site(), "This attribute accepts no arguments")
            .to_compile_error();
    }

    let root = match proc_macro_crate::crate_name("esp-hal") {
        Ok(proc_macro_crate::FoundCrate::Name(ref name)) => quote::format_ident!("{name}"),
        _ => quote::format_ident!("esp_hal"),
    };

    quote::quote!(
        #[doc = "The main entry point of the firmware, generated by the `#[main]` macro."]
        #[#root::__macro_implementation::__entry]
        #f
    )
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_basic() {
        let result = main(
            quote::quote! {}.into(),
            syn::parse2(quote::quote! {
                fn main() {}
            })
            .unwrap(),
        );

        assert_eq!(
            result.to_string(),
            quote::quote! {
                #[doc = "The main entry point of the firmware, generated by the `#[main]` macro."]
                #[esp_hal::__macro_implementation::__entry]
                fn main () { }
            }
            .to_string()
        );
    }

    #[test]
    fn test_try_async() {
        let result = main(
            quote::quote! {}.into(),
            syn::parse2(quote::quote! {
                async fn main() {}
            })
            .unwrap(),
        );

        assert_eq!(
            result.to_string(),
            quote::quote! {
                ::core::compile_error!{ "If you want to use `async` please use `esp-rtos`'s `#[esp_rtos::main]` macro instead." }
            }
            .to_string()
        );
    }

    #[test]
    fn test_try_non_emptyargs() {
        let result = main(
            quote::quote! {non_empty}.into(),
            syn::parse2(quote::quote! {
                fn main() {}
            })
            .unwrap(),
        );

        assert_eq!(
            result.to_string(),
            quote::quote! {
                ::core::compile_error!{ "This attribute accepts no arguments" }
            }
            .to_string()
        );
    }
}