emit_macros 1.20.1

Internal proc macro crate for emit.
Documentation
use proc_macro2::TokenStream;
use syn::{
    Attribute, Expr, ExprLit, FieldValue, Ident, Lit, LitStr, parse::Parse, punctuated::Punctuated,
    spanned::Spanned, token::Comma,
};

use crate::{
    args::{self, Arg},
    hook,
};

pub fn key_with_hook(
    attrs: &[Attribute],
    key_expr: &ExprLit,
    interpolated: bool,
    captured: bool,
) -> TokenStream {
    let interpolated_expr = if interpolated {
        quote!(.__private_interpolated())
    } else {
        quote!(.__private_uninterpolated())
    };

    let captured_expr = if captured {
        quote!(.__private_captured())
    } else {
        quote!(.__private_uncaptured())
    };

    quote_spanned!(key_expr.span()=>
        #(#attrs)*
        #[allow(unused_imports)]
        {
            use emit::__private::{__PrivateKeyHook as _, __PrivateInterpolatedHook as _};
            emit::__private::Key(#key_expr).__private_key_as_default() #interpolated_expr #captured_expr
        }
    )
}

pub struct Args {
    /*
    NOTE: Also update docs in _Control Parameters_ for this macro when adding new args
    */
    pub name: Name,
}

pub enum Name {
    Str(String),
    Any(TokenStream),
}

impl Parse for Args {
    fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
        // Accept a standalone string as a shorthand for the key name
        let name = if input.peek(LitStr) {
            let value: LitStr = input.parse()?;

            Name::Str(value.value())
        } else {
            let mut name = Arg::new("name", |fv| {
                let expr = &fv.expr;

                if let Expr::Lit(ExprLit {
                    attrs: _,
                    lit: Lit::Str(lit),
                }) = expr
                {
                    Ok(Name::Str(lit.value()))
                } else {
                    Ok(Name::Any(quote_spanned!(expr.span()=> #expr)))
                }
            });

            args::set_from_field_values(
                input.parse_terminated(FieldValue::parse, Token![,])?.iter(),
                [&mut name],
            )?;

            name.take()
                .ok_or_else(|| syn::Error::new(input.span(), "the `name` argument is missing"))?
        };

        Ok(Args { name })
    }
}

pub struct RenameHookTokens {
    pub args: TokenStream,
    pub expr: TokenStream,
}

pub fn rename_hook_tokens(opts: RenameHookTokens) -> Result<TokenStream, syn::Error> {
    hook::rename_hook_tokens(hook::RenameHookTokens {
        name: "key",
        target: "values in templates or event macros",
        args: opts.args,
        expr: opts.expr,
        predicate: |ident: &str| ident.starts_with("__private_key"),
        to: move |args: &Args, ident: &Ident, _: &Punctuated<Expr, Comma>| {
            if ident.to_string().starts_with("__private_key_external") {
                return None;
            }

            let (to_ident, to_arg) = match args.name {
                Name::Str(ref name) => (quote!(__private_key_as), quote!(emit::Str::new(#name))),
                Name::Any(ref name) => (
                    quote!(__private_key_as),
                    quote!(emit::__private::__private_capture_key(#name)),
                ),
            };

            Some((to_ident, to_arg))
        },
    })
}