Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/tests/core/object/test_object.cpp
46006 views
1
/**************************************************************************/
2
/* test_object.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 "tests/test_macros.h"
32
33
TEST_FORCE_LINK(test_object)
34
35
#include "core/object/callable_mp.h"
36
#include "core/object/class_db.h"
37
#include "core/object/object.h"
38
#include "core/object/script_language.h"
39
#include "tests/signal_watcher.h"
40
41
namespace TestObject {
42
43
class _TestDerivedObject : public Object {
44
GDCLASS(_TestDerivedObject, Object);
45
46
int property_value;
47
48
protected:
49
static void _bind_methods() {
50
ClassDB::bind_method(D_METHOD("set_property", "property"), &_TestDerivedObject::set_property);
51
ClassDB::bind_method(D_METHOD("get_property"), &_TestDerivedObject::get_property);
52
ADD_PROPERTY(PropertyInfo(Variant::INT, "property"), "set_property", "get_property");
53
}
54
55
public:
56
void set_property(int value) { property_value = value; }
57
int get_property() const { return property_value; }
58
};
59
60
class _MockScriptInstance : public ScriptInstance {
61
StringName property_name = "NO_NAME";
62
Variant property_value;
63
64
public:
65
bool set(const StringName &p_name, const Variant &p_value) override {
66
property_name = p_name;
67
property_value = p_value;
68
return true;
69
}
70
bool get(const StringName &p_name, Variant &r_ret) const override {
71
if (property_name == p_name) {
72
r_ret = property_value;
73
return true;
74
}
75
return false;
76
}
77
void get_property_list(List<PropertyInfo> *p_properties) const override {
78
}
79
Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid) const override {
80
return Variant::PACKED_FLOAT32_ARRAY;
81
}
82
virtual void validate_property(PropertyInfo &p_property) const override {
83
}
84
bool property_can_revert(const StringName &p_name) const override {
85
return false;
86
}
87
bool property_get_revert(const StringName &p_name, Variant &r_ret) const override {
88
return false;
89
}
90
void get_method_list(List<MethodInfo> *p_list) const override {
91
}
92
bool has_method(const StringName &p_method) const override {
93
return false;
94
}
95
int get_method_argument_count(const StringName &p_method, bool *r_is_valid = nullptr) const override {
96
if (r_is_valid) {
97
*r_is_valid = false;
98
}
99
return 0;
100
}
101
Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override {
102
return Variant();
103
}
104
void notification(int p_notification, bool p_reversed = false) override {
105
}
106
Ref<Script> get_script() const override {
107
return Ref<Script>();
108
}
109
const Variant get_rpc_config() const override {
110
return Variant();
111
}
112
ScriptLanguage *get_language() override {
113
return nullptr;
114
}
115
};
116
117
TEST_CASE("[Object] Core getters") {
118
Object object;
119
120
CHECK_MESSAGE(
121
object.is_class("Object"),
122
"is_class() should return the expected value.");
123
CHECK_MESSAGE(
124
object.get_class() == "Object",
125
"The returned class should match the expected value.");
126
CHECK_MESSAGE(
127
object.get_class_name() == "Object",
128
"The returned class name should match the expected value.");
129
CHECK_MESSAGE(
130
object.get_class_static() == "Object",
131
"The returned static class should match the expected value.");
132
CHECK_MESSAGE(
133
object.get_save_class() == "Object",
134
"The returned save class should match the expected value.");
135
}
136
137
TEST_CASE("[Object] Metadata") {
138
const String meta_path = "complex_metadata_path";
139
Object object;
140
141
object.set_meta(meta_path, Color(0, 1, 0));
142
CHECK_MESSAGE(
143
Color(object.get_meta(meta_path)).is_equal_approx(Color(0, 1, 0)),
144
"The returned object metadata after setting should match the expected value.");
145
146
List<StringName> meta_list;
147
object.get_meta_list(&meta_list);
148
CHECK_MESSAGE(
149
meta_list.size() == 1,
150
"The metadata list should only contain 1 item after adding one metadata item.");
151
152
object.remove_meta(meta_path);
153
// Also try removing nonexistent metadata (it should do nothing, without printing an error message).
154
object.remove_meta("I don't exist");
155
ERR_PRINT_OFF;
156
CHECK_MESSAGE(
157
object.get_meta(meta_path) == Variant(),
158
"The returned object metadata after removing should match the expected value.");
159
ERR_PRINT_ON;
160
161
List<StringName> meta_list2;
162
object.get_meta_list(&meta_list2);
163
CHECK_MESSAGE(
164
meta_list2.size() == 0,
165
"The metadata list should contain 0 items after removing all metadata items.");
166
167
Object other;
168
object.set_meta("conflicting_meta", "string");
169
object.set_meta("not_conflicting_meta", 123);
170
other.set_meta("conflicting_meta", Color(0, 1, 0));
171
other.set_meta("other_meta", "other");
172
object.merge_meta_from(&other);
173
174
CHECK_MESSAGE(
175
Color(object.get_meta("conflicting_meta")).is_equal_approx(Color(0, 1, 0)),
176
"String meta should be overwritten with Color after merging.");
177
178
CHECK_MESSAGE(
179
int(object.get_meta("not_conflicting_meta")) == 123,
180
"Not conflicting meta on destination should be kept intact.");
181
182
CHECK_MESSAGE(
183
object.get_meta("other_meta", String()) == "other",
184
"Not conflicting meta name on source should merged.");
185
186
List<StringName> meta_list3;
187
object.get_meta_list(&meta_list3);
188
CHECK_MESSAGE(
189
meta_list3.size() == 3,
190
"The metadata list should contain 3 items after merging meta from two objects.");
191
}
192
193
TEST_CASE("[Object] Construction") {
194
Object object;
195
196
CHECK_MESSAGE(
197
!object.is_ref_counted(),
198
"Object is not a RefCounted.");
199
200
Object *p_db = ObjectDB::get_instance(object.get_instance_id());
201
CHECK_MESSAGE(
202
p_db == &object,
203
"The database pointer returned by the object id should reference same object.");
204
}
205
206
TEST_CASE("[Object] Script instance property setter") {
207
Object *object = memnew(Object);
208
_MockScriptInstance *script_instance = memnew(_MockScriptInstance);
209
object->set_script_instance(script_instance);
210
211
bool valid = false;
212
object->set("some_name", 100, &valid);
213
CHECK(valid);
214
Variant actual_value;
215
CHECK_MESSAGE(
216
script_instance->get("some_name", actual_value),
217
"The assigned script instance should successfully retrieve value by name.");
218
CHECK_MESSAGE(
219
actual_value == Variant(100),
220
"The returned value should equal the one which was set by the object.");
221
memdelete(object);
222
}
223
224
TEST_CASE("[Object] Script instance property getter") {
225
Object *object = memnew(Object);
226
_MockScriptInstance *script_instance = memnew(_MockScriptInstance);
227
script_instance->set("some_name", 100); // Make sure script instance has the property
228
object->set_script_instance(script_instance);
229
230
bool valid = false;
231
const Variant &actual_value = object->get("some_name", &valid);
232
CHECK(valid);
233
CHECK_MESSAGE(
234
actual_value == Variant(100),
235
"The returned value should equal the one which was set by the script instance.");
236
memdelete(object);
237
}
238
239
TEST_CASE("[Object] Built-in property setter") {
240
GDREGISTER_CLASS(_TestDerivedObject);
241
_TestDerivedObject derived_object;
242
243
bool valid = false;
244
derived_object.set("property", 100, &valid);
245
CHECK(valid);
246
CHECK_MESSAGE(
247
derived_object.get_property() == 100,
248
"The property value should equal the one which was set with built-in setter.");
249
}
250
251
TEST_CASE("[Object] Built-in property getter") {
252
GDREGISTER_CLASS(_TestDerivedObject);
253
_TestDerivedObject derived_object;
254
derived_object.set_property(100);
255
256
bool valid = false;
257
const Variant &actual_value = derived_object.get("property", &valid);
258
CHECK(valid);
259
CHECK_MESSAGE(
260
actual_value == Variant(100),
261
"The returned value should equal the one which was set with built-in setter.");
262
}
263
264
TEST_CASE("[Object] Script property setter") {
265
Object object;
266
Variant script;
267
268
bool valid = false;
269
object.set(CoreStringName(script), script, &valid);
270
CHECK(valid);
271
CHECK_MESSAGE(
272
object.get_script() == script,
273
"The object script should be equal to the assigned one.");
274
}
275
276
TEST_CASE("[Object] Script property getter") {
277
Object object;
278
Variant script;
279
object.set_script(script);
280
281
bool valid = false;
282
const Variant &actual_value = object.get(CoreStringName(script), &valid);
283
CHECK(valid);
284
CHECK_MESSAGE(
285
actual_value == script,
286
"The returned value should be equal to the assigned script.");
287
}
288
289
TEST_CASE("[Object] Absent name setter") {
290
Object object;
291
292
bool valid = true;
293
object.set("absent_name", 100, &valid);
294
CHECK(!valid);
295
}
296
297
TEST_CASE("[Object] Absent name getter") {
298
Object object;
299
300
bool valid = true;
301
const Variant &actual_value = object.get("absent_name", &valid);
302
CHECK(!valid);
303
CHECK_MESSAGE(
304
actual_value == Variant(),
305
"The returned value should equal nil variant.");
306
}
307
308
class SignalReceiver : public Object {
309
GDCLASS(SignalReceiver, Object);
310
311
public:
312
Vector<Variant> received_args;
313
314
void callback0() {
315
received_args = Vector<Variant>{};
316
}
317
318
void callback1(Variant p_arg1) {
319
received_args = Vector<Variant>{ p_arg1 };
320
}
321
322
void callback2(Variant p_arg1, Variant p_arg2) {
323
received_args = Vector<Variant>{ p_arg1, p_arg2 };
324
}
325
326
void callback3(Variant p_arg1, Variant p_arg2, Variant p_arg3) {
327
received_args = Vector<Variant>{ p_arg1, p_arg2, p_arg3 };
328
}
329
};
330
331
TEST_CASE("[Object] Signals") {
332
Object object;
333
334
CHECK_FALSE(object.has_signal("my_custom_signal"));
335
336
List<MethodInfo> signals_before;
337
object.get_signal_list(&signals_before);
338
339
object.add_user_signal(MethodInfo("my_custom_signal"));
340
341
CHECK(object.has_signal("my_custom_signal"));
342
343
List<MethodInfo> signals_after;
344
object.get_signal_list(&signals_after);
345
346
// Should be one more signal.
347
CHECK_EQ(signals_before.size() + 1, signals_after.size());
348
349
SUBCASE("Adding the same user signal again should not have any effect") {
350
CHECK(object.has_signal("my_custom_signal"));
351
ERR_PRINT_OFF;
352
object.add_user_signal(MethodInfo("my_custom_signal"));
353
ERR_PRINT_ON;
354
CHECK(object.has_signal("my_custom_signal"));
355
356
List<MethodInfo> signals_after_existing_added;
357
object.get_signal_list(&signals_after_existing_added);
358
359
CHECK_EQ(signals_after.size(), signals_after_existing_added.size());
360
}
361
362
SUBCASE("Trying to add a preexisting signal should not have any effect") {
363
CHECK(object.has_signal("script_changed"));
364
ERR_PRINT_OFF;
365
object.add_user_signal(MethodInfo("script_changed"));
366
ERR_PRINT_ON;
367
CHECK(object.has_signal("script_changed"));
368
369
List<MethodInfo> signals_after_existing_added;
370
object.get_signal_list(&signals_after_existing_added);
371
372
CHECK_EQ(signals_after.size(), signals_after_existing_added.size());
373
}
374
375
SUBCASE("Adding an empty signal should not have any effect") {
376
CHECK_FALSE(object.has_signal(""));
377
ERR_PRINT_OFF;
378
object.add_user_signal(MethodInfo(""));
379
ERR_PRINT_ON;
380
CHECK_FALSE(object.has_signal(""));
381
382
List<MethodInfo> signals_after_empty_added;
383
object.get_signal_list(&signals_after_empty_added);
384
385
CHECK_EQ(signals_after.size(), signals_after_empty_added.size());
386
}
387
388
SUBCASE("Deleting an object with connected signals should disconnect them") {
389
List<Object::Connection> signal_connections;
390
391
{
392
Object target;
393
target.add_user_signal(MethodInfo("my_custom_signal"));
394
395
ERR_PRINT_OFF;
396
target.connect("nonexistent_signal1", callable_mp(&object, &Object::notify_property_list_changed));
397
target.connect("my_custom_signal", callable_mp(&object, &Object::notify_property_list_changed));
398
target.connect("nonexistent_signal2", callable_mp(&object, &Object::notify_property_list_changed));
399
ERR_PRINT_ON;
400
401
signal_connections.clear();
402
object.get_all_signal_connections(&signal_connections);
403
CHECK(signal_connections.size() == 0);
404
signal_connections.clear();
405
object.get_signals_connected_to_this(&signal_connections);
406
CHECK(signal_connections.size() == 1);
407
408
ERR_PRINT_OFF;
409
object.connect("nonexistent_signal1", callable_mp(&target, &Object::notify_property_list_changed));
410
object.connect("my_custom_signal", callable_mp(&target, &Object::notify_property_list_changed));
411
object.connect("nonexistent_signal2", callable_mp(&target, &Object::notify_property_list_changed));
412
ERR_PRINT_ON;
413
414
signal_connections.clear();
415
object.get_all_signal_connections(&signal_connections);
416
CHECK(signal_connections.size() == 1);
417
signal_connections.clear();
418
object.get_signals_connected_to_this(&signal_connections);
419
CHECK(signal_connections.size() == 1);
420
}
421
422
signal_connections.clear();
423
object.get_all_signal_connections(&signal_connections);
424
CHECK(signal_connections.size() == 0);
425
signal_connections.clear();
426
object.get_signals_connected_to_this(&signal_connections);
427
CHECK(signal_connections.size() == 0);
428
}
429
430
SUBCASE("Emitting a non existing signal will return an error") {
431
Error err = object.emit_signal("some_signal");
432
CHECK(err == ERR_UNAVAILABLE);
433
}
434
435
SUBCASE("Emitting an existing signal should call the connected method") {
436
Array empty_signal_args = { {} };
437
438
SIGNAL_WATCH(&object, "my_custom_signal");
439
SIGNAL_CHECK_FALSE("my_custom_signal");
440
441
Error err = object.emit_signal("my_custom_signal");
442
CHECK(err == OK);
443
444
SIGNAL_CHECK("my_custom_signal", empty_signal_args);
445
SIGNAL_UNWATCH(&object, "my_custom_signal");
446
}
447
448
SUBCASE("Connecting and then disconnecting many signals should not leave anything behind") {
449
List<Object::Connection> signal_connections;
450
Object targets[100];
451
452
for (int i = 0; i < 10; i++) {
453
ERR_PRINT_OFF;
454
for (Object &target : targets) {
455
object.connect("my_custom_signal", callable_mp(&target, &Object::notify_property_list_changed));
456
}
457
ERR_PRINT_ON;
458
signal_connections.clear();
459
object.get_all_signal_connections(&signal_connections);
460
CHECK(signal_connections.size() == 100);
461
}
462
463
for (Object &target : targets) {
464
object.disconnect("my_custom_signal", callable_mp(&target, &Object::notify_property_list_changed));
465
}
466
signal_connections.clear();
467
object.get_all_signal_connections(&signal_connections);
468
CHECK(signal_connections.size() == 0);
469
}
470
471
SUBCASE("Connecting with CONNECT_APPEND_SOURCE_OBJECT flag") {
472
SignalReceiver target;
473
474
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback1), Object::CONNECT_APPEND_SOURCE_OBJECT);
475
object.emit_signal("my_custom_signal");
476
CHECK_EQ(target.received_args, Vector<Variant>{ &object });
477
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback1));
478
479
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2), Object::CONNECT_APPEND_SOURCE_OBJECT);
480
object.emit_signal("my_custom_signal", "emit_arg");
481
CHECK_EQ(target.received_args, Vector<Variant>{ "emit_arg", &object });
482
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2));
483
484
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2).bind("bind_arg"), Object::CONNECT_APPEND_SOURCE_OBJECT);
485
object.emit_signal("my_custom_signal");
486
CHECK_EQ(target.received_args, Vector<Variant>{ &object, "bind_arg" });
487
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2));
488
489
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback3).bind("bind_arg"), Object::CONNECT_APPEND_SOURCE_OBJECT);
490
object.emit_signal("my_custom_signal", "emit_arg");
491
CHECK_EQ(target.received_args, Vector<Variant>{ "emit_arg", &object, "bind_arg" });
492
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback3));
493
494
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback3).bind(&object), Object::CONNECT_APPEND_SOURCE_OBJECT);
495
object.emit_signal("my_custom_signal", &object);
496
CHECK_EQ(target.received_args, Vector<Variant>{ &object, &object, &object });
497
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback3));
498
499
// Source should be appended regardless of unbinding.
500
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback1).unbind(1), Object::CONNECT_APPEND_SOURCE_OBJECT);
501
object.emit_signal("my_custom_signal", "emit_arg");
502
CHECK_EQ(target.received_args, Vector<Variant>{ &object });
503
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback1));
504
505
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2).bind("bind_arg").unbind(1), Object::CONNECT_APPEND_SOURCE_OBJECT);
506
object.emit_signal("my_custom_signal", "emit_arg");
507
CHECK_EQ(target.received_args, Vector<Variant>{ &object, "bind_arg" });
508
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2));
509
510
object.connect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2).unbind(1).bind("bind_arg"), Object::CONNECT_APPEND_SOURCE_OBJECT);
511
object.emit_signal("my_custom_signal", "emit_arg");
512
CHECK_EQ(target.received_args, Vector<Variant>{ "emit_arg", &object });
513
object.disconnect("my_custom_signal", callable_mp(&target, &SignalReceiver::callback2));
514
}
515
}
516
517
class NotificationObjectSuperclass : public Object {
518
GDCLASS(NotificationObjectSuperclass, Object);
519
520
protected:
521
void _notification(int p_what) {
522
order_superclass = ++order_global;
523
}
524
525
public:
526
static inline int order_global = 0;
527
int order_superclass = -1;
528
};
529
530
class NotificationObjectSubclass : public NotificationObjectSuperclass {
531
GDCLASS(NotificationObjectSubclass, NotificationObjectSuperclass);
532
533
protected:
534
void _notification(int p_what) {
535
order_subclass = ++order_global;
536
}
537
538
public:
539
int order_subclass = -1;
540
};
541
542
class NotificationScriptInstance : public _MockScriptInstance {
543
void notification(int p_notification, bool p_reversed) override {
544
order_script = ++NotificationObjectSuperclass::order_global;
545
}
546
547
public:
548
int order_script = -1;
549
};
550
551
TEST_CASE("[Object] Notification order") { // GH-52325
552
NotificationObjectSubclass *object = memnew(NotificationObjectSubclass);
553
554
NotificationScriptInstance *script = memnew(NotificationScriptInstance);
555
object->set_script_instance(script);
556
557
SUBCASE("regular order") {
558
NotificationObjectSubclass::order_global = 0;
559
object->order_superclass = -1;
560
object->order_subclass = -1;
561
script->order_script = -1;
562
object->notification(12345, false);
563
564
CHECK_EQ(object->order_superclass, 1);
565
CHECK_EQ(object->order_subclass, 2);
566
// TODO If an extension is attached, it should come here.
567
CHECK_EQ(script->order_script, 3);
568
CHECK_EQ(NotificationObjectSubclass::order_global, 3);
569
}
570
571
SUBCASE("reverse order") {
572
NotificationObjectSubclass::order_global = 0;
573
object->order_superclass = -1;
574
object->order_subclass = -1;
575
script->order_script = -1;
576
object->notification(12345, true);
577
578
CHECK_EQ(script->order_script, 1);
579
// TODO If an extension is attached, it should come here.
580
CHECK_EQ(object->order_subclass, 2);
581
CHECK_EQ(object->order_superclass, 3);
582
CHECK_EQ(NotificationObjectSubclass::order_global, 3);
583
}
584
585
memdelete(object);
586
}
587
588
TEST_CASE("[Object] Destruction at the end of the call chain is safe") {
589
Object *object = memnew(Object);
590
ObjectID obj_id = object->get_instance_id();
591
592
class _SelfDestroyingScriptInstance : public _MockScriptInstance {
593
Object *self = nullptr;
594
595
// This has to be static because ~Object() also destroys the script instance.
596
static void free_self(Object *p_self) {
597
#if defined(ASAN_ENABLED) || defined(TSAN_ENABLED)
598
// Regular deletion is enough becausa asan/tsan will catch a potential heap-after-use.
599
memdelete(p_self);
600
#else
601
// Without asan/tsan, try at least to force a crash by replacing the otherwise seemingly good data with garbage.
602
// Operations such as dereferencing pointers or decreasing a refcount would fail.
603
// Unfortunately, we may not poison the memory after the deletion, because the memory would no longer belong to us
604
// and on doing so we may cause a more generalized crash on some platforms (allocator implementations).
605
p_self->~Object();
606
memset((void *)p_self, 0, sizeof(Object));
607
Memory::free_static(p_self, false);
608
#endif
609
}
610
611
public:
612
Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override {
613
free_self(self);
614
return Variant();
615
}
616
Variant call_const(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override {
617
free_self(self);
618
return Variant();
619
}
620
bool has_method(const StringName &p_method) const override {
621
return p_method == "some_method";
622
}
623
624
public:
625
_SelfDestroyingScriptInstance(Object *p_self) :
626
self(p_self) {}
627
};
628
629
_SelfDestroyingScriptInstance *script_instance = memnew(_SelfDestroyingScriptInstance(object));
630
object->set_script_instance(script_instance);
631
632
SUBCASE("Within callp()") {
633
SUBCASE("Through call()") {
634
object->call("some_method");
635
}
636
SUBCASE("Through callv()") {
637
object->callv("some_method", Array());
638
}
639
}
640
SUBCASE("Within call_const()") {
641
Callable::CallError call_error;
642
object->call_const("some_method", nullptr, 0, call_error);
643
}
644
SUBCASE("Within signal handling (from emit_signalp(), through emit_signal())") {
645
Object emitter;
646
emitter.add_user_signal(MethodInfo("some_signal"));
647
emitter.connect("some_signal", Callable(object, "some_method"));
648
emitter.emit_signal("some_signal");
649
}
650
651
CHECK_MESSAGE(
652
ObjectDB::get_instance(obj_id) == nullptr,
653
"Object was tail-deleted without crashes.");
654
}
655
656
int required_param_compare(const Ref<RefCounted> &p_ref, const RequiredParam<RefCounted> &rp_required) {
657
EXTRACT_PARAM_OR_FAIL_V(p_required, rp_required, false);
658
ERR_FAIL_COND_V(p_ref->get_reference_count() != p_required->get_reference_count(), -1);
659
return p_ref->get_reference_count();
660
}
661
662
TEST_CASE("[Object] RequiredParam Ref<T>") {
663
Ref<RefCounted> ref;
664
ref.instantiate();
665
const Ref<RefCounted> &ref_ref = ref;
666
667
RequiredParam<RefCounted> required = ref;
668
EXTRACT_PARAM_OR_FAIL(extract, required);
669
670
static_assert(std::is_same_v<decltype(ref_ref), decltype(extract)>);
671
672
CHECK_EQ(ref->get_reference_count(), extract->get_reference_count());
673
674
const int count = required_param_compare(ref, ref);
675
CHECK_NE(count, -1);
676
CHECK_EQ(count, ref->get_reference_count());
677
678
CHECK_EQ(ref->get_reference_count(), extract->get_reference_count());
679
}
680
681
TEST_CASE("[Object] RequiredResult") {
682
Ref<RefCounted> ref;
683
ref.instantiate();
684
685
RequiredResult<RefCounted> required = ref;
686
687
Ref<RefCounted> unpacked = required;
688
Variant var = Ref<RefCounted>(required);
689
690
CHECK_EQ(ref, unpacked);
691
CHECK_EQ(ref, var);
692
}
693
694
} // namespace TestObject
695
696