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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]

use proc_macro::TokenStream;
use proc_macro2::{Span as Span2, TokenStream as TokenStream2};
use quote::{quote, ToTokens};
use syn::{
    parenthesized,
    parse::{Parse, ParseStream},
    parse_macro_input,
    punctuated::Punctuated,
    Expr, GenericParam, Ident, Result, Token, Type,
};

/// Parses either an identifier or an underscore for arguments of specializations.
// TODO(ozars): Make this accept patterns for unpacking arguments. Maybe switch to using
// `syn::PatType`.
#[derive(Debug, Eq, PartialEq, Clone)]
enum FnArgName {
    Ident(Ident),
    Underscore(Token![_]),
}

impl Parse for FnArgName {
    fn parse(input: ParseStream) -> Result<Self> {
        if input.peek(Ident) {
            Ok(Self::Ident(input.parse()?))
        } else if input.peek(Token![_]) {
            Ok(Self::Underscore(input.parse()?))
        } else {
            Err(input.error("expected identifier or underscore"))
        }
    }
}

impl ToTokens for FnArgName {
    fn to_tokens(&self, tokens: &mut TokenStream2) {
        match self {
            Self::Ident(ident) => ident.to_tokens(tokens),
            Self::Underscore(underscore) => underscore.to_tokens(tokens),
        }
    }
}

/// Function argument with name and type.
#[derive(Debug, Eq, PartialEq, Clone)]
struct FnArg {
    name: FnArgName,
    ty: Type,
}

impl Parse for FnArg {
    fn parse(input: ParseStream) -> Result<Self> {
        let name = input.parse()?;
        let _ = input.parse::<Token![:]>()?;
        let ty = input.parse()?;
        Ok(Self { name, ty })
    }
}

impl ToTokens for FnArg {
    fn to_tokens(&self, tokens: &mut TokenStream2) {
        self.name.to_tokens(tokens);
        Token![:](Span2::mixed_site()).to_tokens(tokens);
        self.ty.to_tokens(tokens);
    }
}

/// Represents an arm for specialized dispatch macro.
#[derive(Debug, Eq, PartialEq)]
struct DispatchArmExpr {
    default: Option<Token![default]>,
    generic_params: Option<Punctuated<GenericParam, Token![,]>>,
    input_expr: FnArg,
    extra_args: Vec<FnArg>,
    body: Expr,
}

impl Parse for DispatchArmExpr {
    fn parse(input: ParseStream) -> Result<Self> {
        let default = input.parse::<Option<Token![default]>>()?;
        let _ = input.parse::<Token![fn]>()?;
        let generic_params = if input.peek(Token![<]) {
            let _ = input.parse::<Token![<]>()?;
            let generic_params =
                Punctuated::<GenericParam, Token![,]>::parse_separated_nonempty(input)?;
            let _ = input.parse::<Token![>]>()?;
            Some(generic_params)
        } else {
            None
        };
        let input_expr_content;
        let _ = parenthesized!(input_expr_content in input);
        let input_expr = input_expr_content.parse()?;
        let extra_args = if input_expr_content.peek(Token![,]) {
            let _ = input_expr_content.parse::<Token![,]>()?;
            Punctuated::<FnArg, Token![,]>::parse_separated_nonempty(&input_expr_content)?
                .into_iter()
                .collect()
        } else {
            Vec::new()
        };
        let _ = input.parse::<Token![=>]>()?;
        let body = input.parse()?;
        Ok(Self {
            default,
            generic_params,
            input_expr,
            extra_args,
            body,
        })
    }
}

/// This is entry point for handling arguments of `specialized_dispatch` macro. It parses arguments
/// of the specialized dispatch macro and expands to the corresponding implementation.
#[derive(Debug, Eq, PartialEq)]
struct SpecializedDispatchExpr {
    from_type: Type,
    to_type: Type,
    arms: Vec<DispatchArmExpr>,
    input_expr: Expr,
    extra_args: Vec<Expr>,
}

/// Parses specialization arms as long as they start with `default` or `fn`.
fn parse_punctuated_arms(input: &ParseStream) -> Result<Punctuated<DispatchArmExpr, Token![,]>> {
    let mut arms = Punctuated::new();
    loop {
        if input.peek(Token![default]) || input.peek(Token![fn]) {
            arms.push(input.parse()?);
        } else {
            break;
        }
        if input.peek(Token![,]) && (input.peek2(Token![default]) || input.peek2(Token![fn])) {
            let _ = input.parse::<Token![,]>()?;
        } else {
            break;
        }
    }
    Ok(arms)
}

impl Parse for SpecializedDispatchExpr {
    fn parse(input: ParseStream) -> Result<Self> {
        let from_type = input.parse()?;
        let _ = input.parse::<Token![->]>()?;
        let to_type = input.parse()?;
        let _ = input.parse::<Token![,]>()?;
        let arms = parse_punctuated_arms(&input)?.into_iter().collect();
        let _ = input.parse::<Token![,]>()?;
        let input_expr = input.parse()?;
        let _ = input.parse::<Token![,]>().ok();
        let extra_args = Punctuated::<Expr, Token![,]>::parse_terminated(input)?
            .into_iter()
            .collect();
        Ok(Self {
            from_type,
            to_type,
            arms,
            input_expr,
            extra_args,
        })
    }
}

/// Generates local helper trait declaration that will be used for specialized dispatch.
fn generate_trait_declaration(
    trait_name: &Ident,
    extra_args: Vec<FnArg>,
    return_type: &Type,
) -> TokenStream2 {
    let tpl = Ident::new("T", Span2::mixed_site());
    quote! {
        trait #trait_name<#tpl> {
            fn dispatch(_: #tpl #(, #extra_args)*) -> #return_type;
        }
    }
}

/// Generates implementation of the helper trait for specialized dispatch arms. This covers both
/// generic case(s) and concrete case(s).
fn generate_trait_implementation(
    default: Option<&Token![default]>,
    trait_name: &Ident,
    generic_params: Option<&Punctuated<GenericParam, Token![,]>>,
    FnArg {
        name: input_expr_name,
        ty: input_expr_type,
    }: &FnArg,
    extra_args: &[FnArg],
    return_type: &Type,
    body: &Expr,
) -> TokenStream2 {
    let generics = generic_params.map(|g| quote! {<#g>});
    quote! {
        impl #generics #trait_name<#input_expr_type> for #input_expr_type {
            #default fn dispatch(#input_expr_name: #input_expr_type #(, #extra_args)*) -> #return_type {
                #body
            }
        }
    }
}

/// Generates the dispatch call to the helper trait.
fn generate_dispatch_call(
    from_type: &Type,
    trait_name: &Ident,
    input_expr: &Expr,
    extra_args: &[Expr],
) -> TokenStream2 {
    quote! {
        <#from_type as #trait_name<#from_type>>::dispatch(#input_expr #(, #extra_args)*)
    }
}

impl ToTokens for SpecializedDispatchExpr {
    fn to_tokens(&self, tokens: &mut TokenStream2) {
        let trait_name = Ident::new("SpecializedDispatchCall", Span2::mixed_site());
        let mut trait_impls = TokenStream2::new();
        let mut extra_args = Vec::new();

        for arm in &self.arms {
            if arm.default.is_some() {
                extra_args.clone_from(&arm.extra_args);
            }
            trait_impls.extend(generate_trait_implementation(
                arm.default.as_ref(),
                &trait_name,
                arm.generic_params.as_ref(),
                &arm.input_expr,
                &arm.extra_args,
                &self.to_type,
                &arm.body,
            ));
        }

        let trait_decl = generate_trait_declaration(&trait_name, extra_args, &self.to_type);

        let dispatch_call = generate_dispatch_call(
            &self.from_type,
            &trait_name,
            &self.input_expr,
            &self.extra_args,
        );

        tokens.extend(quote! {
            {
                #trait_decl
                #trait_impls
                #dispatch_call
            }
        });
    }
}

/// Entry point for the macro. Please see [the crate documentation](`crate`) for
/// more information and example.
#[proc_macro]
pub fn specialized_dispatch(input: TokenStream) -> TokenStream {
    parse_macro_input!(input as SpecializedDispatchExpr)
        .into_token_stream()
        .into()
}

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

    #[test]
    fn parse_arm_with_concrete_type() {
        let arm: DispatchArmExpr = parse_quote!(fn (v: u8) => format!("u8: {}", v));
        assert_eq!(
            arm,
            DispatchArmExpr {
                default: None,
                generic_params: None,
                input_expr: parse_quote!(v: u8),
                extra_args: vec![],
                body: parse_quote!(format!("u8: {}", v)),
            }
        );
    }

    #[test]
    fn parse_arm_with_generic_type() {
        let arm: DispatchArmExpr = parse_quote!(default fn <T>(_: T) => format!("default value"));
        assert_eq!(
            arm,
            DispatchArmExpr {
                default: Some(Default::default()),
                generic_params: Some(parse_quote!(T)),
                input_expr: parse_quote!(_: T),
                extra_args: vec![],
                body: parse_quote!(format!("default value")),
            }
        );
    }

    #[test]
    fn parse_specialized_dispatch_expr() {
        let expr: SpecializedDispatchExpr = parse_quote! {
            E -> String,
            default fn <T>(_: T) => format!("default value"),
            fn (v: u8) => format!("u8: {}", v),
            fn (v: u16) => format!("u16: {}", v),
            expr,
        };
        assert_eq!(
            expr,
            SpecializedDispatchExpr {
                from_type: parse_quote!(E),
                to_type: parse_quote!(String),
                arms: vec![
                    DispatchArmExpr {
                        default: Some(Default::default()),
                        generic_params: Some(parse_quote!(T)),
                        input_expr: parse_quote!(_: T),
                        extra_args: vec![],
                        body: parse_quote!(format!("default value")),
                    },
                    DispatchArmExpr {
                        default: None,
                        generic_params: None,
                        input_expr: parse_quote!(v: u8),
                        extra_args: vec![],
                        body: parse_quote!(format!("u8: {}", v)),
                    },
                    DispatchArmExpr {
                        default: None,
                        generic_params: None,
                        input_expr: parse_quote!(v: u16),
                        extra_args: vec![],
                        body: parse_quote!(format!("u16: {}", v)),
                    },
                ],
                input_expr: parse_quote!(expr),
                extra_args: vec![],
            }
        );
    }

    #[test]
    fn parse_trailing_args() {
        let expr: SpecializedDispatchExpr = parse_quote! {
            E -> String,
            default fn <T>(_: T, arg1: u8, arg2: u16, arg3: &str) => format!("default value"),
            fn (v: u8, arg1: u8, arg2: u16, arg3: &str) => format!("u8: {}", v),
            fn (v: u16, arg1: u8, arg2: u16, arg3: &str) => format!("u16: {}", v),
            expr,
            1u8,
            2u16,
            "bugun_bayram_erken_kalkin_cocuklar",
        };

        assert_eq!(
            expr,
            SpecializedDispatchExpr {
                from_type: parse_quote!(E),
                to_type: parse_quote!(String),
                arms: vec![
                    DispatchArmExpr {
                        default: Some(Default::default()),
                        generic_params: Some(parse_quote!(T)),
                        input_expr: parse_quote!(_: T),
                        extra_args: vec![
                            parse_quote!(arg1: u8),
                            parse_quote!(arg2: u16),
                            parse_quote!(arg3: &str)
                        ],
                        body: parse_quote!(format!("default value")),
                    },
                    DispatchArmExpr {
                        default: None,
                        generic_params: None,
                        input_expr: parse_quote!(v: u8),
                        extra_args: vec![
                            parse_quote!(arg1: u8),
                            parse_quote!(arg2: u16),
                            parse_quote!(arg3: &str)
                        ],
                        body: parse_quote!(format!("u8: {}", v)),
                    },
                    DispatchArmExpr {
                        default: None,
                        generic_params: None,
                        input_expr: parse_quote!(v: u16),
                        extra_args: vec![
                            parse_quote!(arg1: u8),
                            parse_quote!(arg2: u16),
                            parse_quote!(arg3: &str)
                        ],
                        body: parse_quote!(format!("u16: {}", v)),
                    },
                ],
                input_expr: parse_quote!(expr),
                extra_args: vec![
                    parse_quote!(1u8),
                    parse_quote!(2u16),
                    parse_quote!("bugun_bayram_erken_kalkin_cocuklar")
                ],
            }
        );
    }
}