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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
/*!
# Types to represent compounds

A [`Compound`] is either an enum variant or a struct. These types are used by
[`crate::enums`] and [`crate::structs`], as well as for extracted child fields
in order to build the code to convert to/from XML nodes.
*/
use proc_macro2::{Span, TokenStream};

use quote::quote;
use syn::{spanned::Spanned, *};

use crate::common::{FromEventsSubmachine, IntoEventsSubmachine, Scope, ScopeNamespace};
use crate::error_message::ParentRef;
use crate::field::{
    FieldDef, FieldFromEventsPart, FieldIntoEventsPart, FieldTempInit, NestedMatcher,
};
use crate::types::*;

/// Expand the given identifier to resolve as member of the
/// `UnknownChildPolicy` enum. If the identifier is absent, invoke
/// `UnknownChildPolicy::default()` instead.
fn default_on_unknown_child(p: Option<Ident>) -> Expr {
    match p {
        Some(v) => unknown_child_policy_variant(v),
        None => default_value(unknown_child_policy_ty(Span::call_site())),
    }
}

/// Expand the given identifier to resolve as member of the
/// `UnknownAttributePolicy` enum. If the identifier is absent, invoke
/// `UnknownAttributePolicy::default()` instead.
fn default_on_unknown_attribute(p: Option<Ident>) -> Expr {
    match p {
        Some(v) => unknown_attribute_policy_variant(v),
        None => default_value(unknown_attribute_policy_ty(Span::call_site())),
    }
}

/// An struct or enum variant's contents.
///
/// This struct is used to generate the parsing/serialisation loop, but most
/// notably it is *not* responsible for matching the incoming element; that
/// is the responsibility of the caller of the corresponding functions.
#[derive(Debug)]
pub(crate) struct Compound {
    /// The fields, in declaration order.
    fields: Vec<FieldDef>,

    /// Information about the field annotated with `#[xml(namespace)]`, if
    /// any.
    namespace_field: Option<(Span, Type, Member)>,

    /// Member of the `UnknownChildPolicy` enum to use when handling unknown
    /// children.
    on_unknown_child: Expr,

    /// Member of the `UnknownAttributePolicy` enum to use when handling
    /// unknown attributes.
    on_unknown_attribute: Expr,
}

impl Compound {
    /// Construct a new compound from an iterator of [`FieldDef`] structs.
    pub(crate) fn new<T: Iterator<Item = Result<FieldDef>>>(
        on_unknown_child: Option<Ident>,
        on_unknown_attribute: Option<Ident>,
        input: T,
    ) -> Result<Self> {
        let mut fields = Vec::with_capacity(input.size_hint().1.unwrap_or(0));
        let mut text_field: Option<Span> = None;
        let mut namespace_field: Option<(Span, Type, Member)> = None;
        let mut collect_wildcard_field: Option<Span> = None;
        for field in input {
            let field = field?;

            if let Some(ty) = field.namespace_field_type() {
                if namespace_field.is_some() {
                    return Err(Error::new_spanned(
                        field.ident,
                        "only one #[xml(namespace)] field is allowed",
                    ));
                }
                namespace_field = Some((field.span, ty.clone(), field.ident.clone()));
            };

            if field.kind.is_text() {
                if text_field.is_some() {
                    return Err(Error::new_spanned(
                        field.ident,
                        "only one #[xml(text)] field is allowed",
                    ));
                }
                text_field = Some(field.ident.span());
            }

            if field.kind.is_child_wildcard() {
                if collect_wildcard_field.is_some() {
                    return Err(Error::new_spanned(
                        field.ident,
                        "only one #[xml(elements)] field without namespace/name selector is allowed",
                    ));
                }
                collect_wildcard_field = Some(field.ident.span());
            }

            fields.push(field);
        }

        Ok(Self {
            fields,
            namespace_field,
            on_unknown_child: default_on_unknown_child(on_unknown_child),
            on_unknown_attribute: default_on_unknown_attribute(on_unknown_attribute),
        })
    }

    /// Construct a compound from [`syn::Fields`].
    ///
    /// This a convenience wrapper around [`Self::new`], converting the
    /// [`syn::Field`] structs to [`FieldDef`].
    pub(crate) fn from_fields(
        on_unknown_child: Option<Ident>,
        on_unknown_attribute: Option<Ident>,
        fields: &Fields,
    ) -> Result<Self> {
        Self::new(
            on_unknown_child,
            on_unknown_attribute,
            fields.iter().enumerate().map(|(i, field)| {
                FieldDef::from_field(field, i.try_into().expect("too many fields"))
            }),
        )
    }

    /// Obtain references to the information about the
    /// `#[xml(namespace)]`-annotated field, if this compound has one.
    pub(crate) fn namespace_field(&self) -> Option<(Span, &Type, &Member)> {
        self.namespace_field.as_ref().map(|(a, b, c)| (*a, b, c))
    }

    /// Number of fields.
    pub(crate) fn field_count(&self) -> usize {
        self.fields.len()
    }

    /// Construct a token stream which contains:
    ///
    /// - A struct declaration
    /// - An impl of `xso::FromEventsBuilder` for that struct.
    /// - A method `fn init(attrs: HashMap<.., ..>) -> Result<Self>` for that struct.
    ///   If the compound has a dynamic namespace, the init method gets a
    ///   second argument with the type of the dynamic namespace.
    ///
    /// The init method does not do any matching; it merely extracts and
    /// checks the contents of the attributes.
    pub(crate) fn build_from_events_builder(
        &self,
        scope_namespace: ScopeNamespace,
        state_ty_ident: &Ident,
        output_name: &ParentRef,
        state_prefix: &str,
    ) -> Result<FromEventsSubmachine> {
        let scope = Scope::new(
            scope_namespace,
            state_prefix,
            state_ty_ident.clone(),
            &Span::call_site(),
        );
        let Scope {
            ref attrs,
            ref text,
            ref start_ev_qname,
            ref start_ev_attrs,
            ref substate_result,
            ref default_state_ident,
            ..
        } = scope;

        let builder_data = Ident::new("__data", Span::call_site());
        let substate_data = Ident::new("__substate_data", Span::call_site());

        let readable_name = output_name.to_string();
        let on_unknown_child = &self.on_unknown_child;
        let on_unknown_attribute = &self.on_unknown_attribute;

        let builder_data_ty_ident = quote::format_ident!("{}Data{}", state_ty_ident, state_prefix);
        let builder_data_ty: Type = ty_from_ident(builder_data_ty_ident.clone()).into();

        struct State {
            name: Ident,
            extra_decl: TokenStream,
            extra_destructure: TokenStream,
            advance_body: TokenStream,
            uses_mut: Option<Ident>,
        }

        impl State {
            fn new(name: Ident) -> Self {
                Self {
                    name,
                    extra_decl: TokenStream::default(),
                    extra_destructure: TokenStream::default(),
                    advance_body: TokenStream::default(),
                    uses_mut: None,
                }
            }

            fn add_field(&mut self, name: &Ident, ty: &Type) {
                self.extra_decl.extend(quote! { #name: #ty, });
                self.extra_destructure.extend(quote! { #name, });
            }

            fn with_field(mut self, name: &Ident, ty: &Type) -> Self {
                self.add_field(name, ty);
                self
            }

            fn with_impl(mut self, body: TokenStream) -> Self {
                self.advance_body = body;
                self
            }

            fn with_uses_mut(mut self, ident: &Ident) -> Self {
                self.uses_mut = Some(ident.clone());
                self
            }
        }

        let mut states = Vec::new();

        let mut struct_body = TokenStream::default();
        let mut output_init = TokenStream::default();
        let mut child_match = TokenStream::default();
        let mut child_fallback: Option<TokenStream> = None;
        let mut init_fields = TokenStream::default();
        let mut collect_fields = TokenStream::default();
        let mut process_text = TokenStream::default();
        let mut inner_defs = TokenStream::default();

        let is_tuple = !output_name.is_path();

        for field in self.fields.iter() {
            let field_ident = &field.ident;

            let tempname = scope.mangle_field(field_ident);

            let builder = field.build_from_events_builder(&scope, output_name, &tempname)?;

            let read_expr = match builder {
                FieldFromEventsPart::Nested {
                    temp:
                        FieldTempInit {
                            ty: temp_ty,
                            init: temp_init,
                        },
                    matcher,
                    builder,
                    collect,
                    finish,
                    extra_defs,
                } => {
                    inner_defs.extend(extra_defs);
                    let substate = scope.mangle_state(field_ident);

                    struct_body.extend(quote! {
                        #tempname: #temp_ty,
                    });

                    init_fields.extend(quote! {
                        #tempname: #temp_init,
                    });

                    match matcher {
                        NestedMatcher::Inline(matcher) => {
                            child_match.extend(quote! {
                                let (#start_ev_qname, #start_ev_attrs) = match #matcher {
                                    ::std::result::Result::Ok(builder) => {
                                        return ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#substate { #builder_data, #substate_data: builder }));
                                    },
                                    ::std::result::Result::Err(::xso::FromEventsError::Mismatch{ name, attrs }) => (name, attrs),
                                    ::std::result::Result::Err(::xso::FromEventsError::Invalid(err)) => return ::std::result::Result::Err(err),
                                };
                            });
                        }
                        NestedMatcher::Fallback(fallback) => {
                            if child_fallback.is_some() {
                                return Err(Error::new(
                                    Span::call_site(),
                                    "multiple fields attempting to collect all children",
                                ));
                            }
                            child_fallback = Some(quote! {
                                return ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#substate { #builder_data, #substate_data: #fallback }));
                            });
                        }
                    }

                    let feed = feed_fn(builder.clone());
                    states.push(State::new(substate.clone()).with_field(&substate_data, &builder).with_uses_mut(&substate_data).with_impl(quote! {
                        match #feed(&mut #substate_data, ev)? {
                            Some(#substate_result) => {
                                #collect
                                ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#default_state_ident { #builder_data }))
                            }
                            None => {
                                ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#substate { #builder_data, #substate_data }))
                            }
                        }
                    }));

                    quote! {
                        #finish
                    }
                }
                FieldFromEventsPart::Init {
                    value:
                        FieldTempInit {
                            ty: temp_ty,
                            init: temp_init,
                        },
                } => {
                    collect_fields.extend(quote! {
                        let #tempname: #temp_ty = #temp_init;
                    });

                    init_fields.extend(quote! {
                        #tempname,
                    });

                    struct_body.extend(quote! {
                        #tempname: #temp_ty,
                    });

                    quote! {
                        #builder_data.#tempname
                    }
                }
                FieldFromEventsPart::Text {
                    temp:
                        FieldTempInit {
                            ty: temp_ty,
                            init: temp_init,
                        },
                    accum,
                    finalize,
                } => {
                    init_fields.extend(quote! {
                        #tempname: #temp_init,
                    });

                    struct_body.extend(quote! {
                        #tempname: #temp_ty,
                    });

                    process_text.extend(accum);

                    quote! {
                        #finalize
                    }
                }
            };

            if is_tuple {
                output_init.extend(quote! {
                    #read_expr,
                });
            } else {
                output_init.extend(quote! {
                    #field_ident: #read_expr,
                });
            }
        }

        let child_fallback = if let Some(child_fallback) = child_fallback {
            child_fallback
        } else {
            let discard_state_ident = quote::format_ident!("{}Discard", state_prefix);
            let ty = discard_events_ty(Span::call_site());
            let feed = feed_fn(ty.clone());
            states.push(State::new(discard_state_ident.clone()).with_field(&substate_data, &ty).with_uses_mut(&substate_data).with_impl(quote! {
                match #feed(&mut #substate_data, ev)? {
                    Some(()) => {
                        ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#default_state_ident { #builder_data }))
                    }
                    None => {
                        ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#discard_state_ident { #builder_data, #substate_data }))
                    }
                }
            }));
            quote! {
                #on_unknown_child.trigger(concat!("Unknown child in ", #readable_name, "."))?;
                return ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#discard_state_ident { #builder_data, #substate_data: #ty::new() }));
            }
        };

        let output_cons = match output_name {
            ParentRef::Named(ref path) => {
                quote! {
                    #path { #output_init }
                }
            }
            ParentRef::Unnamed { .. } | ParentRef::Wrapper { .. } => {
                quote! {
                    ( #output_init )
                }
            }
        };

        let attr_enforcement = quote! {
            if let Some(_) = #attrs.into_iter().next() {
                #on_unknown_attribute.trigger(concat!("Unknown attribute in ", #readable_name, "."))?;
            }
        };

        let init = quote! {
            {
                #collect_fields
                #attr_enforcement
                ::std::result::Result::Ok(#state_ty_ident::#default_state_ident {
                    #builder_data: #builder_data_ty_ident {
                        #init_fields
                    },
                })
            }
        };

        states.push(State::new(default_state_ident.clone()).with_impl(quote! {
            match ev {
                ::xso::exports::rxml::Event::EndElement(_) => {
                    ::std::result::Result::Ok(::std::ops::ControlFlow::Continue(#output_cons))
                }
                ::xso::exports::rxml::Event::Text(_, #text) => {
                    #process_text
                    ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#default_state_ident { #builder_data }))  // TODO: unknown text behavior
                }
                ::xso::exports::rxml::Event::StartElement(_, #start_ev_qname, #start_ev_attrs) => {
                    #child_match
                    #child_fallback
                }
                ::xso::exports::rxml::Event::XmlDeclaration(_, _) => {
                    ::std::result::Result::Ok(::std::ops::ControlFlow::Break(Self::#default_state_ident { #builder_data }))
                },
            }
        }));

        let mut advance_match_arms = TokenStream::default();
        let mut state_enum_body = TokenStream::default();

        for state in states {
            let State {
                name,
                extra_decl,
                extra_destructure,
                uses_mut,
                advance_body,
            } = state;
            state_enum_body.extend(quote! {
                #name { #builder_data: #builder_data_ty, #extra_decl },
            });
            let extra_init = if let Some(ident) = uses_mut {
                quote! { let mut #ident = #ident; }
            } else {
                TokenStream::default()
            };
            advance_match_arms.extend(quote! {
                Self::#name { mut #builder_data, #extra_destructure } => {
                    #extra_init
                    #advance_body
                },
            });
        }

        Ok(FromEventsSubmachine {
            defs: quote! {
                #inner_defs

                struct #builder_data_ty_ident {
                    #struct_body
                }
            },
            state_defs: state_enum_body,
            advance_match_arms,
            init,
        })
    }

    pub(crate) fn build_into_events_iterator(
        &self,
        scope_namespace: ScopeNamespace,
        input_name: &ParentRef,
        state_prefix: &str,
        state_ty_ident: &Ident,
        attrs_ident: Option<&Ident>,
    ) -> Result<IntoEventsSubmachine> {
        let scope = Scope::new(
            scope_namespace,
            state_prefix,
            state_ty_ident.clone(),
            &Span::call_site(),
        );
        let Scope { ref attrs, .. } = scope;

        let start_element_ident = quote::format_ident!("{}StartElement", state_prefix);
        let end_element_ident = quote::format_ident!("{}EndElement", state_prefix);

        struct Variant {
            name: Ident,
            decl: TokenStream,
            destructure: TokenStream,
            body: TokenStream,
            uses_mut: Option<Ident>,
        }

        impl Variant {
            fn new(name: Ident) -> Self {
                Self {
                    name,
                    decl: TokenStream::default(),
                    destructure: TokenStream::default(),
                    body: TokenStream::default(),
                    uses_mut: None,
                }
            }

            fn add_field(&mut self, name: &Ident, ty: &Type) {
                self.decl.extend(quote! { #name: #ty, });
                self.destructure.extend(quote! { #name, });
            }

            fn with_field(mut self, name: &Ident, ty: &Type) -> Self {
                self.add_field(name, ty);
                self
            }

            fn with_impl(mut self, body: TokenStream) -> Self {
                self.body = body;
                self
            }

            fn with_uses_mut(mut self, ident: &Ident) -> Self {
                self.uses_mut = Some(ident.clone());
                self
            }
        }

        let mut state_enum_variants: Vec<Variant> = Vec::new();
        let mut inner_defs = TokenStream::default();
        let mut start_element_init = quote! {
            qname: qname,
        };
        let mut destructure_struct = TokenStream::default();
        let mut destructure_tuple = TokenStream::default();

        let mut passive_fields: Vec<(Ident, Member, Type)> = Vec::new();

        state_enum_variants.push(Variant::new(start_element_ident.clone()).with_field(
            &Ident::new("qname", Span::call_site()),
            &qname_ty(Span::call_site()),
        ));

        let mut start_element_body = if let Some(ident) = attrs_ident.as_ref() {
            start_element_init.extend(quote! {
                attrs: #ident,
            });
            state_enum_variants[0].add_field(
                &Ident::new("attrs", Span::call_site()),
                &attr_map_ty(Span::call_site()),
            );
            quote! {
                let mut #attrs = attrs;
                { let _ = &mut #attrs; };
            }
        } else {
            quote! {
                let mut #attrs = ::xso::exports::rxml::AttrMap::new();
                { let _ = &mut #attrs; };
            }
        };

        for field in self.fields.iter() {
            let field_ident = &field.ident;

            let tempname = scope.mangle_field(field_ident);

            destructure_struct.extend(quote! {
                #field_ident: #tempname,
            });

            destructure_tuple.extend(quote! {
                #tempname,
            });

            match field.build_into_events_iterator(&scope, input_name, &tempname)? {
                FieldIntoEventsPart::Header { setter } => {
                    state_enum_variants[0].add_field(&tempname, &field.ty);
                    start_element_init.extend(quote! {
                        #tempname: #tempname,
                    });
                    start_element_body.extend(quote! {
                        #setter
                    });
                }
                FieldIntoEventsPart::ContentConsume { prepare, emitter } => {
                    start_element_init.extend(quote! {
                        #tempname: #prepare,
                    });
                    for variant in state_enum_variants.iter_mut() {
                        variant.add_field(&tempname, &field.ty);
                    }
                    state_enum_variants.push(
                        Variant::new(scope.mangle_state(field_ident))
                            .with_field(&tempname, &field.ty)
                            .with_impl(quote! {
                                #emitter
                            }),
                    );
                }
                FieldIntoEventsPart::ContentMut {
                    extra_defs,
                    init,
                    ty,
                    emitter,
                } => {
                    inner_defs.extend(extra_defs);
                    start_element_init.extend(quote! {
                        #tempname: #init,
                    });
                    for variant in state_enum_variants.iter_mut() {
                        variant.add_field(&tempname, &ty);
                    }
                    state_enum_variants.push(
                        Variant::new(scope.mangle_state(field_ident))
                            .with_field(&tempname, &ty)
                            .with_uses_mut(&tempname)
                            .with_impl(quote! {
                                #emitter
                            }),
                    );
                }
                FieldIntoEventsPart::Passive => {
                    passive_fields.push((tempname, field.ident.clone(), field.ty.clone()));
                }
            }
        }

        state_enum_variants[0].body = quote! {
            {
                #start_element_body
                ::std::option::Option::Some(::xso::exports::rxml::Event::StartElement(
                    ::xso::exports::rxml::parser::EventMetrics::zero(),
                    qname,
                    #attrs,
                ))
            }
        };

        state_enum_variants.push(Variant::new(end_element_ident.clone()).with_impl(quote! {
            ::std::option::Option::Some(::xso::exports::rxml::Event::EndElement(::xso::exports::rxml::parser::EventMetrics::zero()))
        }));

        let mut end_element_body_prefix = TokenStream::default();
        for (name, _, ty) in passive_fields {
            for variant in state_enum_variants.iter_mut() {
                variant.add_field(&name, &ty);
            }
            start_element_init.extend(quote! {
                #name: #name,
            });
            end_element_body_prefix.extend(quote! {
                let _ = #name;
            });
        }

        {
            let end_element = state_enum_variants.last_mut().unwrap();
            end_element_body_prefix.extend(end_element.body.clone());
            end_element.body = quote! {
                {
                    #end_element_body_prefix
                }
            };
        }

        let mut advance_impl = TokenStream::default();
        let mut state_enum_body = TokenStream::default();
        for (
            i,
            Variant {
                ref name,
                ref decl,
                ref destructure,
                ref body,
                ref uses_mut,
            },
        ) in state_enum_variants.iter().enumerate()
        {
            let footer = match state_enum_variants.get(i + 1) {
                Some(Variant {
                    name: ref next_name,
                    destructure: ref construct_next,
                    ..
                }) => {
                    quote! {
                        let next_state = Self::#next_name { #construct_next };
                        ::std::result::Result::Ok((::std::option::Option::Some(next_state), event))
                    }
                }
                // final state
                None => {
                    quote! {
                        ::std::result::Result::Ok((::std::option::Option::None, event))
                    }
                }
            };

            if let Some(uses_mut) = uses_mut.as_ref() {
                // the variant is non-consuming, meaning it can be called
                // multiple times and it uses the identifier in `uses_mut`
                // mutably.
                // the transition is only triggered when it emits a None event
                advance_impl.extend(quote! {
                    Self::#name { #destructure } => {
                        let mut #uses_mut = #uses_mut;
                        match #body {
                            ::std::option::Option::Some(event) => {
                                ::std::result::Result::Ok((::std::option::Option::Some(Self::#name { #destructure }), ::std::option::Option::Some(event)))
                            },
                            event => { #footer },
                        }
                    },
                });
            } else {
                // if the variant is consuming, it can only be called once.
                // it may or may not emit an event, but the transition is
                // always triggered
                advance_impl.extend(quote! {
                    Self::#name { #destructure } => {
                        let event = #body;
                        #footer
                    },
                });
            }

            state_enum_body.extend(quote! {
                #name { #decl },
            });
        }

        Ok(IntoEventsSubmachine {
            defs: inner_defs,
            state_defs: state_enum_body,
            advance_match_arms: advance_impl,
            destructure: match input_name {
                ParentRef::Named(name) => quote! { #name { #destructure_struct } },
                ParentRef::Unnamed { .. } | ParentRef::Wrapper { .. } => {
                    quote! { ( #destructure_tuple ) }
                }
            },
            init: quote! {
                Self::#start_element_ident { #start_element_init }
            },
        })
    }

    /// If and only if this compound has exactly one field, return a reference
    /// to that field's type.
    pub(crate) fn single_type(&self) -> Option<&Type> {
        if self.fields.len() != 1 {
            None
        } else {
            Some(&self.fields[0].ty)
        }
    }

    /// Return a [`DynCompound`] refering to `self`, if and only if this
    /// compound has a valid `#[xml(namespace)]` field.
    ///
    /// The function and type name refer to this being a precondition for a
    /// valid `namespace = dyn` struct or enum variant.
    pub(crate) fn as_dyn(&self) -> Option<DynCompound<'_>> {
        let (_, ty, member) = self.namespace_field.as_ref()?;
        Some(DynCompound {
            namespace_ty: ty,
            namespace_member: member,
            fields: &self.fields,
        })
    }

    /// Construct a tuple type with all the fields of this compound.
    pub(crate) fn as_tuple_ty(&self) -> Type {
        let mut ty = TypeTuple {
            paren_token: syn::token::Paren::default(),
            elems: syn::punctuated::Punctuated::new(),
        };

        for field in self.fields.iter() {
            ty.elems.push(field.ty.clone());
        }

        Type::Tuple(ty)
    }
}

/// Reference to a [`Compound`] which has proven that it has a
/// `#[xml(namespace)]` field.
///
/// This simplifies some checks here and there.
pub(crate) struct DynCompound<'x> {
    /// The type of the `#[xml(namespace)]` field.
    namespace_ty: &'x Type,

    /// The member referring to the `#[xml(namespace)]` field.
    namespace_member: &'x Member,

    /// The fields of the compound.
    fields: &'x [FieldDef],
}

impl<'x> DynCompound<'x> {
    /// Return a reference to the [`Type`] of the field annotated with
    /// `#[xml(namespace)]`.
    pub(crate) fn namespace_ty(&self) -> &'x Type {
        self.namespace_ty
    }

    /// Build the implementation of
    /// `DynNamespace::namespace(&self) -> &Self::Namespace`.
    pub(crate) fn build_get_namespace(
        &self,
        mut access_field: impl FnMut(Member) -> Expr,
    ) -> Result<TokenStream> {
        let member = access_field(self.namespace_member.clone());
        Ok(quote! {
            &#member
        })
    }

    /// Build the implementation of
    /// `DynNamespace::set_namespace<T: Into<Self::Namespace>>(&mut self, ns: T)`.
    pub(crate) fn build_set_namespace(
        &self,
        input: &Ident,
        mut access_field: impl FnMut(Member) -> Expr,
    ) -> Result<TokenStream> {
        let member = access_field(self.namespace_member.clone());
        let mut field_impls = quote! {};
        for field in self.fields {
            let field_impl = field.build_set_namespace(input, &mut access_field);
            field_impls.extend(field_impl);
        }
        Ok(quote! {
            #field_impls
            #member = #input;
        })
    }
}