d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
100 lines
3.8 KiB
C++
100 lines
3.8 KiB
C++
/**************************************************************************/
|
|
/* node_path.h */
|
|
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef NODE_PATH_H
|
|
#define NODE_PATH_H
|
|
|
|
#include "core/string/string_name.h"
|
|
#include "core/string/ustring.h"
|
|
|
|
class NodePath {
|
|
struct Data {
|
|
SafeRefCount refcount;
|
|
Vector<StringName> path;
|
|
Vector<StringName> subpath;
|
|
StringName concatenated_path;
|
|
StringName concatenated_subpath;
|
|
bool absolute;
|
|
bool has_slashes;
|
|
mutable bool hash_cache_valid;
|
|
mutable uint32_t hash_cache;
|
|
};
|
|
|
|
mutable Data *data = nullptr;
|
|
void unref();
|
|
|
|
void _update_hash_cache() const;
|
|
|
|
public:
|
|
bool is_absolute() const;
|
|
int get_name_count() const;
|
|
StringName get_name(int p_idx) const;
|
|
int get_subname_count() const;
|
|
StringName get_subname(int p_idx) const;
|
|
Vector<StringName> get_names() const;
|
|
Vector<StringName> get_subnames() const;
|
|
StringName get_concatenated_names() const;
|
|
StringName get_concatenated_subnames() const;
|
|
|
|
NodePath rel_path_to(const NodePath &p_np) const;
|
|
NodePath get_as_property_path() const;
|
|
|
|
void prepend_period();
|
|
|
|
_FORCE_INLINE_ uint32_t hash() const {
|
|
if (!data) {
|
|
return 0;
|
|
}
|
|
if (!data->hash_cache_valid) {
|
|
_update_hash_cache();
|
|
}
|
|
return data->hash_cache;
|
|
}
|
|
|
|
operator String() const;
|
|
bool is_empty() const;
|
|
|
|
bool operator==(const NodePath &p_path) const;
|
|
bool operator!=(const NodePath &p_path) const;
|
|
void operator=(const NodePath &p_path);
|
|
|
|
void simplify();
|
|
NodePath simplified() const;
|
|
|
|
NodePath(const Vector<StringName> &p_path, bool p_absolute);
|
|
NodePath(const Vector<StringName> &p_path, const Vector<StringName> &p_subpath, bool p_absolute);
|
|
NodePath(const NodePath &p_path);
|
|
NodePath(const String &p_path);
|
|
NodePath() {}
|
|
~NodePath();
|
|
};
|
|
|
|
#endif // NODE_PATH_H
|