1 /*************************************************************************/
2 /*  path_db.h                                                            */
3 /*************************************************************************/
4 /*                       This file is part of:                           */
5 /*                           GODOT ENGINE                                */
6 /*                      https://godotengine.org                          */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md)    */
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 #ifndef PATH_DB_H
31 #define PATH_DB_H
32 
33 #include "string_db.h"
34 #include "ustring.h"
35 /**
36 	@author Juan Linietsky <reduzio@gmail.com>
37 */
38 
39 class NodePath {
40 
41 	struct Data {
42 
43 		SafeRefCount refcount;
44 		StringName property;
45 		Vector<StringName> path;
46 		Vector<StringName> subpath;
47 		bool absolute;
48 	};
49 
50 	Data *data;
51 	void unref();
52 
53 public:
get_sname()54 	_FORCE_INLINE_ StringName get_sname() const {
55 
56 		if (data && data->path.size() == 1 && data->subpath.empty() && !data->property) {
57 			return data->path[0];
58 		} else {
59 			return operator String();
60 		}
61 	}
62 
63 	bool is_absolute() const;
64 	int get_name_count() const;
65 	StringName get_name(int p_idx) const;
66 	int get_subname_count() const;
67 	StringName get_subname(int p_idx) const;
68 	Vector<StringName> get_names() const;
69 	Vector<StringName> get_subnames() const;
70 
71 	NodePath rel_path_to(const NodePath &p_np) const;
72 
73 	void prepend_period();
74 
75 	StringName get_property() const;
76 
77 	NodePath get_parent() const;
78 
79 	uint32_t hash() const;
80 
81 	operator String() const;
82 	bool is_empty() const;
83 
84 	bool operator==(const NodePath &p_path) const;
85 	bool operator!=(const NodePath &p_path) const;
86 	void operator=(const NodePath &p_path);
87 
88 	void simplify();
89 	NodePath simplified() const;
90 
91 	NodePath(const Vector<StringName> &p_path, bool p_absolute, const String &p_property = "");
92 	NodePath(const Vector<StringName> &p_path, const Vector<StringName> &p_subpath, bool p_absolute, const String &p_property = "");
93 	NodePath(const NodePath &p_path);
94 	NodePath(const String &p_path);
95 	NodePath();
96 	~NodePath();
97 };
98 
99 #endif
100