Skip to content

Commit

Permalink
Add CallableCustom that devs can use in their GDExtensions
Browse files Browse the repository at this point in the history
  • Loading branch information
dsnopek committed Oct 22, 2023
1 parent 0a6a19e commit c1f3235
Show file tree
Hide file tree
Showing 5 changed files with 157 additions and 13 deletions.
5 changes: 5 additions & 0 deletions binding_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,9 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
if class_name == "Array":
result.append("#include <godot_cpp/variant/array_helpers.hpp>")

if class_name == "Callable":
result.append("#include <godot_cpp/variant/callable_custom.hpp>")

for include in fully_used_classes:
if include == "TypedArray":
result.append("#include <godot_cpp/variant/typed_array.hpp>")
Expand Down Expand Up @@ -525,6 +528,8 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
result.append(f"\t{class_name}(const wchar_t *from);")
result.append(f"\t{class_name}(const char16_t *from);")
result.append(f"\t{class_name}(const char32_t *from);")
if class_name == "Callable":
result.append("\tCallable(CallableCustom *p_custom);")

if "constants" in builtin_api:
axis_constants_count = 0
Expand Down
59 changes: 59 additions & 0 deletions include/godot_cpp/variant/callable_custom.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/**************************************************************************/
/* callable_custom.hpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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 GODOT_CALLABLE_CUSTOM_HPP
#define GODOT_CALLABLE_CUSTOM_HPP

#include <godot_cpp/variant/string_name.hpp>

namespace godot {

class Object;

class CallableCustom {
public:
typedef GDExtensionBool (*CompareEqualFunc)(const CallableCustom *p_a, const CallableCustom *p_b);
typedef GDExtensionBool (*CompareLessFunc)(const CallableCustom *p_a, const CallableCustom *p_b);

virtual uint32_t hash() const = 0;
virtual String get_as_text() const = 0;
virtual CompareEqualFunc get_compare_equal_func() const = 0;
virtual CompareLessFunc get_compare_less_func() const = 0;
virtual bool is_valid() const = 0;
virtual StringName get_method() const = 0;
virtual Object *get_object() const = 0;
virtual void call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, GDExtensionCallError &r_call_error) const = 0;

virtual ~CallableCustom() {}
};

} // namespace godot

#endif // GODOT_CALLABLE_CUSTOM_HPP
12 changes: 6 additions & 6 deletions include/godot_cpp/variant/callable_method_pointer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class CallableCustomMethodPointerBase {

namespace internal {

Callable create_custom_callable(CallableCustomMethodPointerBase *p_callable_method_pointer);
Callable create_callable_from_ccmp(CallableCustomMethodPointerBase *p_callable_method_pointer);

} // namespace internal

Expand Down Expand Up @@ -77,7 +77,7 @@ template <class T, class... P>
Callable create_custom_callable_function_pointer(T *p_instance, void (T::*p_method)(P...)) {
typedef CallableCustomMethodPointer<T, P...> CCMP;
CCMP *ccmp = memnew(CCMP(p_instance, p_method));
return ::godot::internal::create_custom_callable(ccmp);
return ::godot::internal::create_callable_from_ccmp(ccmp);
}

//
Expand Down Expand Up @@ -109,7 +109,7 @@ template <class T, class R, class... P>
Callable create_custom_callable_function_pointer(T *p_instance, R (T::*p_method)(P...)) {
typedef CallableCustomMethodPointerRet<T, R, P...> CCMP; // Messes with memnew otherwise.
CCMP *ccmp = memnew(CCMP(p_instance, p_method));
return ::godot::internal::create_custom_callable(ccmp);
return ::godot::internal::create_callable_from_ccmp(ccmp);
}

//
Expand Down Expand Up @@ -141,7 +141,7 @@ template <class T, class R, class... P>
Callable create_custom_callable_function_pointer(const T *p_instance, R (T::*p_method)(P...) const) {
typedef CallableCustomMethodPointerRetC<T, R, P...> CCMP; // Messes with memnew otherwise.
CCMP *ccmp = memnew(CCMP(p_instance, p_method));
return ::godot::internal::create_custom_callable(ccmp);
return ::godot::internal::create_callable_from_ccmp(ccmp);
}

//
Expand Down Expand Up @@ -171,7 +171,7 @@ template <class... P>
Callable create_custom_callable_static_function_pointer(void (*p_method)(P...)) {
typedef CallableCustomStaticMethodPointer<P...> CCMP;
CCMP *ccmp = memnew(CCMP(p_method));
return ::godot::internal::create_custom_callable(ccmp);
return ::godot::internal::create_callable_from_ccmp(ccmp);
}

//
Expand Down Expand Up @@ -201,7 +201,7 @@ template <class R, class... P>
Callable create_custom_callable_static_function_pointer(R (*p_method)(P...)) {
typedef CallableCustomStaticMethodPointerRet<R, P...> CCMP;
CCMP *ccmp = memnew(CCMP(p_method));
return ::godot::internal::create_custom_callable(ccmp);
return ::godot::internal::create_callable_from_ccmp(ccmp);
}

//
Expand Down
82 changes: 82 additions & 0 deletions src/variant/callable_custom.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
/**************************************************************************/
/* callable_custom.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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 <godot_cpp/variant/callable_custom.hpp>

#include <godot_cpp/classes/object.hpp>
#include <godot_cpp/variant/callable.hpp>

namespace godot {

static void callable_custom_call(void *p_userdata, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error) {
CallableCustom *callable_custom = (CallableCustom *)p_userdata;
callable_custom->call((const Variant **)p_args, p_argument_count, *(Variant *)r_return, *r_error);
}

static GDExtensionBool callable_custom_is_valid(void *p_userdata) {
CallableCustom *callable_custom = (CallableCustom *)p_userdata;
return callable_custom->is_valid();
}

static void callable_custom_free(void *p_userdata) {
CallableCustom *callable_custom = (CallableCustom *)p_userdata;
memdelete(callable_custom);
}

static uint32_t callable_custom_hash(void *p_userdata) {
CallableCustom *callable_custom = (CallableCustom *)p_userdata;
return callable_custom->hash();
}

static void callable_custom_to_string(void *p_userdata, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out) {
CallableCustom *callable_custom = (CallableCustom *)p_userdata;
*((String *)r_out) = callable_custom->get_as_text();
*r_is_valid = true;
}

Callable::Callable(CallableCustom *p_callable_custom) {
Object *object = p_callable_custom->get_object();

GDExtensionCallableCustomInfo info = {};
info.callable_userdata = p_callable_custom;
info.token = internal::token;
info.object = object != nullptr ? object->_owner : nullptr;
info.call_func = &callable_custom_call;
info.is_valid_func = &callable_custom_is_valid;
info.free_func = &callable_custom_free;
info.hash_func = &callable_custom_hash;
info.equal_func = (GDExtensionCallableCustomEqual)p_callable_custom->get_compare_equal_func();
info.less_than_func = (GDExtensionCallableCustomLessThan)p_callable_custom->get_compare_less_func();
info.to_string_func = &callable_custom_to_string;

::godot::internal::gdextension_interface_callable_custom_create(_native_ptr(), &info);
}

} // namespace godot
12 changes: 5 additions & 7 deletions src/variant/callable_method_pointer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -30,31 +30,29 @@

#include <godot_cpp/variant/callable_method_pointer.hpp>

//#include <godot_cpp/godot.hpp>

namespace godot {

static void call_custom_callable(void *userdata, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error) {
static void custom_callable_mp_call(void *userdata, const GDExtensionConstVariantPtr *p_args, GDExtensionInt p_argument_count, GDExtensionVariantPtr r_return, GDExtensionCallError *r_error) {
CallableCustomMethodPointerBase *callable_method_pointer = (CallableCustomMethodPointerBase *)userdata;
callable_method_pointer->call((const Variant **)p_args, p_argument_count, *(Variant *)r_return, *r_error);
}

static void free_custom_callable(void *userdata) {
static void custom_callable_mp_free(void *userdata) {
CallableCustomMethodPointerBase *callable_method_pointer = (CallableCustomMethodPointerBase *)userdata;
memdelete(callable_method_pointer);
}

namespace internal {

Callable create_custom_callable(CallableCustomMethodPointerBase *p_callable_method_pointer) {
Callable create_callable_from_ccmp(CallableCustomMethodPointerBase *p_callable_method_pointer) {
Object *object = p_callable_method_pointer->get_object();

GDExtensionCallableCustomInfo info = {};
info.callable_userdata = p_callable_method_pointer;
info.token = internal::token;
info.object = object != nullptr ? object->_owner : nullptr;
info.call_func = &call_custom_callable;
info.free_func = &free_custom_callable;
info.call_func = &custom_callable_mp_call;
info.free_func = &custom_callable_mp_free;

Callable callable;
::godot::internal::gdextension_interface_callable_custom_create(callable._native_ptr(), &info);
Expand Down

0 comments on commit c1f3235

Please sign in to comment.