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

//! Procedural macro support crate for the `illicit` crate.

extern crate proc_macro;
use proc_macro::TokenStream;
use proc_macro_error::{abort, abort_call_site, proc_macro_error};
use quote::quote;
use syn::{
    parse::Parser, parse_macro_input, parse_quote, punctuated::Punctuated, spanned::Spanned,
    Attribute, FnArg, ItemFn, Local, PatType, Stmt, Token, Type, TypeReference,
};

#[proc_macro_attribute]
#[proc_macro_error]
pub fn from_env(args: TokenStream, input: TokenStream) -> TokenStream {
    let mut input_fn: ItemFn = parse_macro_input!(input);

    let args = Punctuated::<FnArg, Token![,]>::parse_terminated.parse(args).unwrap();
    if args.is_empty() {
        abort_call_site!("must specify >=1 one argument");
    }

    let doc_prelude = "
# Environment Expectations

This function requires the following types to be visible to [`illicit::get`] and will
panic otherwise:
";

    for line in doc_prelude.lines() {
        input_fn.attrs.push(parse_quote!(#[doc = #line]));
    }

    for arg in args {
        let arg = match arg {
            FnArg::Receiver(rec) => abort!(rec.span(), "can't receive self by-environment"),
            FnArg::Typed(pt) => pt,
        };
        let ([first_stmt, second_stmt], doc_attr) = bind_env_reference(&arg);
        input_fn.block.stmts.insert(0, Stmt::Local(first_stmt));
        input_fn.block.stmts.insert(1, Stmt::Local(second_stmt));
        input_fn.attrs.push(doc_attr);
    }

    quote::quote!(#input_fn).into()
}

/// Create a pair of local assignment expressions from the `pattern: &type`
/// pair which is passed.
fn bind_env_reference(arg: &PatType) -> ([Local; 2], Attribute) {
    let arg_span = arg.span();

    let ty = match &*arg.ty {
        Type::Reference(TypeReference { lifetime, mutability, elem, .. }) => {
            if mutability.is_some() {
                abort!(mutability.span(), "mutable references cannot be passed by environment");
            }

            if lifetime.is_some() {
                abort!(
                    lifetime.span(),
                    "cannot bind to concrete lifetimes for environment references"
                );
            }

            quote!(#elem)
        }

        ty => abort!(ty.span(), "arguments must be references"),
    };

    let name = *arg.pat.clone();
    let init_expr = parse_quote!(illicit::expect::<#ty>());
    let deref_expr = parse_quote!(&*#name);

    let shadowed = Local {
        attrs: vec![],
        let_token: Token![let](arg_span),
        pat: name.clone(),
        init: Some((Token![=](arg_span), Box::new(init_expr))),
        semi_token: Token![;](arg_span),
    };
    let derefd = Local {
        attrs: vec![],
        let_token: Token![let](arg_span),
        pat: name,
        init: Some((Token![=](arg_span), Box::new(deref_expr))),
        semi_token: Token![;](arg_span),
    };

    let ty_bullet = format!("* `{}`", ty);
    let doc_attr = parse_quote!(#[doc = #ty_bullet]);

    ([shadowed, derefd], doc_attr)
}