1/**************************************************************************/
2/* object_id.h */
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#ifndef OBJECT_ID_H
32#define OBJECT_ID_H
33
34#include "core/typedefs.h"
35
36// Class to store an object ID (int64)
37// needs to be compatile with int64 because this is what Variant uses
38// Also, need to be explicitly only castable to 64 bits integer types
39// to avoid bugs due to loss of precision
40
41class ObjectID {
42 uint64_t id = 0;
43
44public:
45 _ALWAYS_INLINE_ bool is_ref_counted() const { return (id & (uint64_t(1) << 63)) != 0; }
46 _ALWAYS_INLINE_ bool is_valid() const { return id != 0; }
47 _ALWAYS_INLINE_ bool is_null() const { return id == 0; }
48 _ALWAYS_INLINE_ operator uint64_t() const { return id; }
49 _ALWAYS_INLINE_ operator int64_t() const { return id; }
50
51 _ALWAYS_INLINE_ bool operator==(const ObjectID &p_id) const { return id == p_id.id; }
52 _ALWAYS_INLINE_ bool operator!=(const ObjectID &p_id) const { return id != p_id.id; }
53 _ALWAYS_INLINE_ bool operator<(const ObjectID &p_id) const { return id < p_id.id; }
54
55 _ALWAYS_INLINE_ void operator=(int64_t p_int64) { id = p_int64; }
56 _ALWAYS_INLINE_ void operator=(uint64_t p_uint64) { id = p_uint64; }
57
58 _ALWAYS_INLINE_ ObjectID() {}
59 _ALWAYS_INLINE_ explicit ObjectID(const uint64_t p_id) { id = p_id; }
60 _ALWAYS_INLINE_ explicit ObjectID(const int64_t p_id) { id = p_id; }
61};
62
63#endif // OBJECT_ID_H
64