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