200bf226bf
implemented instance binding data usage This commit changes the way C++ wrapper classes work. Previously, wrapper classes were merely wrapper *interfaces*. They used the `this` pointer to store the actual foreign Godot Object. With the NativeScript 1.1 extension it is now possible to have low-overhead language binding data attached to Objects. The C++ bindings use that feature to implement *proper* wrappers and enable regular C++ inheritance usage that way. Some things might still be buggy and untested, but the C++ SimpleDemo works with those changes. new and free change, custom free will crash engine, be wary fix exporting of non-object types fix free() crash with custom resources added type tags and safe object casting fix global type registration order fix cast_to changed build system to be more self contained updated .gitignore use typeid() for type tags now fix indentation in bindings generator remove accidentally added files fix gitignore Fixed up registering tool and updated godot_headers Fix crash when calling String::split/split_floats Was casting to the wrong object type. Also adds parse_ints function to String with the same logic Better warning/error macros Change gitignore so we get our gen folders New documentation based on nativescript 1.1 Fixed GODOT_SUBCLASS macro Preventing crash when function returned null ptr Adds needed include <typeinfo> Solves this issue #168 due to not having the include of typeinfo Fix compile error of 'WARN_PRINT' and 'ERR_PRINT'. cannot pass non-trivial object of type 'godot::String' to variadic function; expected type from format string was 'char *' [-Wnon-pod-varargs] update vector3::distance_to Remove godot_api.json as its now in the godot_headers submodule (api.json)
522 lines
14 KiB
C++
522 lines
14 KiB
C++
#ifndef GODOT_HPP
|
|
#define GODOT_HPP
|
|
|
|
#include <cstdlib>
|
|
#include <cstring>
|
|
|
|
#include <gdnative_api_struct.gen.h>
|
|
#include <nativescript/godot_nativescript.h>
|
|
#include <typeinfo>
|
|
|
|
#include "CoreTypes.hpp"
|
|
#include "Variant.hpp"
|
|
#include "Ref.hpp"
|
|
#include "TagDB.hpp"
|
|
|
|
#include "Object.hpp"
|
|
|
|
#include "GodotGlobal.hpp"
|
|
|
|
#include <NativeScript.hpp>
|
|
#include <GDNativeLibrary.hpp>
|
|
|
|
namespace godot {
|
|
|
|
|
|
template<class T>
|
|
T *as(const Object *obj)
|
|
{
|
|
return (T *) godot::nativescript_api->godot_nativescript_get_userdata(obj->_owner);
|
|
}
|
|
|
|
template<class T>
|
|
T *get_wrapper(godot_object *obj)
|
|
{
|
|
return (T *) godot::nativescript_1_1_api->godot_nativescript_get_instance_binding_data(godot::_RegisterState::language_index, obj);
|
|
}
|
|
|
|
|
|
#define GODOT_CLASS(Name, Base) \
|
|
public: inline static const char *___get_type_name() { return static_cast<const char *>(#Name); } \
|
|
enum { ___CLASS_IS_SCRIPT = 1, }; \
|
|
inline static Name *_new() { godot::NativeScript *script = godot::NativeScript::_new(); script->set_library(godot::get_wrapper<godot::GDNativeLibrary>((godot_object *) godot::gdnlib)); script->set_class_name(#Name); Name *instance = godot::as<Name>(script->new_()); return instance; } \
|
|
inline static const char *___get_base_type_name() { return Base::___get_class_name(); } \
|
|
inline static Object *___get_from_variant(godot::Variant a) { return (godot::Object *) godot::as<Name>(godot::Object::___get_from_variant(a)); } \
|
|
private:
|
|
|
|
#define GODOT_SUBCLASS(Name, Base) \
|
|
public: inline static const char *___get_type_name() { return static_cast<const char *>(#Name); } \
|
|
enum { ___CLASS_IS_SCRIPT = 1, }; \
|
|
inline static Name *_new() { godot::NativeScript *script = godot::NativeScript::_new(); script->set_library(godot::get_wrapper<godot::GDNativeLibrary>((godot_object *) godot::gdnlib)); script->set_class_name(#Name); Name *instance = godot::as<Name>(script->new_()); return instance; } \
|
|
inline static const char *___get_base_type_name() { return #Base; } \
|
|
inline static Object *___get_from_variant(godot::Variant a) { return (godot::Object *) godot::as<Name>(godot::Object::___get_from_variant(a)); } \
|
|
private:
|
|
|
|
template<class T>
|
|
struct _ArgCast {
|
|
static T _arg_cast(Variant a)
|
|
{
|
|
return a;
|
|
}
|
|
};
|
|
|
|
template<class T>
|
|
struct _ArgCast<T*> {
|
|
static T *_arg_cast(Variant a)
|
|
{
|
|
return (T *) T::___get_from_variant(a);
|
|
}
|
|
};
|
|
|
|
template<>
|
|
struct _ArgCast<Variant> {
|
|
static Variant _arg_cast(Variant a)
|
|
{
|
|
return a;
|
|
}
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
// instance and destroy funcs
|
|
|
|
template<class T>
|
|
void *_godot_class_instance_func(godot_object *p, void *method_data)
|
|
{
|
|
T *d = new T();
|
|
d->_owner = p;
|
|
d->_type_tag = typeid(T).hash_code();
|
|
d->_init();
|
|
return d;
|
|
}
|
|
|
|
template<class T>
|
|
void _godot_class_destroy_func(godot_object *p, void *method_data, void *data)
|
|
{
|
|
T *d = (T *) data;
|
|
delete d;
|
|
}
|
|
|
|
|
|
template<class T>
|
|
void register_class()
|
|
{
|
|
godot_instance_create_func create = {};
|
|
create.create_func = _godot_class_instance_func<T>;
|
|
|
|
godot_instance_destroy_func destroy = {};
|
|
destroy.destroy_func = _godot_class_destroy_func<T>;
|
|
|
|
_TagDB::register_type(typeid(T).hash_code(), typeid(T).hash_code());
|
|
|
|
godot::nativescript_api->godot_nativescript_register_class(godot::_RegisterState::nativescript_handle, T::___get_type_name(), T::___get_base_type_name(), create, destroy);
|
|
godot::nativescript_1_1_api->godot_nativescript_set_type_tag(godot::_RegisterState::nativescript_handle, T::___get_type_name(), (const void *) typeid(T).hash_code());
|
|
T::_register_methods();
|
|
}
|
|
|
|
template<class T>
|
|
void register_tool_class()
|
|
{
|
|
godot_instance_create_func create = {};
|
|
create.create_func = _godot_class_instance_func<T>;
|
|
|
|
godot_instance_destroy_func destroy = {};
|
|
destroy.destroy_func = _godot_class_destroy_func<T>;
|
|
|
|
_TagDB::register_type(typeid(T).hash_code(), typeid(T).hash_code());
|
|
|
|
godot::nativescript_api->godot_nativescript_register_tool_class(godot::_RegisterState::nativescript_handle, T::___get_type_name(), T::___get_base_type_name(), create, destroy);
|
|
godot::nativescript_1_1_api->godot_nativescript_set_type_tag(godot::_RegisterState::nativescript_handle, T::___get_type_name(), (const void *) typeid(T).hash_code());
|
|
T::_register_methods();
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// method registering
|
|
|
|
typedef godot_variant (*__godot_wrapper_method)(godot_object *, void *, void *, int, godot_variant **);
|
|
|
|
|
|
template<class T, class R, class ...args>
|
|
const char *___get_method_class_name(R (T::*p)(args... a))
|
|
{
|
|
return T::___get_type_name();
|
|
}
|
|
|
|
template<class T, class R, class ...args>
|
|
const char *___get_method_class_name(R (T::*p)(args... a) const)
|
|
{
|
|
return T::___get_type_name();
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Okay, time for some template magic.
|
|
// Many thanks to manpat from the GDL Discord Server.
|
|
|
|
|
|
// This is stuff that's available in C++14 I think, but whatever.
|
|
|
|
template<int... I>
|
|
struct __Sequence{};
|
|
|
|
template<int N, int... I>
|
|
struct __construct_sequence {
|
|
using type = typename __construct_sequence<N-1, N-1, I...>::type;
|
|
};
|
|
|
|
template<int... I>
|
|
struct __construct_sequence<0, I...> {
|
|
using type = __Sequence<I...>;
|
|
};
|
|
|
|
|
|
// Now the wrapping part.
|
|
template<class T, class R, class... As>
|
|
struct _WrappedMethod {
|
|
R (T::*f)(As...);
|
|
|
|
template<int... I>
|
|
void apply(Variant* ret, T* obj, Variant** args, __Sequence<I...>) {
|
|
*ret = (obj->*f)( _ArgCast<As>::_arg_cast(*args[I])... );
|
|
}
|
|
};
|
|
|
|
template<class T, class... As>
|
|
struct _WrappedMethod<T, void, As...> {
|
|
void (T::*f)(As...);
|
|
|
|
template<int... I>
|
|
void apply(Variant* ret, T* obj, Variant** args, __Sequence<I...>) {
|
|
(obj->*f)( _ArgCast<As>::_arg_cast(*args[I])... );
|
|
}
|
|
};
|
|
|
|
|
|
template<class T, class R, class... As>
|
|
godot_variant __wrapped_method(godot_object *, void *method_data, void *user_data, int num_args, godot_variant **args)
|
|
{
|
|
godot_variant v;
|
|
godot::api->godot_variant_new_nil(&v);
|
|
|
|
T *obj = (T *) user_data;
|
|
_WrappedMethod<T, R, As...> *method = (_WrappedMethod<T, R, As...>*) method_data;
|
|
|
|
Variant *var = (Variant *) &v;
|
|
Variant **arg = (Variant **) args;
|
|
|
|
method->apply(var, obj, arg, typename __construct_sequence<sizeof...(As)>::type {});
|
|
|
|
return v;
|
|
}
|
|
|
|
template<class T, class R, class... As>
|
|
void *___make_wrapper_function(R (T::*f)(As...))
|
|
{
|
|
using MethodType = _WrappedMethod<T, R, As...>;
|
|
MethodType *p = (MethodType *) godot::api->godot_alloc(sizeof(MethodType));
|
|
p->f = f;
|
|
return (void *) p;
|
|
}
|
|
|
|
template<class T, class R, class... As>
|
|
__godot_wrapper_method ___get_wrapper_function(R (T::*f)(As...))
|
|
{
|
|
return (__godot_wrapper_method) &__wrapped_method<T, R, As...>;
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
template<class T, class R, class ...A>
|
|
void *___make_wrapper_function(R (T::*f)(A...) const)
|
|
{
|
|
return ___make_wrapper_function((R (T::*)(A...)) f);
|
|
}
|
|
|
|
|
|
template<class T, class R, class ...A>
|
|
__godot_wrapper_method ___get_wrapper_function(R (T::*f)(A...) const)
|
|
{
|
|
return ___get_wrapper_function((R (T::*)(A...)) f);
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
template<class M>
|
|
void register_method(const char *name, M method_ptr, godot_method_rpc_mode rpc_type = GODOT_METHOD_RPC_MODE_DISABLED)
|
|
{
|
|
godot_instance_method method = {};
|
|
method.method_data = ___make_wrapper_function(method_ptr);
|
|
method.free_func = godot::api->godot_free;
|
|
method.method = (__godot_wrapper_method) ___get_wrapper_function(method_ptr);
|
|
|
|
|
|
godot_method_attributes attr = {};
|
|
attr.rpc_type = rpc_type;
|
|
|
|
godot::nativescript_api->godot_nativescript_register_method(godot::_RegisterState::nativescript_handle, ___get_method_class_name(method_ptr), name, attr, method);
|
|
}
|
|
|
|
|
|
|
|
template<class T, class P>
|
|
struct _PropertySetFunc {
|
|
void (T::*f)(P);
|
|
static void _wrapped_setter(godot_object *object, void *method_data, void *user_data, godot_variant *value)
|
|
{
|
|
_PropertySetFunc<T, P> *set_func = (_PropertySetFunc<T, P> *) method_data;
|
|
T *obj = (T *) user_data;
|
|
|
|
Variant *v = (Variant *) value;
|
|
|
|
(obj->*(set_func->f))(_ArgCast<P>::_arg_cast(*v));
|
|
}
|
|
};
|
|
|
|
template<class T, class P>
|
|
struct _PropertyGetFunc {
|
|
P (T::*f)();
|
|
static godot_variant _wrapped_getter(godot_object *object, void *method_data, void *user_data)
|
|
{
|
|
_PropertyGetFunc<T, P> *get_func = (_PropertyGetFunc<T, P> *) method_data;
|
|
T *obj = (T *) user_data;
|
|
|
|
godot_variant var;
|
|
godot::api->godot_variant_new_nil(&var);
|
|
|
|
Variant *v = (Variant *) &var;
|
|
|
|
*v = (obj->*(get_func->f))();
|
|
|
|
return var;
|
|
}
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
template<class T, class P>
|
|
struct _PropertyDefaultSetFunc {
|
|
P (T::*f);
|
|
static void _wrapped_setter(godot_object *object, void *method_data, void *user_data, godot_variant *value)
|
|
{
|
|
_PropertyDefaultSetFunc<T, P> *set_func = (_PropertyDefaultSetFunc<T, P> *) method_data;
|
|
T *obj = (T *) user_data;
|
|
|
|
Variant *v = (Variant *) value;
|
|
|
|
(obj->*(set_func->f)) = _ArgCast<P>::_arg_cast(*v);
|
|
}
|
|
};
|
|
|
|
template<class T, class P>
|
|
struct _PropertyDefaultGetFunc {
|
|
P (T::*f);
|
|
static godot_variant _wrapped_getter(godot_object *object, void *method_data, void *user_data)
|
|
{
|
|
_PropertyDefaultGetFunc<T, P> *get_func = (_PropertyDefaultGetFunc<T, P> *) method_data;
|
|
T *obj = (T *) user_data;
|
|
|
|
godot_variant var;
|
|
godot::api->godot_variant_new_nil(&var);
|
|
|
|
Variant *v = (Variant *) &var;
|
|
|
|
*v = (obj->*(get_func->f));
|
|
|
|
return var;
|
|
}
|
|
};
|
|
|
|
|
|
template<class T, class P>
|
|
void register_property(const char *name, P (T::*var), P default_value, godot_method_rpc_mode rpc_mode = GODOT_METHOD_RPC_MODE_DISABLED, godot_property_usage_flags usage = GODOT_PROPERTY_USAGE_DEFAULT, godot_property_hint hint = GODOT_PROPERTY_HINT_NONE, String hint_string = "")
|
|
{
|
|
Variant def_val = default_value;
|
|
|
|
usage = (godot_property_usage_flags) ((int) usage | GODOT_PROPERTY_USAGE_SCRIPT_VARIABLE);
|
|
|
|
if (def_val.get_type() == Variant::OBJECT) {
|
|
Object *o = get_wrapper<Object>(def_val.operator godot_object*());
|
|
if (o && o->is_class("Resource")) {
|
|
hint = (godot_property_hint) ((int) hint | GODOT_PROPERTY_HINT_RESOURCE_TYPE);
|
|
hint_string = o->get_class();
|
|
}
|
|
}
|
|
|
|
godot_string *_hint_string = (godot_string*) &hint_string;
|
|
|
|
godot_property_attributes attr = {};
|
|
attr.type = def_val.get_type();
|
|
attr.default_value = *(godot_variant *) &def_val;
|
|
attr.hint = hint;
|
|
attr.rset_type = rpc_mode;
|
|
attr.usage = usage;
|
|
attr.hint_string = *_hint_string;
|
|
|
|
_PropertyDefaultSetFunc<T, P> *wrapped_set = (_PropertyDefaultSetFunc<T, P> *)godot::api->godot_alloc(sizeof(_PropertyDefaultSetFunc<T, P>));
|
|
wrapped_set->f = var;
|
|
|
|
_PropertyDefaultGetFunc<T, P> *wrapped_get = (_PropertyDefaultGetFunc<T, P> *) godot::api->godot_alloc(sizeof(_PropertyDefaultGetFunc<T, P>));
|
|
wrapped_get->f = var;
|
|
|
|
godot_property_set_func set_func = {};
|
|
set_func.method_data = (void *) wrapped_set;
|
|
set_func.free_func = godot::api->godot_free;
|
|
set_func.set_func = &_PropertyDefaultSetFunc<T, P>::_wrapped_setter;
|
|
|
|
godot_property_get_func get_func = {};
|
|
get_func.method_data = (void *) wrapped_get;
|
|
get_func.free_func = godot::api->godot_free;
|
|
get_func.get_func = &_PropertyDefaultGetFunc<T, P>::_wrapped_getter;
|
|
|
|
godot::nativescript_api->godot_nativescript_register_property(godot::_RegisterState::nativescript_handle, T::___get_type_name(), name, &attr, set_func, get_func);
|
|
}
|
|
|
|
|
|
|
|
|
|
template<class T, class P>
|
|
void register_property(const char *name, void (T::*setter)(P), P (T::*getter)(), P default_value, godot_method_rpc_mode rpc_mode = GODOT_METHOD_RPC_MODE_DISABLED, godot_property_usage_flags usage = GODOT_PROPERTY_USAGE_DEFAULT, godot_property_hint hint = GODOT_PROPERTY_HINT_NONE, String hint_string = "")
|
|
{
|
|
Variant def_val = default_value;
|
|
|
|
godot_property_attributes attr = {};
|
|
attr.type = def_val.get_type();
|
|
attr.default_value = *(godot_variant *) &def_val;
|
|
attr.hint = hint;
|
|
attr.rset_type = rpc_mode;
|
|
attr.usage = usage;
|
|
|
|
_PropertySetFunc<T, P> *wrapped_set = (_PropertySetFunc<T, P> *) godot::api->godot_alloc(sizeof(_PropertySetFunc<T, P>));
|
|
wrapped_set->f = setter;
|
|
|
|
_PropertyGetFunc<T, P> *wrapped_get = (_PropertyGetFunc<T, P> *) godot::api->godot_alloc(sizeof(_PropertyGetFunc<T, P>));
|
|
wrapped_get->f = getter;
|
|
|
|
godot_property_set_func set_func = {};
|
|
set_func.method_data = (void *) wrapped_set;
|
|
set_func.free_func = godot::api->godot_free;
|
|
set_func.set_func = &_PropertySetFunc<T, P>::_wrapped_setter;
|
|
|
|
godot_property_get_func get_func = {};
|
|
get_func.method_data = (void *) wrapped_get;
|
|
get_func.free_func = godot::api->godot_free;
|
|
get_func.get_func = &_PropertyGetFunc<T, P>::_wrapped_getter;
|
|
|
|
godot::nativescript_api->godot_nativescript_register_property(godot::_RegisterState::nativescript_handle, T::___get_type_name(), name, &attr, set_func, get_func);
|
|
|
|
}
|
|
|
|
template<class T, class P>
|
|
void register_property(const char *name, void (T::*setter)(P), P (T::*getter)() const, P default_value, godot_method_rpc_mode rpc_mode = GODOT_METHOD_RPC_MODE_DISABLED, godot_property_usage_flags usage = GODOT_PROPERTY_USAGE_DEFAULT, godot_property_hint hint = GODOT_PROPERTY_HINT_NONE, String hint_string = "")
|
|
{
|
|
register_property(name, setter, (P (T::*)()) getter, default_value, rpc_mode, usage, hint, hint_string);
|
|
}
|
|
|
|
template<class T>
|
|
void register_signal(String name, Dictionary args = Dictionary())
|
|
{
|
|
godot_signal signal = {};
|
|
signal.name = *(godot_string *)&name;
|
|
signal.num_args = args.size();
|
|
signal.num_default_args = 0;
|
|
|
|
// Need to check because malloc(0) is platform-dependent. Zero arguments will leave args to nullptr.
|
|
if(signal.num_args != 0) {
|
|
signal.args = (godot_signal_argument*) godot::api->godot_alloc(sizeof(godot_signal_argument) * signal.num_args);
|
|
memset((void *) signal.args, 0, sizeof(godot_signal_argument) * signal.num_args);
|
|
}
|
|
|
|
for (int i = 0; i < signal.num_args; i++) {
|
|
// Array entry = args[i];
|
|
// String name = entry[0];
|
|
String name = args.keys()[i];
|
|
godot_string *_key = (godot_string *)&name;
|
|
godot::api->godot_string_new_copy(&signal.args[i].name, _key);
|
|
|
|
// if (entry.size() > 1) {
|
|
// signal.args[i].type = entry[1];
|
|
// }
|
|
signal.args[i].type = args.values()[i];
|
|
}
|
|
|
|
godot::nativescript_api->godot_nativescript_register_signal(godot::_RegisterState::nativescript_handle, T::___get_type_name(), &signal);
|
|
|
|
for (int i = 0; i < signal.num_args; i++) {
|
|
godot::api->godot_string_destroy(&signal.args[i].name);
|
|
}
|
|
|
|
if(signal.args) {
|
|
godot::api->godot_free(signal.args);
|
|
}
|
|
}
|
|
|
|
template<class T, class... Args>
|
|
void register_signal(String name, Args... varargs)
|
|
{
|
|
register_signal<T>(name, Dictionary::make(varargs...));
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef GODOT_CPP_NO_OBJECT_CAST
|
|
template<class T>
|
|
T *Object::cast_to(const Object *obj)
|
|
{
|
|
size_t have_tag = (size_t) godot::nativescript_1_1_api->godot_nativescript_get_type_tag(obj->_owner);
|
|
|
|
if (have_tag) {
|
|
if (!godot::_TagDB::is_type_known((size_t) have_tag)) {
|
|
have_tag = 0;
|
|
}
|
|
}
|
|
|
|
if (!have_tag) {
|
|
have_tag = obj->_type_tag;
|
|
}
|
|
|
|
if (godot::_TagDB::is_type_compatible(typeid(T).hash_code(), have_tag)) {
|
|
return (T::___CLASS_IS_SCRIPT) ? godot::as<T>(obj) : (T *) obj;
|
|
} else {
|
|
return nullptr;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
|
|
}
|
|
|
|
#endif // GODOT_H
|