gdnative-derive 0.11.3

The Godot game engine's gdnative derive and procedural macros.
Documentation
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
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
use syn::{
    spanned::Spanned, visit::Visit, FnArg, Generics, ImplItem, ItemImpl, Meta, NestedMeta, Pat,
    PatIdent, Signature, Type,
};

use proc_macro2::TokenStream as TokenStream2;
use quote::{quote, ToTokens};
use std::boxed::Box;

use crate::syntax::rpc_mode::RpcMode;
use crate::utils::find_non_concrete;

use self::mixin_args::{MixinArgsBuilder, MixinKind};

mod mixin_args;

pub(crate) struct ClassMethodExport {
    pub(crate) class_ty: Box<Type>,
    pub(crate) methods: Vec<ExportMethod>,
}

#[derive(Clone, Eq, PartialEq, Hash, Debug)]
pub(crate) struct ExportMethod {
    /// Signature of the method *with argument attributes stripped*
    pub(crate) sig: Signature,
    pub(crate) export_args: ExportArgs,
    pub(crate) arg_kind: Vec<ArgKind>,
}

#[derive(Clone, Eq, PartialEq, Hash, Debug)]
pub(crate) enum ArgKind {
    /// Variations of `self`
    Receiver,
    /// `#[base]`
    Base,
    /// `#[async_ctx]`
    AsyncCtx,
    /// Regular arguments
    Regular {
        /// `#[opt]`
        optional: bool,
    },
}

impl std::fmt::Display for ArgKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Receiver => write!(f, "method receiver"),
            Self::Base => write!(f, "base/owner object"),
            Self::AsyncCtx => write!(f, "async context"),
            Self::Regular { optional: true } => write!(f, "optional argument"),
            Self::Regular { optional: false } => write!(f, "regular argument"),
        }
    }
}

impl ArgKind {
    fn strip_parse(arg: &mut FnArg, errors: &mut Vec<syn::Error>) -> (bool, Self) {
        let (receiver, attrs) = match arg {
            FnArg::Receiver(a) => (Some(a.self_token.span), &mut a.attrs),
            FnArg::Typed(a) => (None, &mut a.attrs),
        };

        let mut optional = None;
        let mut base = None;
        let mut async_ctx = None;

        let mut fail = false;

        attrs.retain(|attr| {
            if attr.path.is_ident("opt") {
                if let Some(old_span) = optional.replace(attr.path.span()) {
                    fail = true;
                    optional = Some(old_span);
                    errors.push(syn::Error::new(attr.path.span(), "duplicate attribute"));
                }
                false
            } else if attr.path.is_ident("base") {
                if let Some(old_span) = base.replace(attr.path.span()) {
                    fail = true;
                    base = Some(old_span);
                    errors.push(syn::Error::new(attr.path.span(), "duplicate attribute"));
                }
                false
            } else if attr.path.is_ident("async_ctx") {
                if let Some(old_span) = async_ctx.replace(attr.path.span()) {
                    fail = true;
                    async_ctx = Some(old_span);
                    errors.push(syn::Error::new(attr.path.span(), "duplicate attribute"));
                }
                false
            } else {
                true
            }
        });

        let mut special_kind = None;

        macro_rules! check_special_kind {
            ($ident:ident => $var:expr) => {
                if let Some($ident) = $ident {
                    if let Some(kind) = special_kind.replace($var) {
                        fail = true;
                        errors.push(syn::Error::new(
                            $ident,
                            format_args!("the {} cannot also be the {}", kind, $var),
                        ));
                        special_kind = Some(kind);
                    }
                }
            };
        }

        check_special_kind!(receiver => ArgKind::Receiver);
        check_special_kind!(base => ArgKind::Base);
        check_special_kind!(async_ctx => ArgKind::AsyncCtx);

        let kind = if let Some(special_kind) = special_kind {
            if let Some(optional) = optional {
                fail = true;
                errors.push(syn::Error::new(
                    optional,
                    format_args!(
                        "the {special_kind} cannot be optional (instead, remove the argument entirely)"
                    ),
                ));
            }

            special_kind
        } else {
            ArgKind::Regular {
                optional: optional.is_some(),
            }
        };

        (fail, kind)
    }
}

impl ExportMethod {
    fn strip_parse(
        sig: &mut Signature,
        export_args: ExportArgs,
        errors: &mut Vec<syn::Error>,
    ) -> Option<Self> {
        let mut arg_kind = Vec::new();
        let sig_span = sig.ident.span();

        let mut inputs = sig.inputs.iter_mut().enumerate();

        let mut receiver_seen = None;
        let mut base_seen = None;
        let mut async_ctx_seen = None;

        let mut fail = false;

        let is_async = export_args.is_async || sig.asyncness.is_some();

        if export_args.is_old_syntax {
            if inputs.len() < 2 {
                fail = true;
            } else {
                match inputs.next().expect("argument count checked") {
                    (n, FnArg::Receiver(_)) => {
                        arg_kind.push(ArgKind::Receiver);
                        receiver_seen = Some(n);
                    }
                    (_, arg) => {
                        errors.push(syn::Error::new(arg.span(), "expecting method receiver"));
                        fail = true;
                    }
                }

                let (n, arg) = inputs.next().expect("argument count checked");
                let (arg_fail, kind) = ArgKind::strip_parse(arg, errors);
                fail |= arg_fail;
                match kind {
                    ArgKind::Base | ArgKind::Regular { .. } => {
                        arg_kind.push(ArgKind::Base);
                        base_seen = Some(n);
                    }
                    kind => {
                        errors.push(syn::Error::new(
                            arg.span(),
                            format_args!("expecting {}, found {}", ArgKind::Base, kind),
                        ));
                        fail = true;
                    }
                };
            }

            if fail {
                errors.push(syn::Error::new(
                    sig_span,
                    "methods exported using the old syntax must declare both `self` and `owner`.",
                ));
            }
        }

        let mut regular_argument_seen = None;
        let mut optional_argument_seen = None;

        for (n, arg) in inputs {
            let (arg_fail, kind) = ArgKind::strip_parse(arg, errors);
            fail |= arg_fail;

            if let ArgKind::Regular { optional } = &kind {
                regular_argument_seen.get_or_insert(n);

                if *optional {
                    optional_argument_seen.get_or_insert(n);
                } else if let Some(idx) = optional_argument_seen {
                    fail = true;
                    errors.push(syn::Error::new(
                        arg.span(),
                        format_args!(
                            "required parameters must precede all optional ones (an optional parameter is defined at #{idx})",
                        )
                    ));
                }
            } else if let Some(idx) = regular_argument_seen {
                fail = true;
                errors.push(syn::Error::new(
                    arg.span(),
                    format_args!(
                        "special parameters must precede all regular ones (a regular parameter is defined at #{idx})",
                    )
                ));
            } else {
                let seen = match &kind {
                    ArgKind::Receiver => &mut receiver_seen,
                    ArgKind::Base => &mut base_seen,
                    ArgKind::AsyncCtx => &mut async_ctx_seen,
                    ArgKind::Regular { .. } => unreachable!(),
                };

                if let Some(idx) = seen.replace(n) {
                    *seen = Some(idx);
                    fail = true;
                    errors.push(syn::Error::new(
                        arg.span(),
                        format_args!(
                            "the special parameter {kind} must only be declared once (the same parameter is already defined at #{idx})",
                        )
                    ));
                }
            }

            if matches!(kind, ArgKind::Receiver) && !matches!(arg, FnArg::Receiver(_)) {
                fail = true;
                errors.push(syn::Error::new(
                    arg.span(),
                    "non-self receivers aren't supported yet",
                ));
            }

            if matches!(kind, ArgKind::AsyncCtx) && !is_async {
                fail = true;
                errors.push(syn::Error::new(
                    arg.span(),
                    "the async context is only available to async methods",
                ));
            }

            arg_kind.push(kind);
        }

        if fail {
            None
        } else {
            Some(ExportMethod {
                sig: sig.clone(),
                export_args,
                arg_kind,
            })
        }
    }
}

#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
pub(crate) struct ExportArgs {
    pub(crate) is_old_syntax: bool,
    pub(crate) rpc_mode: Option<RpcMode>,
    pub(crate) name_override: Option<String>,
    pub(crate) is_deref_return: bool,
    pub(crate) is_async: bool,
}

pub(crate) fn derive_methods(
    args: Vec<NestedMeta>,
    item_impl: ItemImpl,
) -> Result<TokenStream2, syn::Error> {
    let derived = crate::automatically_derived();
    let gdnative_core = crate::crate_gdnative_core();
    let (impl_block, export) = impl_gdnative_expose(item_impl);
    let (impl_generics, _, where_clause) = impl_block.generics.split_for_impl();

    let class_name = export.class_ty;

    let builder = syn::Ident::new("builder", proc_macro2::Span::call_site());

    let args = {
        let mut attr_args_builder = MixinArgsBuilder::new();

        for arg in args {
            if let NestedMeta::Meta(Meta::NameValue(ref pair)) = arg {
                attr_args_builder.add_pair(pair)?;
            } else if let NestedMeta::Meta(Meta::Path(ref path)) = arg {
                attr_args_builder.add_path(path)?;
            } else {
                let msg = format!("Unexpected argument: {arg:?}");
                return Err(syn::Error::new(arg.span(), msg));
            }
        }

        attr_args_builder.done()?
    };

    let non_concrete = find_non_concrete::with_visitor(&impl_block.generics, |v| {
        v.visit_type(&impl_block.self_ty)
    });

    let non_concrete = if non_concrete.is_empty() {
        None
    } else if non_concrete.len() == 1 {
        Some(non_concrete[0])
    } else {
        Some(impl_block.self_ty.span())
    };

    if let Some(span) = non_concrete {
        if matches!(args.mixin, Some(MixinKind::Auto(_))) {
            return Err(syn::Error::new(
                span,
                "non-concrete mixins must be named and manually registered",
            ));
        }
    }

    let methods = export
        .methods
        .into_iter()
        .map(|export_method| {
            let ExportMethod {
                sig,
                export_args,
                ..
            } = &export_method;

            let sig_span = sig.ident.span();

            let name = sig.ident.clone();
            let name_string = export_args
                .name_override
                .clone()
                .unwrap_or_else(|| name.to_string());
            let ret_span = sig.output.span();

            let rpc = export_args.rpc_mode.unwrap_or(RpcMode::Disabled);
            let is_deref_return = export_args.is_deref_return;

            let warn_deprecated_export = if export_args.is_old_syntax {
                let warning = crate::emit_warning(
                    sig_span,
                    "deprecated_export_syntax",
                    concat!(
                        "\n",
                        "#[export] is deprecated and will be removed in a future godot-rust version. Use #[method] instead.\n\n",
                        "For more information, see https://godot-rust.github.io/docs/gdnative/derive/derive.NativeClass.html."
                    )
                );

                Some(quote_spanned!(sig_span=>#warning;))
            } else {
                None
            };

            // See gdnative-core::export::deprecated_reference_return!()
            let warn_deprecated_ref_return = if let syn::ReturnType::Type(_, ty) = &sig.output {
                if !is_deref_return && matches!(**ty, syn::Type::Reference(_)) {
                    let warning = crate::emit_warning(
                        ret_span,
                        "deprecated_reference_return",
                        "This function does not actually pass by reference to the Godot engine. You can clarify by writing #[method(deref_return)]."
                    );

                    quote_spanned!(ret_span=>#warning;)
                } else {
                    quote_spanned!(ret_span=>)
                }
            } else {
                quote_spanned!(ret_span=>)
            };

            let method = wrap_method(&class_name, &impl_block.generics, &export_method)
                .unwrap_or_else(|err| err.to_compile_error());

            quote_spanned!( sig_span=>
                {
                    #builder.method(#name_string, #method)
                        .with_rpc_mode(#rpc)
                        .done_stateless();

                    #warn_deprecated_export
                    #warn_deprecated_ref_return
                }
            )
        })
        .collect::<Vec<_>>();

    match args.mixin {
        Some(mixin_kind) => {
            let vis = args.pub_.then(|| quote!(pub));

            let mixin_name = match &mixin_kind {
                MixinKind::Named(ident) => ident.clone(),
                MixinKind::Auto(span) => {
                    return Err(syn::Error::new(
                        *span,
                        "mixins must be named in gdnative v0.11.x",
                    ))
                }
            };

            let body = quote! {
                #derived
                #vis struct #mixin_name {
                    _opaque: #gdnative_core::private::mixin::Opaque,
                }

                #derived
                impl #gdnative_core::private::mixin::Sealed for #mixin_name {}
                #derived
                impl #impl_generics #gdnative_core::export::Mixin<#class_name> for #mixin_name #where_clause {
                    fn register(#builder: &#gdnative_core::export::ClassBuilder<#class_name>) {
                        use #gdnative_core::export::*;

                        #(#methods)*
                    }
                }
            };

            let body = match &mixin_kind {
                MixinKind::Named(_) => body,
                MixinKind::Auto(_) => quote! {
                    const _: () = {
                        #body
                    }
                },
            };

            Ok(quote::quote!(
                #impl_block
                #body
            ))
        }
        None => Ok(quote::quote!(
            #impl_block

            #derived
            impl #impl_generics #gdnative_core::export::NativeClassMethods for #class_name #where_clause {
                fn nativeclass_register(#builder: &#gdnative_core::export::ClassBuilder<Self>) {
                    use #gdnative_core::export::*;

                    #(#methods)*
                }
            }

        )),
    }
}

/// Extract the data to export from the impl block.
#[allow(clippy::single_match)]
fn impl_gdnative_expose(ast: ItemImpl) -> (ItemImpl, ClassMethodExport) {
    // the ast input is used for inspecting.
    // this clone is used to remove all attributes so that the resulting
    // impl block actually compiles again.
    let mut result = ast.clone();

    // This is done by removing all items first, they will be added back on later
    result.items.clear();

    // data used for generating the exported methods.
    let mut export = ClassMethodExport {
        class_ty: ast.self_ty,
        methods: vec![],
    };

    let mut methods_to_export: Vec<ExportMethod> = Vec::new();

    // extract all methods that have the #[method] attribute
    // add all items back to the impl block again.
    for func in ast.items {
        let items = match func {
            ImplItem::Method(mut method) => {
                let mut export_args = None;
                let mut errors = vec![];

                // only allow the "outer" style, aka #[thing] item.
                method.attrs.retain(|attr| {
                    if matches!(attr.style, syn::AttrStyle::Outer) {
                        let last_seg = attr
                            .path
                            .segments
                            .iter()
                            .last()
                            .map(|i| i.ident.to_string());

                        let (is_export, is_old_syntax, macro_name) =
                            if let Some("export") = last_seg.as_deref() {
                                (true, true, "export")
                            } else if let Some("method") = last_seg.as_deref() {
                                (true, false, "method")
                            } else {
                                (false, false, "unknown")
                            };

                        if is_export {
                            use syn::{punctuated::Punctuated, Lit};
                            let mut export_args =
                                export_args.get_or_insert_with(ExportArgs::default);
                            export_args.is_old_syntax = is_old_syntax;

                            // Codes like #[macro(path, name = "value")] are accepted.
                            // Codes like #[path], #[name = "value"] or #[macro("lit")] are not accepted.
                            let nested_meta_iter = match attr.parse_meta() {
                                Err(err) => {
                                    errors.push(err);
                                    return false;
                                }
                                Ok(Meta::NameValue(name_value)) => {
                                    let span = name_value.span();
                                    let msg = "NameValue syntax is not valid";
                                    errors.push(syn::Error::new(span, msg));
                                    return false;
                                }
                                Ok(Meta::Path(_)) => {
                                    Punctuated::<NestedMeta, syn::token::Comma>::new().into_iter()
                                }
                                Ok(Meta::List(list)) => list.nested.into_iter(),
                            };
                            for nested_meta in nested_meta_iter {
                                let (path, lit) = match &nested_meta {
                                    NestedMeta::Lit(param) => {
                                        let span = param.span();
                                        let msg = "Literal item is not valid";
                                        errors.push(syn::Error::new(span, msg));
                                        continue;
                                    }
                                    NestedMeta::Meta(param) => match param {
                                        Meta::List(list) => {
                                            let span = list.span();
                                            let msg = "List item is not valid";
                                            errors.push(syn::Error::new(span, msg));
                                            continue;
                                        }
                                        Meta::Path(path) => (path, None),
                                        Meta::NameValue(name_value) => {
                                            (&name_value.path, Some(&name_value.lit))
                                        }
                                    },
                                };
                                if path.is_ident("rpc") {
                                    // rpc mode
                                    match lit {
                                        None => {
                                            errors.push(syn::Error::new(
                                                nested_meta.span(),
                                                "`rpc` parameter requires string value",
                                            ));
                                        }
                                        Some(Lit::Str(str)) => {
                                            let value = str.value();
                                            if let Some(mode) = RpcMode::parse(value.as_str()) {
                                                if export_args.rpc_mode.replace(mode).is_some() {
                                                    errors.push(syn::Error::new(
                                                        nested_meta.span(),
                                                        "`rpc` mode was set more than once",
                                                    ));
                                                }
                                            } else {
                                                errors.push(syn::Error::new(
                                                    nested_meta.span(),
                                                    format!("unexpected value for `rpc`: {value}"),
                                                ));
                                            }
                                        }
                                        _ => {
                                            errors.push(syn::Error::new(
                                                nested_meta.span(),
                                                "unexpected type for `rpc` value, expected string",
                                            ));
                                        }
                                    }
                                } else if path.is_ident("name") {
                                    // name override
                                    match lit {
                                        None => {
                                            errors.push(syn::Error::new(
                                                nested_meta.span(),
                                                "`name` parameter requires string value",
                                            ));
                                        }
                                        Some(Lit::Str(str)) => {
                                            if export_args
                                                .name_override
                                                .replace(str.value())
                                                .is_some()
                                            {
                                                errors.push(syn::Error::new(
                                                    nested_meta.span(),
                                                    "`name` was set more than once",
                                                ));
                                            }
                                        }
                                        _ => {
                                            errors.push(syn::Error::new(
                                                nested_meta.span(),
                                                "unexpected type for `name` value, expected string",
                                            ));
                                        }
                                    }
                                } else if path.is_ident("deref_return") {
                                    // deref return value
                                    if lit.is_some() {
                                        errors.push(syn::Error::new(
                                            nested_meta.span(),
                                            "`deref_return` does not take any values",
                                        ));
                                    } else if export_args.is_deref_return {
                                        errors.push(syn::Error::new(
                                            nested_meta.span(),
                                            "`deref_return` was set more than once",
                                        ));
                                    } else {
                                        export_args.is_deref_return = true;
                                    }
                                } else if path.is_ident("async") {
                                    // deref return value
                                    if lit.is_some() {
                                        errors.push(syn::Error::new(
                                            nested_meta.span(),
                                            "`async` does not take any values",
                                        ));
                                    } else if export_args.is_async {
                                        errors.push(syn::Error::new(
                                            nested_meta.span(),
                                            "`async` was set more than once",
                                        ));
                                    } else {
                                        export_args.is_async = true;
                                    }
                                } else {
                                    let msg = format!(
                                        "unknown option for #[{}]: `{}`",
                                        macro_name,
                                        path.to_token_stream()
                                    );
                                    errors.push(syn::Error::new(nested_meta.span(), msg));
                                }
                            }
                            return false;
                        }
                    }

                    true
                });

                if let Some(export_args) = export_args.take() {
                    methods_to_export.extend(ExportMethod::strip_parse(
                        &mut method.sig,
                        export_args,
                        &mut errors,
                    ));
                }

                errors
                    .into_iter()
                    .map(|err| ImplItem::Verbatim(err.to_compile_error()))
                    .chain(std::iter::once(ImplItem::Method(method)))
                    .collect()
            }
            item => vec![item],
        };

        result.items.extend(items);
    }

    // check if the export methods have the proper "shape", the write them
    // into the list of things to export.
    {
        for mut method in methods_to_export {
            let generics = &method.sig.generics;
            let span = method.sig.ident.span();

            if generics.type_params().count() > 0 {
                let toks =
                    syn::Error::new(span, "Type parameters not allowed in exported functions")
                        .to_compile_error();
                result.items.push(ImplItem::Verbatim(toks));
                continue;
            }
            if generics.lifetimes().count() > 0 {
                let toks = syn::Error::new(
                    span,
                    "Lifetime parameters not allowed in exported functions",
                )
                .to_compile_error();
                result.items.push(ImplItem::Verbatim(toks));
                continue;
            }
            if generics.const_params().count() > 0 {
                let toks =
                    syn::Error::new(span, "const parameters not allowed in exported functions")
                        .to_compile_error();
                result.items.push(ImplItem::Verbatim(toks));
                continue;
            }

            // remove "mut" from parameters.
            // give every wildcard a (hopefully) unique name.
            method
                .sig
                .inputs
                .iter_mut()
                .enumerate()
                .for_each(|(i, arg)| match arg {
                    FnArg::Typed(cap) => match *cap.pat.clone() {
                        Pat::Wild(_) => {
                            let name = format!("___unused_arg_{i}");

                            cap.pat = Box::new(Pat::Ident(PatIdent {
                                attrs: vec![],
                                by_ref: None,
                                mutability: None,
                                ident: syn::Ident::new(&name, span),
                                subpat: None,
                            }));
                        }
                        Pat::Ident(mut ident) => {
                            ident.mutability = None;
                            cap.pat = Box::new(Pat::Ident(ident));
                        }
                        _ => {}
                    },
                    _ => {}
                });

            // The calling site is already in an unsafe block, so removing it from just the
            // exported binding is fine.
            method.sig.unsafety = None;

            export.methods.push(method);
        }
    }

    (result, export)
}

pub(crate) fn expand_godot_wrap_method(
    input: TokenStream2,
) -> Result<TokenStream2, Vec<syn::Error>> {
    struct Input {
        class_name: syn::Type,
        is_deref_return: syn::LitBool,
        signature: syn::Signature,
    }

    impl syn::parse::Parse for Input {
        fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
            let class_name = input.parse()?;
            input.parse::<Token![,]>()?;

            let is_deref_return = input.parse()?;
            input.parse::<Token![,]>()?;

            let signature = input.parse()?;

            // Ignore the trailing comma
            let _ = input.parse::<Token![,]>();

            if input.is_empty() {
                Ok(Input {
                    class_name,
                    is_deref_return,
                    signature,
                })
            } else {
                Err(syn::Error::new(input.span(), "expecting end of input"))
            }
        }
    }

    let Input {
        class_name,
        is_deref_return,
        mut signature,
    } = syn::parse2(input).map_err(|e| vec![e])?;

    let export_args = ExportArgs {
        is_old_syntax: false,
        rpc_mode: None,
        name_override: None,
        is_deref_return: is_deref_return.value,
        is_async: false,
    };

    let mut errors = Vec::new();
    let export_method = ExportMethod::strip_parse(&mut signature, export_args, &mut errors);

    if !errors.is_empty() {
        return Err(errors);
    }

    wrap_method(
        &class_name,
        &Generics::default(),
        &export_method.expect("ExportMethod is valid"),
    )
    .map_err(|e| vec![e])
}

fn wrap_method(
    class_name: &Type,
    generics: &Generics,
    export_method: &ExportMethod,
) -> Result<TokenStream2, syn::Error> {
    let ExportMethod {
        sig,
        export_args,
        arg_kind,
    } = &export_method;

    let gdnative_core = crate::crate_gdnative_core();
    let automatically_derived = crate::automatically_derived();

    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
    let turbofish_ty_generics = ty_generics.as_turbofish();

    let generic_marker_decl = if generics.params.is_empty() {
        quote!(())
    } else {
        quote!(core::marker::PhantomData #ty_generics)
    };

    let generic_marker_ctor = if generics.params.is_empty() {
        quote!(())
    } else {
        quote!(core::marker::PhantomData)
    };

    let sig_span = sig.ident.span();
    let ret_span = sig.output.span();

    let method_name = &sig.ident;

    let declare_arg_list = arg_kind
        .iter()
        .zip(&sig.inputs)
        .filter_map(|(kind, arg)| {
            if let ArgKind::Regular { optional } = kind {
                if let FnArg::Typed(arg) = arg {
                    let span = arg.span();
                    let maybe_opt = if *optional {
                        Some(quote_spanned!(span => #[opt]))
                    } else {
                        None
                    };
                    Some(quote_spanned!(span => #maybe_opt #arg))
                } else {
                    unreachable!("regular arguments should always be FnArg::Typed")
                }
            } else {
                None
            }
        })
        .collect::<Vec<_>>();

    let destructure_arg_list = arg_kind
        .iter()
        .zip(&sig.inputs)
        .filter_map(|(kind, arg)| {
            if matches!(kind, ArgKind::Regular { .. }) {
                if let FnArg::Typed(arg) = arg {
                    Some(&arg.pat)
                } else {
                    unreachable!("regular arguments should always be FnArg::Typed")
                }
            } else {
                None
            }
        })
        .collect::<Vec<_>>();

    let is_async = export_args.is_async || sig.asyncness.is_some();
    let mut map_method = None;

    let invoke_arg_list = arg_kind
        .iter()
        .zip(&sig.inputs)
        .map(|(kind, arg)| match kind {
            ArgKind::Receiver => {
                if let FnArg::Receiver(receiver) = arg {
                    map_method = Some(if receiver.reference.is_some() {
                        if receiver.mutability.is_some() {
                            syn::Ident::new("map_mut", sig_span)
                        } else {
                            syn::Ident::new("map", sig_span)
                        }
                    } else {
                        syn::Ident::new("map_owned", sig_span)
                    });
                }

                Ok(quote_spanned! { sig_span => __rust_val })
            }
            ArgKind::Base => Ok(quote_spanned! { sig_span => OwnerArg::from_safe_ref(__base) }),
            ArgKind::AsyncCtx => Ok(quote_spanned! { sig_span => __ctx }),
            ArgKind::Regular { .. } => match arg {
                FnArg::Receiver(_) => {
                    unreachable!("receivers cannot be regular arguments")
                }
                FnArg::Typed(arg) => {
                    let pat = &arg.pat;
                    Ok(quote_spanned! { sig_span => #pat })
                }
            },
        })
        .collect::<Result<Vec<_>, syn::Error>>()?;

    let map_method = map_method.unwrap_or_else(|| syn::Ident::new("map", sig_span));

    let recover = if export_args.is_deref_return {
        quote_spanned! { ret_span => std::ops::Deref::deref(&ret) }
    } else {
        quote_spanned! { ret_span => ret }
    };

    let impl_body = if is_async {
        let gdnative_async = crate::crate_gdnative_async();

        quote_spanned! { sig_span =>
            #automatically_derived
            impl #impl_generics #gdnative_async::StaticArgsAsyncMethod<#class_name> for ThisMethod #ty_generics #where_clause {
                type Args = Args #ty_generics;

                fn spawn_with(
                    &self,
                    __spawner: #gdnative_async::Spawner::<'_, #class_name, Self::Args>,
                ) {
                    __spawner.spawn(move |__ctx, __this, __args| {
                        let __future = __this
                            .#map_method(move |__rust_val, __base| {
                                let Args { #(#destructure_arg_list,)* __generic_marker } = __args;

                                #[allow(unused_unsafe)]
                                unsafe {
                                    Some(<#class_name>::#method_name(
                                        #(#invoke_arg_list,)*
                                    ))
                                }
                            })
                            .unwrap_or_else(|err| {
                                #gdnative_core::godot_error!("gdnative-core: method call failed with error: {}", err);
                                #gdnative_core::godot_error!("gdnative-core: check module level documentation on gdnative::user_data for more information");
                                None
                            });

                        async move {
                            if let Some(__future) = __future {
                                let ret = __future.await;
                                #gdnative_core::core_types::OwnedToVariant::owned_to_variant(#recover)
                            } else {
                                #gdnative_core::core_types::Variant::nil()
                            }
                        }
                    });
                }

                fn site() -> Option<#gdnative_core::log::Site<'static>> {
                    Some(#gdnative_core::godot_site!(#class_name::#method_name))
                }
            }

            #gdnative_async::Async::new(#gdnative_async::StaticArgs::new(ThisMethod #turbofish_ty_generics {
                _marker: #generic_marker_ctor,
            }))
        }
    } else {
        quote_spanned! { sig_span =>
            #automatically_derived
            impl #impl_generics #gdnative_core::export::StaticArgsMethod<#class_name> for ThisMethod #ty_generics #where_clause {
                type Args = Args #ty_generics;
                fn call(
                    &self,
                    __this: TInstance<'_, #class_name, #gdnative_core::object::ownership::Shared>,
                    Args { #(#destructure_arg_list,)* __generic_marker }: Self::Args,
                ) -> #gdnative_core::core_types::Variant {
                    __this
                        .#map_method(|__rust_val, __base| {
                            #[allow(unused_unsafe)]
                            unsafe {
                                let ret = <#class_name>::#method_name(
                                    #(#invoke_arg_list,)*
                                );
                                #gdnative_core::core_types::OwnedToVariant::owned_to_variant(#recover)
                            }
                        })
                        .unwrap_or_else(|err| {
                            #gdnative_core::godot_error!("gdnative-core: method call failed with error: {}", err);
                            #gdnative_core::godot_error!("gdnative-core: check module level documentation on gdnative::user_data for more information");
                            #gdnative_core::core_types::Variant::nil()
                        })
                }

                fn site() -> Option<#gdnative_core::log::Site<'static>> {
                    Some(#gdnative_core::godot_site!(#class_name::#method_name))
                }
            }

            #gdnative_core::export::StaticArgs::new(ThisMethod #turbofish_ty_generics {
                _marker: #generic_marker_ctor,
            })
        }
    };

    // Necessary standard traits have to be implemented manually because the default derive isn't smart enough.
    let output = quote_spanned! { sig_span =>
        {
            struct ThisMethod #ty_generics #where_clause {
                _marker: #generic_marker_decl,
            }

            impl #impl_generics Copy for ThisMethod #ty_generics #where_clause {}
            impl #impl_generics Clone for ThisMethod #ty_generics #where_clause {
                fn clone(&self) -> Self {
                    *self
                }
            }

            impl #impl_generics Default for ThisMethod #ty_generics #where_clause {
                fn default() -> Self {
                    Self {
                        _marker: #generic_marker_ctor,
                    }
                }
            }

            unsafe impl #impl_generics Send for ThisMethod #ty_generics #where_clause {}
            unsafe impl #impl_generics Sync for ThisMethod #ty_generics #where_clause {}

            use #gdnative_core::export::{NativeClass, OwnerArg};
            use #gdnative_core::object::{Instance, TInstance};
            use #gdnative_core::derive::FromVarargs;

            #[derive(FromVarargs)]
            #automatically_derived
            struct Args #ty_generics #where_clause {
                #(#declare_arg_list,)*

                #[skip]
                __generic_marker: #generic_marker_decl,
            }

            #impl_body
        }
    };

    Ok(output)
}