virtualx-engine/modules/mono/editor/Godot.NET.Sdk/Godot.SourceGenerators
Ignacio Roldán Etcheverry 282bd37e5c C#: Remove need for reflection to invoking callable delegates
We aim to make the C# API reflection-free, mainly for concerns about
performance, and to be able to target NativeAOT in refletion-free mode,
which reduces the binary size.

One of the main usages of reflection still left was the dynamic
invokation of callable delegates, and for some time I wasn't sure
I would find an alternative solution that I'd be happy with.

The new solution uses trampoline functions to invoke the delegates:

```
static void Trampoline(object delegateObj, NativeVariantPtrArgs args, out godot_variant ret)
{
    if (args.Count != 1)
        throw new ArgumentException($"Callable expected 1 arguments but received {args.Count}.");

    string res = ((Func<int, string>)delegateObj)(
        VariantConversionCallbacks.GetToManagedCallback<int>()(args[0])
    );

    ret = VariantConversionCallbacks.GetToVariantCallback<string>()(res);
}

Callable.CreateWithUnsafeTrampoline((int num) => "Foo" + num, &Trampoline);
```

Of course, this is too much boilerplate for user code. To improve this,
the `Callable.From` methods were added. These are overloads that take
`Action` and `Func` delegates, which covers the most common use cases:
lambdas and method groups:

```
// Lambda
Callable.From((int num) => "Foo" + num);

// Method group
string AppendNum(int num) => "Foo" + num;
Callable.From(AppendNum);
```

Unfortunately, due to limitations in the C# language, implicit
conversions from delegates to `Callable` are not supported.

`Callable.From` does not support custom delegates. These should be
uncommon, but the Godot C# API actually uses them for event signals.
As such, the bindings generator was updated to generate trampoline
functions for event signals. It was also optimized to use `Action`
instead of a custom delegate for parameterless signals, which removes
the need for the trampoline functions for those signals.

The change to reflection-free invokation removes one of the last needs
for `ConvertVariantToManagedObjectOfType`. The only remaining usage is
from calling script constructors with parameters from the engine
(`CreateManagedForGodotObjectScriptInstance`). Once that one is made
reflection-free, `ConvertVariantToManagedObjectOfType` can be removed.
2022-10-30 01:24:15 +02:00
..
Common.cs C#: Ignore property indexers and report if exported 2022-08-28 18:16:57 +02:00
EventHandlerSuffixSuppressor.cs C#: Suppress EventHandler suffix diagnostic for signals 2022-09-22 14:23:01 +02:00
ExtensionMethods.cs C#: Guard against null assemblies 2022-09-22 12:41:38 +02:00
Godot.SourceGenerators.csproj C#: Make GodotSharp API a NuGet package 2022-08-22 03:36:51 +02:00
Godot.SourceGenerators.props C#/netcore: Add base desktop game export implementation 2022-08-22 03:36:51 +02:00
GodotClasses.cs Add MustBeVariant attribute and analyzer 2022-08-25 01:47:40 +02:00
GodotEnums.cs C#: Add source generator for signals as events 2022-08-22 03:36:52 +02:00
GodotMemberData.cs C#: Preserve order of exported fields/categories 2022-08-25 20:39:57 +02:00
GodotPluginsInitializerGenerator.cs Use .generated suffix for generated C# code 2022-10-22 23:13:52 +02:00
MarshalType.cs C#: Re-introduce generic Godot Array and Dictionary 2022-08-22 03:36:52 +02:00
MarshalUtils.cs C#: Guard against null assemblies 2022-09-22 12:41:38 +02:00
MethodInfo.cs C#: Add source generator for signals as events 2022-08-22 03:36:52 +02:00
MustBeVariantAnalyzer.cs C#: Make MustBeVariantAnalyzer ignore OmittedTypeArgument 2022-09-06 18:51:45 +02:00
PropertyInfo.cs C#: Add source generator for signals as events 2022-08-22 03:36:52 +02:00
ScriptMethodsGenerator.cs C#: Remove need for reflection to invoking callable delegates 2022-10-30 01:24:15 +02:00
ScriptPathAttributeGenerator.cs Use .generated suffix for generated C# code 2022-10-22 23:13:52 +02:00
ScriptPropertiesGenerator.cs Use .generated suffix for generated C# code 2022-10-22 23:13:52 +02:00
ScriptPropertyDefValGenerator.cs Use .generated suffix for generated C# code 2022-10-22 23:13:52 +02:00
ScriptRegistrarGenerator.cs C#: Add initial implementation of source generator for script members 2022-08-22 03:36:51 +02:00
ScriptSerializationGenerator.cs Use .generated suffix for generated C# code 2022-10-22 23:13:52 +02:00
ScriptSignalsGenerator.cs C#: Remove need for reflection to invoking callable delegates 2022-10-30 01:24:15 +02:00