2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* rid.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2021-01-01 20:13:46 +01:00
|
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef RID_H
|
|
|
|
#define RID_H
|
|
|
|
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/list.h"
|
|
|
|
#include "core/os/memory.h"
|
|
|
|
#include "core/safe_refcount.h"
|
|
|
|
#include "core/set.h"
|
|
|
|
#include "core/typedefs.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
class RID_OwnerBase;
|
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
class RID_Data {
|
2017-03-05 16:44:50 +01:00
|
|
|
friend class RID_OwnerBase;
|
2016-10-03 21:33:42 +02:00
|
|
|
|
|
|
|
#ifndef DEBUG_ENABLED
|
|
|
|
RID_OwnerBase *_owner;
|
|
|
|
#endif
|
|
|
|
uint32_t _id;
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
public:
|
|
|
|
_FORCE_INLINE_ uint32_t get_id() const { return _id; }
|
|
|
|
|
|
|
|
virtual ~RID_Data();
|
|
|
|
};
|
|
|
|
|
2016-03-09 00:00:52 +01:00
|
|
|
class RID {
|
2017-03-05 16:44:50 +01:00
|
|
|
friend class RID_OwnerBase;
|
2016-10-03 21:33:42 +02:00
|
|
|
|
|
|
|
mutable RID_Data *_data;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
2016-10-03 21:33:42 +02:00
|
|
|
_FORCE_INLINE_ RID_Data *get_data() const { return _data; }
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ bool operator==(const RID &p_rid) const {
|
|
|
|
return _data == p_rid._data;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ bool operator<(const RID &p_rid) const {
|
2016-10-03 21:33:42 +02:00
|
|
|
return _data < p_rid._data;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ bool operator<=(const RID &p_rid) const {
|
2016-10-03 21:33:42 +02:00
|
|
|
return _data <= p_rid._data;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ bool operator>(const RID &p_rid) const {
|
2016-10-03 21:33:42 +02:00
|
|
|
return _data > p_rid._data;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ bool operator!=(const RID &p_rid) const {
|
|
|
|
return _data != p_rid._data;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2021-05-04 16:00:45 +02:00
|
|
|
_FORCE_INLINE_ bool is_valid() const { return _data != nullptr; }
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ uint32_t get_id() const { return _data ? _data->get_id() : 0; }
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
_FORCE_INLINE_ RID() {
|
2021-05-04 16:00:45 +02:00
|
|
|
_data = nullptr;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class RID_OwnerBase {
|
|
|
|
protected:
|
2016-10-03 21:33:42 +02:00
|
|
|
static SafeRefCount refcount;
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ void _set_data(RID &p_rid, RID_Data *p_data) {
|
|
|
|
p_rid._data = p_data;
|
2016-10-03 21:33:42 +02:00
|
|
|
refcount.ref();
|
2017-03-05 16:44:50 +01:00
|
|
|
p_data->_id = refcount.get();
|
2016-10-03 21:33:42 +02:00
|
|
|
#ifndef DEBUG_ENABLED
|
2017-03-05 16:44:50 +01:00
|
|
|
p_data->_owner = this;
|
2016-10-03 21:33:42 +02:00
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
#ifndef DEBUG_ENABLED
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ bool _is_owner(const RID &p_rid) const {
|
|
|
|
return this == p_rid._data->_owner;
|
2016-10-03 21:33:42 +02:00
|
|
|
}
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ void _remove_owner(RID &p_rid) {
|
|
|
|
p_rid._data->_owner = NULL;
|
2016-10-03 21:33:42 +02:00
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void get_owned_list(List<RID> *p_owned) = 0;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
static void init_rid();
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual ~RID_OwnerBase() {}
|
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
template <class T>
|
2014-02-10 02:10:30 +01:00
|
|
|
class RID_Owner : public RID_OwnerBase {
|
|
|
|
public:
|
2016-10-03 21:33:42 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2017-03-05 16:44:50 +01:00
|
|
|
mutable Set<RID_Data *> id_map;
|
2016-10-03 21:33:42 +02:00
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ RID make_rid(T *p_data) {
|
2014-02-10 02:10:30 +01:00
|
|
|
RID rid;
|
2017-03-05 16:44:50 +01:00
|
|
|
_set_data(rid, p_data);
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2017-03-05 16:44:50 +01:00
|
|
|
id_map.insert(p_data);
|
2016-10-03 21:33:42 +02:00
|
|
|
#endif
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
return rid;
|
|
|
|
}
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ T *get(const RID &p_rid) {
|
2016-10-03 21:33:42 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2021-05-04 16:00:45 +02:00
|
|
|
ERR_FAIL_COND_V(!p_rid.is_valid(), nullptr);
|
|
|
|
ERR_FAIL_COND_V(!id_map.has(p_rid.get_data()), nullptr);
|
2016-10-03 21:33:42 +02:00
|
|
|
#endif
|
2017-03-05 16:44:50 +01:00
|
|
|
return static_cast<T *>(p_rid.get_data());
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ T *getornull(const RID &p_rid) {
|
2016-10-03 21:33:42 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
if (p_rid.get_data()) {
|
2021-05-04 16:00:45 +02:00
|
|
|
ERR_FAIL_COND_V(!id_map.has(p_rid.get_data()), nullptr);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2016-10-03 21:33:42 +02:00
|
|
|
#endif
|
2017-03-05 16:44:50 +01:00
|
|
|
return static_cast<T *>(p_rid.get_data());
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ T *getptr(const RID &p_rid) {
|
|
|
|
return static_cast<T *>(p_rid.get_data());
|
2016-10-19 16:14:41 +02:00
|
|
|
}
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
_FORCE_INLINE_ bool owns(const RID &p_rid) const {
|
2021-05-04 16:00:45 +02:00
|
|
|
if (p_rid.get_data() == nullptr)
|
2016-10-03 21:33:42 +02:00
|
|
|
return false;
|
|
|
|
#ifdef DEBUG_ENABLED
|
|
|
|
return id_map.has(p_rid.get_data());
|
|
|
|
#else
|
|
|
|
return _is_owner(p_rid);
|
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
void free(RID p_rid) {
|
|
|
|
#ifdef DEBUG_ENABLED
|
|
|
|
id_map.erase(p_rid.get_data());
|
|
|
|
#else
|
|
|
|
_remove_owner(p_rid);
|
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
void get_owned_list(List<RID> *p_owned) {
|
|
|
|
#ifdef DEBUG_ENABLED
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
for (typename Set<RID_Data *>::Element *E = id_map.front(); E; E = E->next()) {
|
2016-10-03 21:33:42 +02:00
|
|
|
RID r;
|
2017-03-05 16:44:50 +01:00
|
|
|
_set_data(r, static_cast<T *>(E->get()));
|
2016-10-03 21:33:42 +02:00
|
|
|
p_owned->push_back(r);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2016-10-03 21:33:42 +02:00
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|