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

187 lines
16 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. */
/*************************************************************************/
#ifndef GODOT_CPP_WRAPPED_HPP
#define GODOT_CPP_WRAPPED_HPP
#include <godot_cpp/core/memory.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:
Fix object_set_instance being wrongly called for built-in wrapped classes
2021-12-06 14:39:51 +00:00
virtual const char *_get_extension_class() 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;
void _postinitialize();
Wrapped(const char *p_godot_class);
Wrapped(GodotObject *p_godot_object);
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
public:
Fix GDCLASS when inherited class is in another namespace
2022-02-20 19:23:14 +00:00
static const char *get_class_static() {
return "Wrapped";
}
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
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
#define GDCLASS(m_class, m_inherits) \
private: \
void operator=(const m_class &p_rval) {} \
friend class ClassDB; \
\
protected: \
Fix object_set_instance being wrongly called for built-in wrapped classes
2021-12-06 14:39:51 +00:00
virtual const char *_get_extension_class() const override { \
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
return get_class_static(); \
} \
\
virtual const GDNativeInstanceBindingCallbacks *_get_bindings_callbacks() const override { \
return &___binding_callbacks; \
} \
\
static void (*_get_bind_methods())() { \
return &m_class::_bind_methods; \
} \
\
template <class T> \
static void register_virtuals() { \
m_inherits::register_virtuals<T>(); \
} \
\
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(); \
m_inherits::register_virtuals<m_class>(); \
} \
initialized = true; \
} \
\
static const char *get_class_static() { \
return #m_class; \
} \
\
static const char *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 GDNativeObjectPtr create(void *data) { \
m_class *new_object = memnew(m_class); \
return new_object->_owner; \
} \
\
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, \
};
Replace bindgins to work with extensions
2021-08-18 14:03:52 +00:00
// Don't use this for your classes, use GDCLASS() instead.
Make extension instances create the corresponding godot object in their constructor
2021-11-30 13:00:13 +00:00
#define GDNATIVE_CLASS(m_class, m_inherits) \
private: \
void operator=(const m_class &p_rval) {} \
\
protected: \
virtual const GDNativeInstanceBindingCallbacks *_get_bindings_callbacks() const override { \
return &___binding_callbacks; \
} \
\
m_class(const char *p_godot_class) : m_inherits(p_godot_class) {} \
m_class(GodotObject *p_godot_object) : m_inherits(p_godot_object) {} \
\
static void (*_get_bind_methods())() { \
return nullptr; \
} \
\
public: \
static void initialize_class() {} \
\
static const char *get_class_static() { \
return #m_class; \
} \
\
static const char *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
#endif // ! GODOT_CPP_WRAPPED_HPP