gdextension.cpp 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052
  1. /**************************************************************************/
  2. /* gdextension.cpp */
  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. #include "gdextension.h"
  31. #include "gdextension.compat.inc"
  32. #include "core/config/project_settings.h"
  33. #include "core/object/class_db.h"
  34. #include "core/object/method_bind.h"
  35. #include "gdextension_library_loader.h"
  36. #include "gdextension_manager.h"
  37. extern void gdextension_setup_interface();
  38. extern GDExtensionInterfaceFunctionPtr gdextension_get_proc_address(const char *p_name);
  39. typedef GDExtensionBool (*GDExtensionLegacyInitializationFunction)(void *p_interface, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization);
  40. String GDExtension::get_extension_list_config_file() {
  41. return ProjectSettings::get_singleton()->get_project_data_path().path_join("extension_list.cfg");
  42. }
  43. class GDExtensionMethodBind : public MethodBind {
  44. GDExtensionClassMethodCall call_func;
  45. GDExtensionClassMethodValidatedCall validated_call_func;
  46. GDExtensionClassMethodPtrCall ptrcall_func;
  47. void *method_userdata;
  48. bool vararg;
  49. uint32_t argument_count;
  50. PropertyInfo return_value_info;
  51. GodotTypeInfo::Metadata return_value_metadata;
  52. List<PropertyInfo> arguments_info;
  53. List<GodotTypeInfo::Metadata> arguments_metadata;
  54. #ifdef TOOLS_ENABLED
  55. friend class GDExtension;
  56. StringName name;
  57. bool is_reloading = false;
  58. bool valid = true;
  59. #endif
  60. protected:
  61. virtual Variant::Type _gen_argument_type(int p_arg) const override {
  62. if (p_arg < 0) {
  63. return return_value_info.type;
  64. } else {
  65. return arguments_info.get(p_arg).type;
  66. }
  67. }
  68. virtual PropertyInfo _gen_argument_type_info(int p_arg) const override {
  69. if (p_arg < 0) {
  70. return return_value_info;
  71. } else {
  72. return arguments_info.get(p_arg);
  73. }
  74. }
  75. public:
  76. #ifdef TOOLS_ENABLED
  77. virtual bool is_valid() const override { return valid; }
  78. #endif
  79. #ifdef DEBUG_METHODS_ENABLED
  80. virtual GodotTypeInfo::Metadata get_argument_meta(int p_arg) const override {
  81. if (p_arg < 0) {
  82. return return_value_metadata;
  83. } else {
  84. return arguments_metadata.get(p_arg);
  85. }
  86. }
  87. #endif
  88. virtual Variant call(Object *p_object, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) const override {
  89. #ifdef TOOLS_ENABLED
  90. ERR_FAIL_COND_V_MSG(!valid, Variant(), vformat("Cannot call invalid GDExtension method bind '%s'. It's probably cached - you may need to restart Godot.", name));
  91. ERR_FAIL_COND_V_MSG(p_object && p_object->is_extension_placeholder(), Variant(), vformat("Cannot call GDExtension method bind '%s' on placeholder instance.", name));
  92. #endif
  93. Variant ret;
  94. GDExtensionClassInstancePtr extension_instance = is_static() ? nullptr : p_object->_get_extension_instance();
  95. GDExtensionCallError ce{ GDEXTENSION_CALL_OK, 0, 0 };
  96. call_func(method_userdata, extension_instance, reinterpret_cast<GDExtensionConstVariantPtr *>(p_args), p_arg_count, (GDExtensionVariantPtr)&ret, &ce);
  97. r_error.error = Callable::CallError::Error(ce.error);
  98. r_error.argument = ce.argument;
  99. r_error.expected = ce.expected;
  100. return ret;
  101. }
  102. virtual void validated_call(Object *p_object, const Variant **p_args, Variant *r_ret) const override {
  103. #ifdef TOOLS_ENABLED
  104. ERR_FAIL_COND_MSG(!valid, vformat("Cannot call invalid GDExtension method bind '%s'. It's probably cached - you may need to restart Godot.", name));
  105. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder(), vformat("Cannot call GDExtension method bind '%s' on placeholder instance.", name));
  106. #endif
  107. ERR_FAIL_COND_MSG(vararg, "Vararg methods don't have validated call support. This is most likely an engine bug.");
  108. GDExtensionClassInstancePtr extension_instance = is_static() ? nullptr : p_object->_get_extension_instance();
  109. if (validated_call_func) {
  110. // This is added here, but it's unlikely to be provided by most extensions.
  111. validated_call_func(method_userdata, extension_instance, reinterpret_cast<GDExtensionConstVariantPtr *>(p_args), (GDExtensionVariantPtr)r_ret);
  112. } else {
  113. // If not provided, go via ptrcall, which is faster than resorting to regular call.
  114. const void **argptrs = (const void **)alloca(argument_count * sizeof(void *));
  115. for (uint32_t i = 0; i < argument_count; i++) {
  116. argptrs[i] = VariantInternal::get_opaque_pointer(p_args[i]);
  117. }
  118. void *ret_opaque = nullptr;
  119. if (r_ret) {
  120. VariantInternal::initialize(r_ret, return_value_info.type);
  121. ret_opaque = r_ret->get_type() == Variant::NIL ? r_ret : VariantInternal::get_opaque_pointer(r_ret);
  122. }
  123. ptrcall_func(method_userdata, extension_instance, reinterpret_cast<GDExtensionConstTypePtr *>(argptrs), (GDExtensionTypePtr)ret_opaque);
  124. if (r_ret && r_ret->get_type() == Variant::OBJECT) {
  125. VariantInternal::update_object_id(r_ret);
  126. }
  127. }
  128. }
  129. virtual void ptrcall(Object *p_object, const void **p_args, void *r_ret) const override {
  130. #ifdef TOOLS_ENABLED
  131. ERR_FAIL_COND_MSG(!valid, vformat("Cannot call invalid GDExtension method bind '%s'. It's probably cached - you may need to restart Godot.", name));
  132. ERR_FAIL_COND_MSG(p_object && p_object->is_extension_placeholder(), vformat("Cannot call GDExtension method bind '%s' on placeholder instance.", name));
  133. #endif
  134. ERR_FAIL_COND_MSG(vararg, "Vararg methods don't have ptrcall support. This is most likely an engine bug.");
  135. GDExtensionClassInstancePtr extension_instance = is_static() ? nullptr : p_object->_get_extension_instance();
  136. ptrcall_func(method_userdata, extension_instance, reinterpret_cast<GDExtensionConstTypePtr *>(p_args), (GDExtensionTypePtr)r_ret);
  137. }
  138. virtual bool is_vararg() const override {
  139. return vararg;
  140. }
  141. #ifdef TOOLS_ENABLED
  142. bool try_update(const GDExtensionClassMethodInfo *p_method_info) {
  143. if (is_static() != (bool)(p_method_info->method_flags & GDEXTENSION_METHOD_FLAG_STATIC)) {
  144. return false;
  145. }
  146. if (vararg != (bool)(p_method_info->method_flags & GDEXTENSION_METHOD_FLAG_VARARG)) {
  147. return false;
  148. }
  149. if (has_return() != (bool)p_method_info->has_return_value) {
  150. return false;
  151. }
  152. if (has_return() && return_value_info.type != (Variant::Type)p_method_info->return_value_info->type) {
  153. return false;
  154. }
  155. if (argument_count != p_method_info->argument_count) {
  156. return false;
  157. }
  158. List<PropertyInfo>::ConstIterator itr = arguments_info.begin();
  159. for (uint32_t i = 0; i < p_method_info->argument_count; ++itr, ++i) {
  160. if (itr->type != (Variant::Type)p_method_info->arguments_info[i].type) {
  161. return false;
  162. }
  163. }
  164. update(p_method_info);
  165. return true;
  166. }
  167. #endif
  168. void update(const GDExtensionClassMethodInfo *p_method_info) {
  169. #ifdef TOOLS_ENABLED
  170. name = *reinterpret_cast<StringName *>(p_method_info->name);
  171. #endif
  172. method_userdata = p_method_info->method_userdata;
  173. call_func = p_method_info->call_func;
  174. validated_call_func = nullptr;
  175. ptrcall_func = p_method_info->ptrcall_func;
  176. set_name(*reinterpret_cast<StringName *>(p_method_info->name));
  177. if (p_method_info->has_return_value) {
  178. return_value_info = PropertyInfo(*p_method_info->return_value_info);
  179. return_value_metadata = GodotTypeInfo::Metadata(p_method_info->return_value_metadata);
  180. }
  181. arguments_info.clear();
  182. arguments_metadata.clear();
  183. for (uint32_t i = 0; i < p_method_info->argument_count; i++) {
  184. arguments_info.push_back(PropertyInfo(p_method_info->arguments_info[i]));
  185. arguments_metadata.push_back(GodotTypeInfo::Metadata(p_method_info->arguments_metadata[i]));
  186. }
  187. set_hint_flags(p_method_info->method_flags);
  188. argument_count = p_method_info->argument_count;
  189. vararg = p_method_info->method_flags & GDEXTENSION_METHOD_FLAG_VARARG;
  190. _set_returns(p_method_info->has_return_value);
  191. _set_const(p_method_info->method_flags & GDEXTENSION_METHOD_FLAG_CONST);
  192. _set_static(p_method_info->method_flags & GDEXTENSION_METHOD_FLAG_STATIC);
  193. #ifdef DEBUG_METHODS_ENABLED
  194. _generate_argument_types(p_method_info->argument_count);
  195. #endif
  196. set_argument_count(p_method_info->argument_count);
  197. Vector<Variant> defargs;
  198. defargs.resize(p_method_info->default_argument_count);
  199. for (uint32_t i = 0; i < p_method_info->default_argument_count; i++) {
  200. defargs.write[i] = *static_cast<Variant *>(p_method_info->default_arguments[i]);
  201. }
  202. set_default_arguments(defargs);
  203. }
  204. explicit GDExtensionMethodBind(const GDExtensionClassMethodInfo *p_method_info) {
  205. update(p_method_info);
  206. }
  207. };
  208. #ifndef DISABLE_DEPRECATED
  209. void GDExtension::_register_extension_class(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo *p_extension_funcs) {
  210. const GDExtensionClassCreationInfo4 class_info4 = {
  211. p_extension_funcs->is_virtual, // GDExtensionBool is_virtual;
  212. p_extension_funcs->is_abstract, // GDExtensionBool is_abstract;
  213. true, // GDExtensionBool is_exposed;
  214. false, // GDExtensionBool is_runtime;
  215. p_extension_funcs->set_func, // GDExtensionClassSet set_func;
  216. p_extension_funcs->get_func, // GDExtensionClassGet get_func;
  217. p_extension_funcs->get_property_list_func, // GDExtensionClassGetPropertyList get_property_list_func;
  218. nullptr, // GDExtensionClassFreePropertyList2 free_property_list_func;
  219. p_extension_funcs->property_can_revert_func, // GDExtensionClassPropertyCanRevert property_can_revert_func;
  220. p_extension_funcs->property_get_revert_func, // GDExtensionClassPropertyGetRevert property_get_revert_func;
  221. nullptr, // GDExtensionClassValidateProperty validate_property_func;
  222. nullptr, // GDExtensionClassNotification2 notification_func;
  223. p_extension_funcs->to_string_func, // GDExtensionClassToString to_string_func;
  224. p_extension_funcs->reference_func, // GDExtensionClassReference reference_func;
  225. p_extension_funcs->unreference_func, // GDExtensionClassUnreference unreference_func;
  226. nullptr, // GDExtensionClassCreateInstance2 create_instance_func; /* this one is mandatory */
  227. p_extension_funcs->free_instance_func, // GDExtensionClassFreeInstance free_instance_func; /* this one is mandatory */
  228. nullptr, // GDExtensionClassRecreateInstance recreate_instance_func;
  229. p_extension_funcs->get_virtual_func, // GDExtensionClassGetVirtual get_virtual_func;
  230. nullptr, // GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
  231. nullptr, // GDExtensionClassCallVirtualWithData call_virtual_func;
  232. p_extension_funcs->class_userdata, // void *class_userdata;
  233. };
  234. const ClassCreationDeprecatedInfo legacy = {
  235. p_extension_funcs->notification_func, // GDExtensionClassNotification notification_func;
  236. p_extension_funcs->free_property_list_func, // GDExtensionClassFreePropertyList free_property_list_func;
  237. p_extension_funcs->create_instance_func, // GDExtensionClassCreateInstance create_instance_func;
  238. p_extension_funcs->get_rid_func, // GDExtensionClassGetRID get_rid;
  239. };
  240. _register_extension_class_internal(p_library, p_class_name, p_parent_class_name, &class_info4, &legacy);
  241. }
  242. void GDExtension::_register_extension_class2(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo2 *p_extension_funcs) {
  243. const GDExtensionClassCreationInfo4 class_info4 = {
  244. p_extension_funcs->is_virtual, // GDExtensionBool is_virtual;
  245. p_extension_funcs->is_abstract, // GDExtensionBool is_abstract;
  246. p_extension_funcs->is_exposed, // GDExtensionBool is_exposed;
  247. false, // GDExtensionBool is_runtime;
  248. p_extension_funcs->set_func, // GDExtensionClassSet set_func;
  249. p_extension_funcs->get_func, // GDExtensionClassGet get_func;
  250. p_extension_funcs->get_property_list_func, // GDExtensionClassGetPropertyList get_property_list_func;
  251. nullptr, // GDExtensionClassFreePropertyList2 free_property_list_func;
  252. p_extension_funcs->property_can_revert_func, // GDExtensionClassPropertyCanRevert property_can_revert_func;
  253. p_extension_funcs->property_get_revert_func, // GDExtensionClassPropertyGetRevert property_get_revert_func;
  254. p_extension_funcs->validate_property_func, // GDExtensionClassValidateProperty validate_property_func;
  255. p_extension_funcs->notification_func, // GDExtensionClassNotification2 notification_func;
  256. p_extension_funcs->to_string_func, // GDExtensionClassToString to_string_func;
  257. p_extension_funcs->reference_func, // GDExtensionClassReference reference_func;
  258. p_extension_funcs->unreference_func, // GDExtensionClassUnreference unreference_func;
  259. nullptr, // GDExtensionClassCreateInstance2 create_instance_func; /* this one is mandatory */
  260. p_extension_funcs->free_instance_func, // GDExtensionClassFreeInstance free_instance_func; /* this one is mandatory */
  261. p_extension_funcs->recreate_instance_func, // GDExtensionClassRecreateInstance recreate_instance_func;
  262. p_extension_funcs->get_virtual_func, // GDExtensionClassGetVirtual get_virtual_func;
  263. p_extension_funcs->get_virtual_call_data_func, // GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
  264. p_extension_funcs->call_virtual_with_data_func, // GDExtensionClassCallVirtualWithData call_virtual_func;
  265. p_extension_funcs->class_userdata, // void *class_userdata;
  266. };
  267. const ClassCreationDeprecatedInfo legacy = {
  268. nullptr, // GDExtensionClassNotification notification_func;
  269. p_extension_funcs->free_property_list_func, // GDExtensionClassFreePropertyList free_property_list_func;
  270. p_extension_funcs->create_instance_func, // GDExtensionClassCreateInstance create_instance_func;
  271. p_extension_funcs->get_rid_func, // GDExtensionClassGetRID get_rid;
  272. };
  273. _register_extension_class_internal(p_library, p_class_name, p_parent_class_name, &class_info4, &legacy);
  274. }
  275. void GDExtension::_register_extension_class3(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo3 *p_extension_funcs) {
  276. const GDExtensionClassCreationInfo4 class_info4 = {
  277. p_extension_funcs->is_virtual, // GDExtensionBool is_virtual;
  278. p_extension_funcs->is_abstract, // GDExtensionBool is_abstract;
  279. p_extension_funcs->is_exposed, // GDExtensionBool is_exposed;
  280. p_extension_funcs->is_runtime, // GDExtensionBool is_runtime;
  281. p_extension_funcs->set_func, // GDExtensionClassSet set_func;
  282. p_extension_funcs->get_func, // GDExtensionClassGet get_func;
  283. p_extension_funcs->get_property_list_func, // GDExtensionClassGetPropertyList get_property_list_func;
  284. p_extension_funcs->free_property_list_func, // GDExtensionClassFreePropertyList free_property_list_func;
  285. p_extension_funcs->property_can_revert_func, // GDExtensionClassPropertyCanRevert property_can_revert_func;
  286. p_extension_funcs->property_get_revert_func, // GDExtensionClassPropertyGetRevert property_get_revert_func;
  287. p_extension_funcs->validate_property_func, // GDExtensionClassValidateProperty validate_property_func;
  288. p_extension_funcs->notification_func, // GDExtensionClassNotification2 notification_func;
  289. p_extension_funcs->to_string_func, // GDExtensionClassToString to_string_func;
  290. p_extension_funcs->reference_func, // GDExtensionClassReference reference_func;
  291. p_extension_funcs->unreference_func, // GDExtensionClassUnreference unreference_func;
  292. nullptr, // GDExtensionClassCreateInstance2 create_instance_func; /* this one is mandatory */
  293. p_extension_funcs->free_instance_func, // GDExtensionClassFreeInstance free_instance_func; /* this one is mandatory */
  294. p_extension_funcs->recreate_instance_func, // GDExtensionClassRecreateInstance recreate_instance_func;
  295. p_extension_funcs->get_virtual_func, // GDExtensionClassGetVirtual get_virtual_func;
  296. p_extension_funcs->get_virtual_call_data_func, // GDExtensionClassGetVirtualCallData get_virtual_call_data_func;
  297. p_extension_funcs->call_virtual_with_data_func, // GDExtensionClassCallVirtualWithData call_virtual_func;
  298. p_extension_funcs->class_userdata, // void *class_userdata;
  299. };
  300. const ClassCreationDeprecatedInfo legacy = {
  301. nullptr, // GDExtensionClassNotification notification_func;
  302. nullptr, // GDExtensionClassFreePropertyList free_property_list_func;
  303. p_extension_funcs->create_instance_func, // GDExtensionClassCreateInstance2 create_instance_func;
  304. p_extension_funcs->get_rid_func, // GDExtensionClassGetRID get_rid;
  305. };
  306. _register_extension_class_internal(p_library, p_class_name, p_parent_class_name, &class_info4, &legacy);
  307. }
  308. #endif // DISABLE_DEPRECATED
  309. void GDExtension::_register_extension_class4(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo4 *p_extension_funcs) {
  310. _register_extension_class_internal(p_library, p_class_name, p_parent_class_name, p_extension_funcs);
  311. }
  312. void GDExtension::_register_extension_class_internal(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_parent_class_name, const GDExtensionClassCreationInfo4 *p_extension_funcs, const ClassCreationDeprecatedInfo *p_deprecated_funcs) {
  313. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  314. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  315. StringName parent_class_name = *reinterpret_cast<const StringName *>(p_parent_class_name);
  316. ERR_FAIL_COND_MSG(!String(class_name).is_valid_unicode_identifier(), vformat("Attempt to register extension class '%s', which is not a valid class identifier.", class_name));
  317. ERR_FAIL_COND_MSG(ClassDB::class_exists(class_name), vformat("Attempt to register extension class '%s', which appears to be already registered.", class_name));
  318. Extension *parent_extension = nullptr;
  319. if (self->extension_classes.has(parent_class_name)) {
  320. parent_extension = &self->extension_classes[parent_class_name];
  321. } else if (ClassDB::class_exists(parent_class_name)) {
  322. if (ClassDB::get_api_type(parent_class_name) == ClassDB::API_EXTENSION || ClassDB::get_api_type(parent_class_name) == ClassDB::API_EDITOR_EXTENSION) {
  323. ERR_PRINT("Unimplemented yet");
  324. //inheriting from another extension
  325. } else {
  326. //inheriting from engine class
  327. }
  328. } else {
  329. ERR_FAIL_MSG(vformat("Attempt to register an extension class '%s' using non-existing parent class '%s'.", String(class_name), String(parent_class_name)));
  330. }
  331. #ifdef TOOLS_ENABLED
  332. Extension *extension = nullptr;
  333. bool is_runtime = (bool)p_extension_funcs->is_runtime;
  334. if (self->is_reloading && self->extension_classes.has(class_name)) {
  335. extension = &self->extension_classes[class_name];
  336. if (!parent_extension && parent_class_name != extension->gdextension.parent_class_name) {
  337. ERR_FAIL_MSG(vformat("GDExtension class '%s' cannot change parent type from '%s' to '%s' on hot reload. Restart Godot for this change to take effect.", class_name, extension->gdextension.parent_class_name, parent_class_name));
  338. }
  339. if (extension->gdextension.is_runtime != is_runtime) {
  340. ERR_PRINT(vformat("GDExtension class '%s' cannot change to/from runtime class on hot reload. Restart Godot for this change to take effect.", class_name));
  341. is_runtime = extension->gdextension.is_runtime;
  342. }
  343. extension->is_reloading = false;
  344. } else {
  345. self->extension_classes[class_name] = Extension();
  346. extension = &self->extension_classes[class_name];
  347. }
  348. #else
  349. self->extension_classes[class_name] = Extension();
  350. Extension *extension = &self->extension_classes[class_name];
  351. #endif
  352. if (parent_extension) {
  353. extension->gdextension.parent = &parent_extension->gdextension;
  354. parent_extension->gdextension.children.push_back(&extension->gdextension);
  355. }
  356. if (self->reloadable && p_extension_funcs->recreate_instance_func == nullptr) {
  357. ERR_PRINT(vformat("Extension marked as reloadable, but attempted to register class '%s' which doesn't support reloading. Perhaps your language binding don't support it? Reloading disabled for this extension.", class_name));
  358. self->reloadable = false;
  359. }
  360. extension->gdextension.library = self;
  361. extension->gdextension.parent_class_name = parent_class_name;
  362. extension->gdextension.class_name = class_name;
  363. extension->gdextension.editor_class = self->level_initialized == INITIALIZATION_LEVEL_EDITOR;
  364. extension->gdextension.is_virtual = p_extension_funcs->is_virtual;
  365. extension->gdextension.is_abstract = p_extension_funcs->is_abstract;
  366. extension->gdextension.is_exposed = p_extension_funcs->is_exposed;
  367. #ifdef TOOLS_ENABLED
  368. extension->gdextension.is_runtime = is_runtime;
  369. #endif
  370. extension->gdextension.set = p_extension_funcs->set_func;
  371. extension->gdextension.get = p_extension_funcs->get_func;
  372. extension->gdextension.get_property_list = p_extension_funcs->get_property_list_func;
  373. extension->gdextension.free_property_list2 = p_extension_funcs->free_property_list_func;
  374. extension->gdextension.property_can_revert = p_extension_funcs->property_can_revert_func;
  375. extension->gdextension.property_get_revert = p_extension_funcs->property_get_revert_func;
  376. extension->gdextension.validate_property = p_extension_funcs->validate_property_func;
  377. #ifndef DISABLE_DEPRECATED
  378. if (p_deprecated_funcs) {
  379. extension->gdextension.notification = p_deprecated_funcs->notification_func;
  380. extension->gdextension.free_property_list = p_deprecated_funcs->free_property_list_func;
  381. extension->gdextension.create_instance = p_deprecated_funcs->create_instance_func;
  382. extension->gdextension.get_rid = p_deprecated_funcs->get_rid_func;
  383. }
  384. #endif // DISABLE_DEPRECATED
  385. extension->gdextension.notification2 = p_extension_funcs->notification_func;
  386. extension->gdextension.to_string = p_extension_funcs->to_string_func;
  387. extension->gdextension.reference = p_extension_funcs->reference_func;
  388. extension->gdextension.unreference = p_extension_funcs->unreference_func;
  389. extension->gdextension.class_userdata = p_extension_funcs->class_userdata;
  390. extension->gdextension.create_instance2 = p_extension_funcs->create_instance_func;
  391. extension->gdextension.free_instance = p_extension_funcs->free_instance_func;
  392. extension->gdextension.recreate_instance = p_extension_funcs->recreate_instance_func;
  393. extension->gdextension.get_virtual = p_extension_funcs->get_virtual_func;
  394. extension->gdextension.get_virtual_call_data = p_extension_funcs->get_virtual_call_data_func;
  395. extension->gdextension.call_virtual_with_data = p_extension_funcs->call_virtual_with_data_func;
  396. extension->gdextension.reloadable = self->reloadable;
  397. #ifdef TOOLS_ENABLED
  398. if (extension->gdextension.reloadable) {
  399. extension->gdextension.tracking_userdata = extension;
  400. extension->gdextension.track_instance = &GDExtension::_track_instance;
  401. extension->gdextension.untrack_instance = &GDExtension::_untrack_instance;
  402. } else {
  403. extension->gdextension.tracking_userdata = nullptr;
  404. extension->gdextension.track_instance = nullptr;
  405. extension->gdextension.untrack_instance = nullptr;
  406. }
  407. #endif
  408. ClassDB::register_extension_class(&extension->gdextension);
  409. }
  410. void GDExtension::_register_extension_class_method(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionClassMethodInfo *p_method_info) {
  411. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  412. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  413. StringName method_name = *reinterpret_cast<const StringName *>(p_method_info->name);
  414. ERR_FAIL_COND_MSG(!self->extension_classes.has(class_name), vformat("Attempt to register extension method '%s' for unexisting class '%s'.", String(method_name), class_name));
  415. #ifdef TOOLS_ENABLED
  416. Extension *extension = &self->extension_classes[class_name];
  417. GDExtensionMethodBind *method = nullptr;
  418. // If the extension is still marked as reloading, that means it failed to register again.
  419. if (extension->is_reloading) {
  420. return;
  421. }
  422. if (self->is_reloading && extension->methods.has(method_name)) {
  423. method = extension->methods[method_name];
  424. // Try to update the method bind. If it doesn't work (because it's incompatible) then
  425. // mark as invalid and create a new one.
  426. if (!method->is_reloading || !method->try_update(p_method_info)) {
  427. method->valid = false;
  428. self->invalid_methods.push_back(method);
  429. method = nullptr;
  430. }
  431. }
  432. if (method == nullptr) {
  433. method = memnew(GDExtensionMethodBind(p_method_info));
  434. method->set_instance_class(class_name);
  435. extension->methods[method_name] = method;
  436. } else {
  437. method->is_reloading = false;
  438. }
  439. #else
  440. GDExtensionMethodBind *method = memnew(GDExtensionMethodBind(p_method_info));
  441. method->set_instance_class(class_name);
  442. #endif
  443. ClassDB::bind_method_custom(class_name, method);
  444. }
  445. void GDExtension::_register_extension_class_virtual_method(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionClassVirtualMethodInfo *p_method_info) {
  446. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  447. ClassDB::add_extension_class_virtual_method(class_name, p_method_info);
  448. }
  449. void GDExtension::_register_extension_class_integer_constant(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_enum_name, GDExtensionConstStringNamePtr p_constant_name, GDExtensionInt p_constant_value, GDExtensionBool p_is_bitfield) {
  450. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  451. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  452. StringName enum_name = *reinterpret_cast<const StringName *>(p_enum_name);
  453. StringName constant_name = *reinterpret_cast<const StringName *>(p_constant_name);
  454. ERR_FAIL_COND_MSG(!self->extension_classes.has(class_name), vformat("Attempt to register extension constant '%s' for unexisting class '%s'.", constant_name, class_name));
  455. #ifdef TOOLS_ENABLED
  456. // If the extension is still marked as reloading, that means it failed to register again.
  457. Extension *extension = &self->extension_classes[class_name];
  458. if (extension->is_reloading) {
  459. return;
  460. }
  461. #endif
  462. ClassDB::bind_integer_constant(class_name, enum_name, constant_name, p_constant_value, p_is_bitfield);
  463. }
  464. void GDExtension::_register_extension_class_property(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionPropertyInfo *p_info, GDExtensionConstStringNamePtr p_setter, GDExtensionConstStringNamePtr p_getter) {
  465. _register_extension_class_property_indexed(p_library, p_class_name, p_info, p_setter, p_getter, -1);
  466. }
  467. void GDExtension::_register_extension_class_property_indexed(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, const GDExtensionPropertyInfo *p_info, GDExtensionConstStringNamePtr p_setter, GDExtensionConstStringNamePtr p_getter, GDExtensionInt p_index) {
  468. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  469. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  470. StringName setter = *reinterpret_cast<const StringName *>(p_setter);
  471. StringName getter = *reinterpret_cast<const StringName *>(p_getter);
  472. String property_name = *reinterpret_cast<const StringName *>(p_info->name);
  473. ERR_FAIL_COND_MSG(!self->extension_classes.has(class_name), vformat("Attempt to register extension class property '%s' for unexisting class '%s'.", property_name, class_name));
  474. #ifdef TOOLS_ENABLED
  475. // If the extension is still marked as reloading, that means it failed to register again.
  476. Extension *extension = &self->extension_classes[class_name];
  477. if (extension->is_reloading) {
  478. return;
  479. }
  480. #endif
  481. PropertyInfo pinfo(*p_info);
  482. ClassDB::add_property(class_name, pinfo, setter, getter, p_index);
  483. }
  484. void GDExtension::_register_extension_class_property_group(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringPtr p_group_name, GDExtensionConstStringPtr p_prefix) {
  485. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  486. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  487. String group_name = *reinterpret_cast<const String *>(p_group_name);
  488. String prefix = *reinterpret_cast<const String *>(p_prefix);
  489. ERR_FAIL_COND_MSG(!self->extension_classes.has(class_name), vformat("Attempt to register extension class property group '%s' for unexisting class '%s'.", group_name, class_name));
  490. #ifdef TOOLS_ENABLED
  491. // If the extension is still marked as reloading, that means it failed to register again.
  492. Extension *extension = &self->extension_classes[class_name];
  493. if (extension->is_reloading) {
  494. return;
  495. }
  496. #endif
  497. ClassDB::add_property_group(class_name, group_name, prefix);
  498. }
  499. void GDExtension::_register_extension_class_property_subgroup(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringPtr p_subgroup_name, GDExtensionConstStringPtr p_prefix) {
  500. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  501. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  502. String subgroup_name = *reinterpret_cast<const String *>(p_subgroup_name);
  503. String prefix = *reinterpret_cast<const String *>(p_prefix);
  504. ERR_FAIL_COND_MSG(!self->extension_classes.has(class_name), vformat("Attempt to register extension class property subgroup '%s' for unexisting class '%s'.", subgroup_name, class_name));
  505. #ifdef TOOLS_ENABLED
  506. // If the extension is still marked as reloading, that means it failed to register again.
  507. Extension *extension = &self->extension_classes[class_name];
  508. if (extension->is_reloading) {
  509. return;
  510. }
  511. #endif
  512. ClassDB::add_property_subgroup(class_name, subgroup_name, prefix);
  513. }
  514. void GDExtension::_register_extension_class_signal(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name, GDExtensionConstStringNamePtr p_signal_name, const GDExtensionPropertyInfo *p_argument_info, GDExtensionInt p_argument_count) {
  515. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  516. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  517. StringName signal_name = *reinterpret_cast<const StringName *>(p_signal_name);
  518. ERR_FAIL_COND_MSG(!self->extension_classes.has(class_name), vformat("Attempt to register extension class signal '%s' for unexisting class '%s'.", signal_name, class_name));
  519. #ifdef TOOLS_ENABLED
  520. // If the extension is still marked as reloading, that means it failed to register again.
  521. Extension *extension = &self->extension_classes[class_name];
  522. if (extension->is_reloading) {
  523. return;
  524. }
  525. #endif
  526. MethodInfo s;
  527. s.name = signal_name;
  528. for (int i = 0; i < p_argument_count; i++) {
  529. PropertyInfo arg(p_argument_info[i]);
  530. s.arguments.push_back(arg);
  531. }
  532. ClassDB::add_signal(class_name, s);
  533. }
  534. void GDExtension::_unregister_extension_class(GDExtensionClassLibraryPtr p_library, GDExtensionConstStringNamePtr p_class_name) {
  535. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  536. StringName class_name = *reinterpret_cast<const StringName *>(p_class_name);
  537. ERR_FAIL_COND_MSG(!self->extension_classes.has(class_name), vformat("Attempt to unregister unexisting extension class '%s'.", class_name));
  538. Extension *ext = &self->extension_classes[class_name];
  539. #ifdef TOOLS_ENABLED
  540. if (ext->is_reloading) {
  541. self->_clear_extension(ext);
  542. }
  543. #endif
  544. ERR_FAIL_COND_MSG(ext->gdextension.children.size(), vformat("Attempt to unregister class '%s' while other extension classes inherit from it.", class_name));
  545. #ifdef TOOLS_ENABLED
  546. ClassDB::unregister_extension_class(class_name, !ext->is_reloading);
  547. #else
  548. ClassDB::unregister_extension_class(class_name);
  549. #endif
  550. if (ext->gdextension.parent != nullptr) {
  551. ext->gdextension.parent->children.erase(&ext->gdextension);
  552. }
  553. #ifdef TOOLS_ENABLED
  554. if (!ext->is_reloading) {
  555. self->extension_classes.erase(class_name);
  556. }
  557. GDExtensionEditorHelp::remove_class(class_name);
  558. #else
  559. self->extension_classes.erase(class_name);
  560. #endif
  561. }
  562. void GDExtension::_get_library_path(GDExtensionClassLibraryPtr p_library, GDExtensionUninitializedStringPtr r_path) {
  563. GDExtension *self = reinterpret_cast<GDExtension *>(p_library);
  564. Ref<GDExtensionLibraryLoader> library_loader = self->loader;
  565. String library_path;
  566. if (library_loader.is_valid()) {
  567. library_path = library_loader->library_path;
  568. }
  569. memnew_placement(r_path, String(library_path));
  570. }
  571. HashMap<StringName, GDExtensionInterfaceFunctionPtr> GDExtension::gdextension_interface_functions;
  572. void GDExtension::register_interface_function(const StringName &p_function_name, GDExtensionInterfaceFunctionPtr p_function_pointer) {
  573. ERR_FAIL_COND_MSG(gdextension_interface_functions.has(p_function_name), vformat("Attempt to register interface function '%s', which appears to be already registered.", p_function_name));
  574. gdextension_interface_functions.insert(p_function_name, p_function_pointer);
  575. }
  576. GDExtensionInterfaceFunctionPtr GDExtension::get_interface_function(const StringName &p_function_name) {
  577. GDExtensionInterfaceFunctionPtr *function = gdextension_interface_functions.getptr(p_function_name);
  578. ERR_FAIL_NULL_V_MSG(function, nullptr, vformat("Attempt to get non-existent interface function: '%s'.", String(p_function_name)));
  579. return *function;
  580. }
  581. Error GDExtension::open_library(const String &p_path, const Ref<GDExtensionLoader> &p_loader) {
  582. ERR_FAIL_COND_V_MSG(p_loader.is_null(), FAILED, "Can't open GDExtension without a loader.");
  583. loader = p_loader;
  584. Error err = loader->open_library(p_path);
  585. ERR_FAIL_COND_V_MSG(err == ERR_FILE_NOT_FOUND, err, vformat("GDExtension dynamic library not found: '%s'.", p_path));
  586. ERR_FAIL_COND_V_MSG(err != OK, err, vformat("Can't open GDExtension dynamic library: '%s'.", p_path));
  587. err = loader->initialize(&gdextension_get_proc_address, this, &initialization);
  588. if (err != OK) {
  589. // Errors already logged in initialize().
  590. loader->close_library();
  591. return err;
  592. }
  593. level_initialized = -1;
  594. return OK;
  595. }
  596. void GDExtension::close_library() {
  597. ERR_FAIL_COND(!is_library_open());
  598. loader->close_library();
  599. class_icon_paths.clear();
  600. #ifdef TOOLS_ENABLED
  601. instance_bindings.clear();
  602. #endif
  603. }
  604. bool GDExtension::is_library_open() const {
  605. return loader.is_valid() && loader->is_library_open();
  606. }
  607. GDExtension::InitializationLevel GDExtension::get_minimum_library_initialization_level() const {
  608. ERR_FAIL_COND_V(!is_library_open(), INITIALIZATION_LEVEL_CORE);
  609. return InitializationLevel(initialization.minimum_initialization_level);
  610. }
  611. void GDExtension::initialize_library(InitializationLevel p_level) {
  612. ERR_FAIL_COND(!is_library_open());
  613. ERR_FAIL_COND_MSG(p_level <= int32_t(level_initialized), vformat("Level '%d' must be higher than the current level '%d'", p_level, level_initialized));
  614. level_initialized = int32_t(p_level);
  615. ERR_FAIL_NULL(initialization.initialize);
  616. initialization.initialize(initialization.userdata, GDExtensionInitializationLevel(p_level));
  617. }
  618. void GDExtension::deinitialize_library(InitializationLevel p_level) {
  619. ERR_FAIL_COND(!is_library_open());
  620. ERR_FAIL_COND(p_level > int32_t(level_initialized));
  621. level_initialized = int32_t(p_level) - 1;
  622. ERR_FAIL_NULL(initialization.deinitialize);
  623. initialization.deinitialize(initialization.userdata, GDExtensionInitializationLevel(p_level));
  624. }
  625. void GDExtension::_bind_methods() {
  626. ClassDB::bind_method(D_METHOD("is_library_open"), &GDExtension::is_library_open);
  627. ClassDB::bind_method(D_METHOD("get_minimum_library_initialization_level"), &GDExtension::get_minimum_library_initialization_level);
  628. BIND_ENUM_CONSTANT(INITIALIZATION_LEVEL_CORE);
  629. BIND_ENUM_CONSTANT(INITIALIZATION_LEVEL_SERVERS);
  630. BIND_ENUM_CONSTANT(INITIALIZATION_LEVEL_SCENE);
  631. BIND_ENUM_CONSTANT(INITIALIZATION_LEVEL_EDITOR);
  632. }
  633. GDExtension::GDExtension() {
  634. }
  635. GDExtension::~GDExtension() {
  636. if (is_library_open()) {
  637. close_library();
  638. }
  639. #ifdef TOOLS_ENABLED
  640. // If we have any invalid method binds still laying around, we can finally free them!
  641. for (GDExtensionMethodBind *E : invalid_methods) {
  642. memdelete(E);
  643. }
  644. #endif
  645. }
  646. void GDExtension::initialize_gdextensions() {
  647. gdextension_setup_interface();
  648. #ifndef DISABLE_DEPRECATED
  649. register_interface_function("classdb_register_extension_class", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class);
  650. register_interface_function("classdb_register_extension_class2", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class2);
  651. register_interface_function("classdb_register_extension_class3", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class3);
  652. #endif // DISABLE_DEPRECATED
  653. register_interface_function("classdb_register_extension_class4", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class4);
  654. register_interface_function("classdb_register_extension_class_method", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_method);
  655. register_interface_function("classdb_register_extension_class_virtual_method", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_virtual_method);
  656. register_interface_function("classdb_register_extension_class_integer_constant", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_integer_constant);
  657. register_interface_function("classdb_register_extension_class_property", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_property);
  658. register_interface_function("classdb_register_extension_class_property_indexed", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_property_indexed);
  659. register_interface_function("classdb_register_extension_class_property_group", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_property_group);
  660. register_interface_function("classdb_register_extension_class_property_subgroup", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_property_subgroup);
  661. register_interface_function("classdb_register_extension_class_signal", (GDExtensionInterfaceFunctionPtr)&GDExtension::_register_extension_class_signal);
  662. register_interface_function("classdb_unregister_extension_class", (GDExtensionInterfaceFunctionPtr)&GDExtension::_unregister_extension_class);
  663. register_interface_function("get_library_path", (GDExtensionInterfaceFunctionPtr)&GDExtension::_get_library_path);
  664. }
  665. void GDExtension::finalize_gdextensions() {
  666. gdextension_interface_functions.clear();
  667. }
  668. Error GDExtensionResourceLoader::load_gdextension_resource(const String &p_path, Ref<GDExtension> &p_extension) {
  669. ERR_FAIL_COND_V_MSG(p_extension.is_valid() && p_extension->is_library_open(), ERR_ALREADY_IN_USE, "Cannot load GDExtension resource into already opened library.");
  670. GDExtensionManager *extension_manager = GDExtensionManager::get_singleton();
  671. GDExtensionManager::LoadStatus status = extension_manager->load_extension(p_path);
  672. if (status != GDExtensionManager::LOAD_STATUS_OK && status != GDExtensionManager::LOAD_STATUS_ALREADY_LOADED) {
  673. // Errors already logged in load_extension().
  674. return FAILED;
  675. }
  676. p_extension = extension_manager->get_extension(p_path);
  677. return OK;
  678. }
  679. Ref<Resource> GDExtensionResourceLoader::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {
  680. // We can't have two GDExtension resource object representing the same library, because
  681. // loading (or unloading) a GDExtension affects global data. So, we need reuse the same
  682. // object if one has already been loaded (even if caching is disabled at the resource
  683. // loader level).
  684. GDExtensionManager *manager = GDExtensionManager::get_singleton();
  685. if (manager->is_extension_loaded(p_path)) {
  686. return manager->get_extension(p_path);
  687. }
  688. Ref<GDExtension> lib;
  689. Error err = load_gdextension_resource(p_path, lib);
  690. if (err != OK && r_error) {
  691. // Errors already logged in load_gdextension_resource().
  692. *r_error = err;
  693. }
  694. return lib;
  695. }
  696. void GDExtensionResourceLoader::get_recognized_extensions(List<String> *p_extensions) const {
  697. p_extensions->push_back("gdextension");
  698. }
  699. bool GDExtensionResourceLoader::handles_type(const String &p_type) const {
  700. return p_type == "GDExtension";
  701. }
  702. String GDExtensionResourceLoader::get_resource_type(const String &p_path) const {
  703. String el = p_path.get_extension().to_lower();
  704. if (el == "gdextension") {
  705. return "GDExtension";
  706. }
  707. return "";
  708. }
  709. #ifdef TOOLS_ENABLED
  710. bool GDExtension::has_library_changed() const {
  711. return loader->has_library_changed();
  712. }
  713. void GDExtension::prepare_reload() {
  714. is_reloading = true;
  715. for (KeyValue<StringName, Extension> &E : extension_classes) {
  716. E.value.is_reloading = true;
  717. for (KeyValue<StringName, GDExtensionMethodBind *> &M : E.value.methods) {
  718. M.value->is_reloading = true;
  719. }
  720. for (const ObjectID &obj_id : E.value.instances) {
  721. Object *obj = ObjectDB::get_instance(obj_id);
  722. if (!obj) {
  723. continue;
  724. }
  725. // Store instance state so it can be restored after reload.
  726. List<Pair<String, Variant>> state;
  727. List<PropertyInfo> prop_list;
  728. obj->get_property_list(&prop_list);
  729. for (const PropertyInfo &P : prop_list) {
  730. if (!(P.usage & PROPERTY_USAGE_STORAGE)) {
  731. continue;
  732. }
  733. Variant value = obj->get(P.name);
  734. Variant default_value = ClassDB::class_get_default_property_value(obj->get_class_name(), P.name);
  735. if (default_value.get_type() != Variant::NIL && bool(Variant::evaluate(Variant::OP_EQUAL, value, default_value))) {
  736. continue;
  737. }
  738. if (P.type == Variant::OBJECT && value.is_zero() && !(P.usage & PROPERTY_USAGE_STORE_IF_NULL)) {
  739. continue;
  740. }
  741. state.push_back(Pair<String, Variant>(P.name, value));
  742. }
  743. E.value.instance_state[obj_id] = {
  744. state, // List<Pair<String, Variant>> properties;
  745. obj->is_extension_placeholder(), // bool is_placeholder;
  746. };
  747. }
  748. }
  749. }
  750. void GDExtension::_clear_extension(Extension *p_extension) {
  751. // Clear out hierarchy information because it may change.
  752. p_extension->gdextension.parent = nullptr;
  753. p_extension->gdextension.children.clear();
  754. // Clear all objects of any GDExtension data. It will become its native parent class
  755. // until the reload can reset the object with the new GDExtension data.
  756. for (const ObjectID &obj_id : p_extension->instances) {
  757. Object *obj = ObjectDB::get_instance(obj_id);
  758. if (!obj) {
  759. continue;
  760. }
  761. obj->clear_internal_extension();
  762. }
  763. }
  764. void GDExtension::track_instance_binding(Object *p_object) {
  765. instance_bindings.push_back(p_object->get_instance_id());
  766. }
  767. void GDExtension::untrack_instance_binding(Object *p_object) {
  768. instance_bindings.erase(p_object->get_instance_id());
  769. }
  770. void GDExtension::clear_instance_bindings() {
  771. for (ObjectID obj_id : instance_bindings) {
  772. Object *obj = ObjectDB::get_instance(obj_id);
  773. if (!obj) {
  774. continue;
  775. }
  776. obj->free_instance_binding(this);
  777. }
  778. instance_bindings.clear();
  779. }
  780. void GDExtension::finish_reload() {
  781. is_reloading = false;
  782. // Clean up any classes or methods that didn't get re-added.
  783. Vector<StringName> classes_to_remove;
  784. for (KeyValue<StringName, Extension> &E : extension_classes) {
  785. if (E.value.is_reloading) {
  786. E.value.is_reloading = false;
  787. classes_to_remove.push_back(E.key);
  788. }
  789. Vector<StringName> methods_to_remove;
  790. for (KeyValue<StringName, GDExtensionMethodBind *> &M : E.value.methods) {
  791. if (M.value->is_reloading) {
  792. M.value->valid = false;
  793. invalid_methods.push_back(M.value);
  794. M.value->is_reloading = false;
  795. methods_to_remove.push_back(M.key);
  796. }
  797. }
  798. for (const StringName &method_name : methods_to_remove) {
  799. E.value.methods.erase(method_name);
  800. }
  801. }
  802. for (const StringName &class_name : classes_to_remove) {
  803. extension_classes.erase(class_name);
  804. }
  805. // Reset any the extension on instances made from the classes that remain.
  806. for (KeyValue<StringName, Extension> &E : extension_classes) {
  807. // Loop over 'instance_state' rather than 'instance' because new instances
  808. // may have been created when re-initializing the extension.
  809. for (const KeyValue<ObjectID, Extension::InstanceState> &S : E.value.instance_state) {
  810. Object *obj = ObjectDB::get_instance(S.key);
  811. if (!obj) {
  812. continue;
  813. }
  814. if (S.value.is_placeholder) {
  815. obj->reset_internal_extension(ClassDB::get_placeholder_extension(E.value.gdextension.class_name));
  816. } else {
  817. obj->reset_internal_extension(&E.value.gdextension);
  818. }
  819. }
  820. }
  821. // Now that all the classes are back, restore the state.
  822. for (KeyValue<StringName, Extension> &E : extension_classes) {
  823. for (const KeyValue<ObjectID, Extension::InstanceState> &S : E.value.instance_state) {
  824. Object *obj = ObjectDB::get_instance(S.key);
  825. if (!obj) {
  826. continue;
  827. }
  828. for (const Pair<String, Variant> &state : S.value.properties) {
  829. obj->set(state.first, state.second);
  830. }
  831. }
  832. }
  833. // Finally, let the objects know that we are done reloading them.
  834. for (KeyValue<StringName, Extension> &E : extension_classes) {
  835. for (const KeyValue<ObjectID, Extension::InstanceState> &S : E.value.instance_state) {
  836. Object *obj = ObjectDB::get_instance(S.key);
  837. if (!obj) {
  838. continue;
  839. }
  840. obj->notification(NOTIFICATION_EXTENSION_RELOADED);
  841. }
  842. // Clear the instance state, we're done looping.
  843. E.value.instance_state.clear();
  844. }
  845. }
  846. void GDExtension::_track_instance(void *p_user_data, void *p_instance) {
  847. Extension *extension = reinterpret_cast<Extension *>(p_user_data);
  848. Object *obj = reinterpret_cast<Object *>(p_instance);
  849. extension->instances.insert(obj->get_instance_id());
  850. }
  851. void GDExtension::_untrack_instance(void *p_user_data, void *p_instance) {
  852. Extension *extension = reinterpret_cast<Extension *>(p_user_data);
  853. Object *obj = reinterpret_cast<Object *>(p_instance);
  854. extension->instances.erase(obj->get_instance_id());
  855. }
  856. Vector<StringName> GDExtensionEditorPlugins::extension_classes;
  857. GDExtensionEditorPlugins::EditorPluginRegisterFunc GDExtensionEditorPlugins::editor_node_add_plugin = nullptr;
  858. GDExtensionEditorPlugins::EditorPluginRegisterFunc GDExtensionEditorPlugins::editor_node_remove_plugin = nullptr;
  859. void GDExtensionEditorPlugins::add_extension_class(const StringName &p_class_name) {
  860. if (editor_node_add_plugin) {
  861. editor_node_add_plugin(p_class_name);
  862. } else {
  863. extension_classes.push_back(p_class_name);
  864. }
  865. }
  866. void GDExtensionEditorPlugins::remove_extension_class(const StringName &p_class_name) {
  867. if (editor_node_remove_plugin) {
  868. editor_node_remove_plugin(p_class_name);
  869. } else {
  870. extension_classes.erase(p_class_name);
  871. }
  872. }
  873. GDExtensionEditorHelp::EditorHelpLoadXmlBufferFunc GDExtensionEditorHelp::editor_help_load_xml_buffer = nullptr;
  874. GDExtensionEditorHelp::EditorHelpRemoveClassFunc GDExtensionEditorHelp::editor_help_remove_class = nullptr;
  875. void GDExtensionEditorHelp::load_xml_buffer(const uint8_t *p_buffer, int p_size) {
  876. ERR_FAIL_NULL(editor_help_load_xml_buffer);
  877. editor_help_load_xml_buffer(p_buffer, p_size);
  878. }
  879. void GDExtensionEditorHelp::remove_class(const String &p_class) {
  880. ERR_FAIL_NULL(editor_help_remove_class);
  881. editor_help_remove_class(p_class);
  882. }
  883. #endif // TOOLS_ENABLED