godot/core/object/ref_counted.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

306 lines
8.1 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/**************************************************************************/
2021-06-04 16:03:15 +00:00
/* ref_counted.h */
2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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. */
/**************************************************************************/
2021-06-04 16:03:15 +00:00
#ifndef REF_COUNTED_H
#define REF_COUNTED_H
2014-02-10 01:10:30 +00:00
#include "core/object/class_db.h"
#include "core/templates/safe_refcount.h"
2014-02-10 01:10:30 +00:00
2021-06-04 16:03:15 +00:00
class RefCounted : public Object {
GDCLASS(RefCounted, Object);
2014-02-10 01:10:30 +00:00
SafeRefCount refcount;
SafeRefCount refcount_init;
protected:
static void _bind_methods();
public:
2019-09-03 16:04:37 +00:00
_FORCE_INLINE_ bool is_referenced() const { return refcount_init.get() != 1; }
2014-02-10 01:10:30 +00:00
bool init_ref();
bool reference(); // returns false if refcount is at zero and didn't get increased
2014-02-10 01:10:30 +00:00
bool unreference();
int get_reference_count() const;
2014-02-10 01:10:30 +00:00
2021-06-04 16:03:15 +00:00
RefCounted();
~RefCounted() {}
2014-02-10 01:10:30 +00:00
};
template <class T>
class Ref {
T *reference = nullptr;
2014-02-10 01:10:30 +00:00
void ref(const Ref &p_from) {
if (p_from.reference == reference) {
2014-02-10 01:10:30 +00:00
return;
}
2014-02-10 01:10:30 +00:00
unref();
reference = p_from.reference;
if (reference) {
2014-02-10 01:10:30 +00:00
reference->reference();
}
2014-02-10 01:10:30 +00:00
}
void ref_pointer(T *p_ref) {
ERR_FAIL_NULL(p_ref);
2014-02-10 01:10:30 +00:00
if (p_ref->init_ref()) {
2014-02-10 01:10:30 +00:00
reference = p_ref;
}
2014-02-10 01:10:30 +00:00
}
2021-06-04 16:03:15 +00:00
//virtual RefCounted * get_reference() const { return reference; }
2014-02-10 01:10:30 +00:00
public:
_FORCE_INLINE_ bool operator==(const T *p_ptr) const {
return reference == p_ptr;
}
_FORCE_INLINE_ bool operator!=(const T *p_ptr) const {
return reference != p_ptr;
}
2014-02-10 01:10:30 +00:00
_FORCE_INLINE_ bool operator<(const Ref<T> &p_r) const {
return reference < p_r.reference;
}
_FORCE_INLINE_ bool operator==(const Ref<T> &p_r) const {
return reference == p_r.reference;
}
_FORCE_INLINE_ bool operator!=(const Ref<T> &p_r) const {
return reference != p_r.reference;
}
_FORCE_INLINE_ T *operator*() const {
2014-02-10 01:10:30 +00:00
return reference;
}
_FORCE_INLINE_ T *operator->() const {
2014-02-10 01:10:30 +00:00
return reference;
}
_FORCE_INLINE_ T *ptr() const {
2014-02-10 01:10:30 +00:00
return reference;
}
operator Variant() const {
return Variant(reference);
2014-02-10 01:10:30 +00:00
}
void operator=(const Ref &p_from) {
ref(p_from);
}
template <class T_Other>
void operator=(const Ref<T_Other> &p_from) {
2021-06-04 16:03:15 +00:00
RefCounted *refb = const_cast<RefCounted *>(static_cast<const RefCounted *>(p_from.ptr()));
2014-02-10 01:10:30 +00:00
if (!refb) {
unref();
return;
}
Ref r;
r.reference = Object::cast_to<T>(refb);
2014-02-10 01:10:30 +00:00
ref(r);
2020-04-01 23:20:12 +00:00
r.reference = nullptr;
2014-02-10 01:10:30 +00:00
}
void operator=(const Variant &p_variant) {
Object *object = p_variant.get_validated_object();
if (object == reference) {
2014-02-10 01:10:30 +00:00
return;
}
unref();
2014-02-10 01:10:30 +00:00
if (!object) {
2014-02-10 01:10:30 +00:00
return;
}
T *r = Object::cast_to<T>(object);
if (r && r->reference()) {
reference = r;
}
2014-02-10 01:10:30 +00:00
}
template <class T_Other>
void reference_ptr(T_Other *p_ptr) {
if (reference == p_ptr) {
return;
}
unref();
T *r = Object::cast_to<T>(p_ptr);
if (r) {
ref_pointer(r);
}
}
2014-02-10 01:10:30 +00:00
Ref(const Ref &p_from) {
ref(p_from);
}
template <class T_Other>
Ref(const Ref<T_Other> &p_from) {
2021-06-04 16:03:15 +00:00
RefCounted *refb = const_cast<RefCounted *>(static_cast<const RefCounted *>(p_from.ptr()));
2014-02-10 01:10:30 +00:00
if (!refb) {
unref();
return;
}
Ref r;
r.reference = Object::cast_to<T>(refb);
2014-02-10 01:10:30 +00:00
ref(r);
2020-04-01 23:20:12 +00:00
r.reference = nullptr;
2014-02-10 01:10:30 +00:00
}
Ref(T *p_reference) {
if (p_reference) {
2014-02-10 01:10:30 +00:00
ref_pointer(p_reference);
}
2014-02-10 01:10:30 +00:00
}
Ref(const Variant &p_variant) {
Object *object = p_variant.get_validated_object();
if (!object) {
2014-02-10 01:10:30 +00:00
return;
}
T *r = Object::cast_to<T>(object);
if (r && r->reference()) {
reference = r;
2014-02-10 01:10:30 +00:00
}
}
2020-04-01 23:20:12 +00:00
inline bool is_valid() const { return reference != nullptr; }
inline bool is_null() const { return reference == nullptr; }
2014-02-10 01:10:30 +00:00
void unref() {
// TODO: this should be moved to mutexes, since this engine does not really
2014-02-10 01:10:30 +00:00
// do a lot of referencing on references and stuff
// mutexes will avoid more crashes?
if (reference && reference->unreference()) {
memdelete(reference);
}
2020-04-01 23:20:12 +00:00
reference = nullptr;
2014-02-10 01:10:30 +00:00
}
void instantiate() {
2015-06-14 05:13:47 +00:00
ref(memnew(T));
}
2014-02-10 01:10:30 +00:00
Ref() {}
2014-02-10 01:10:30 +00:00
~Ref() {
unref();
}
};
2021-06-04 16:03:15 +00:00
class WeakRef : public RefCounted {
GDCLASS(WeakRef, RefCounted);
2014-02-10 01:10:30 +00:00
ObjectID ref;
2014-02-10 01:10:30 +00:00
protected:
static void _bind_methods();
public:
Variant get_ref() const;
void set_obj(Object *p_object);
void set_ref(const Ref<RefCounted> &p_ref);
2014-02-10 01:10:30 +00:00
WeakRef() {}
2014-02-10 01:10:30 +00:00
};
template <class T>
struct PtrToArg<Ref<T>> {
_FORCE_INLINE_ static Ref<T> convert(const void *p_ptr) {
if (p_ptr == nullptr) {
return Ref<T>();
}
// p_ptr points to a RefCounted object
return Ref<T>(const_cast<T *>(*reinterpret_cast<T *const *>(p_ptr)));
}
typedef Ref<T> EncodeT;
_FORCE_INLINE_ static void encode(Ref<T> p_val, const void *p_ptr) {
// p_ptr points to an EncodeT object which is a Ref<T> object.
2022-04-05 10:40:26 +00:00
*(const_cast<Ref<RefCounted> *>(reinterpret_cast<const Ref<RefCounted> *>(p_ptr))) = p_val;
}
};
template <class T>
struct PtrToArg<const Ref<T> &> {
typedef Ref<T> EncodeT;
_FORCE_INLINE_ static Ref<T> convert(const void *p_ptr) {
if (p_ptr == nullptr) {
return Ref<T>();
}
// p_ptr points to a RefCounted object
return Ref<T>(*((T *const *)p_ptr));
}
};
2014-02-10 01:10:30 +00:00
template <class T>
struct GetTypeInfo<Ref<T>> {
static const Variant::Type VARIANT_TYPE = Variant::OBJECT;
static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
static inline PropertyInfo get_class_info() {
return PropertyInfo(Variant::OBJECT, String(), PROPERTY_HINT_RESOURCE_TYPE, T::get_class_static());
}
};
template <class T>
struct GetTypeInfo<const Ref<T> &> {
static const Variant::Type VARIANT_TYPE = Variant::OBJECT;
static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
static inline PropertyInfo get_class_info() {
return PropertyInfo(Variant::OBJECT, String(), PROPERTY_HINT_RESOURCE_TYPE, T::get_class_static());
}
};
template <class T>
struct VariantInternalAccessor<Ref<T>> {
static _FORCE_INLINE_ Ref<T> get(const Variant *v) { return Ref<T>(*VariantInternal::get_object(v)); }
static _FORCE_INLINE_ void set(Variant *v, const Ref<T> &p_ref) { VariantInternal::refcounted_object_assign(v, p_ref.ptr()); }
};
template <class T>
struct VariantInternalAccessor<const Ref<T> &> {
static _FORCE_INLINE_ Ref<T> get(const Variant *v) { return Ref<T>(*VariantInternal::get_object(v)); }
static _FORCE_INLINE_ void set(Variant *v, const Ref<T> &p_ref) { VariantInternal::refcounted_object_assign(v, p_ref.ptr()); }
};
2021-06-04 16:03:15 +00:00
#endif // REF_COUNTED_H