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
use std::collections::HashSet;

use devise::{*, ext::{TypeExt, SpanDiagnosticExt}};

use syn::{visit_mut::VisitMut, visit::Visit};
use proc_macro2::{TokenStream, TokenTree, Span};
use quote::{ToTokens, TokenStreamExt};

use crate::syn_ext::IdentExt;
use crate::name::Name;

#[derive(Debug)]
pub enum FieldName {
    Cased(Name),
    Uncased(Name),
}

#[derive(FromMeta)]
pub struct FieldAttr {
    pub name: Option<FieldName>,
    pub validate: Option<SpanWrapped<syn::Expr>>,
    pub default: Option<syn::Expr>,
    pub default_with: Option<syn::Expr>,
}

impl FieldAttr {
    const NAME: &'static str = "field";
}

pub(crate) trait FieldExt {
    fn ident(&self) -> Option<&syn::Ident>;
    fn member(&self) -> syn::Member;
    fn context_ident(&self) -> syn::Ident;
    fn field_names(&self) -> Result<Vec<FieldName>>;
    fn first_field_name(&self) -> Result<Option<FieldName>>;
    fn stripped_ty(&self) -> syn::Type;
    fn name_buf_opt(&self) -> Result<TokenStream>;
}

#[derive(FromMeta)]
pub struct VariantAttr {
    pub value: Name,
}

impl VariantAttr {
    const NAME: &'static str = "field";
}

pub(crate) trait VariantExt {
    fn first_form_field_value(&self) -> Result<FieldName>;
    fn form_field_values(&self) -> Result<Vec<FieldName>>;
}

impl VariantExt for Variant<'_> {
    fn first_form_field_value(&self) -> Result<FieldName> {
        let value = VariantAttr::from_attrs(VariantAttr::NAME, &self.attrs)?
            .into_iter()
            .next()
            .map(|attr| FieldName::Uncased(attr.value))
            .unwrap_or_else(|| FieldName::Uncased(Name::from(&self.ident)));

        Ok(value)
    }

    fn form_field_values(&self) -> Result<Vec<FieldName>> {
        let attr_values = VariantAttr::from_attrs(VariantAttr::NAME, &self.attrs)?
            .into_iter()
            .map(|attr| FieldName::Uncased(attr.value))
            .collect::<Vec<_>>();

        if attr_values.is_empty() {
            return Ok(vec![FieldName::Uncased(Name::from(&self.ident))]);
        }

        Ok(attr_values)
    }
}

impl FromMeta for FieldName {
    fn from_meta(meta: &MetaItem) -> Result<Self> {
        // These are used during parsing.
        const CONTROL_CHARS: &[char] = &['&', '=', '?', '.', '[', ']'];

        fn is_valid_field_name(s: &str) -> bool {
            // The HTML5 spec (4.10.18.1) says 'isindex' is not allowed.
            if s == "isindex" || s.is_empty() {
                return false
            }

            // We allow all visible ASCII characters except `CONTROL_CHARS`.
            s.chars().all(|c| c.is_ascii_graphic() && !CONTROL_CHARS.contains(&c))
        }

        let field_name = match Name::from_meta(meta) {
            Ok(name) => FieldName::Cased(name),
            Err(_) => {
                #[derive(FromMeta)]
                struct Inner {
                    #[meta(naked)]
                    uncased: Name
                }

                let expr = meta.expr()?;
                let item: MetaItem = syn::parse2(quote!(#expr))?;
                let inner = Inner::from_meta(&item)?;
                FieldName::Uncased(inner.uncased)
            }
        };

        if !is_valid_field_name(field_name.as_str()) {
            let chars = CONTROL_CHARS.iter()
                .map(|c| format!("{:?}", c))
                .collect::<Vec<_>>()
                .join(", ");

            return Err(meta.value_span()
                .error("invalid form field name")
                .help(format!("field name cannot be `isindex` or contain {}", chars)));
        }

        Ok(field_name)
    }
}

impl std::ops::Deref for FieldName {
    type Target = Name;

    fn deref(&self) -> &Self::Target {
        match self {
            FieldName::Cased(n) | FieldName::Uncased(n) => n,
        }
    }
}

impl ToTokens for FieldName {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        (self as &Name).to_tokens(tokens)
    }
}

impl PartialEq for FieldName {
    fn eq(&self, other: &Self) -> bool {
        use FieldName::*;

        match (self, other) {
            (Cased(a), Cased(b)) => a == b,
            (Cased(a), Uncased(u)) | (Uncased(u), Cased(a)) => a == u.as_uncased_str(),
            (Uncased(u1), Uncased(u2)) => u1.as_uncased_str() == u2.as_uncased_str(),
        }
    }
}

fn member_to_ident(member: syn::Member) -> syn::Ident {
    match member {
        syn::Member::Named(ident) => ident,
        syn::Member::Unnamed(i) => format_ident!("__{}", i.index, span = i.span),
    }
}

impl FieldExt for Field<'_> {
    fn ident(&self) -> Option<&syn::Ident> {
        self.ident.as_ref()
    }

    fn member(&self) -> syn::Member {
        match self.ident().cloned() {
            Some(ident) => syn::Member::Named(ident),
            None => syn::Member::Unnamed(syn::Index {
                index: self.index as u32,
                span: self.ty.span()
            })
        }
    }

    /// Returns the ident used by the context generated for the `FromForm` impl.
    /// This is _not_ the field's ident and should not be used as such.
    fn context_ident(&self) -> syn::Ident {
        member_to_ident(self.member())
    }

    // With named existentials, this could return an `impl Iterator`...
    fn field_names(&self) -> Result<Vec<FieldName>> {
        let attr_names = FieldAttr::from_attrs(FieldAttr::NAME, &self.attrs)?
            .into_iter()
            .filter_map(|attr| attr.name)
            .collect::<Vec<_>>();

        if attr_names.is_empty() {
            if let Some(ident) = self.ident() {
                return Ok(vec![FieldName::Cased(Name::from(ident))]);
            }
        }

        Ok(attr_names)
    }

    fn first_field_name(&self) -> Result<Option<FieldName>> {
        Ok(self.field_names()?.into_iter().next())
    }

    fn stripped_ty(&self) -> syn::Type {
        self.ty.with_stripped_lifetimes()
    }

    fn name_buf_opt(&self) -> Result<TokenStream> {
        let (span, field_names) = (self.span(), self.field_names()?);
        define_spanned_export!(span => _form);

        Ok(field_names.first()
            .map(|name| quote_spanned!(span => Some(#_form::NameBuf::from((__c.__parent, #name)))))
            .unwrap_or_else(|| quote_spanned!(span => None::<#_form::NameBuf>)))
    }
}

#[derive(Default)]
struct RecordMemberAccesses {
    reference: bool,
    accesses: HashSet<(syn::Ident, bool)>,
}

impl<'a> Visit<'a> for RecordMemberAccesses {
    fn visit_expr_reference(&mut self, i: &'a syn::ExprReference) {
        self.reference = true;
        syn::visit::visit_expr_reference(self, i);
        self.reference = false;
    }

    fn visit_expr_field(&mut self, i: &syn::ExprField) {
        if let syn::Expr::Path(e) = &*i.base {
            if e.path.is_ident("self") {
                let ident = member_to_ident(i.member.clone());
                self.accesses.insert((ident, self.reference));
            }
        }

        syn::visit::visit_expr_field(self, i);
    }
}

struct ValidationMutator<'a> {
    field: Field<'a>,
    visited: bool,
}

impl ValidationMutator<'_> {
    fn visit_token_stream(&mut self, tt: TokenStream) -> TokenStream {
        use TokenTree::*;

        let mut iter = tt.into_iter();
        let mut stream = TokenStream::new();
        while let Some(tt) = iter.next() {
            match tt {
                Ident(s3lf) if s3lf == "self" => {
                    match (iter.next(), iter.next()) {
                        (Some(Punct(p)), Some(Ident(i))) if p.as_char() == '.' => {
                            let field = syn::parse_quote!(#s3lf #p #i);
                            let mut expr = syn::Expr::Field(field);
                            self.visit_expr_mut(&mut expr);
                            expr.to_tokens(&mut stream);
                        },
                        (tt1, tt2) => stream.append_all(&[Some(Ident(s3lf)), tt1, tt2]),
                    }
                },
                TokenTree::Group(group) => {
                    let tt = self.visit_token_stream(group.stream());
                    let mut new = proc_macro2::Group::new(group.delimiter(), tt);
                    new.set_span(group.span());
                    let group = TokenTree::Group(new);
                    stream.append(group);
                }
                tt => stream.append(tt),
            }
        }

        stream
    }
}

impl VisitMut for ValidationMutator<'_> {
    fn visit_expr_call_mut(&mut self, call: &mut syn::ExprCall) {
        // Only modify the first call we see.
        if self.visited {
            return syn::visit_mut::visit_expr_call_mut(self, call);
        }

        self.visited = true;
        let accessor = self.field.context_ident().with_span(self.field.ty.span());
        call.args.insert(0, syn::parse_quote!(#accessor));
        syn::visit_mut::visit_expr_call_mut(self, call);
    }

    fn visit_macro_mut(&mut self, mac: &mut syn::Macro) {
        mac.tokens = self.visit_token_stream(mac.tokens.clone());
        syn::visit_mut::visit_macro_mut(self, mac);
    }

    fn visit_ident_mut(&mut self, i: &mut syn::Ident) {
        // replace `self` with the context ident
        if i == "self" {
            *i = self.field.context_ident().with_span(self.field.ty.span());
        }
    }

    fn visit_expr_mut(&mut self, i: &mut syn::Expr) {
        fn inner_field(i: &syn::Expr) -> Option<syn::Expr> {
            if let syn::Expr::Field(e) = i {
                if let syn::Expr::Path(p) = &*e.base {
                    if p.path.is_ident("self") {
                        let member = &e.member;
                        return Some(syn::parse_quote!(#member));
                    }
                }
            }

            None
        }

        // replace `self.field` and `&self.field` with `field`
        if let syn::Expr::Reference(r) = i {
            if let Some(expr) = inner_field(&r.expr) {
                if let Some(ref m) = r.mutability {
                    m.span()
                        .warning("`mut` has no effect in FromForm` validation")
                        .note("`mut` is being discarded")
                        .emit_as_item_tokens();
                }

                *i = expr;
            }
        } else if let Some(expr) = inner_field(&i) {
            *i = expr;
        }

        syn::visit_mut::visit_expr_mut(self, i);
    }
}

pub fn validators<'v>(field: Field<'v>) -> Result<impl Iterator<Item = syn::Expr> + 'v> {
    Ok(FieldAttr::from_attrs(FieldAttr::NAME, &field.attrs)?
        .into_iter()
        .chain(FieldAttr::from_attrs(FieldAttr::NAME, field.parent.attrs())?)
        .filter_map(|a| a.validate)
        .map(move |mut expr| {
            let mut record = RecordMemberAccesses::default();
            record.accesses.insert((field.context_ident(), true));
            record.visit_expr(&expr);

            let mut v = ValidationMutator { field, visited: false };
            v.visit_expr_mut(&mut expr);

            let span = expr.key_span.unwrap_or(field.ty.span());
            let matchers = record.accesses.iter().map(|(member, _)| member);
            let values = record.accesses.iter()
                .map(|(member, is_ref)| {
                    if *is_ref { quote_spanned!(span => &#member) }
                    else { quote_spanned!(span => #member) }
                });

            let matchers = quote_spanned!(span => (#(Some(#matchers)),*));
            let values = quote_spanned!(span => (#(#values),*));
            let name_opt = field.name_buf_opt().unwrap();

            define_spanned_export!(span => _form);
            let expr: syn::Expr = syn::parse_quote_spanned!(span => {
                #[allow(unused_parens)]
                let __result: #_form::Result<'_, ()> = match #values {
                    #matchers => #expr,
                    _ => Ok(()),
                };

                let __e_name = #name_opt;
                __result.map_err(|__e| match __e_name {
                    Some(__name) => __e.with_name(__name),
                    None => __e
                })
            });

            expr
        }))
}

/// Take an $expr in `default = $expr` and turn it into a `Some($expr.into())`.
///
/// As a result of calling `into()`, type inference fails for two common
/// expressions: integer literals and the bare `None`. As a result, we cheat: if
/// the expr matches either condition, we pass them through unchanged.
fn default_expr(expr: &syn::Expr) -> TokenStream {
    use syn::{Expr, Lit, ExprLit};

    if matches!(expr, Expr::Path(e) if e.path.is_ident("None")) {
        quote!(#expr)
    } else if matches!(expr, Expr::Lit(ExprLit { lit: Lit::Int(_), .. })) {
        quote_spanned!(expr.span() => Some(#expr))
    } else {
        quote_spanned!(expr.span() => Some({ #expr }.into()))
    }
}

pub fn default<'v>(field: Field<'v>) -> Result<Option<TokenStream>> {
    let field_attrs = FieldAttr::from_attrs(FieldAttr::NAME, &field.attrs)?;
    let parent_attrs = FieldAttr::from_attrs(FieldAttr::NAME, field.parent.attrs())?;

    // Expressions in `default = `, except for `None`, are wrapped in `Some()`.
    let mut expr = field_attrs.iter()
        .chain(parent_attrs.iter())
        .filter_map(|a| a.default.as_ref()).map(default_expr);

    // Expressions in `default_with` are passed through directly.
    let mut expr_with = field_attrs.iter()
        .chain(parent_attrs.iter())
        .filter_map(|a| a.default_with.as_ref())
        .map(|e| e.to_token_stream());

    // Pull the first `default` and `default_with` expressions.
    let (default, default_with) = (expr.next(), expr_with.next());

    // If there are any more of either, emit an error.
    if let (Some(e), _) | (_, Some(e)) = (expr.next(), expr_with.next()) {
        return Err(e.span()
            .error("duplicate default field expression")
            .help("at most one `default` or `default_with` is allowed"));
    }

    // Emit the final expression of type `Option<#ty>` unless both `default` and
    // `default_with` were provided in which case we error.
    let ty = field.stripped_ty();
    match (default, default_with) {
        (Some(e1), Some(e2)) => {
            Err(e1.span()
                .error("duplicate default expressions")
                .help("only one of `default` or `default_with` must be used")
                .span_note(e2.span(), "other default expression is here"))
        },
        (Some(e), None) | (None, Some(e)) => {
            Ok(Some(quote_spanned!(e.span() => {
                let __default: Option<#ty> = if __opts.strict {
                    None
                } else {
                    #e
                };

                __default
            })))
        },
        (None, None) => Ok(None)
    }
}

pub fn first_duplicate<K: Spanned, V: PartialEq + Spanned>(
    keys: impl Iterator<Item = K> + Clone,
    values: impl Fn(&K) -> Result<Vec<V>>,
) -> Result<Option<((usize, Span, Span), (usize, Span, Span))>> {
    let (mut all_values, mut key_map) = (vec![], vec![]);
    for key in keys {
        all_values.append(&mut values(&key)?);
        key_map.push((all_values.len(), key));
    }

    // get the key corresponding to all_value index `k`.
    let key = |k| key_map.iter().find(|(i, _)| k < *i).expect("k < *i");

    for (i, a) in all_values.iter().enumerate() {
        let mut rest = all_values.iter().enumerate().skip(i + 1);
        if let Some((j, b)) = rest.find(|(_, b)| *b == a) {
            let (a_i, key_a) = key(i);
            let (b_i, key_b) = key(j);

            let a = (*a_i, key_a.span(), a.span());
            let b = (*b_i, key_b.span(), b.span());
            return Ok(Some((a, b)));
        }
    }

    Ok(None)
}