/*************************************************************************/ /* method_bind.hpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* 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_METHOD_BIND_HPP #define GODOT_CPP_METHOD_BIND_HPP #include #include #include #include #include #include #include #include namespace godot { class MethodBind { const char *name = nullptr; const char *instance_class = nullptr; int argument_count = 0; uint32_t hint_flags = METHOD_FLAGS_DEFAULT; bool _is_const = false; bool _has_return = false; std::vector argument_names; GDNativeVariantType *argument_types = nullptr; std::vector default_arguments; protected: virtual GDNativeVariantType gen_argument_type(int p_arg) const = 0; virtual GDNativePropertyInfo gen_argument_type_info(int p_arg) const = 0; void generate_argument_types(int p_count); void set_const(bool p_const); void set_return(bool p_return); void set_argument_count(int p_count); public: const char *get_name() const; void set_name(const char *p_name); _FORCE_INLINE_ int get_default_argument_count() const { return default_arguments.size(); } _FORCE_INLINE_ const std::vector &get_default_arguments() const { return default_arguments; } _FORCE_INLINE_ Variant has_default_argument(int p_arg) const { int idx = p_arg - (argument_count - default_arguments.size()); if (idx < 0 || idx >= default_arguments.size()) { return false; } else { return true; } } _FORCE_INLINE_ Variant get_default_argument(int p_arg) const { int idx = p_arg - (argument_count - default_arguments.size()); if (idx < 0 || idx >= default_arguments.size()) { return Variant(); } else { return default_arguments[idx]; } } _FORCE_INLINE_ const char *get_instance_class() const { return instance_class; } _FORCE_INLINE_ void set_instance_class(const char *p_class) { instance_class = p_class; } _FORCE_INLINE_ int get_argument_count() const { return argument_count; }; _FORCE_INLINE_ bool is_const() const { return _is_const; } _FORCE_INLINE_ bool has_return() const { return _has_return; } _FORCE_INLINE_ uint32_t get_hint_flags() const { return hint_flags; } _FORCE_INLINE_ void set_hint_flags(uint32_t p_hint_flags) { hint_flags = p_hint_flags; } void set_argument_names(const std::vector &p_names); std::vector get_argument_names() const; void set_default_arguments(const std::vector &p_default_arguments) { default_arguments = p_default_arguments; } _FORCE_INLINE_ GDNativeVariantType get_argument_type(int p_argument) const { ERR_FAIL_COND_V(p_argument < -1 || p_argument > argument_count, GDNATIVE_VARIANT_TYPE_NIL); return argument_types[p_argument + 1]; } GDNativePropertyInfo get_argument_info(int p_argument) const; virtual GDNativeExtensionClassMethodArgumentMetadata get_argument_metadata(int p_argument) const = 0; virtual Variant call(GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeCallError &r_error) const = 0; virtual void ptrcall(GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_return) const = 0; // Extension info. static GDNativeVariantType bind_get_argument_type(void *p_method_userdata, int32_t p_argument); static void bind_get_argument_info(void *p_method_userdata, int32_t p_argument, GDNativePropertyInfo *r_info); static GDNativeExtensionClassMethodArgumentMetadata bind_get_argument_metadata(void *p_method_userdata, int32_t p_argument); static void bind_call(void *p_method_userdata, GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeVariantPtr r_return, GDNativeCallError *r_error); static void bind_ptrcall(void *p_method_userdata, GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_return); virtual ~MethodBind(); }; template class MethodBindVarArg : public MethodBind { public: typedef Variant (T::*NativeCall)(const Variant **, GDNativeInt, GDNativeCallError &); protected: NativeCall call_method = nullptr; MethodInfo arguments; public: virtual GDNativePropertyInfo gen_argument_type_info(int p_arg) const { if (p_arg < 0) { return arguments.return_val; } else if (p_arg < arguments.arguments.size()) { return arguments.arguments[p_arg]; } else { return PropertyInfo(Variant::NIL, "vararg", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_NIL_IS_VARIANT); } } virtual GDNativeVariantType gen_argument_type(int p_arg) const { return static_cast(gen_argument_type_info(p_arg).type); } virtual GDNativeExtensionClassMethodArgumentMetadata get_argument_metadata(int) const { return GDNATIVE_EXTENSION_METHOD_ARGUMENT_METADATA_NONE; } virtual Variant call(GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeCallError &r_error) const { T *instance = static_cast(p_instance); return (instance->*call_method)((const Variant **)p_args, p_argument_count, r_error); } void set_method_info(const MethodInfo &p_info, bool p_return_nil_is_variant) { set_argument_count(p_info.arguments.size()); if (p_info.arguments.size()) { std::vector names; names.reserve(p_info.arguments.size()); for (int i = 0; i < p_info.arguments.size(); i++) { names.push_back(p_info.arguments[i].name); } set_argument_names(names); } arguments = p_info; if (p_return_nil_is_variant) { arguments.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT; } generate_argument_types(p_info.arguments.size()); } virtual void ptrcall(GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_return) const { ERR_FAIL(); // Can't call. } void set_method(NativeCall p_method) { call_method = p_method; } virtual bool is_const() const { return false; } virtual bool is_vararg() const { return true; } MethodBindVarArg() { set_return(true); } }; template MethodBind *create_vararg_method_bind(Variant (T::*p_method)(const Variant **, GDNativeInt, GDNativeCallError &), const MethodInfo &p_info, bool p_return_nil_is_variant) { MethodBindVarArg *a = memnew(MethodBindVarArg()); a->set_method(p_method); a->set_method_info(p_info, p_return_nil_is_variant); a->set_instance_class(T::get_class_static()); return a; } #ifndef TYPED_METHOD_BIND class ___UnexistingClass; #define MB_T ___UnexistingClass #else #define MB_T T #endif // No return, not const. #ifdef TYPED_METHOD_BIND template #else template #endif // TYPED_METHOD_BIND class MethodBindT : public MethodBind { void (MB_T::*method)(P...); protected: // GCC raises warnings in the case P = {} as the comparison is always false... #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wlogical-op" #endif virtual GDNativeVariantType gen_argument_type(int p_arg) const { if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { return call_get_argument_type(p_arg); } else { return GDNATIVE_VARIANT_TYPE_NIL; } } virtual GDNativePropertyInfo gen_argument_type_info(int p_arg) const { GDNativePropertyInfo pi; if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { call_get_argument_type_info(p_arg, pi); } else { pi = PropertyInfo(); } return pi; } #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic pop #endif public: virtual GDNativeExtensionClassMethodArgumentMetadata get_argument_metadata(int p_argument) const { return call_get_argument_metadata(p_argument); } virtual Variant call(GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeCallError &r_error) const { #ifdef TYPED_METHOD_BIND call_with_variant_args_dv(static_cast(p_instance), method, p_args, p_argument_count, r_error, get_default_arguments()); #else call_with_variant_args_dv(reinterpret_cast(p_instance), method, p_args, p_argument_count, r_error, get_default_arguments()); #endif return Variant(); } virtual void ptrcall(GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_ret) const { #ifdef TYPED_METHOD_BIND call_with_ptr_args(static_cast(p_instance), method, p_args, nullptr); #else call_with_ptr_args(reinterpret_cast(p_instance), method, p_args, nullptr); #endif // TYPED_METHOD_BIND } MethodBindT(void (MB_T::*p_method)(P...)) { method = p_method; #ifdef DEBUG_METHODS_ENABLED generate_argument_types(sizeof...(P)); #endif // DEBUG_METHODS_ENABLED set_argument_count(sizeof...(P)); } }; template MethodBind *create_method_bind(void (T::*p_method)(P...)) { #ifdef TYPED_METHOD_BIND MethodBind *a = memnew((MethodBindT)(p_method)); #else MethodBind *a = memnew((MethodBindT)(reinterpret_cast(p_method))); #endif // TYPED_METHOD_BIND a->set_instance_class(T::get_class_static()); return a; } // No return, const. #ifdef TYPED_METHOD_BIND template #else template #endif // TYPED_METHOD_BIND class MethodBindTC : public MethodBind { void (MB_T::*method)(P...) const; protected: // GCC raises warnings in the case P = {} as the comparison is always false... #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wlogical-op" #endif virtual GDNativeVariantType gen_argument_type(int p_arg) const { if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { return call_get_argument_type(p_arg); } else { return GDNATIVE_VARIANT_TYPE_NIL; } } virtual GDNativePropertyInfo gen_argument_type_info(int p_arg) const { GDNativePropertyInfo pi; if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { call_get_argument_type_info(p_arg, pi); } else { pi = PropertyInfo(); } return pi; } #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic pop #endif public: virtual GDNativeExtensionClassMethodArgumentMetadata get_argument_metadata(int p_argument) const { return call_get_argument_metadata(p_argument); } virtual Variant call(GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeCallError &r_error) const { #ifdef TYPED_METHOD_BIND call_with_variant_argsc_dv(static_cast(p_instance), method, p_args, p_argument_count, r_error, get_default_arguments()); #else call_with_variant_argsc_dv(reinterpret_cast(p_instance), method, p_args, p_argument_count, r_error, get_default_arguments()); #endif return Variant(); } virtual void ptrcall(GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_ret) const { #ifdef TYPED_METHOD_BIND call_with_ptr_args(static_cast(p_instance), method, p_args, nullptr); #else call_with_ptr_args(reinterpret_cast(p_instance), method, p_args, nullptr); #endif // TYPED_METHOD_BIND } MethodBindTC(void (MB_T::*p_method)(P...) const) { method = p_method; #ifdef DEBUG_METHODS_ENABLED generate_argument_types(sizeof...(P)); #endif // DEBUG_METHODS_ENABLED set_argument_count(sizeof...(P)); } }; template MethodBind *create_method_bind(void (T::*p_method)(P...) const) { #ifdef TYPED_METHOD_BIND MethodBind *a = memnew((MethodBindTC)(p_method)); #else MethodBind *a = memnew((MethodBindTC)(reinterpret_cast(p_method))); #endif // TYPED_METHOD_BIND a->set_instance_class(T::get_class_static()); return a; } // Return, not const. #ifdef TYPED_METHOD_BIND template #else template #endif // TYPED_METHOD_BIND class MethodBindTR : public MethodBind { R(MB_T::*method) (P...); protected: // GCC raises warnings in the case P = {} as the comparison is always false... #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wlogical-op" #endif virtual GDNativeVariantType gen_argument_type(int p_arg) const { if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { return call_get_argument_type(p_arg); } else { return GetTypeInfo::VARIANT_TYPE; } } virtual GDNativePropertyInfo gen_argument_type_info(int p_arg) const { if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { GDNativePropertyInfo pi; call_get_argument_type_info(p_arg, pi); return pi; } else { return GetTypeInfo::get_class_info(); } } #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic pop #endif public: virtual GDNativeExtensionClassMethodArgumentMetadata get_argument_metadata(int p_argument) const { if (p_argument >= 0) { return call_get_argument_metadata(p_argument); } else { return GetTypeInfo::METADATA; } } virtual Variant call(GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeCallError &r_error) const { Variant ret; #ifdef TYPED_METHOD_BIND call_with_variant_args_ret_dv(static_cast(p_instance), method, p_args, p_argument_count, ret, r_error, get_default_arguments()); #else call_with_variant_args_ret_dv((MB_T *)p_instance, method, p_args, p_argument_count, ret, r_error, get_default_arguments()); #endif return ret; } virtual void ptrcall(GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_ret) const { #ifdef TYPED_METHOD_BIND call_with_ptr_args(static_cast(p_instance), method, p_args, r_ret); #else call_with_ptr_args(reinterpret_cast(p_instance), method, p_args, r_ret); #endif // TYPED_METHOD_BIND } MethodBindTR(R (MB_T::*p_method)(P...)) { method = p_method; #ifdef DEBUG_METHODS_ENABLED generate_argument_types(sizeof...(P)); #endif // DEBUG_METHODS_ENABLED set_argument_count(sizeof...(P)); set_return(true); } }; template MethodBind *create_method_bind(R (T::*p_method)(P...)) { #ifdef TYPED_METHOD_BIND MethodBind *a = memnew((MethodBindTR)(p_method)); #else MethodBind *a = memnew((MethodBindTR)(reinterpret_cast(p_method))); #endif // TYPED_METHOD_BIND a->set_instance_class(T::get_class_static()); return a; } // Return, const. #ifdef TYPED_METHOD_BIND template #else template #endif // TYPED_METHOD_BIND class MethodBindTRC : public MethodBind { R(MB_T::*method) (P...) const; protected: // GCC raises warnings in the case P = {} as the comparison is always false... #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wlogical-op" #endif virtual GDNativeVariantType gen_argument_type(int p_arg) const { if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { return call_get_argument_type(p_arg); } else { return GetTypeInfo::VARIANT_TYPE; } } virtual GDNativePropertyInfo gen_argument_type_info(int p_arg) const { if (p_arg >= 0 && p_arg < (int)sizeof...(P)) { GDNativePropertyInfo pi; call_get_argument_type_info(p_arg, pi); return pi; } else { return GetTypeInfo::get_class_info(); } } #if defined(__GNUC__) && !defined(__clang__) #pragma GCC diagnostic pop #endif public: virtual GDNativeExtensionClassMethodArgumentMetadata get_argument_metadata(int p_argument) const { if (p_argument >= 0) { return call_get_argument_metadata(p_argument); } else { return GetTypeInfo::METADATA; } } virtual Variant call(GDExtensionClassInstancePtr p_instance, const GDNativeVariantPtr *p_args, const GDNativeInt p_argument_count, GDNativeCallError &r_error) const { Variant ret; #ifdef TYPED_METHOD_BIND call_with_variant_args_retc_dv(static_cast(p_instance), method, p_args, p_argument_count, ret, r_error, get_default_arguments()); #else call_with_variant_args_retc_dv((MB_T *)p_instance, method, p_args, p_argument_count, ret, r_error, get_default_arguments()); #endif return ret; } virtual void ptrcall(GDExtensionClassInstancePtr p_instance, const GDNativeTypePtr *p_args, GDNativeTypePtr r_ret) const { #ifdef TYPED_METHOD_BIND call_with_ptr_args(static_cast(p_instance), method, p_args, r_ret); #else call_with_ptr_args(reinterpret_cast(p_instance), method, p_args, r_ret); #endif // TYPED_METHOD_BIND } MethodBindTRC(R (MB_T::*p_method)(P...) const) { method = p_method; #ifdef DEBUG_METHODS_ENABLED generate_argument_types(sizeof...(P)); #endif // DEBUG_METHODS_ENABLED set_argument_count(sizeof...(P)); set_return(true); } }; template MethodBind *create_method_bind(R (T::*p_method)(P...) const) { #ifdef TYPED_METHOD_BIND MethodBind *a = memnew((MethodBindTRC)(p_method)); #else MethodBind *a = memnew((MethodBindTRC)(reinterpret_cast(p_method))); #endif // TYPED_METHOD_BIND a->set_instance_class(T::get_class_static()); return a; } } // namespace godot #endif // ! GODOT_CPP_METHOD_BIND_HPP