1/**************************************************************************/
2/* node_path.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 NODE_PATH_H
32#define NODE_PATH_H
33
34#include "core/string/string_name.h"
35#include "core/string/ustring.h"
36
37class NodePath {
38 struct Data {
39 SafeRefCount refcount;
40 Vector<StringName> path;
41 Vector<StringName> subpath;
42 StringName concatenated_path;
43 StringName concatenated_subpath;
44 bool absolute;
45 mutable bool hash_cache_valid;
46 mutable uint32_t hash_cache;
47 };
48
49 mutable Data *data = nullptr;
50 void unref();
51
52 void _update_hash_cache() const;
53
54public:
55 bool is_absolute() const;
56 int get_name_count() const;
57 StringName get_name(int p_idx) const;
58 int get_subname_count() const;
59 StringName get_subname(int p_idx) const;
60 Vector<StringName> get_names() const;
61 Vector<StringName> get_subnames() const;
62 StringName get_concatenated_names() const;
63 StringName get_concatenated_subnames() const;
64
65 NodePath rel_path_to(const NodePath &p_np) const;
66 NodePath get_as_property_path() const;
67
68 void prepend_period();
69
70 _FORCE_INLINE_ uint32_t hash() const {
71 if (!data) {
72 return 0;
73 }
74 if (!data->hash_cache_valid) {
75 _update_hash_cache();
76 }
77 return data->hash_cache;
78 }
79
80 operator String() const;
81 bool is_empty() const;
82
83 bool operator==(const NodePath &p_path) const;
84 bool operator!=(const NodePath &p_path) const;
85 void operator=(const NodePath &p_path);
86
87 void simplify();
88 NodePath simplified() const;
89
90 NodePath(const Vector<StringName> &p_path, bool p_absolute);
91 NodePath(const Vector<StringName> &p_path, const Vector<StringName> &p_subpath, bool p_absolute);
92 NodePath(const NodePath &p_path);
93 NodePath(const String &p_path);
94 NodePath() {}
95 ~NodePath();
96};
97
98#endif // NODE_PATH_H
99