Sara.Sync
/
godot-cpp
mirror of https://github.com/godotengine/godot-cpp
0
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
godot-cpp/include/godot_cpp/classes/wrapped.hpp

519 lines
64 KiB
C++
Raw Normal View History

Sync license copyright with upstream GH-70885
2023-01-10 15:14:30 +00:00
/**************************************************************************/
/* wrapped.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. */
/**************************************************************************/
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
Run scripts to format and make headers consistent
2022-10-09 06:47:07 +00:00
#ifndef GODOT_WRAPPED_HPP
#define GODOT_WRAPPED_HPP
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
#include <godot_cpp/core/memory.hpp>
Add support for `_notification`, `_set`, `_get`, `_get_property_list`, `_property_can_revert`, `_property_get_revert`, and `_to_string` methods.
2022-08-19 07:30:06 +00:00
#include <godot_cpp/core/property_info.hpp>
#include <godot_cpp/templates/list.hpp>
Allow GDExtensions to register virtual methods and call them on scripts
2024-01-30 17:25:25 +00:00
#include <godot_cpp/templates/vector.hpp>
Add support for `_notification`, `_set`, `_get`, `_get_property_list`, `_property_can_revert`, `_property_get_revert`, and `_to_string` methods.
2022-08-19 07:30:06 +00:00
Change constructor/destructor management of extension classes This makes sure custom constructors are always called on extension classes. However, note that constructors should not take any parameters, since Godot doesn't support that. Parameters are ignore in memnew macro. Use memnew(MyClass()) instead of memnew(MyClass) since it now needs a value instead of a class name. This macro calls MyClass::_new() (define in GDCLASS macro) which ultimately calls Godot to create the object, ensuring that both the Godot and the extension instances are created. Non Godot classes (that don't derive godot::Object) are constructed as usual an can have parameters. memdelete is also changed for the same reason, as it needs to destroy the Godot object as well, and that automatically frees the bound extension instance.
2021-09-09 23:40:40 +00:00
#include <godot_cpp/godot.hpp>
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
Avoid `thread_local` on MacOS to prevent issues with hot reload
2024-09-17 19:53:39 +00:00
#if defined(MACOS_ENABLED) && defined(HOT_RELOAD_ENABLED)
#include <mutex>
#define _GODOT_CPP_AVOID_THREAD_LOCAL
#define _GODOT_CPP_THREAD_LOCAL
#else
#define _GODOT_CPP_THREAD_LOCAL thread_local
#endif
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
namespace godot {
Fix GDCLASS needs explicit ClassDB fwd declaration
2022-12-16 12:49:10 +00:00
class ClassDB;
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
typedef void GodotObject;
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
template <typename T, std::enable_if_t<std::is_base_of<::godot::Wrapped, T>::value, bool> = true>
_ALWAYS_INLINE_ void _pre_initialize();
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
// Base for all engine classes, to contain the pointer to the engine instance.
class Wrapped {
friend class GDExtensionBinding;
Rework GDCLASS macro to allow pure virtual functions
2024-01-12 20:25:56 +00:00
friend class ClassDB;
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
friend void postinitialize_handler(Wrapped *);
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
template <typename T, std::enable_if_t<std::is_base_of<::godot::Wrapped, T>::value, bool>>
friend _ALWAYS_INLINE_ void _pre_initialize();
Avoid `thread_local` on MacOS to prevent issues with hot reload
2024-09-17 19:53:39 +00:00
#ifdef _GODOT_CPP_AVOID_THREAD_LOCAL
static std::recursive_mutex _constructing_mutex;
#endif
_GODOT_CPP_THREAD_LOCAL static const StringName *_constructing_extension_class_name;
_GODOT_CPP_THREAD_LOCAL static const GDExtensionInstanceBindingCallbacks *_constructing_class_binding_callbacks;
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
Correctly set instance bindings on reload
2024-09-17 14:18:08 +00:00
#ifdef HOT_RELOAD_ENABLED
Avoid `thread_local` on MacOS to prevent issues with hot reload
2024-09-17 19:53:39 +00:00
_GODOT_CPP_THREAD_LOCAL static GDExtensionObjectPtr _constructing_recreate_owner;
Correctly set instance bindings on reload
2024-09-17 14:18:08 +00:00
#endif
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
template <typename T>
_ALWAYS_INLINE_ static void _set_construct_info() {
_constructing_extension_class_name = T::_get_extension_class_name();
_constructing_class_binding_callbacks = &T::_gde_binding_callbacks;
}
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
protected:
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
virtual bool _is_extension_class() const { return false; }
static const StringName *_get_extension_class_name(); // This is needed to retrieve the class name before the godot object has its _extension and _extension_instance members assigned.
Basic static analysis fixes - remove extraneous semicolons - use "nullptr" instead of "0" - remove "break" after "return" - use <cstdio> instead of <stdio.h>
2022-11-18 18:33:28 +00:00
void _notification(int p_what) {}
bool _set(const StringName &p_name, const Variant &p_property) { return false; }
bool _get(const StringName &p_name, Variant &r_property) const { return false; }
void _get_property_list(List<PropertyInfo> *p_list) const {}
bool _property_can_revert(const StringName &p_name) const { return false; }
bool _property_get_revert(const StringName &p_name, Variant &r_property) const { return false; }
Support `_validate_property()`
2023-09-09 17:52:31 +00:00
void _validate_property(PropertyInfo &p_property) const {}
Add support for `_notification`, `_set`, `_get`, `_get_property_list`, `_property_can_revert`, `_property_get_revert`, and `_to_string` methods.
2022-08-19 07:30:06 +00:00
String _to_string() const { return "[" + String(get_class_static()) + ":" + itos(get_instance_id()) + "]"; }
GDExtension: fix `bool` unknown in C
2023-09-02 10:59:46 +00:00
static void notification_bind(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed) {}
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static GDExtensionBool set_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value) { return false; }
static GDExtensionBool get_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { return false; }
static const GDExtensionPropertyInfo *get_property_list_bind(GDExtensionClassInstancePtr p_instance, uint32_t *r_count) { return nullptr; }
Update `free_property_list` callback to take count
2024-04-26 18:40:13 +00:00
static void free_property_list_bind(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t p_count) {}
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static GDExtensionBool property_can_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name) { return false; }
static GDExtensionBool property_get_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { return false; }
Support `_validate_property()`
2023-09-09 17:52:31 +00:00
static GDExtensionBool validate_property_bind(GDExtensionClassInstancePtr p_instance, GDExtensionPropertyInfo *p_property) { return false; }
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static void to_string_bind(GDExtensionClassInstancePtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out) {}
Add support for `_notification`, `_set`, `_get`, `_get_property_list`, `_property_can_revert`, `_property_get_revert`, and `_to_string` methods.
2022-08-19 07:30:06 +00:00
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
// The only reason this has to be held here, is when we return results of `_get_property_list` to Godot, we pass
// pointers to strings in this list. They have to remain valid to pass the bridge, until the list is freed by Godot...
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
::godot::List<::godot::PropertyInfo> plist_owned;
Add support for `_notification`, `_set`, `_get`, `_get_property_list`, `_property_can_revert`, `_property_get_revert`, and `_to_string` methods.
2022-08-19 07:30:06 +00:00
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
void _postinitialize();
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
Wrapped(const StringName p_godot_class);
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
Wrapped(GodotObject *p_godot_object);
"Wrapped" has virtual functions so it should have a virtual destructor. Deleting an object through a pointer to a base class is undefined behaviour unless the destructor in the base class is virtual.
2023-01-18 00:30:18 +00:00
virtual ~Wrapped() {}
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
public:
mark return value of `get_class_static` and `get_parent_class_static` as const
2024-05-16 18:06:59 +00:00
static const StringName &get_class_static() {
static const StringName string_name = StringName("Wrapped");
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
return string_name;
Fix GDCLASS when inherited class is in another namespace
2022-02-20 19:23:14 +00:00
}
Add support for `_notification`, `_set`, `_get`, `_get_property_list`, `_property_can_revert`, `_property_get_revert`, and `_to_string` methods.
2022-08-19 07:30:06 +00:00
uint64_t get_instance_id() const {
return 0;
}
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
// Must be public but you should not touch this.
GodotObject *_owner = nullptr;
Change constructor/destructor management of extension classes This makes sure custom constructors are always called on extension classes. However, note that constructors should not take any parameters, since Godot doesn't support that. Parameters are ignore in memnew macro. Use memnew(MyClass()) instead of memnew(MyClass) since it now needs a value instead of a class name. This macro calls MyClass::_new() (define in GDCLASS macro) which ultimately calls Godot to create the object, ensuring that both the Godot and the extension instances are created. Non Godot classes (that don't derive godot::Object) are constructed as usual an can have parameters. memdelete is also changed for the same reason, as it needs to destroy the Godot object as well, and that automatically frees the bound extension instance.
2021-09-09 23:40:40 +00:00
};
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
template <typename T, std::enable_if_t<std::is_base_of<::godot::Wrapped, T>::value, bool>>
_ALWAYS_INLINE_ void _pre_initialize() {
Avoid `thread_local` on MacOS to prevent issues with hot reload
2024-09-17 19:53:39 +00:00
#ifdef _GODOT_CPP_AVOID_THREAD_LOCAL
Wrapped::_constructing_mutex.lock();
#endif
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
Wrapped::_set_construct_info<T>();
}
Allow GDExtensions to register virtual methods and call them on scripts
2024-01-30 17:25:25 +00:00
_FORCE_INLINE_ void snarray_add_str(Vector<StringName> &arr) {
}
_FORCE_INLINE_ void snarray_add_str(Vector<StringName> &arr, const StringName &p_str) {
arr.push_back(p_str);
}
Enforce template syntax `typename` over `class`
2024-03-10 21:02:43 +00:00
template <typename... P>
Allow GDExtensions to register virtual methods and call them on scripts
2024-01-30 17:25:25 +00:00
_FORCE_INLINE_ void snarray_add_str(Vector<StringName> &arr, const StringName &p_str, P... p_args) {
arr.push_back(p_str);
snarray_add_str(arr, p_args...);
}
Enforce template syntax `typename` over `class`
2024-03-10 21:02:43 +00:00
template <typename... P>
Allow GDExtensions to register virtual methods and call them on scripts
2024-01-30 17:25:25 +00:00
_FORCE_INLINE_ Vector<StringName> snarray(P... p_args) {
Vector<StringName> arr;
snarray_add_str(arr, p_args...);
return arr;
}
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
namespace internal {
GDExtensionPropertyInfo *create_c_property_list(const ::godot::List<::godot::PropertyInfo> &plist_cpp, uint32_t *r_size);
void free_c_property_list(GDExtensionPropertyInfo *plist);
Automatically register only engine classes whose header has been included
2023-10-12 03:59:59 +00:00
typedef void (*EngineClassRegistrationCallback)();
void add_engine_class_registration_callback(EngineClassRegistrationCallback p_callback);
void register_engine_class(const StringName &p_name, const GDExtensionInstanceBindingCallbacks *p_callbacks);
void register_engine_classes();
Enforce template syntax `typename` over `class`
2024-03-10 21:02:43 +00:00
template <typename T>
Automatically register only engine classes whose header has been included
2023-10-12 03:59:59 +00:00
struct EngineClassRegistration {
EngineClassRegistration() {
add_engine_class_registration_callback(&EngineClassRegistration<T>::callback);
}
static void callback() {
register_engine_class(T::get_class_static(), &T::_gde_binding_callbacks);
}
};
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
} // namespace internal
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
} // namespace godot
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
// Use this on top of your own classes.
// Note: the trail of `***` is to keep sane diffs in PRs, because clang-format otherwise moves every `\` which makes
// every line of the macro different
#define GDCLASS(m_class, m_inherits) /***********************************************************************************************************************************************/ \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
private: \
removes warnings generated by GDCLASS usage This change removes the warnings (unused parameters) coming from code injected by the GDCLASS macro. Contrary to warnings coming from the normal source code which can be suppressed with most compiles by specifying the include directories of this library as external or system, when the code is injected through a macro it is considered in the context of the user, which is the source code of user of the library. That forces the users to modify their code to hide the warnings coming from the mandatory `GDCLASS` here. That's why it's important to remove these warning from that specific macro and ideally any other macro that the user must use.
2024-08-08 00:10:41 +00:00
void operator=(const m_class & /*p_rval*/) {} \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
friend class ::godot::ClassDB; \
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
friend class ::godot::Wrapped; \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
\
protected: \
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
virtual bool _is_extension_class() const override { return true; } \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
\
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
static const ::godot::StringName *_get_extension_class_name() { \
const ::godot::StringName &string_name = get_class_static(); \
return &string_name; \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
\
static void (*_get_bind_methods())() { \
return &m_class::_bind_methods; \
} \
\
static void (::godot::Wrapped::*_get_notification())(int) { \
return (void(::godot::Wrapped::*)(int)) & m_class::_notification; \
} \
\
static bool (::godot::Wrapped::*_get_set())(const ::godot::StringName &p_name, const ::godot::Variant &p_property) { \
return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name, const ::godot::Variant &p_property)) & m_class::_set; \
} \
\
static bool (::godot::Wrapped::*_get_get())(const ::godot::StringName &p_name, ::godot::Variant &r_ret) const { \
return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name, ::godot::Variant &r_ret) const) & m_class::_get; \
} \
\
static void (::godot::Wrapped::*_get_get_property_list())(::godot::List<::godot::PropertyInfo> * p_list) const { \
return (void(::godot::Wrapped::*)(::godot::List<::godot::PropertyInfo> * p_list) const) & m_class::_get_property_list; \
} \
\
Ensure `const` correctness for wrappers
2023-09-06 17:32:55 +00:00
static bool (::godot::Wrapped::*_get_property_can_revert())(const ::godot::StringName &p_name) const { \
return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name) const) & m_class::_property_can_revert; \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
\
Ensure `const` correctness for wrappers
2023-09-06 17:32:55 +00:00
static bool (::godot::Wrapped::*_get_property_get_revert())(const ::godot::StringName &p_name, ::godot::Variant &) const { \
return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name, ::godot::Variant &) const) & m_class::_property_get_revert; \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
\
Support `_validate_property()`
2023-09-09 17:52:31 +00:00
static void (::godot::Wrapped::*_get_validate_property())(::godot::PropertyInfo & p_property) const { \
return (void(::godot::Wrapped::*)(::godot::PropertyInfo & p_property) const) & m_class::_validate_property; \
} \
\
Ensure `const` correctness for wrappers
2023-09-06 17:32:55 +00:00
static ::godot::String (::godot::Wrapped::*_get_to_string())() const { \
return (::godot::String(::godot::Wrapped::*)() const) & m_class::_to_string; \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
\
Enforce template syntax `typename` over `class`
2024-03-10 21:02:43 +00:00
template <typename T, typename B> \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
static void register_virtuals() { \
m_inherits::register_virtuals<T, B>(); \
} \
\
public: \
Add protections against registering classes that didn't use GDCLASS()
2023-10-21 22:54:46 +00:00
typedef m_class self_type; \
Give compile-time error if registering a class without its own `_bind_methods()` function
2024-04-24 19:26:06 +00:00
typedef m_inherits parent_type; \
Add protections against registering classes that didn't use GDCLASS()
2023-10-21 22:54:46 +00:00
\
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
static void initialize_class() { \
static bool initialized = false; \
if (initialized) { \
return; \
} \
m_inherits::initialize_class(); \
if (m_class::_get_bind_methods() != m_inherits::_get_bind_methods()) { \
_bind_methods(); \
m_inherits::register_virtuals<m_class, m_inherits>(); \
} \
initialized = true; \
} \
\
mark return value of `get_class_static` and `get_parent_class_static` as const
2024-05-16 18:06:59 +00:00
static const ::godot::StringName &get_class_static() { \
Allow unicode class names
2024-09-06 22:24:07 +00:00
static const ::godot::StringName string_name = ::godot::StringName(U## #m_class); \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
return string_name; \
} \
\
mark return value of `get_class_static` and `get_parent_class_static` as const
2024-05-16 18:06:59 +00:00
static const ::godot::StringName &get_parent_class_static() { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
return m_inherits::get_class_static(); \
} \
\
GDExtension: fix `bool` unknown in C
2023-09-02 10:59:46 +00:00
static void notification_bind(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (p_instance && m_class::_get_notification()) { \
Fix _notification with parent and child classes
2024-02-02 16:07:45 +00:00
if (!p_reversed) { \
m_inherits::notification_bind(p_instance, p_what, p_reversed); \
} \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (m_class::_get_notification() != m_inherits::_get_notification()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
Fix _notification with parent and child classes
2024-02-02 16:07:45 +00:00
cls->_notification(p_what); \
} \
if (p_reversed) { \
m_inherits::notification_bind(p_instance, p_what, p_reversed); \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
} \
} \
\
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static GDExtensionBool set_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value) { \
Make sure `_get` and `_set` dispatch up the class hierarchy
2024-08-01 00:06:07 +00:00
if (p_instance) { \
if (m_inherits::set_bind(p_instance, p_name, p_value)) { \
return true; \
} \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (m_class::_get_set() != m_inherits::_get_set()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
return cls->_set(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<const ::godot::Variant *>(p_value)); \
} \
} \
return false; \
} \
\
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static GDExtensionBool get_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { \
Make sure `_get` and `_set` dispatch up the class hierarchy
2024-08-01 00:06:07 +00:00
if (p_instance) { \
if (m_inherits::get_bind(p_instance, p_name, r_ret)) { \
return true; \
} \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (m_class::_get_get() != m_inherits::_get_get()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
return cls->_get(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<::godot::Variant *>(r_ret)); \
} \
} \
return false; \
} \
\
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
static inline bool has_get_property_list() { \
return m_class::_get_get_property_list() && m_class::_get_get_property_list() != m_inherits::_get_get_property_list(); \
} \
\
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static const GDExtensionPropertyInfo *get_property_list_bind(GDExtensionClassInstancePtr p_instance, uint32_t *r_count) { \
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
if (!p_instance) { \
if (r_count) \
*r_count = 0; \
return nullptr; \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
::godot::List<::godot::PropertyInfo> &plist_cpp = cls->plist_owned; \
ERR_FAIL_COND_V_MSG(!plist_cpp.is_empty(), nullptr, "Internal error, property list was not freed by engine!"); \
cls->_get_property_list(&plist_cpp); \
return ::godot::internal::create_c_property_list(plist_cpp, r_count); \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
\
removes warnings generated by GDCLASS usage This change removes the warnings (unused parameters) coming from code injected by the GDCLASS macro. Contrary to warnings coming from the normal source code which can be suppressed with most compiles by specifying the include directories of this library as external or system, when the code is injected through a macro it is considered in the context of the user, which is the source code of user of the library. That forces the users to modify their code to hide the warnings coming from the mandatory `GDCLASS` here. That's why it's important to remove these warning from that specific macro and ideally any other macro that the user must use.
2024-08-08 00:10:41 +00:00
static void free_property_list_bind(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list, uint32_t /*p_count*/) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (p_instance) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
cls->plist_owned.clear(); \
Don't call parent _get_property_list when a class doesn't define it. Godot is already supposed to call _get_property_list of parent classes, so this binding function must really only return procedural properties of the class it belongs to, and not parent or child classes.
2023-07-20 20:40:41 +00:00
::godot::internal::free_c_property_list(const_cast<GDExtensionPropertyInfo *>(p_list)); \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
} \
\
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static GDExtensionBool property_can_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (p_instance && m_class::_get_property_can_revert()) { \
if (m_class::_get_property_can_revert() != m_inherits::_get_property_can_revert()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
return cls->_property_can_revert(*reinterpret_cast<const ::godot::StringName *>(p_name)); \
} \
return m_inherits::property_can_revert_bind(p_instance, p_name); \
} \
return false; \
} \
\
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static GDExtensionBool property_get_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (p_instance && m_class::_get_property_get_revert()) { \
if (m_class::_get_property_get_revert() != m_inherits::_get_property_get_revert()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
return cls->_property_get_revert(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<::godot::Variant *>(r_ret)); \
} \
return m_inherits::property_get_revert_bind(p_instance, p_name, r_ret); \
} \
return false; \
} \
\
Support `_validate_property()`
2023-09-09 17:52:31 +00:00
static GDExtensionBool validate_property_bind(GDExtensionClassInstancePtr p_instance, GDExtensionPropertyInfo *p_property) { \
bool ret = false; \
if (p_instance && m_class::_get_validate_property()) { \
ret = m_inherits::validate_property_bind(p_instance, p_property); \
if (m_class::_get_validate_property() != m_inherits::_get_validate_property()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
::godot::PropertyInfo info(p_property); \
cls->_validate_property(info); \
info._update(p_property); \
return true; \
} \
} \
return ret; \
} \
\
Rename GDNative to GDExtension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension -> Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION -> EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 13:11:44 +00:00
static void to_string_bind(GDExtensionClassInstancePtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (p_instance && m_class::_get_to_string()) { \
if (m_class::_get_to_string() != m_inherits::_get_to_string()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
*reinterpret_cast<::godot::String *>(r_out) = cls->_to_string(); \
*r_is_valid = true; \
return; \
} \
m_inherits::to_string_bind(p_instance, r_is_valid, r_out); \
} \
} \
\
removes warnings generated by GDCLASS usage This change removes the warnings (unused parameters) coming from code injected by the GDCLASS macro. Contrary to warnings coming from the normal source code which can be suppressed with most compiles by specifying the include directories of this library as external or system, when the code is injected through a macro it is considered in the context of the user, which is the source code of user of the library. That forces the users to modify their code to hide the warnings coming from the mandatory `GDCLASS` here. That's why it's important to remove these warning from that specific macro and ideally any other macro that the user must use.
2024-08-08 00:10:41 +00:00
static void free(void * /*data*/, GDExtensionClassInstancePtr ptr) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
if (ptr) { \
m_class *cls = reinterpret_cast<m_class *>(ptr); \
cls->~m_class(); \
::godot::Memory::free_static(cls); \
} \
} \
\
removes warnings generated by GDCLASS usage This change removes the warnings (unused parameters) coming from code injected by the GDCLASS macro. Contrary to warnings coming from the normal source code which can be suppressed with most compiles by specifying the include directories of this library as external or system, when the code is injected through a macro it is considered in the context of the user, which is the source code of user of the library. That forces the users to modify their code to hide the warnings coming from the mandatory `GDCLASS` here. That's why it's important to remove these warning from that specific macro and ideally any other macro that the user must use.
2024-08-08 00:10:41 +00:00
static void *_gde_binding_create_callback(void * /*p_token*/, void * /*p_instance*/) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
return nullptr; \
} \
\
removes warnings generated by GDCLASS usage This change removes the warnings (unused parameters) coming from code injected by the GDCLASS macro. Contrary to warnings coming from the normal source code which can be suppressed with most compiles by specifying the include directories of this library as external or system, when the code is injected through a macro it is considered in the context of the user, which is the source code of user of the library. That forces the users to modify their code to hide the warnings coming from the mandatory `GDCLASS` here. That's why it's important to remove these warning from that specific macro and ideally any other macro that the user must use.
2024-08-08 00:10:41 +00:00
static void _gde_binding_free_callback(void * /*p_token*/, void * /*p_instance*/, void * /*p_binding*/) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
} \
\
removes warnings generated by GDCLASS usage This change removes the warnings (unused parameters) coming from code injected by the GDCLASS macro. Contrary to warnings coming from the normal source code which can be suppressed with most compiles by specifying the include directories of this library as external or system, when the code is injected through a macro it is considered in the context of the user, which is the source code of user of the library. That forces the users to modify their code to hide the warnings coming from the mandatory `GDCLASS` here. That's why it's important to remove these warning from that specific macro and ideally any other macro that the user must use.
2024-08-08 00:10:41 +00:00
static GDExtensionBool _gde_binding_reference_callback(void * /*p_token*/, void * /*p_instance*/, GDExtensionBool /*p_reference*/) { \
Fix lifetime of StringName objects returned by Wrapped::_get_property_list
2022-11-29 17:12:47 +00:00
return true; \
} \
\
Identifiers containing double underscore are reserved according to the C++ standard Rename __* to _gde_* https://timsong-cpp.github.io/cppwp/n3337/global.names https://en.cppreference.com/w/cpp/language/identifiers Identifiers appearing as a token or preprocessing token (i.e., not in user-defined-string-literal like operator ""id) (since C++11) of one of the following forms are reserved: - identifiers with a double underscore anywhere; - identifiers that begin with an underscore followed by an uppercase letter; - in the global namespace, identifiers that begin with an underscore.
2023-02-16 15:38:38 +00:00
static constexpr GDExtensionInstanceBindingCallbacks _gde_binding_callbacks = { \
_gde_binding_create_callback, \
_gde_binding_free_callback, \
_gde_binding_reference_callback, \
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
}; \
\
private:
Add support for `_notification`, `_set`, `_get`, `_get_property_list`, `_property_can_revert`, `_property_get_revert`, and `_to_string` methods.
2022-08-19 07:30:06 +00:00
// Don't use this for your classes, use GDCLASS() instead.
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
#define GDEXTENSION_CLASS_ALIAS(m_class, m_alias_for, m_inherits) /******************************************************************************************************************/ \
private: \
inline static ::godot::internal::EngineClassRegistration<m_class> _gde_engine_class_registration_helper; \
void operator=(const m_class &p_rval) {} \
Give compile-time error if registering a class without its own `_bind_methods()` function
2024-04-24 19:26:06 +00:00
friend class ::godot::ClassDB; \
Set instance and instance binding in Wrapped constructor.
2024-04-24 14:14:33 +00:00
friend class ::godot::Wrapped; \
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
\
protected: \
m_class(const char *p_godot_class) : m_inherits(p_godot_class) {} \
m_class(GodotObject *p_godot_object) : m_inherits(p_godot_object) {} \
\
Give compile-time error if registering a class without its own `_bind_methods()` function
2024-04-24 19:26:06 +00:00
static void _bind_methods() {} \
\
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
static void (*_get_bind_methods())() { \
return nullptr; \
} \
\
static void (Wrapped::*_get_notification())(int) { \
return nullptr; \
} \
\
static bool (Wrapped::*_get_set())(const ::godot::StringName &p_name, const Variant &p_property) { \
return nullptr; \
} \
\
static bool (Wrapped::*_get_get())(const ::godot::StringName &p_name, Variant &r_ret) const { \
return nullptr; \
} \
\
static inline bool has_get_property_list() { \
return false; \
} \
\
static void (Wrapped::*_get_get_property_list())(List<PropertyInfo> * p_list) const { \
return nullptr; \
} \
\
static bool (Wrapped::*_get_property_can_revert())(const ::godot::StringName &p_name) const { \
return nullptr; \
} \
\
static bool (Wrapped::*_get_property_get_revert())(const ::godot::StringName &p_name, Variant &) const { \
return nullptr; \
} \
\
static void (Wrapped::*_get_validate_property())(::godot::PropertyInfo & p_property) const { \
return nullptr; \
} \
\
static String (Wrapped::*_get_to_string())() const { \
return nullptr; \
} \
\
public: \
typedef m_class self_type; \
Give compile-time error if registering a class without its own `_bind_methods()` function
2024-04-24 19:26:06 +00:00
typedef m_inherits parent_type; \
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
\
static void initialize_class() {} \
\
mark return value of `get_class_static` and `get_parent_class_static` as const
2024-05-16 18:06:59 +00:00
static const ::godot::StringName &get_class_static() { \
static const ::godot::StringName string_name = ::godot::StringName(#m_alias_for); \
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
return string_name; \
} \
\
mark return value of `get_class_static` and `get_parent_class_static` as const
2024-05-16 18:06:59 +00:00
static const ::godot::StringName &get_parent_class_static() { \
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
return m_inherits::get_class_static(); \
} \
\
static void free(void *data, GDExtensionClassInstancePtr ptr) { \
} \
\
static void *_gde_binding_create_callback(void *p_token, void *p_instance) { \
/* Do not call memnew here, we don't want the post-initializer to be called */ \
[iOS] Fix building as static library or xcframework, add iOS config and xcframework build script to the test project.
2023-11-05 21:04:03 +00:00
return new ("", "") m_class((GodotObject *)p_instance); \
GDCLASS synced by ending with "private:" • Matches implementation used by modules and godot itself • Apply same to GDEXTENSION_CLASS, setup with same diff-friendly spacers as GDCLASS
2023-11-01 17:44:14 +00:00
} \
static void _gde_binding_free_callback(void *p_token, void *p_instance, void *p_binding) { \
/* Explicitly call the deconstructor to ensure proper lifecycle for non-trivial members */ \
reinterpret_cast<m_class *>(p_binding)->~m_class(); \
Memory::free_static(reinterpret_cast<m_class *>(p_binding)); \
} \
static GDExtensionBool _gde_binding_reference_callback(void *p_token, void *p_instance, GDExtensionBool p_reference) { \
return true; \
} \
static constexpr GDExtensionInstanceBindingCallbacks _gde_binding_callbacks = { \
_gde_binding_create_callback, \
_gde_binding_free_callback, \
_gde_binding_reference_callback, \
}; \
m_class() : m_class(#m_alias_for) {} \
\
private:
Add static methods to `ClassDB` for the methods bound to the `ClassDB` singleton
2023-07-07 02:16:27 +00:00
// Don't use this for your classes, use GDCLASS() instead.
#define GDEXTENSION_CLASS(m_class, m_inherits) GDEXTENSION_CLASS_ALIAS(m_class, m_class, m_inherits)
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
Allow GDExtensions to register virtual methods and call them on scripts
2024-01-30 17:25:25 +00:00
#define GDVIRTUAL_CALL(m_name, ...) _gdvirtual_##m_name##_call<false>(__VA_ARGS__)
#define GDVIRTUAL_CALL_PTR(m_obj, m_name, ...) m_obj->_gdvirtual_##m_name##_call<false>(__VA_ARGS__)
#define GDVIRTUAL_REQUIRED_CALL(m_name, ...) _gdvirtual_##m_name##_call<true>(__VA_ARGS__)
#define GDVIRTUAL_REQUIRED_CALL_PTR(m_obj, m_name, ...) m_obj->_gdvirtual_##m_name##_call<true>(__VA_ARGS__)
#define GDVIRTUAL_BIND(m_name, ...) ::godot::ClassDB::add_virtual_method(get_class_static(), _gdvirtual_##m_name##_get_method_info(), ::godot::snarray(__VA_ARGS__));
#define GDVIRTUAL_IS_OVERRIDDEN(m_name) _gdvirtual_##m_name##_overridden()
#define GDVIRTUAL_IS_OVERRIDDEN_PTR(m_obj, m_name) m_obj->_gdvirtual_##m_name##_overridden()
Run scripts to format and make headers consistent
2022-10-09 06:47:07 +00:00
#endif // GODOT_WRAPPED_HPP