282bd37e5c
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.
77 lines
3.7 KiB
C++
77 lines
3.7 KiB
C++
/*************************************************************************/
|
|
/* managed_callable.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef MANAGED_CALLABLE_H
|
|
#define MANAGED_CALLABLE_H
|
|
|
|
#include "core/os/mutex.h"
|
|
#include "core/templates/self_list.h"
|
|
#include "core/variant/callable.h"
|
|
|
|
#include "mono_gc_handle.h"
|
|
|
|
class ManagedCallable : public CallableCustom {
|
|
friend class CSharpLanguage;
|
|
GCHandleIntPtr delegate_handle;
|
|
void *trampoline = nullptr;
|
|
ObjectID object_id;
|
|
|
|
#ifdef GD_MONO_HOT_RELOAD
|
|
SelfList<ManagedCallable> self_instance = this;
|
|
static SelfList<ManagedCallable>::List instances;
|
|
static RBMap<ManagedCallable *, Array> instances_pending_reload;
|
|
static Mutex instances_mutex;
|
|
#endif
|
|
|
|
public:
|
|
uint32_t hash() const override;
|
|
String get_as_text() const override;
|
|
CompareEqualFunc get_compare_equal_func() const override;
|
|
CompareLessFunc get_compare_less_func() const override;
|
|
ObjectID get_object() const override;
|
|
void call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const override;
|
|
|
|
_FORCE_INLINE_ GCHandleIntPtr get_delegate() const { return delegate_handle; }
|
|
_FORCE_INLINE_ void *get_trampoline() const { return trampoline; }
|
|
|
|
static bool compare_equal(const CallableCustom *p_a, const CallableCustom *p_b);
|
|
static bool compare_less(const CallableCustom *p_a, const CallableCustom *p_b);
|
|
|
|
static constexpr CompareEqualFunc compare_equal_func_ptr = &ManagedCallable::compare_equal;
|
|
static constexpr CompareEqualFunc compare_less_func_ptr = &ManagedCallable::compare_less;
|
|
|
|
void release_delegate_handle();
|
|
|
|
ManagedCallable(GCHandleIntPtr p_delegate_handle, void *p_trampoline, ObjectID p_object_id);
|
|
~ManagedCallable();
|
|
};
|
|
|
|
#endif // MANAGED_CALLABLE_H
|