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.
130 lines
5 KiB
C++
130 lines
5 KiB
C++
/*************************************************************************/
|
|
/* managed_callable.cpp */
|
|
/*************************************************************************/
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#include "managed_callable.h"
|
|
|
|
#include "csharp_script.h"
|
|
#include "mono_gd/gd_mono_cache.h"
|
|
|
|
#ifdef GD_MONO_HOT_RELOAD
|
|
SelfList<ManagedCallable>::List ManagedCallable::instances;
|
|
RBMap<ManagedCallable *, Array> ManagedCallable::instances_pending_reload;
|
|
Mutex ManagedCallable::instances_mutex;
|
|
#endif
|
|
|
|
bool ManagedCallable::compare_equal(const CallableCustom *p_a, const CallableCustom *p_b) {
|
|
const ManagedCallable *a = static_cast<const ManagedCallable *>(p_a);
|
|
const ManagedCallable *b = static_cast<const ManagedCallable *>(p_b);
|
|
|
|
if (!a->delegate_handle.value || !b->delegate_handle.value) {
|
|
if (!a->delegate_handle.value && !b->delegate_handle.value) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
// Call Delegate's 'Equals'
|
|
return GDMonoCache::managed_callbacks.DelegateUtils_DelegateEquals(
|
|
a->delegate_handle, b->delegate_handle);
|
|
}
|
|
|
|
bool ManagedCallable::compare_less(const CallableCustom *p_a, const CallableCustom *p_b) {
|
|
if (compare_equal(p_a, p_b)) {
|
|
return false;
|
|
}
|
|
return p_a < p_b;
|
|
}
|
|
|
|
uint32_t ManagedCallable::hash() const {
|
|
return hash_murmur3_one_64((uint64_t)delegate_handle.value);
|
|
}
|
|
|
|
String ManagedCallable::get_as_text() const {
|
|
return "Delegate::Invoke";
|
|
}
|
|
|
|
CallableCustom::CompareEqualFunc ManagedCallable::get_compare_equal_func() const {
|
|
return compare_equal_func_ptr;
|
|
}
|
|
|
|
CallableCustom::CompareLessFunc ManagedCallable::get_compare_less_func() const {
|
|
return compare_less_func_ptr;
|
|
}
|
|
|
|
ObjectID ManagedCallable::get_object() const {
|
|
if (object_id != ObjectID()) {
|
|
return object_id;
|
|
}
|
|
return CSharpLanguage::get_singleton()->get_managed_callable_middleman()->get_instance_id();
|
|
}
|
|
|
|
void ManagedCallable::call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const {
|
|
r_call_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD; // Can't find anything better
|
|
r_return_value = Variant();
|
|
|
|
ERR_FAIL_COND(delegate_handle.value == nullptr);
|
|
|
|
GDMonoCache::managed_callbacks.DelegateUtils_InvokeWithVariantArgs(
|
|
delegate_handle, trampoline, p_arguments, p_argcount, &r_return_value);
|
|
|
|
r_call_error.error = Callable::CallError::CALL_OK;
|
|
}
|
|
|
|
void ManagedCallable::release_delegate_handle() {
|
|
if (delegate_handle.value) {
|
|
GDMonoCache::managed_callbacks.GCHandleBridge_FreeGCHandle(delegate_handle);
|
|
delegate_handle = { nullptr };
|
|
}
|
|
}
|
|
|
|
// Why you do this clang-format...
|
|
/* clang-format off */
|
|
ManagedCallable::ManagedCallable(GCHandleIntPtr p_delegate_handle, void *p_trampoline, ObjectID p_object_id) :
|
|
delegate_handle(p_delegate_handle), trampoline(p_trampoline), object_id(p_object_id) {
|
|
#ifdef GD_MONO_HOT_RELOAD
|
|
{
|
|
MutexLock lock(instances_mutex);
|
|
instances.add(&self_instance);
|
|
}
|
|
#endif
|
|
}
|
|
/* clang-format on */
|
|
|
|
ManagedCallable::~ManagedCallable() {
|
|
#ifdef GD_MONO_HOT_RELOAD
|
|
{
|
|
MutexLock lock(instances_mutex);
|
|
instances.remove(&self_instance);
|
|
instances_pending_reload.erase(this);
|
|
}
|
|
#endif
|
|
|
|
release_delegate_handle();
|
|
}
|