180e5d3028
These typedefs don't save much typing compared to the full `Ref<Resource>` and `Ref<RefCounted>`, yet they sometimes introduce confusion among new contributors.
128 lines
4.3 KiB
C++
128 lines
4.3 KiB
C++
/*************************************************************************/
|
|
/* ref_counted.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/*************************************************************************/
|
|
|
|
#include "ref_counted.h"
|
|
|
|
#include "core/object/script_language.h"
|
|
|
|
bool RefCounted::init_ref() {
|
|
if (reference()) {
|
|
if (!is_referenced() && refcount_init.unref()) {
|
|
unreference(); // first referencing is already 1, so compensate for the ref above
|
|
}
|
|
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
void RefCounted::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("init_ref"), &RefCounted::init_ref);
|
|
ClassDB::bind_method(D_METHOD("reference"), &RefCounted::reference);
|
|
ClassDB::bind_method(D_METHOD("unreference"), &RefCounted::unreference);
|
|
}
|
|
|
|
int RefCounted::reference_get_count() const {
|
|
return refcount.get();
|
|
}
|
|
|
|
bool RefCounted::reference() {
|
|
uint32_t rc_val = refcount.refval();
|
|
bool success = rc_val != 0;
|
|
|
|
if (success && rc_val <= 2 /* higher is not relevant */) {
|
|
if (get_script_instance()) {
|
|
get_script_instance()->refcount_incremented();
|
|
}
|
|
if (_get_extension() && _get_extension()->reference) {
|
|
_get_extension()->reference(_get_extension_instance());
|
|
}
|
|
|
|
_instance_binding_reference(true);
|
|
}
|
|
|
|
return success;
|
|
}
|
|
|
|
bool RefCounted::unreference() {
|
|
uint32_t rc_val = refcount.unrefval();
|
|
bool die = rc_val == 0;
|
|
|
|
if (rc_val <= 1 /* higher is not relevant */) {
|
|
if (get_script_instance()) {
|
|
bool script_ret = get_script_instance()->refcount_decremented();
|
|
die = die && script_ret;
|
|
}
|
|
if (_get_extension() && _get_extension()->unreference) {
|
|
_get_extension()->unreference(_get_extension_instance());
|
|
}
|
|
|
|
die = die && _instance_binding_reference(false);
|
|
}
|
|
|
|
return die;
|
|
}
|
|
|
|
RefCounted::RefCounted() :
|
|
Object(true) {
|
|
refcount.init();
|
|
refcount_init.init();
|
|
}
|
|
|
|
Variant WeakRef::get_ref() const {
|
|
if (ref.is_null()) {
|
|
return Variant();
|
|
}
|
|
|
|
Object *obj = ObjectDB::get_instance(ref);
|
|
if (!obj) {
|
|
return Variant();
|
|
}
|
|
RefCounted *r = cast_to<RefCounted>(obj);
|
|
if (r) {
|
|
return Ref<RefCounted>(r);
|
|
}
|
|
|
|
return obj;
|
|
}
|
|
|
|
void WeakRef::set_obj(Object *p_object) {
|
|
ref = p_object ? p_object->get_instance_id() : ObjectID();
|
|
}
|
|
|
|
void WeakRef::set_ref(const Ref<RefCounted> &p_ref) {
|
|
ref = p_ref.is_valid() ? p_ref->get_instance_id() : ObjectID();
|
|
}
|
|
|
|
void WeakRef::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("get_ref"), &WeakRef::get_ref);
|
|
}
|