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
use proc_macro2::{Span, TokenStream};
use quote::{quote, quote_spanned};
use syn::ext::IdentExt;
use syn::parse::{Parse, ParseStream};
use syn::punctuated::Punctuated;
use syn::spanned::Spanned;
use syn::{parse_macro_input, Data, DeriveInput, Fields, Generics, Ident, Token, Variant};

#[proc_macro_derive(ProtocolMessage, attributes(protocol_message))]
pub fn protocol_message(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let input = parse_macro_input!(input as DeriveInput);

    let mut root = None;

    for attr in input.attrs {
        if !attr.path.is_ident("protocol_message") {
            continue;
        }
        if root.is_some() {
            return quote_spanned! { attr.path.span() => compile_error!("#[protocol_message] attribute appears more than once"); }.into();
        }
        let tokens = attr.tokens.into();
        root = Some(parse_macro_input!(tokens as RootAttribute));
    }

    let root_path = root
        .map(|root| root.path)
        .unwrap_or_else(|| Punctuated::from_iter([Ident::new("round_based", Span::call_site())]));

    let enum_data = match input.data {
        Data::Enum(e) => e,
        Data::Struct(s) => {
            return quote_spanned! {s.struct_token.span => compile_error!("only enum may implement ProtocolMessage");}.into()
        }
        Data::Union(s) => {
            return quote_spanned! {s.union_token.span => compile_error!("only enum may implement ProtocolMessage");}.into()
        }
    };

    let name = input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
    let round_method_impl = if !enum_data.variants.is_empty() {
        round_method(&name, enum_data.variants.iter())
    } else {
        // Special case for empty enum. Empty protocol message is useless, but let it be
        quote! { match *self {} }
    };

    let impl_protocol_message = quote! {
        impl #impl_generics #root_path::ProtocolMessage for #name #ty_generics #where_clause {
            fn round(&self) -> u16 {
                #round_method_impl
            }
        }
    };

    let impl_round_message = round_messages(
        &root_path,
        &name,
        &input.generics,
        enum_data.variants.iter(),
    );

    proc_macro::TokenStream::from(quote! {
        #impl_protocol_message
        #impl_round_message
    })
}

fn round_method<'v>(enum_name: &Ident, variants: impl Iterator<Item = &'v Variant>) -> TokenStream {
    let match_variants = (0u16..).zip(variants).map(|(i, variant)| {
        let variant_name = &variant.ident;
        match &variant.fields {
            Fields::Unit => quote_spanned! {
                variant.ident.span() =>
                #enum_name::#variant_name => compile_error!("unit variants are not allowed in ProtocolMessage"),
            },
            Fields::Named(_) => quote_spanned! {
                variant.ident.span() =>
                #enum_name::#variant_name{..} => compile_error!("named variants are not allowed in ProtocolMessage"),
            },
            Fields::Unnamed(unnamed) => if unnamed.unnamed.len() == 1 {
                quote_spanned! {
                    variant.ident.span() =>
                    #enum_name::#variant_name(_) => #i,
                }
            } else {
                quote_spanned! {
                    variant.ident.span() =>
                    #enum_name::#variant_name(..) => compile_error!("this variant must contain exactly one field to be valid ProtocolMessage"),
                }
            },
        }
    });
    quote! {
        match self {
            #(#match_variants)*
        }
    }
}

fn round_messages<'v>(
    root_path: &RootPath,
    enum_name: &Ident,
    generics: &Generics,
    variants: impl Iterator<Item = &'v Variant>,
) -> TokenStream {
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
    let impls = (0u16..).zip(variants).map(|(i, variant)| {
        let variant_name = &variant.ident;
        match &variant.fields {
            Fields::Unnamed(unnamed) if unnamed.unnamed.len() == 1 => {
                let msg_type = &unnamed.unnamed[0].ty;
                quote_spanned! {
                    variant.ident.span() =>
                    impl #impl_generics #root_path::RoundMessage<#msg_type> for #enum_name #ty_generics #where_clause {
                        const ROUND: u16 = #i;
                        fn to_protocol_message(round_message: #msg_type) -> Self {
                            #enum_name::#variant_name(round_message)
                        }
                        fn from_protocol_message(protocol_message: Self) -> Result<#msg_type, Self> {
                            #[allow(unreachable_patterns)]
                            match protocol_message {
                                #enum_name::#variant_name(msg) => Ok(msg),
                                _ => Err(protocol_message),
                            }
                        }
                    }
                }
            }
            _ => quote! {},
        }
    });
    quote! {
        #(#impls)*
    }
}

type RootPath = Punctuated<Ident, Token![::]>;

#[allow(dead_code)]
struct RootAttribute {
    paren: syn::token::Paren,
    root: kw::root,
    eq: Token![=],
    path: RootPath,
}

impl Parse for RootAttribute {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let content;
        let paren = syn::parenthesized!(content in input);
        let root = content.parse::<kw::root>()?;
        let eq = content.parse::<Token![=]>()?;
        let path = RootPath::parse_separated_nonempty_with(&content, Ident::parse_any)?;
        let _ = content.parse::<syn::parse::Nothing>()?;

        Ok(Self {
            paren,
            root,
            eq,
            path,
        })
    }
}

mod kw {
    syn::custom_keyword! { root }
}