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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
use std::collections::HashMap;

use darling::{FromDeriveInput, FromField, FromMeta, FromVariant};
use proc_macro2::{Span, TokenStream};
use quote::{format_ident, quote, quote_spanned};
use syn::{parse_macro_input, spanned::Spanned, DeriveInput, LitStr, Token};

#[derive(FromField)]
struct TokenVariantField {
    ident: Option<syn::Ident>,
}

struct TokenDisplay {
    format: String,
    args: Vec<String>,
}

impl FromMeta for TokenDisplay {
    fn from_string(value: &str) -> darling::Result<Self> {
        Ok(Self {
            format: value.to_owned(),
            args: vec![],
        })
    }

    fn from_list(items: &[darling::ast::NestedMeta]) -> darling::Result<Self> {
        Ok(Self {
            format: String::from_nested_meta(
                items
                    .first()
                    .ok_or_else(|| darling::Error::custom("missing format string"))?,
            )?,
            args: items
                .iter()
                .skip(1)
                .map(String::from_nested_meta)
                .collect::<Result<Vec<_>, _>>()?,
        })
    }
}

struct TokenAttr {
    token: String,
}

impl FromMeta for TokenAttr {
    fn from_list(items: &[darling::ast::NestedMeta]) -> darling::Result<Self> {
        Ok(Self {
            token: String::from_nested_meta(
                items
                    .first()
                    .ok_or_else(|| darling::Error::custom("missing token literal"))?,
            )?,
        })
    }
}

enum AsParser {
    Path(syn::Path),
    RawString(String),
}

impl FromMeta for AsParser {
    fn from_string(value: &str) -> darling::Result<Self> {
        Ok(Self::RawString(value.to_owned()))
    }

    fn from_nested_meta(item: &darling::ast::NestedMeta) -> darling::Result<Self> {
        match item {
            darling::ast::NestedMeta::Meta(syn::Meta::Path(p)) => Ok(Self::Path(p.to_owned())),
            _ => Err(darling::Error::unsupported_format("meta")),
        }
    }

    fn from_list(items: &[darling::ast::NestedMeta]) -> darling::Result<Self> {
        if let Some(item) = items.first() {
            return Self::from_nested_meta(item);
        }

        Err(darling::Error::unsupported_format("list"))
    }
}

#[derive(FromVariant)]
#[darling(attributes(lang_util), forward_attrs(token))]
struct TokenVariant {
    ident: syn::Ident,
    fields: darling::ast::Fields<TokenVariantField>,
    attrs: Vec<syn::Attribute>,
    #[darling(default)]
    display: Option<TokenDisplay>,
    #[darling(default, rename = "parser")]
    as_parser: Option<AsParser>,
    #[darling(default, rename = "token")]
    fallback_token: Option<String>,
    #[darling(multiple, rename = "kind")]
    kinds: Vec<String>,
}

struct Token<'s> {
    base_ident: &'s syn::Ident,
    variant: &'s TokenVariant,
    token: TokenAttrTy<'s>,
    as_parser: Result<String, AsParserError>,
}

impl<'s> Token<'s> {
    fn empty_variant_header(&self) -> TokenStream {
        let variant_name = &self.variant.ident;
        let variant_header = match &self.variant.fields.style {
            darling::ast::Style::Tuple => {
                let fields = self
                    .variant
                    .fields
                    .fields
                    .iter()
                    .map(|_| Token![_](Span::call_site()));

                quote! { #variant_name ( #(#fields),* ) }
            }
            darling::ast::Style::Struct => {
                quote! { .. }
            }
            darling::ast::Style::Unit => quote! { #variant_name },
        };

        let base_ident = self.base_ident;
        quote_spanned! { self.variant.ident.span() => #base_ident :: #variant_header }
    }

    fn variant_name_arm(&self) -> TokenStream {
        let variant_header = self.empty_variant_header();

        let body = {
            let value = &self.variant.ident.to_string();
            quote_spanned! { self.variant.ident.span() => #value }
        };

        quote_spanned! {
            self.variant.ident.span() =>
                #variant_header => #body
        }
    }

    fn parser_token_body(&self) -> TokenStream {
        match &self.as_parser {
            Ok(value) => quote_spanned! { self.variant.ident.span() => #value },
            Err(error) => {
                let error = error.to_string();
                quote_spanned! {
                    self.variant.ident.span() =>
                        compile_error!(#error)
                }
            }
        }
    }

    fn parser_token_arm(&self) -> TokenStream {
        let variant_header = self.empty_variant_header();
        let body = self.parser_token_body();

        quote_spanned! {
            self.variant.ident.span() =>
                #variant_header => #body
        }
    }

    fn kinds_body(&self) -> TokenStream {
        if self.variant.kinds.is_empty() {
            if let Some((token, attr)) = &self.token {
                match token {
                    Ok(value) => {
                        let value = &value.token;
                        quote_spanned! { self.variant.ident.span() => &[#value] }
                    }
                    Err(error) => {
                        let s = format!("invalid token attribute: {}", error);
                        quote_spanned! {
                            attr.span() =>
                                compile_error!(#s)
                        }
                    }
                }
            } else {
                quote_spanned! {
                    self.variant.ident.span() =>
                        compile_error!("cannot determine token kind for this token")
                }
            }
        } else {
            let kinds = &self.variant.kinds;

            if let Some((Ok(token), _)) = &self.token {
                let value = &token.token;
                quote_spanned! { self.variant.ident.span() => &[#(#kinds),*, #value] }
            } else {
                quote_spanned! { self.variant.ident.span() => &[#(#kinds),*] }
            }
        }
    }

    fn kinds_arm(&self) -> TokenStream {
        let variant_header = self.empty_variant_header();
        let body = self.kinds_body();

        quote_spanned! {
            self.variant.ident.span() =>
                #variant_header => #body
        }
    }

    fn get_prefixed_fmt(&self, base_fmt: &str) -> String {
        if self.variant.kinds.is_empty() {
            format!("`{}`", base_fmt)
        } else {
            format!("{} `{}`", self.variant.kinds.last().unwrap(), base_fmt)
        }
    }

    fn display_arm_body(&self, declared_fields: &[syn::Ident]) -> TokenStream {
        match self.variant.fields.style {
            darling::ast::Style::Tuple => {
                if let Some(display) = &self.variant.display {
                    let fmt = &display.format;

                    // TODO: Better than this ugly format string parsing?
                    let args = if display.args.is_empty() {
                        if declared_fields.len() == 1 && display.format.contains("{}") {
                            let f = &declared_fields[0];
                            vec![quote_spanned! { self.variant.ident.span() => #f }]
                        } else {
                            declared_fields
                                .iter()
                                .enumerate()
                                .filter_map(|(i, df)| {
                                    let ph = format!("_{}", i);

                                    if fmt.contains(&ph) {
                                        let ph = format_ident!("{}", ph);
                                        Some(quote_spanned! { self.variant.ident.span() => #ph = #df })
                                    } else {
                                        None
                                    }
                                })
                                .collect()
                        }
                    } else {
                        let mut repl = Vec::new();
                        for (i, df) in declared_fields.iter().enumerate() {
                            repl.push((format!("_{}", i), df.to_string()));
                        }

                        display
                            .args
                            .iter()
                            .map(|arg| {
                                let mut arg = arg.clone();
                                for (src, dst) in &repl {
                                    arg = arg.replace(src, dst);
                                }

                                syn::parse_str(&arg).expect("parsing error")
                            })
                            .collect()
                    };

                    let fmt = self.get_prefixed_fmt(fmt);
                    return quote_spanned! {
                        self.variant.ident.span() =>
                            write!(f, #fmt, #(#args),*)
                    };
                } else {
                    // No display attribute, check if we can have a sensible default
                    if declared_fields.len() == 1 {
                        let v1 = &declared_fields[0];
                        let fmt = self.get_prefixed_fmt("{}");
                        return quote_spanned! {
                            self.variant.ident.span() =>
                                write!(f, #fmt, #v1)
                        };
                    }
                }
            }
            darling::ast::Style::Struct => {
                return quote_spanned! {
                    self.variant.ident.span() =>
                        compile_error!("struct variants are not supported yet by derive(Token)")
                };
            }
            darling::ast::Style::Unit => {
                // Unit struct, is there a token impl?
                if let Some((token, attr)) = &self.token {
                    return match token {
                        Ok(value) => {
                            let value = &value.token;
                            let fmt = self.get_prefixed_fmt("{}");
                            quote_spanned! { self.variant.ident.span() => write!(f, #fmt, #value) }
                        }
                        Err(error) => {
                            let s = format!("invalid token attribute: {}", error);
                            quote_spanned! {
                                attr.span() =>
                                    compile_error!(#s)
                            }
                        }
                    };
                } else if let Some(display) = &self.variant.display {
                    let value = &display.format;
                    let fmt = self.get_prefixed_fmt("{}");
                    return quote_spanned! { self.variant.ident.span() => write!(f, #fmt, #value) };
                }
            }
        }

        quote_spanned! {
            self.variant.ident.span() =>
                compile_error!("missing token or lang_util(display(...)) attributes")
        }
    }

    fn display_arm(&self) -> TokenStream {
        // Create arm header
        let variant_name = &self.variant.ident;
        let (variant_header, declared_fields) = match &self.variant.fields.style {
            darling::ast::Style::Tuple => {
                let fields: Vec<_> = self
                    .variant
                    .fields
                    .fields
                    .iter()
                    .enumerate()
                    .map(|(i, _field)| format_ident!("value_{}", i))
                    .collect();

                (
                    quote_spanned! { self.variant.ident.span() => #variant_name ( #(#fields),* ) },
                    fields,
                )
            }
            darling::ast::Style::Struct => {
                let fields: Vec<_> = self
                    .variant
                    .fields
                    .fields
                    .iter()
                    .map(|field| field.ident.as_ref().unwrap().clone())
                    .collect();

                (
                    quote_spanned! { self.variant.ident.span() => #variant_name { #(#fields),* } },
                    fields,
                )
            }
            darling::ast::Style::Unit => (quote! { #variant_name }, vec![]),
        };

        // Create arm body
        let body = self.display_arm_body(&declared_fields);

        let base_ident = self.base_ident;
        quote_spanned! {
            self.variant.ident.span() =>
                #base_ident :: #variant_header => { #body }
        }
    }

    fn all_tokens_arm(&self) -> TokenStream {
        let variant_name = self.variant.ident.to_string();
        let parser_token = self.parser_token_body();
        let kinds = self.kinds_body();

        quote_spanned! {
            self.variant.ident.span() =>
                ::lang_util::token::TokenDescriptor::new(#variant_name, #parser_token, #kinds)
        }
    }
}

type TokenAttrTy<'s> = Option<(darling::Result<TokenAttr>, proc_macro2::Span)>;

fn parse_token_attr(variant: &TokenVariant) -> TokenAttrTy {
    // Unit struct, is there a token impl?
    for attr in variant.attrs.iter() {
        if attr.path().is_ident("token") {
            return Some((
                if let Ok(result) = attr.parse_args::<LitStr>() {
                    Ok(TokenAttr {
                        token: result.value(),
                    })
                } else {
                    attr.parse_args()
                        .map_err(darling::Error::custom)
                        .and_then(|meta| TokenAttr::from_meta(&meta))
                },
                attr.span(),
            ));
        }
    }

    // Check for the fallback attr
    if let Some(fallback) = &variant.fallback_token {
        return Some((
            Ok(TokenAttr {
                token: fallback.clone(),
            }),
            proc_macro2::Span::call_site(),
        ));
    }

    None
}

#[derive(Debug)]
enum AsParserError {
    MissingDisplayImpl,
    InvalidAs,
    InvalidTokenAttribute(String),
    NoTokenOrAs,
}

impl std::fmt::Display for AsParserError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::MissingDisplayImpl => write!(f, "in lang_util attribute, `parser = display` specified but not display implementation provided"),
            Self::InvalidAs => write!(f, "invalid `parser` value, expected display or a literal string"),
            Self::InvalidTokenAttribute(error) => write!(f, "invalid token attribute: {}", error),
            Self::NoTokenOrAs => write!(f, "missing token or lang_util(parser = \"...\") attributes"),
        }
    }
}

fn parse_as_parser(variant: &TokenVariant, token: &TokenAttrTy) -> Result<String, AsParserError> {
    if let Some(as_parser) = &variant.as_parser {
        match as_parser {
            AsParser::Path(path) => {
                if path.get_ident().map(|id| id == "display").unwrap_or(false) {
                    if let Some(display) = &variant.display {
                        Ok(format!("\"{}\"", &display.format))
                    } else {
                        Err(AsParserError::MissingDisplayImpl)
                    }
                } else {
                    Err(AsParserError::InvalidAs)
                }
            }
            AsParser::RawString(s) => Ok(s.to_owned()),
        }
    } else if let Some((token, _)) = &token {
        match token {
            Ok(value) => {
                // Tokens would be wrapped with quotes
                Ok(format!("\"{}\"", &value.token))
            }
            Err(error) => Err(AsParserError::InvalidTokenAttribute(error.to_string())),
        }
    } else {
        Err(AsParserError::NoTokenOrAs)
    }
}

impl<'s> From<(&'s syn::Ident, &'s TokenVariant)> for Token<'s> {
    fn from((base_ident, variant): (&'s syn::Ident, &'s TokenVariant)) -> Self {
        let token = parse_token_attr(variant);
        let as_parser = parse_as_parser(variant, &token);

        Self {
            base_ident,
            variant,
            token,
            as_parser,
        }
    }
}

#[derive(FromDeriveInput)]
#[darling(attributes(lang_util))]
struct TokenOpts {
    ident: syn::Ident,
    generics: syn::Generics,
    data: darling::ast::Data<TokenVariant, ()>,
}

fn display_impl(
    base_ident: &syn::Ident,
    enum_name: &TokenStream,
    variants: &[Token],
) -> TokenStream {
    let arms = variants.iter().map(Token::display_arm);

    quote_spanned! {
        base_ident.span() =>
            impl ::std::fmt::Display for #enum_name {
                fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
                    match self {
                        #(#arms),*
                    }
                }
            }
    }
}

fn token_impl(base_ident: &syn::Ident, enum_name: &TokenStream, variants: &[Token]) -> TokenStream {
    let variant_name_arms = variants.iter().map(Token::variant_name_arm);
    let parser_token_arms = variants.iter().map(Token::parser_token_arm);
    let kinds_arms = variants.iter().map(Token::kinds_arm);
    let all_tokens_arms = variants.iter().map(Token::all_tokens_arm);

    let id = format_ident!("__{}_TOKENS", base_ident.to_string().to_uppercase());
    let cnt = variants.len();

    quote_spanned! {
        base_ident.span() =>
            static #id: [::lang_util::token::TokenDescriptor; #cnt] = [
                #(#all_tokens_arms),*
            ];

            impl ::lang_util::token::Token for #enum_name {
                fn variant_name(&self) -> &'static str {
                    match self {
                        #(#variant_name_arms),*
                    }
                }

                fn parser_token(&self) -> &'static str {
                    match self {
                        #(#parser_token_arms),*
                    }
                }

                fn kinds(&self) -> &'static [&'static str] {
                    match self {
                        #(#kinds_arms),*
                    }
                }

                fn all_tokens() -> &'static [::lang_util::token::TokenDescriptor] {
                    &#id
                }
            }
    }
}

pub(crate) fn token(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let opts = {
        // Parse the input tokens into a syntax tree
        let input = parse_macro_input!(input as DeriveInput);
        // Find out enum-level options
        match TokenOpts::from_derive_input(&input) {
            Ok(res) => res,
            Err(err) => return err.write_errors().into(),
        }
    };

    let base_ident = &opts.ident;

    // Extract enum fields
    let fields = match &opts.data {
        darling::ast::Data::Enum(fields) => fields,
        darling::ast::Data::Struct(_) => {
            return proc_macro::TokenStream::from(quote_spanned! {
                opts.ident.span() =>
                    compile_error!("only enums can be used as tokens with derive(Token)")
            })
        }
    };

    // Create the Token structs
    let fields: Vec<Token> = fields
        .iter()
        .map(|variant| (base_ident, variant).into())
        .collect();

    // All declarations
    let mut decls = Vec::new();

    // Check unicity of the as declarations
    let mut seen: HashMap<_, &Token> = HashMap::new();
    for decl in &fields {
        if let Ok(as_parser) = &decl.as_parser {
            if let Some(previous) = seen.get(as_parser) {
                let s = format!(
                    "`{}` parser token already declared by variant {}",
                    as_parser, previous.variant.ident
                );
                decls.push(quote_spanned! { decl.variant.ident.span() => compile_error!(#s); });
            } else {
                seen.insert(as_parser, decl);
            }
        }
    }

    // Compute enum name
    let enum_name = {
        // Add anonymous lifetimes as needed
        let lifetimes: Vec<_> = opts.generics.lifetimes().map(|_| quote! { '_ }).collect();

        if lifetimes.is_empty() {
            quote! { #base_ident }
        } else {
            quote! { #base_ident<#(#lifetimes),*> }
        }
    };

    decls.push(display_impl(base_ident, &enum_name, &fields));
    decls.push(token_impl(base_ident, &enum_name, &fields));

    proc_macro::TokenStream::from(quote_spanned! {
        opts.ident.span() =>
            #(#decls)*
    })
}