wrapped.hpp 64 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. /**************************************************************************/
  2. /* wrapped.hpp */
  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. #ifndef GODOT_WRAPPED_HPP
  31. #define GODOT_WRAPPED_HPP
  32. #include <godot_cpp/core/memory.hpp>
  33. #include <godot_cpp/core/property_info.hpp>
  34. #include <godot_cpp/templates/list.hpp>
  35. #include <godot_cpp/godot.hpp>
  36. namespace godot {
  37. class ClassDB;
  38. typedef void GodotObject;
  39. // Base for all engine classes, to contain the pointer to the engine instance.
  40. class Wrapped {
  41. friend class GDExtensionBinding;
  42. friend void postinitialize_handler(Wrapped *);
  43. protected:
  44. #ifdef HOT_RELOAD_ENABLED
  45. struct RecreateInstance {
  46. GDExtensionClassInstancePtr wrapper;
  47. GDExtensionObjectPtr owner;
  48. RecreateInstance *next;
  49. };
  50. inline static RecreateInstance *recreate_instance = nullptr;
  51. #endif
  52. 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.
  53. virtual const GDExtensionInstanceBindingCallbacks *_get_bindings_callbacks() const = 0;
  54. void _notification(int p_what) {}
  55. bool _set(const StringName &p_name, const Variant &p_property) { return false; }
  56. bool _get(const StringName &p_name, Variant &r_property) const { return false; }
  57. void _get_property_list(List<PropertyInfo> *p_list) const {}
  58. bool _property_can_revert(const StringName &p_name) const { return false; }
  59. bool _property_get_revert(const StringName &p_name, Variant &r_property) const { return false; }
  60. void _validate_property(PropertyInfo &p_property) const {}
  61. String _to_string() const { return "[" + String(get_class_static()) + ":" + itos(get_instance_id()) + "]"; }
  62. static void notification_bind(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed) {}
  63. static GDExtensionBool set_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value) { return false; }
  64. static GDExtensionBool get_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { return false; }
  65. static const GDExtensionPropertyInfo *get_property_list_bind(GDExtensionClassInstancePtr p_instance, uint32_t *r_count) { return nullptr; }
  66. static void free_property_list_bind(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list) {}
  67. static GDExtensionBool property_can_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name) { return false; }
  68. static GDExtensionBool property_get_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { return false; }
  69. static GDExtensionBool validate_property_bind(GDExtensionClassInstancePtr p_instance, GDExtensionPropertyInfo *p_property) { return false; }
  70. static void to_string_bind(GDExtensionClassInstancePtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out) {}
  71. // The only reason this has to be held here, is when we return results of `_get_property_list` to Godot, we pass
  72. // pointers to strings in this list. They have to remain valid to pass the bridge, until the list is freed by Godot...
  73. ::godot::List<::godot::PropertyInfo> plist_owned;
  74. void _postinitialize();
  75. Wrapped(const StringName p_godot_class);
  76. Wrapped(GodotObject *p_godot_object);
  77. virtual ~Wrapped() {}
  78. public:
  79. static StringName &get_class_static() {
  80. static StringName string_name = StringName("Wrapped");
  81. return string_name;
  82. }
  83. uint64_t get_instance_id() const {
  84. return 0;
  85. }
  86. // Must be public but you should not touch this.
  87. GodotObject *_owner = nullptr;
  88. };
  89. namespace internal {
  90. GDExtensionPropertyInfo *create_c_property_list(const ::godot::List<::godot::PropertyInfo> &plist_cpp, uint32_t *r_size);
  91. void free_c_property_list(GDExtensionPropertyInfo *plist);
  92. typedef void (*EngineClassRegistrationCallback)();
  93. void add_engine_class_registration_callback(EngineClassRegistrationCallback p_callback);
  94. void register_engine_class(const StringName &p_name, const GDExtensionInstanceBindingCallbacks *p_callbacks);
  95. void register_engine_classes();
  96. template <class T>
  97. struct EngineClassRegistration {
  98. EngineClassRegistration() {
  99. add_engine_class_registration_callback(&EngineClassRegistration<T>::callback);
  100. }
  101. static void callback() {
  102. register_engine_class(T::get_class_static(), &T::_gde_binding_callbacks);
  103. }
  104. };
  105. } // namespace internal
  106. } // namespace godot
  107. #ifdef HOT_RELOAD_ENABLED
  108. #define _GDCLASS_RECREATE(m_class, m_inherits) \
  109. m_class *new_instance = (m_class *)memalloc(sizeof(m_class)); \
  110. Wrapped::RecreateInstance recreate_data = { new_instance, obj, Wrapped::recreate_instance }; \
  111. Wrapped::recreate_instance = &recreate_data; \
  112. memnew_placement(new_instance, m_class); \
  113. return new_instance;
  114. #else
  115. #define _GDCLASS_RECREATE(m_class, m_inherits) return nullptr;
  116. #endif
  117. // Use this on top of your own classes.
  118. // Note: the trail of `***` is to keep sane diffs in PRs, because clang-format otherwise moves every `\` which makes
  119. // every line of the macro different
  120. #define GDCLASS(m_class, m_inherits) /***********************************************************************************************************************************************/ \
  121. private: \
  122. void operator=(const m_class &p_rval) {} \
  123. friend class ::godot::ClassDB; \
  124. \
  125. protected: \
  126. virtual const ::godot::StringName *_get_extension_class_name() const override { \
  127. static ::godot::StringName string_name = get_class_static(); \
  128. return &string_name; \
  129. } \
  130. \
  131. virtual const GDExtensionInstanceBindingCallbacks *_get_bindings_callbacks() const override { \
  132. return &_gde_binding_callbacks; \
  133. } \
  134. \
  135. static void (*_get_bind_methods())() { \
  136. return &m_class::_bind_methods; \
  137. } \
  138. \
  139. static void (::godot::Wrapped::*_get_notification())(int) { \
  140. return (void(::godot::Wrapped::*)(int)) & m_class::_notification; \
  141. } \
  142. \
  143. static bool (::godot::Wrapped::*_get_set())(const ::godot::StringName &p_name, const ::godot::Variant &p_property) { \
  144. return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name, const ::godot::Variant &p_property)) & m_class::_set; \
  145. } \
  146. \
  147. static bool (::godot::Wrapped::*_get_get())(const ::godot::StringName &p_name, ::godot::Variant &r_ret) const { \
  148. return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name, ::godot::Variant &r_ret) const) & m_class::_get; \
  149. } \
  150. \
  151. static void (::godot::Wrapped::*_get_get_property_list())(::godot::List<::godot::PropertyInfo> * p_list) const { \
  152. return (void(::godot::Wrapped::*)(::godot::List<::godot::PropertyInfo> * p_list) const) & m_class::_get_property_list; \
  153. } \
  154. \
  155. static bool (::godot::Wrapped::*_get_property_can_revert())(const ::godot::StringName &p_name) const { \
  156. return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name) const) & m_class::_property_can_revert; \
  157. } \
  158. \
  159. static bool (::godot::Wrapped::*_get_property_get_revert())(const ::godot::StringName &p_name, ::godot::Variant &) const { \
  160. return (bool(::godot::Wrapped::*)(const ::godot::StringName &p_name, ::godot::Variant &) const) & m_class::_property_get_revert; \
  161. } \
  162. \
  163. static void (::godot::Wrapped::*_get_validate_property())(::godot::PropertyInfo & p_property) const { \
  164. return (void(::godot::Wrapped::*)(::godot::PropertyInfo & p_property) const) & m_class::_validate_property; \
  165. } \
  166. \
  167. static ::godot::String (::godot::Wrapped::*_get_to_string())() const { \
  168. return (::godot::String(::godot::Wrapped::*)() const) & m_class::_to_string; \
  169. } \
  170. \
  171. template <class T, class B> \
  172. static void register_virtuals() { \
  173. m_inherits::register_virtuals<T, B>(); \
  174. } \
  175. \
  176. public: \
  177. typedef m_class self_type; \
  178. \
  179. static void initialize_class() { \
  180. static bool initialized = false; \
  181. if (initialized) { \
  182. return; \
  183. } \
  184. m_inherits::initialize_class(); \
  185. if (m_class::_get_bind_methods() != m_inherits::_get_bind_methods()) { \
  186. _bind_methods(); \
  187. m_inherits::register_virtuals<m_class, m_inherits>(); \
  188. } \
  189. initialized = true; \
  190. } \
  191. \
  192. static ::godot::StringName &get_class_static() { \
  193. static ::godot::StringName string_name = ::godot::StringName(#m_class); \
  194. return string_name; \
  195. } \
  196. \
  197. static ::godot::StringName &get_parent_class_static() { \
  198. return m_inherits::get_class_static(); \
  199. } \
  200. \
  201. static GDExtensionObjectPtr create(void *data) { \
  202. m_class *new_object = memnew(m_class); \
  203. return new_object->_owner; \
  204. } \
  205. \
  206. static GDExtensionClassInstancePtr recreate(void *data, GDExtensionObjectPtr obj) { \
  207. _GDCLASS_RECREATE(m_class, m_inherits); \
  208. } \
  209. \
  210. static void notification_bind(GDExtensionClassInstancePtr p_instance, int32_t p_what, GDExtensionBool p_reversed) { \
  211. if (p_instance && m_class::_get_notification()) { \
  212. if (m_class::_get_notification() != m_inherits::_get_notification()) { \
  213. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  214. return cls->_notification(p_what); \
  215. } \
  216. m_inherits::notification_bind(p_instance, p_what, p_reversed); \
  217. } \
  218. } \
  219. \
  220. static GDExtensionBool set_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionConstVariantPtr p_value) { \
  221. if (p_instance && m_class::_get_set()) { \
  222. if (m_class::_get_set() != m_inherits::_get_set()) { \
  223. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  224. return cls->_set(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<const ::godot::Variant *>(p_value)); \
  225. } \
  226. return m_inherits::set_bind(p_instance, p_name, p_value); \
  227. } \
  228. return false; \
  229. } \
  230. \
  231. static GDExtensionBool get_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { \
  232. if (p_instance && m_class::_get_get()) { \
  233. if (m_class::_get_get() != m_inherits::_get_get()) { \
  234. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  235. return cls->_get(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<::godot::Variant *>(r_ret)); \
  236. } \
  237. return m_inherits::get_bind(p_instance, p_name, r_ret); \
  238. } \
  239. return false; \
  240. } \
  241. \
  242. static inline bool has_get_property_list() { \
  243. return m_class::_get_get_property_list() && m_class::_get_get_property_list() != m_inherits::_get_get_property_list(); \
  244. } \
  245. \
  246. static const GDExtensionPropertyInfo *get_property_list_bind(GDExtensionClassInstancePtr p_instance, uint32_t *r_count) { \
  247. if (!p_instance) { \
  248. if (r_count) \
  249. *r_count = 0; \
  250. return nullptr; \
  251. } \
  252. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  253. ::godot::List<::godot::PropertyInfo> &plist_cpp = cls->plist_owned; \
  254. ERR_FAIL_COND_V_MSG(!plist_cpp.is_empty(), nullptr, "Internal error, property list was not freed by engine!"); \
  255. cls->_get_property_list(&plist_cpp); \
  256. return ::godot::internal::create_c_property_list(plist_cpp, r_count); \
  257. } \
  258. \
  259. static void free_property_list_bind(GDExtensionClassInstancePtr p_instance, const GDExtensionPropertyInfo *p_list) { \
  260. if (p_instance) { \
  261. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  262. cls->plist_owned.clear(); \
  263. /* TODO `GDExtensionClassFreePropertyList` is ill-defined, we need a non-const pointer to free this. */ \
  264. ::godot::internal::free_c_property_list(const_cast<GDExtensionPropertyInfo *>(p_list)); \
  265. } \
  266. } \
  267. \
  268. static GDExtensionBool property_can_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name) { \
  269. if (p_instance && m_class::_get_property_can_revert()) { \
  270. if (m_class::_get_property_can_revert() != m_inherits::_get_property_can_revert()) { \
  271. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  272. return cls->_property_can_revert(*reinterpret_cast<const ::godot::StringName *>(p_name)); \
  273. } \
  274. return m_inherits::property_can_revert_bind(p_instance, p_name); \
  275. } \
  276. return false; \
  277. } \
  278. \
  279. static GDExtensionBool property_get_revert_bind(GDExtensionClassInstancePtr p_instance, GDExtensionConstStringNamePtr p_name, GDExtensionVariantPtr r_ret) { \
  280. if (p_instance && m_class::_get_property_get_revert()) { \
  281. if (m_class::_get_property_get_revert() != m_inherits::_get_property_get_revert()) { \
  282. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  283. return cls->_property_get_revert(*reinterpret_cast<const ::godot::StringName *>(p_name), *reinterpret_cast<::godot::Variant *>(r_ret)); \
  284. } \
  285. return m_inherits::property_get_revert_bind(p_instance, p_name, r_ret); \
  286. } \
  287. return false; \
  288. } \
  289. \
  290. static GDExtensionBool validate_property_bind(GDExtensionClassInstancePtr p_instance, GDExtensionPropertyInfo *p_property) { \
  291. bool ret = false; \
  292. if (p_instance && m_class::_get_validate_property()) { \
  293. ret = m_inherits::validate_property_bind(p_instance, p_property); \
  294. if (m_class::_get_validate_property() != m_inherits::_get_validate_property()) { \
  295. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  296. ::godot::PropertyInfo info(p_property); \
  297. cls->_validate_property(info); \
  298. info._update(p_property); \
  299. return true; \
  300. } \
  301. } \
  302. return ret; \
  303. } \
  304. \
  305. static void to_string_bind(GDExtensionClassInstancePtr p_instance, GDExtensionBool *r_is_valid, GDExtensionStringPtr r_out) { \
  306. if (p_instance && m_class::_get_to_string()) { \
  307. if (m_class::_get_to_string() != m_inherits::_get_to_string()) { \
  308. m_class *cls = reinterpret_cast<m_class *>(p_instance); \
  309. *reinterpret_cast<::godot::String *>(r_out) = cls->_to_string(); \
  310. *r_is_valid = true; \
  311. return; \
  312. } \
  313. m_inherits::to_string_bind(p_instance, r_is_valid, r_out); \
  314. } \
  315. } \
  316. \
  317. static void free(void *data, GDExtensionClassInstancePtr ptr) { \
  318. if (ptr) { \
  319. m_class *cls = reinterpret_cast<m_class *>(ptr); \
  320. cls->~m_class(); \
  321. ::godot::Memory::free_static(cls); \
  322. } \
  323. } \
  324. \
  325. static void *_gde_binding_create_callback(void *p_token, void *p_instance) { \
  326. return nullptr; \
  327. } \
  328. \
  329. static void _gde_binding_free_callback(void *p_token, void *p_instance, void *p_binding) { \
  330. } \
  331. \
  332. static GDExtensionBool _gde_binding_reference_callback(void *p_token, void *p_instance, GDExtensionBool p_reference) { \
  333. return true; \
  334. } \
  335. \
  336. static constexpr GDExtensionInstanceBindingCallbacks _gde_binding_callbacks = { \
  337. _gde_binding_create_callback, \
  338. _gde_binding_free_callback, \
  339. _gde_binding_reference_callback, \
  340. }; \
  341. \
  342. private:
  343. // Don't use this for your classes, use GDCLASS() instead.
  344. #define GDEXTENSION_CLASS_ALIAS(m_class, m_alias_for, m_inherits) /******************************************************************************************************************/ \
  345. private: \
  346. inline static ::godot::internal::EngineClassRegistration<m_class> _gde_engine_class_registration_helper; \
  347. void operator=(const m_class &p_rval) {} \
  348. \
  349. protected: \
  350. virtual const GDExtensionInstanceBindingCallbacks *_get_bindings_callbacks() const override { \
  351. return &_gde_binding_callbacks; \
  352. } \
  353. \
  354. m_class(const char *p_godot_class) : m_inherits(p_godot_class) {} \
  355. m_class(GodotObject *p_godot_object) : m_inherits(p_godot_object) {} \
  356. \
  357. static void (*_get_bind_methods())() { \
  358. return nullptr; \
  359. } \
  360. \
  361. static void (Wrapped::*_get_notification())(int) { \
  362. return nullptr; \
  363. } \
  364. \
  365. static bool (Wrapped::*_get_set())(const ::godot::StringName &p_name, const Variant &p_property) { \
  366. return nullptr; \
  367. } \
  368. \
  369. static bool (Wrapped::*_get_get())(const ::godot::StringName &p_name, Variant &r_ret) const { \
  370. return nullptr; \
  371. } \
  372. \
  373. static inline bool has_get_property_list() { \
  374. return false; \
  375. } \
  376. \
  377. static void (Wrapped::*_get_get_property_list())(List<PropertyInfo> * p_list) const { \
  378. return nullptr; \
  379. } \
  380. \
  381. static bool (Wrapped::*_get_property_can_revert())(const ::godot::StringName &p_name) const { \
  382. return nullptr; \
  383. } \
  384. \
  385. static bool (Wrapped::*_get_property_get_revert())(const ::godot::StringName &p_name, Variant &) const { \
  386. return nullptr; \
  387. } \
  388. \
  389. static void (Wrapped::*_get_validate_property())(::godot::PropertyInfo & p_property) const { \
  390. return nullptr; \
  391. } \
  392. \
  393. static String (Wrapped::*_get_to_string())() const { \
  394. return nullptr; \
  395. } \
  396. \
  397. public: \
  398. typedef m_class self_type; \
  399. \
  400. static void initialize_class() {} \
  401. \
  402. static ::godot::StringName &get_class_static() { \
  403. static ::godot::StringName string_name = ::godot::StringName(#m_alias_for); \
  404. return string_name; \
  405. } \
  406. \
  407. static ::godot::StringName &get_parent_class_static() { \
  408. return m_inherits::get_class_static(); \
  409. } \
  410. \
  411. static GDExtensionObjectPtr create(void *data) { \
  412. return nullptr; \
  413. } \
  414. \
  415. static GDExtensionClassInstancePtr recreate(void *data, GDExtensionObjectPtr obj) { \
  416. return nullptr; \
  417. } \
  418. \
  419. static void free(void *data, GDExtensionClassInstancePtr ptr) { \
  420. } \
  421. \
  422. static void *_gde_binding_create_callback(void *p_token, void *p_instance) { \
  423. /* Do not call memnew here, we don't want the post-initializer to be called */ \
  424. return new ("", "") m_class((GodotObject *)p_instance); \
  425. } \
  426. static void _gde_binding_free_callback(void *p_token, void *p_instance, void *p_binding) { \
  427. /* Explicitly call the deconstructor to ensure proper lifecycle for non-trivial members */ \
  428. reinterpret_cast<m_class *>(p_binding)->~m_class(); \
  429. Memory::free_static(reinterpret_cast<m_class *>(p_binding)); \
  430. } \
  431. static GDExtensionBool _gde_binding_reference_callback(void *p_token, void *p_instance, GDExtensionBool p_reference) { \
  432. return true; \
  433. } \
  434. static constexpr GDExtensionInstanceBindingCallbacks _gde_binding_callbacks = { \
  435. _gde_binding_create_callback, \
  436. _gde_binding_free_callback, \
  437. _gde_binding_reference_callback, \
  438. }; \
  439. m_class() : m_class(#m_alias_for) {} \
  440. \
  441. private:
  442. // Don't use this for your classes, use GDCLASS() instead.
  443. #define GDEXTENSION_CLASS(m_class, m_inherits) GDEXTENSION_CLASS_ALIAS(m_class, m_class, m_inherits)
  444. #endif // GODOT_WRAPPED_HPP