method_bind.h 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781
  1. /**************************************************************************/
  2. /* method_bind.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #pragma once
  31. #include "core/variant/binder_common.h"
  32. VARIANT_BITFIELD_CAST(MethodFlags)
  33. // some helpers
  34. class MethodBind {
  35. int method_id;
  36. uint32_t hint_flags = METHOD_FLAGS_DEFAULT;
  37. StringName name;
  38. StringName instance_class;
  39. Vector<Variant> default_arguments;
  40. int default_argument_count = 0;
  41. int argument_count = 0;
  42. bool _static = false;
  43. bool _const = false;
  44. bool _returns = false;
  45. bool _returns_raw_obj_ptr = false;
  46. protected:
  47. Variant::Type *argument_types = nullptr;
  48. #ifdef DEBUG_ENABLED
  49. Vector<StringName> arg_names;
  50. #endif // DEBUG_ENABLED
  51. void _set_const(bool p_const);
  52. void _set_static(bool p_static);
  53. void _set_returns(bool p_returns);
  54. virtual Variant::Type _gen_argument_type(int p_arg) const = 0;
  55. virtual PropertyInfo _gen_argument_type_info(int p_arg) const = 0;
  56. void _generate_argument_types(int p_count);
  57. void set_argument_count(int p_count) { argument_count = p_count; }
  58. public:
  59. _FORCE_INLINE_ const Vector<Variant> &get_default_arguments() const { return default_arguments; }
  60. _FORCE_INLINE_ int get_default_argument_count() const { return default_argument_count; }
  61. _FORCE_INLINE_ Variant has_default_argument(int p_arg) const {
  62. int idx = p_arg - (argument_count - default_arguments.size());
  63. if (idx < 0 || idx >= default_arguments.size()) {
  64. return false;
  65. } else {
  66. return true;
  67. }
  68. }
  69. _FORCE_INLINE_ Variant get_default_argument(int p_arg) const {
  70. int idx = p_arg - (argument_count - default_arguments.size());
  71. if (idx < 0 || idx >= default_arguments.size()) {
  72. return Variant();
  73. } else {
  74. return default_arguments[idx];
  75. }
  76. }
  77. _FORCE_INLINE_ Variant::Type get_argument_type(int p_argument) const {
  78. ERR_FAIL_COND_V(p_argument < -1 || p_argument >= argument_count, Variant::NIL);
  79. return argument_types[p_argument + 1];
  80. }
  81. PropertyInfo get_argument_info(int p_argument) const;
  82. PropertyInfo get_return_info() const;
  83. #ifdef DEBUG_ENABLED
  84. void set_argument_names(const Vector<StringName> &p_names); // Set by ClassDB, can't be inferred otherwise.
  85. Vector<StringName> get_argument_names() const;
  86. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const = 0;
  87. #endif // DEBUG_ENABLED
  88. void set_hint_flags(uint32_t p_hint) { hint_flags = p_hint; }
  89. uint32_t get_hint_flags() const { return hint_flags | (is_const() ? METHOD_FLAG_CONST : 0) | (is_vararg() ? METHOD_FLAG_VARARG : 0) | (is_static() ? METHOD_FLAG_STATIC : 0); }
  90. _FORCE_INLINE_ StringName get_instance_class() const { return instance_class; }
  91. _FORCE_INLINE_ void set_instance_class(const StringName &p_class) { instance_class = p_class; }
  92. _FORCE_INLINE_ int get_argument_count() const { return argument_count; }
  93. #ifdef TOOLS_ENABLED
  94. virtual bool is_valid() const { return true; }
  95. #endif
  96. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const = 0;
  97. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const = 0;
  98. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const = 0;
  99. StringName get_name() const;
  100. void set_name(const StringName &p_name);
  101. _FORCE_INLINE_ int get_method_id() const { return method_id; }
  102. _FORCE_INLINE_ bool is_const() const { return _const; }
  103. _FORCE_INLINE_ bool is_static() const { return _static; }
  104. _FORCE_INLINE_ bool has_return() const { return _returns; }
  105. virtual bool is_vararg() const { return false; }
  106. _FORCE_INLINE_ bool is_return_type_raw_object_ptr() { return _returns_raw_obj_ptr; }
  107. _FORCE_INLINE_ void set_return_type_is_raw_object_ptr(bool p_returns_raw_obj) { _returns_raw_obj_ptr = p_returns_raw_obj; }
  108. void set_default_arguments(const Vector<Variant> &p_defargs);
  109. uint32_t get_hash() const;
  110. MethodBind();
  111. virtual ~MethodBind();
  112. };
  113. // MethodBindVarArg base CRTP
  114. template <typename Derived, typename T, typename R, bool should_returns>
  115. class MethodBindVarArgBase : public MethodBind {
  116. protected:
  117. R (T::*method)(const Variant **, int, Callable::CallError &);
  118. MethodInfo method_info;
  119. public:
  120. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  121. if (p_arg < 0) {
  122. return _gen_return_type_info();
  123. } else if (p_arg < method_info.arguments.size()) {
  124. return method_info.arguments[p_arg];
  125. } else {
  126. return PropertyInfo(Variant::NIL, "arg_" + itos(p_arg), PROPERTY_HINT_NONE, String(), PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_NIL_IS_VARIANT);
  127. }
  128. }
  129. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  130. return _gen_argument_type_info(p_arg).type;
  131. }
  132. #ifdef DEBUG_ENABLED
  133. virtual GodotTypeInfo::Metadata get_argument_meta(int) const override {
  134. return GodotTypeInfo::METADATA_NONE;
  135. }
  136. #endif // DEBUG_ENABLED
  137. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  138. ERR_FAIL_MSG("Validated call can't be used with vararg methods. This is a bug.");
  139. }
  140. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  141. ERR_FAIL_MSG("ptrcall can't be used with vararg methods. This is a bug.");
  142. }
  143. virtual bool is_const() const { return false; }
  144. virtual bool is_vararg() const override { return true; }
  145. MethodBindVarArgBase(
  146. R (T::*p_method)(const Variant **, int, Callable::CallError &),
  147. const MethodInfo &p_method_info,
  148. bool p_return_nil_is_variant) :
  149. method(p_method), method_info(p_method_info) {
  150. set_argument_count(method_info.arguments.size());
  151. Variant::Type *at = memnew_arr(Variant::Type, method_info.arguments.size() + 1);
  152. at[0] = _gen_return_type_info().type;
  153. if (method_info.arguments.size()) {
  154. #ifdef DEBUG_ENABLED
  155. Vector<StringName> names;
  156. names.resize(method_info.arguments.size());
  157. #endif // DEBUG_ENABLED
  158. for (int64_t i = 0; i < method_info.arguments.size(); ++i) {
  159. at[i + 1] = method_info.arguments[i].type;
  160. #ifdef DEBUG_ENABLED
  161. names.write[i] = method_info.arguments[i].name;
  162. #endif // DEBUG_ENABLED
  163. }
  164. #ifdef DEBUG_ENABLED
  165. set_argument_names(names);
  166. #endif // DEBUG_ENABLED
  167. }
  168. argument_types = at;
  169. if (p_return_nil_is_variant) {
  170. method_info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  171. }
  172. _set_returns(should_returns);
  173. }
  174. private:
  175. PropertyInfo _gen_return_type_info() const {
  176. return Derived::_gen_return_type_info_impl();
  177. }
  178. };
  179. // variadic, no return
  180. template <typename T>
  181. class MethodBindVarArgT : public MethodBindVarArgBase<MethodBindVarArgT<T>, T, void, false> {
  182. friend class MethodBindVarArgBase<MethodBindVarArgT<T>, T, void, false>;
  183. public:
  184. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  185. #ifdef TOOLS_ENABLED
  186. ERR_FAIL_COND_V_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == MethodBind::get_instance_class(), Variant(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  187. #endif
  188. (static_cast<T *>(p_object)->*MethodBindVarArgBase<MethodBindVarArgT<T>, T, void, false>::method)(p_args, p_arg_count, r_error);
  189. return {};
  190. }
  191. MethodBindVarArgT(
  192. void (T::*p_method)(const Variant **, int, Callable::CallError &),
  193. const MethodInfo &p_method_info,
  194. bool p_return_nil_is_variant) :
  195. MethodBindVarArgBase<MethodBindVarArgT<T>, T, void, false>(p_method, p_method_info, p_return_nil_is_variant) {
  196. }
  197. private:
  198. static PropertyInfo _gen_return_type_info_impl() {
  199. return {};
  200. }
  201. };
  202. template <typename T>
  203. MethodBind *create_vararg_method_bind(void (T::*p_method)(const Variant **, int, Callable::CallError &), const MethodInfo &p_info, bool p_return_nil_is_variant) {
  204. MethodBind *a = memnew((MethodBindVarArgT<T>)(p_method, p_info, p_return_nil_is_variant));
  205. a->set_instance_class(T::get_class_static());
  206. return a;
  207. }
  208. // variadic, return
  209. template <typename T, typename R>
  210. class MethodBindVarArgTR : public MethodBindVarArgBase<MethodBindVarArgTR<T, R>, T, R, true> {
  211. friend class MethodBindVarArgBase<MethodBindVarArgTR<T, R>, T, R, true>;
  212. public:
  213. GODOT_GCC_WARNING_PUSH_AND_IGNORE("-Wmaybe-uninitialized") // Workaround GH-66343 raised only with UBSAN, seems to be a false positive.
  214. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  215. #ifdef TOOLS_ENABLED
  216. ERR_FAIL_COND_V_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == MethodBind::get_instance_class(), Variant(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  217. #endif
  218. return (static_cast<T *>(p_object)->*MethodBindVarArgBase<MethodBindVarArgTR<T, R>, T, R, true>::method)(p_args, p_arg_count, r_error);
  219. }
  220. GODOT_GCC_WARNING_POP
  221. MethodBindVarArgTR(
  222. R (T::*p_method)(const Variant **, int, Callable::CallError &),
  223. const MethodInfo &p_info,
  224. bool p_return_nil_is_variant) :
  225. MethodBindVarArgBase<MethodBindVarArgTR<T, R>, T, R, true>(p_method, p_info, p_return_nil_is_variant) {
  226. }
  227. private:
  228. static PropertyInfo _gen_return_type_info_impl() {
  229. return GetTypeInfo<R>::get_class_info();
  230. }
  231. };
  232. template <typename T, typename R>
  233. MethodBind *create_vararg_method_bind(R (T::*p_method)(const Variant **, int, Callable::CallError &), const MethodInfo &p_info, bool p_return_nil_is_variant) {
  234. MethodBind *a = memnew((MethodBindVarArgTR<T, R>)(p_method, p_info, p_return_nil_is_variant));
  235. a->set_instance_class(T::get_class_static());
  236. return a;
  237. }
  238. /**** VARIADIC TEMPLATES ****/
  239. #ifndef TYPED_METHOD_BIND
  240. class __UnexistingClass;
  241. #define MB_T __UnexistingClass
  242. #else
  243. #define MB_T T
  244. #endif
  245. // no return, not const
  246. #ifdef TYPED_METHOD_BIND
  247. template <typename T, typename... P>
  248. #else
  249. template <typename... P>
  250. #endif
  251. class MethodBindT : public MethodBind {
  252. void (MB_T::*method)(P...);
  253. protected:
  254. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  255. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  256. return call_get_argument_type<P...>(p_arg);
  257. } else {
  258. return Variant::NIL;
  259. }
  260. }
  261. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  262. PropertyInfo pi;
  263. call_get_argument_type_info<P...>(p_arg, pi);
  264. return pi;
  265. }
  266. public:
  267. #ifdef DEBUG_ENABLED
  268. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const override {
  269. return call_get_argument_metadata<P...>(p_arg);
  270. }
  271. #endif // DEBUG_ENABLED
  272. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  273. #ifdef TOOLS_ENABLED
  274. ERR_FAIL_COND_V_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), Variant(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  275. #endif
  276. #ifdef TYPED_METHOD_BIND
  277. call_with_variant_args_dv(static_cast<T *>(p_object), method, p_args, p_arg_count, r_error, get_default_arguments());
  278. #else
  279. call_with_variant_args_dv(reinterpret_cast<MB_T *>(p_object), method, p_args, p_arg_count, r_error, get_default_arguments());
  280. #endif
  281. return Variant();
  282. }
  283. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  284. #ifdef TOOLS_ENABLED
  285. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  286. #endif
  287. #ifdef TYPED_METHOD_BIND
  288. call_with_validated_object_instance_args(static_cast<T *>(p_object), method, p_args);
  289. #else
  290. call_with_validated_object_instance_args(reinterpret_cast<MB_T *>(p_object), method, p_args);
  291. #endif
  292. }
  293. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  294. #ifdef TOOLS_ENABLED
  295. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  296. #endif
  297. #ifdef TYPED_METHOD_BIND
  298. call_with_ptr_args<T, P...>(static_cast<T *>(p_object), method, p_args);
  299. #else
  300. call_with_ptr_args<MB_T, P...>(reinterpret_cast<MB_T *>(p_object), method, p_args);
  301. #endif
  302. }
  303. MethodBindT(void (MB_T::*p_method)(P...)) {
  304. method = p_method;
  305. _generate_argument_types(sizeof...(P));
  306. set_argument_count(sizeof...(P));
  307. }
  308. };
  309. template <typename T, typename... P>
  310. MethodBind *create_method_bind(void (T::*p_method)(P...)) {
  311. #ifdef TYPED_METHOD_BIND
  312. MethodBind *a = memnew((MethodBindT<T, P...>)(p_method));
  313. #else
  314. MethodBind *a = memnew((MethodBindT<P...>)(reinterpret_cast<void (MB_T::*)(P...)>(p_method)));
  315. #endif
  316. a->set_instance_class(T::get_class_static());
  317. return a;
  318. }
  319. // no return, const
  320. #ifdef TYPED_METHOD_BIND
  321. template <typename T, typename... P>
  322. #else
  323. template <typename... P>
  324. #endif
  325. class MethodBindTC : public MethodBind {
  326. void (MB_T::*method)(P...) const;
  327. protected:
  328. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  329. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  330. return call_get_argument_type<P...>(p_arg);
  331. } else {
  332. return Variant::NIL;
  333. }
  334. }
  335. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  336. PropertyInfo pi;
  337. call_get_argument_type_info<P...>(p_arg, pi);
  338. return pi;
  339. }
  340. public:
  341. #ifdef DEBUG_ENABLED
  342. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const override {
  343. return call_get_argument_metadata<P...>(p_arg);
  344. }
  345. #endif // DEBUG_ENABLED
  346. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  347. #ifdef TOOLS_ENABLED
  348. ERR_FAIL_COND_V_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), Variant(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  349. #endif
  350. #ifdef TYPED_METHOD_BIND
  351. call_with_variant_argsc_dv(static_cast<T *>(p_object), method, p_args, p_arg_count, r_error, get_default_arguments());
  352. #else
  353. call_with_variant_argsc_dv(reinterpret_cast<MB_T *>(p_object), method, p_args, p_arg_count, r_error, get_default_arguments());
  354. #endif
  355. return Variant();
  356. }
  357. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  358. #ifdef TOOLS_ENABLED
  359. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  360. #endif
  361. #ifdef TYPED_METHOD_BIND
  362. call_with_validated_object_instance_argsc(static_cast<T *>(p_object), method, p_args);
  363. #else
  364. call_with_validated_object_instance_argsc(reinterpret_cast<MB_T *>(p_object), method, p_args);
  365. #endif
  366. }
  367. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  368. #ifdef TOOLS_ENABLED
  369. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  370. #endif
  371. #ifdef TYPED_METHOD_BIND
  372. call_with_ptr_argsc<T, P...>(static_cast<T *>(p_object), method, p_args);
  373. #else
  374. call_with_ptr_argsc<MB_T, P...>(reinterpret_cast<MB_T *>(p_object), method, p_args);
  375. #endif
  376. }
  377. MethodBindTC(void (MB_T::*p_method)(P...) const) {
  378. method = p_method;
  379. _set_const(true);
  380. _generate_argument_types(sizeof...(P));
  381. set_argument_count(sizeof...(P));
  382. }
  383. };
  384. template <typename T, typename... P>
  385. MethodBind *create_method_bind(void (T::*p_method)(P...) const) {
  386. #ifdef TYPED_METHOD_BIND
  387. MethodBind *a = memnew((MethodBindTC<T, P...>)(p_method));
  388. #else
  389. MethodBind *a = memnew((MethodBindTC<P...>)(reinterpret_cast<void (MB_T::*)(P...) const>(p_method)));
  390. #endif
  391. a->set_instance_class(T::get_class_static());
  392. return a;
  393. }
  394. // return, not const
  395. #ifdef TYPED_METHOD_BIND
  396. template <typename T, typename R, typename... P>
  397. #else
  398. template <typename R, typename... P>
  399. #endif
  400. class MethodBindTR : public MethodBind {
  401. R (MB_T::*method)(P...);
  402. protected:
  403. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  404. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  405. return call_get_argument_type<P...>(p_arg);
  406. } else {
  407. return GetTypeInfo<R>::VARIANT_TYPE;
  408. }
  409. }
  410. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  411. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  412. PropertyInfo pi;
  413. call_get_argument_type_info<P...>(p_arg, pi);
  414. return pi;
  415. } else {
  416. return GetTypeInfo<R>::get_class_info();
  417. }
  418. }
  419. public:
  420. #ifdef DEBUG_ENABLED
  421. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const override {
  422. if (p_arg >= 0) {
  423. return call_get_argument_metadata<P...>(p_arg);
  424. } else {
  425. return GetTypeInfo<R>::METADATA;
  426. }
  427. }
  428. #endif // DEBUG_ENABLED
  429. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  430. Variant ret;
  431. #ifdef TOOLS_ENABLED
  432. ERR_FAIL_COND_V_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), ret, vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  433. #endif
  434. #ifdef TYPED_METHOD_BIND
  435. call_with_variant_args_ret_dv(static_cast<T *>(p_object), method, p_args, p_arg_count, ret, r_error, get_default_arguments());
  436. #else
  437. call_with_variant_args_ret_dv(reinterpret_cast<MB_T *>(p_object), method, p_args, p_arg_count, ret, r_error, get_default_arguments());
  438. #endif
  439. return ret;
  440. }
  441. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  442. #ifdef TOOLS_ENABLED
  443. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  444. #endif
  445. #ifdef TYPED_METHOD_BIND
  446. call_with_validated_object_instance_args_ret(static_cast<T *>(p_object), method, p_args, r_ret);
  447. #else
  448. call_with_validated_object_instance_args_ret(reinterpret_cast<MB_T *>(p_object), method, p_args, r_ret);
  449. #endif
  450. }
  451. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  452. #ifdef TOOLS_ENABLED
  453. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  454. #endif
  455. #ifdef TYPED_METHOD_BIND
  456. call_with_ptr_args_ret<T, R, P...>(static_cast<T *>(p_object), method, p_args, r_ret);
  457. #else
  458. call_with_ptr_args_ret<MB_T, R, P...>(reinterpret_cast<MB_T *>(p_object), method, p_args, r_ret);
  459. #endif
  460. }
  461. MethodBindTR(R (MB_T::*p_method)(P...)) {
  462. method = p_method;
  463. _set_returns(true);
  464. _generate_argument_types(sizeof...(P));
  465. set_argument_count(sizeof...(P));
  466. }
  467. };
  468. template <typename T, typename R, typename... P>
  469. MethodBind *create_method_bind(R (T::*p_method)(P...)) {
  470. #ifdef TYPED_METHOD_BIND
  471. MethodBind *a = memnew((MethodBindTR<T, R, P...>)(p_method));
  472. #else
  473. MethodBind *a = memnew((MethodBindTR<R, P...>)(reinterpret_cast<R (MB_T::*)(P...)>(p_method)));
  474. #endif
  475. a->set_instance_class(T::get_class_static());
  476. return a;
  477. }
  478. // return, const
  479. #ifdef TYPED_METHOD_BIND
  480. template <typename T, typename R, typename... P>
  481. #else
  482. template <typename R, typename... P>
  483. #endif
  484. class MethodBindTRC : public MethodBind {
  485. R (MB_T::*method)(P...) const;
  486. protected:
  487. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  488. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  489. return call_get_argument_type<P...>(p_arg);
  490. } else {
  491. return GetTypeInfo<R>::VARIANT_TYPE;
  492. }
  493. }
  494. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  495. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  496. PropertyInfo pi;
  497. call_get_argument_type_info<P...>(p_arg, pi);
  498. return pi;
  499. } else {
  500. return GetTypeInfo<R>::get_class_info();
  501. }
  502. }
  503. public:
  504. #ifdef DEBUG_ENABLED
  505. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const override {
  506. if (p_arg >= 0) {
  507. return call_get_argument_metadata<P...>(p_arg);
  508. } else {
  509. return GetTypeInfo<R>::METADATA;
  510. }
  511. }
  512. #endif // DEBUG_ENABLED
  513. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  514. Variant ret;
  515. #ifdef TOOLS_ENABLED
  516. ERR_FAIL_COND_V_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), ret, vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  517. #endif
  518. #ifdef TYPED_METHOD_BIND
  519. call_with_variant_args_retc_dv(static_cast<T *>(p_object), method, p_args, p_arg_count, ret, r_error, get_default_arguments());
  520. #else
  521. call_with_variant_args_retc_dv(reinterpret_cast<MB_T *>(p_object), method, p_args, p_arg_count, ret, r_error, get_default_arguments());
  522. #endif
  523. return ret;
  524. }
  525. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  526. #ifdef TOOLS_ENABLED
  527. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  528. #endif
  529. #ifdef TYPED_METHOD_BIND
  530. call_with_validated_object_instance_args_retc(static_cast<T *>(p_object), method, p_args, r_ret);
  531. #else
  532. call_with_validated_object_instance_args_retc(reinterpret_cast<MB_T *>(p_object), method, p_args, r_ret);
  533. #endif
  534. }
  535. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  536. #ifdef TOOLS_ENABLED
  537. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder() && p_object->get_class_name() == get_instance_class(), vformat("Cannot call method bind '%s' on placeholder instance.", MethodBind::get_name()));
  538. #endif
  539. #ifdef TYPED_METHOD_BIND
  540. call_with_ptr_args_retc<T, R, P...>(static_cast<T *>(p_object), method, p_args, r_ret);
  541. #else
  542. call_with_ptr_args_retc<MB_T, R, P...>(reinterpret_cast<MB_T *>(p_object), method, p_args, r_ret);
  543. #endif
  544. }
  545. MethodBindTRC(R (MB_T::*p_method)(P...) const) {
  546. method = p_method;
  547. _set_returns(true);
  548. _set_const(true);
  549. _generate_argument_types(sizeof...(P));
  550. set_argument_count(sizeof...(P));
  551. }
  552. };
  553. template <typename T, typename R, typename... P>
  554. MethodBind *create_method_bind(R (T::*p_method)(P...) const) {
  555. #ifdef TYPED_METHOD_BIND
  556. MethodBind *a = memnew((MethodBindTRC<T, R, P...>)(p_method));
  557. #else
  558. MethodBind *a = memnew((MethodBindTRC<R, P...>)(reinterpret_cast<R (MB_T::*)(P...) const>(p_method)));
  559. #endif
  560. a->set_instance_class(T::get_class_static());
  561. return a;
  562. }
  563. /* STATIC BINDS */
  564. // no return
  565. template <typename... P>
  566. class MethodBindTS : public MethodBind {
  567. void (*function)(P...);
  568. protected:
  569. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  570. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  571. return call_get_argument_type<P...>(p_arg);
  572. } else {
  573. return Variant::NIL;
  574. }
  575. }
  576. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  577. PropertyInfo pi;
  578. call_get_argument_type_info<P...>(p_arg, pi);
  579. return pi;
  580. }
  581. public:
  582. #ifdef DEBUG_ENABLED
  583. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const override {
  584. return call_get_argument_metadata<P...>(p_arg);
  585. }
  586. #endif // DEBUG_ENABLED
  587. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  588. (void)p_object; // unused
  589. call_with_variant_args_static_dv(function, p_args, p_arg_count, r_error, get_default_arguments());
  590. return Variant();
  591. }
  592. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  593. call_with_validated_variant_args_static_method(function, p_args);
  594. }
  595. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  596. (void)p_object;
  597. (void)r_ret;
  598. call_with_ptr_args_static_method(function, p_args);
  599. }
  600. MethodBindTS(void (*p_function)(P...)) {
  601. function = p_function;
  602. _generate_argument_types(sizeof...(P));
  603. set_argument_count(sizeof...(P));
  604. _set_static(true);
  605. }
  606. };
  607. template <typename... P>
  608. MethodBind *create_static_method_bind(void (*p_method)(P...)) {
  609. MethodBind *a = memnew((MethodBindTS<P...>)(p_method));
  610. return a;
  611. }
  612. // return
  613. template <typename R, typename... P>
  614. class MethodBindTRS : public MethodBind {
  615. R (*function)(P...);
  616. protected:
  617. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  618. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  619. return call_get_argument_type<P...>(p_arg);
  620. } else {
  621. return GetTypeInfo<R>::VARIANT_TYPE;
  622. }
  623. }
  624. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  625. if (p_arg >= 0 && p_arg < (int)sizeof...(P)) {
  626. PropertyInfo pi;
  627. call_get_argument_type_info<P...>(p_arg, pi);
  628. return pi;
  629. } else {
  630. return GetTypeInfo<R>::get_class_info();
  631. }
  632. }
  633. public:
  634. #ifdef DEBUG_ENABLED
  635. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const override {
  636. if (p_arg >= 0) {
  637. return call_get_argument_metadata<P...>(p_arg);
  638. } else {
  639. return GetTypeInfo<R>::METADATA;
  640. }
  641. }
  642. #endif // DEBUG_ENABLED
  643. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  644. Variant ret;
  645. call_with_variant_args_static_ret_dv(function, p_args, p_arg_count, ret, r_error, get_default_arguments());
  646. return ret;
  647. }
  648. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  649. call_with_validated_variant_args_static_method_ret(function, p_args, r_ret);
  650. }
  651. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  652. (void)p_object;
  653. call_with_ptr_args_static_method_ret(function, p_args, r_ret);
  654. }
  655. MethodBindTRS(R (*p_function)(P...)) {
  656. function = p_function;
  657. _generate_argument_types(sizeof...(P));
  658. set_argument_count(sizeof...(P));
  659. _set_static(true);
  660. _set_returns(true);
  661. }
  662. };
  663. template <typename R, typename... P>
  664. MethodBind *create_static_method_bind(R (*p_method)(P...)) {
  665. MethodBind *a = memnew((MethodBindTRS<R, P...>)(p_method));
  666. return a;
  667. }