use std::collections::{BTreeMap, HashSet};
use proc_macro::TokenStream;
use proc_macro2::{Span, TokenStream as TokenStream2};
use quote::{quote, ToTokens};
use syn::{
parse::{Parse, ParseStream},
parse_macro_input,
spanned::Spanned,
Data, DeriveInput, Fields, Ident, LitStr, Token, Type,
};
fn error_tokens(span: Span, message: &str) -> TokenStream {
syn::Error::new(span, message).to_compile_error().into()
}
const ATTR_NAME: &str = "rpc";
const TX_ATTR: &str = "tx";
const RX_ATTR: &str = "rx";
const DEFAULT_RX_TYPE: &str = "::irpc::channel::none::NoReceiver";
fn generate_parent_span_impl(enum_name: &Ident, variant_names: &[&Ident]) -> TokenStream2 {
quote! {
impl #enum_name {
pub fn parent_span(&self) -> tracing::Span {
let span = match self {
#(#enum_name::#variant_names(inner) => inner.parent_span_opt()),*
};
span.cloned().unwrap_or_else(|| ::tracing::Span::current())
}
}
}
}
fn generate_channels_impl(
mut args: NamedTypeArgs,
service_name: &Ident,
request_type: &Type,
attr_span: Span,
) -> syn::Result<TokenStream2> {
let rx = args.types.remove(RX_ATTR).unwrap_or_else(|| {
syn::parse_str::<Type>(DEFAULT_RX_TYPE).expect("Failed to parse default rx type")
});
let tx = args.get(TX_ATTR, attr_span)?;
let res = quote! {
impl ::irpc::Channels<#service_name> for #request_type {
type Tx = #tx;
type Rx = #rx;
}
};
args.check_empty(attr_span)?;
Ok(res)
}
fn generate_case_from_impls(
enum_name: &Ident,
variants_with_attr: &[(Ident, Type)],
) -> TokenStream2 {
let mut impls = quote! {};
for (variant_name, inner_type) in variants_with_attr {
let impl_tokens = quote! {
impl From<#inner_type> for #enum_name {
fn from(value: #inner_type) -> Self {
#enum_name::#variant_name(value)
}
}
};
impls = quote! {
#impls
#impl_tokens
};
}
impls
}
fn generate_message_enum_from_impls(
message_enum_name: &Ident,
variants_with_attr: &[(Ident, Type)],
service_name: &Ident,
) -> TokenStream2 {
let mut impls = quote! {};
for (variant_name, inner_type) in variants_with_attr {
let impl_tokens = quote! {
impl From<::irpc::WithChannels<#inner_type, #service_name>> for #message_enum_name {
fn from(value: ::irpc::WithChannels<#inner_type, #service_name>) -> Self {
#message_enum_name::#variant_name(value)
}
}
};
impls = quote! {
#impls
#impl_tokens
};
}
impls
}
fn generate_type_aliases(
variants: &[(Ident, Type)],
service_name: &Ident,
suffix: &str,
) -> TokenStream2 {
let mut aliases = quote! {};
for (variant_name, inner_type) in variants {
let type_name = format!("{}{}", variant_name, suffix);
let type_ident = Ident::new(&type_name, variant_name.span());
let alias = quote! {
pub type #type_ident = ::irpc::WithChannels<#inner_type, #service_name>;
};
aliases = quote! {
#aliases
#alias
};
}
aliases
}
#[proc_macro_attribute]
pub fn rpc_requests(attr: TokenStream, item: TokenStream) -> TokenStream {
let mut input = parse_macro_input!(item as DeriveInput);
let args = parse_macro_input!(attr as MacroArgs);
let service_name = args.service_name;
let message_enum_name = args.message_enum_name;
let alias_suffix = args.alias_suffix;
let enum_name = &input.ident;
let input_span = input.span();
let data_enum = match &mut input.data {
Data::Enum(data_enum) => data_enum,
_ => return error_tokens(input.span(), "RpcRequests can only be applied to enums"),
};
let mut channel_impls = Vec::new();
let mut types = HashSet::new();
let mut all_variants = Vec::new();
let mut variants_with_attr = Vec::new();
for variant in &mut data_enum.variants {
let request_type = match &variant.fields {
Fields::Unnamed(fields) if fields.unnamed.len() == 1 => &fields.unnamed[0].ty,
_ => {
return error_tokens(
variant.span(),
"Each variant must have exactly one unnamed field",
)
}
};
all_variants.push((variant.ident.clone(), request_type.clone()));
if !types.insert(request_type.to_token_stream().to_string()) {
return error_tokens(input_span, "Each variant must have a unique request type");
}
let mut rpc_attr = None;
let mut multiple_rpc_attrs = false;
variant.attrs.retain(|attr| {
if attr.path.is_ident(ATTR_NAME) {
if rpc_attr.is_some() {
multiple_rpc_attrs = true;
true } else {
rpc_attr = Some(attr.clone());
false }
} else {
true }
});
if multiple_rpc_attrs {
return error_tokens(
variant.span(),
"Each variant can only have one rpc attribute",
);
}
if let Some(attr) = rpc_attr {
variants_with_attr.push((variant.ident.clone(), request_type.clone()));
let args = match attr.parse_args::<NamedTypeArgs>() {
Ok(info) => info,
Err(e) => return e.to_compile_error().into(),
};
match generate_channels_impl(args, &service_name, request_type, attr.span()) {
Ok(impls) => channel_impls.push(impls),
Err(e) => return e.to_compile_error().into(),
}
}
}
let original_from_impls = generate_case_from_impls(enum_name, &variants_with_attr);
let type_aliases = if let Some(suffix) = alias_suffix {
generate_type_aliases(&all_variants, &service_name, &suffix)
} else {
quote! {}
};
let extended_enum_code = if let Some(message_enum_name) = message_enum_name {
let message_variants = all_variants
.iter()
.map(|(variant_name, inner_type)| {
quote! {
#[allow(missing_docs)]
#variant_name(::irpc::WithChannels<#inner_type, #service_name>)
}
})
.collect::<Vec<_>>();
let variant_names: Vec<&Ident> = all_variants.iter().map(|(name, _)| name).collect();
let message_enum = quote! {
#[allow(missing_docs)]
#[derive(Debug)]
pub enum #message_enum_name {
#(#message_variants),*
}
};
let parent_span_impl = generate_parent_span_impl(&message_enum_name, &variant_names);
let message_from_impls = generate_message_enum_from_impls(
&message_enum_name,
&variants_with_attr,
&service_name,
);
quote! {
#message_enum
#parent_span_impl
#message_from_impls
}
} else {
quote! {}
};
let output = quote! {
#input
#(#channel_impls)*
#original_from_impls
#type_aliases
#extended_enum_code
};
output.into()
}
struct MacroArgs {
service_name: Ident,
message_enum_name: Option<Ident>,
alias_suffix: Option<String>,
}
impl Parse for MacroArgs {
fn parse(input: ParseStream) -> syn::Result<Self> {
let service_name: Ident = input.parse()?;
let mut message_enum_name = None;
let mut alias_suffix = None;
while input.peek(Token![,]) {
input.parse::<Token![,]>()?;
let param_name: Ident = input.parse()?;
input.parse::<Token![=]>()?;
match param_name.to_string().as_str() {
"message" => {
message_enum_name = Some(input.parse()?);
}
"alias" => {
let lit: LitStr = input.parse()?;
alias_suffix = Some(lit.value());
}
_ => {
return Err(syn::Error::new(
param_name.span(),
format!("Unknown parameter: {}", param_name),
));
}
}
}
Ok(MacroArgs {
service_name,
message_enum_name,
alias_suffix,
})
}
}
struct NamedTypeArgs {
types: BTreeMap<String, Type>,
}
impl NamedTypeArgs {
fn get(&mut self, key: &str, span: Span) -> syn::Result<Type> {
self.types
.remove(key)
.ok_or_else(|| syn::Error::new(span, format!("rpc requires a {key} type")))
}
fn check_empty(&self, span: Span) -> syn::Result<()> {
if self.types.is_empty() {
Ok(())
} else {
Err(syn::Error::new(
span,
format!(
"Unknown arguments provided: {:?}",
self.types.keys().collect::<Vec<_>>()
),
))
}
}
}
impl Parse for NamedTypeArgs {
fn parse(input: ParseStream) -> syn::Result<Self> {
let mut types = BTreeMap::new();
loop {
if input.is_empty() {
break;
}
let key: Ident = input.parse()?;
let _: Token![=] = input.parse()?;
let value: Type = input.parse()?;
types.insert(key.to_string(), value);
if !input.peek(Token![,]) {
break;
}
let _: Token![,] = input.parse()?;
}
Ok(NamedTypeArgs { types })
}
}