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

381 lines
43 KiB
C++
Raw Normal View History

Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
/*************************************************************************/
/* wrapped.hpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright year
2022-03-15 09:17:53 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
/* */
/* 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. */
/*************************************************************************/
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>
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
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
namespace godot {
typedef void GodotObject;
// Base for all engine classes, to contain the pointer to the engine instance.
class Wrapped {
friend class GDExtensionBinding;
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
protected:
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
virtual const StringName *_get_extension_class_name() const; // This is needed to retrieve the class name before the godot object has its _extension and _extension_instance members assigned.
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
virtual const GDNativeInstanceBindingCallbacks *_get_bindings_callbacks() const = 0;
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
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; };
String _to_string() const { return "[" + String(get_class_static()) + ":" + itos(get_instance_id()) + "]"; }
static void notification_bind(GDExtensionClassInstancePtr p_instance, int32_t p_what) {}
static GDNativeBool set_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, const GDNativeVariantPtr p_value) { return false; }
static GDNativeBool get_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret) { return false; }
static const GDNativePropertyInfo *get_property_list_bind(GDExtensionClassInstancePtr p_instance, uint32_t *r_count) { return nullptr; }
static void free_property_list_bind(GDExtensionClassInstancePtr p_instance, const GDNativePropertyInfo *p_list) {}
static GDNativeBool property_can_revert_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name) { return false; }
static GDNativeBool property_get_revert_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret) { return false; }
Correct GDNativeExtensionScriptInstanceToString
2022-10-23 12:45:57 +00:00
static void to_string_bind(GDExtensionClassInstancePtr p_instance, GDNativeBool *r_is_valid, GDNativeStringPtr 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
GDNativePropertyInfo *plist = nullptr;
uint32_t plist_size = 0;
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);
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
public:
StringName is working fine with demo \o/
2022-10-23 20:31:57 +00:00
static StringName &get_class_static() {
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
static StringName string_name = StringName("Wrapped");
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
};
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
} // namespace godot
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
#define GDCLASS(m_class, m_inherits) \
private: \
void operator=(const m_class &p_rval) {} \
friend class ::godot::ClassDB; \
\
protected: \
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
virtual const ::godot::StringName *_get_extension_class_name() const override { \
static ::godot::StringName string_name = get_class_static(); \
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
return &string_name; \
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
} \
\
virtual const GDNativeInstanceBindingCallbacks *_get_bindings_callbacks() const override { \
return &___binding_callbacks; \
} \
\
static void (*_get_bind_methods())() { \
return &m_class::_bind_methods; \
} \
\
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
static void (::godot::Wrapped::*_get_notification())(int) { \
return (void(::godot::Wrapped::*)(int)) & m_class::_notification; \
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
} \
\
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
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; \
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
} \
\
Fix issues with `_get` and `_get_property_list` `_get` was using `_set` internally, and should be `const`. `_get_property_list` should be `const`.
2022-09-15 22:46:50 +00:00
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; \
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
} \
\
Fix issues with `_get` and `_get_property_list` `_get` was using `_set` internally, and should be `const`. `_get_property_list` should be `const`.
2022-09-15 22:46:50 +00:00
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; \
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
} \
\
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
static bool (::godot::Wrapped::*_get_property_can_revert())(const ::godot::StringName &p_name) { \
return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name)) & m_class::_property_can_revert; \
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
} \
\
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
static bool (::godot::Wrapped::*_get_property_get_revert())(const ::godot::StringName &p_name, ::godot::Variant &) { \
return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name, ::godot::Variant &)) & m_class::_property_get_revert; \
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
} \
\
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
static ::godot::String (::godot::Wrapped::*_get_to_string())() { \
return (::godot::String(::godot::Wrapped::*)()) & m_class::_to_string; \
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
} \
\
Fix deriving a custom class with virtual methods
2022-09-19 23:29:39 +00:00
template <class T, class B> \
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
static void register_virtuals() { \
Fix deriving a custom class with virtual methods
2022-09-19 23:29:39 +00:00
m_inherits::register_virtuals<T, B>(); \
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
} \
\
public: \
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(); \
Fix deriving a custom class with virtual methods
2022-09-19 23:29:39 +00:00
m_inherits::register_virtuals<m_class, m_inherits>(); \
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
} \
initialized = true; \
} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static ::godot::StringName &get_class_static() { \
static ::godot::StringName string_name = ::godot::StringName(#m_class); \
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
return string_name; \
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
} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static ::godot::StringName &get_parent_class_static() { \
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
return m_inherits::get_class_static(); \
} \
\
static GDNativeObjectPtr create(void *data) { \
m_class *new_object = memnew(m_class); \
return new_object->_owner; \
} \
\
static void notification_bind(GDExtensionClassInstancePtr p_instance, int32_t p_what) { \
if (p_instance && m_class::_get_notification()) { \
if (m_class::_get_notification() != m_inherits::_get_notification()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
return cls->_notification(p_what); \
} \
m_inherits::notification_bind(p_instance, p_what); \
} \
} \
\
static GDNativeBool set_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, const GDNativeVariantPtr p_value) { \
if (p_instance && m_class::_get_set()) { \
if (m_class::_get_set() != m_inherits::_get_set()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
return cls->_set(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<const ::godot::Variant *>(p_value)); \
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
} \
return m_inherits::set_bind(p_instance, p_name, p_value); \
} \
return false; \
} \
\
static GDNativeBool get_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret) { \
if (p_instance && m_class::_get_get()) { \
if (m_class::_get_get() != m_inherits::_get_get()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
return cls->_get(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<::godot::Variant *>(r_ret)); \
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
} \
return m_inherits::get_bind(p_instance, p_name, r_ret); \
} \
return false; \
} \
\
static const GDNativePropertyInfo *get_property_list_bind(GDExtensionClassInstancePtr p_instance, uint32_t *r_count) { \
if (p_instance && m_class::_get_get_property_list()) { \
if (m_class::_get_get_property_list() != m_inherits::_get_get_property_list()) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
::godot::List<::godot::PropertyInfo> list; \
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
cls->_get_property_list(&list); \
ERR_FAIL_COND_V_MSG(cls->plist != nullptr || cls->plist_size != 0, nullptr, "Internal error, property list was not freed by engine!"); \
cls->plist = reinterpret_cast<GDNativePropertyInfo *>(memalloc(sizeof(GDNativePropertyInfo) * list.size())); \
cls->plist_size = 0; \
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
for (const ::godot::PropertyInfo &E : list) { \
Type `GDNativePropertyInfo.type` field as `GDNativeVariantType`
2022-10-09 21:21:32 +00:00
cls->plist[cls->plist_size].type = static_cast<GDNativeVariantType>(E.type); \
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
cls->plist[cls->plist_size].name = E.name._native_ptr(); \
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
cls->plist[cls->plist_size].hint = E.hint; \
Use StringName in the whole GDExtension API instead of const char *
2022-10-22 17:42:48 +00:00
cls->plist[cls->plist_size].hint_string = E.hint_string._native_ptr(); \
cls->plist[cls->plist_size].class_name = E.class_name._native_ptr(); \
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
cls->plist[cls->plist_size].usage = E.usage; \
cls->plist_size++; \
} \
if (r_count) \
*r_count = cls->plist_size; \
return cls->plist; \
} \
return m_inherits::get_property_list_bind(p_instance, r_count); \
} \
return nullptr; \
} \
\
static void free_property_list_bind(GDExtensionClassInstancePtr p_instance, const GDNativePropertyInfo *p_list) { \
if (p_instance) { \
m_class *cls = reinterpret_cast<m_class *>(p_instance); \
ERR_FAIL_COND_MSG(cls->plist == nullptr, "Internal error, property list double free!"); \
memfree(cls->plist); \
cls->plist = nullptr; \
cls->plist_size = 0; \
} \
} \
\
static GDNativeBool property_can_revert_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name) { \
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); \
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
return cls->_property_can_revert(*reinterpret_cast<const ::godot::StringName *>(p_name)); \
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
} \
return m_inherits::property_can_revert_bind(p_instance, p_name); \
} \
return false; \
} \
\
static GDNativeBool property_get_revert_bind(GDExtensionClassInstancePtr p_instance, const GDNativeStringNamePtr p_name, GDNativeVariantPtr r_ret) { \
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); \
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
return cls->_property_get_revert(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<::godot::Variant *>(r_ret)); \
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
} \
return m_inherits::property_get_revert_bind(p_instance, p_name, r_ret); \
} \
return false; \
} \
\
Correct GDNativeExtensionScriptInstanceToString
2022-10-23 12:45:57 +00:00
static void to_string_bind(GDExtensionClassInstancePtr p_instance, GDNativeBool *r_is_valid, GDNativeStringPtr 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
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); \
Ensure GDCLASS can be used outside the godot namespace. The `GDCLASS` macro should not assume to be called inside the `godot` namespace and should thus prefix function calls for that namespace with `::godot::` to ensure proper namespace referencing.
2022-09-01 02:11:23 +00:00
*reinterpret_cast<::godot::String *>(r_out) = cls->_to_string(); \
Correct GDNativeExtensionScriptInstanceToString
2022-10-23 12:45:57 +00:00
*r_is_valid = true; \
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
return; \
} \
Correct GDNativeExtensionScriptInstanceToString
2022-10-23 12:45:57 +00:00
m_inherits::to_string_bind(p_instance, r_is_valid, 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
} \
} \
\
static void free(void *data, GDExtensionClassInstancePtr ptr) { \
if (ptr) { \
m_class *cls = reinterpret_cast<m_class *>(ptr); \
cls->~m_class(); \
::godot::Memory::free_static(cls); \
} \
} \
\
static void *___binding_create_callback(void *p_token, void *p_instance) { \
return nullptr; \
} \
\
static void ___binding_free_callback(void *p_token, void *p_instance, void *p_binding) { \
} \
\
static GDNativeBool ___binding_reference_callback(void *p_token, void *p_instance, GDNativeBool p_reference) { \
return true; \
} \
\
static constexpr GDNativeInstanceBindingCallbacks ___binding_callbacks = { \
___binding_create_callback, \
___binding_free_callback, \
___binding_reference_callback, \
};
// Don't use this for your classes, use GDCLASS() instead.
#define GDNATIVE_CLASS(m_class, m_inherits) \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
private: \
void operator=(const m_class &p_rval) {} \
\
protected: \
virtual const GDNativeInstanceBindingCallbacks *_get_bindings_callbacks() const override { \
return &___binding_callbacks; \
} \
\
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
m_class(const char *p_godot_class) : m_inherits(p_godot_class) {} \
m_class(GodotObject *p_godot_object) : m_inherits(p_godot_object) {} \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +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
static void (*_get_bind_methods())() { \
return nullptr; \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +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
static void (Wrapped::*_get_notification())(int) { \
return nullptr; \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static bool (Wrapped::*_get_set())(const ::godot::StringName &p_name, const Variant &p_property) { \
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
return nullptr; \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static bool (Wrapped::*_get_get())(const ::godot::StringName &p_name, Variant &r_ret) 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
return nullptr; \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
} \
\
Fix issues with `_get` and `_get_property_list` `_get` was using `_set` internally, and should be `const`. `_get_property_list` should be `const`.
2022-09-15 22:46:50 +00:00
static void (Wrapped::*_get_get_property_list())(List<PropertyInfo> * p_list) 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
return nullptr; \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static bool (Wrapped::*_get_property_can_revert())(const ::godot::StringName &p_name) { \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
return nullptr; \
} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static bool (Wrapped::*_get_property_get_revert())(const ::godot::StringName &p_name, Variant &) { \
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
return nullptr; \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +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
static String (Wrapped::*_get_to_string())() { \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
return nullptr; \
} \
\
public: \
static void initialize_class() {} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static ::godot::StringName &get_class_static() { \
static ::godot::StringName string_name = ::godot::StringName(#m_class); \
Uses `StringName` in GDExtension perf critical instance creation & method/properties setter/getter
2022-10-22 11:46:59 +00:00
return string_name; \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
} \
\
Fix broken namespace isolation in GDCLASS macro
2022-11-11 15:45:42 +00:00
static ::godot::StringName &get_parent_class_static() { \
Fix GDCLASS when inherited class is in another namespace
2022-02-20 19:23:14 +00:00
return m_inherits::get_class_static(); \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
} \
\
static void *___binding_create_callback(void *p_token, void *p_instance) { \
Fix "_instance_bindings != nullptr" for Wrapped objects. This is an attempt to make the lifecycle of wrapped objects clearer. Godot keeps track of bindings' userdata for each object it creates. This allows allocating the memory of the wrapper only once per object even if that object is passed multiple times between binding code and godot code. The binding information is composed of multiple functions, this includes a callback for when the userdata is to be allocated (called once) and for when the userdata is to be deallocated (again, called once). When allocating data with "memnew" we set the object bindings during the postinitialize phase, but surely we shouldn't do that when allocating the userdata as a result of bindings callback themselves. Additionally, since we let Godot handle (and track) raw memory allocation and de-allocation, we need to manually call the deconstructor of the wrapper class during the free callback, to ensure that its non-trivial members are correctly de-initialized.
2022-07-28 23:20:07 +00:00
/* Do not call memnew here, we don't want the postinitializer to be called */ \
return new ("") m_class((GodotObject *)p_instance); \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
} \
static void ___binding_free_callback(void *p_token, void *p_instance, void *p_binding) { \
Fix "_instance_bindings != nullptr" for Wrapped objects. This is an attempt to make the lifecycle of wrapped objects clearer. Godot keeps track of bindings' userdata for each object it creates. This allows allocating the memory of the wrapper only once per object even if that object is passed multiple times between binding code and godot code. The binding information is composed of multiple functions, this includes a callback for when the userdata is to be allocated (called once) and for when the userdata is to be deallocated (again, called once). When allocating data with "memnew" we set the object bindings during the postinitialize phase, but surely we shouldn't do that when allocating the userdata as a result of bindings callback themselves. Additionally, since we let Godot handle (and track) raw memory allocation and de-allocation, we need to manually call the deconstructor of the wrapper class during the free callback, to ensure that its non-trivial members are correctly de-initialized.
2022-07-28 23:20:07 +00:00
/* Explicitly call the deconstructor to ensure proper lifecycle for non-trivial members */ \
reinterpret_cast<m_class *>(p_binding)->~m_class(); \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
Memory::free_static(reinterpret_cast<m_class *>(p_binding)); \
} \
static GDNativeBool ___binding_reference_callback(void *p_token, void *p_instance, GDNativeBool p_reference) { \
return true; \
} \
static constexpr GDNativeInstanceBindingCallbacks ___binding_callbacks = { \
___binding_create_callback, \
___binding_free_callback, \
___binding_reference_callback, \
}; \
m_class() : m_class(#m_class) {}
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
#endif // GODOT_WRAPPED_HPP