2017-10-02 23:24:00 +02:00
|
|
|
/*************************************************************************/
|
|
|
|
/* path_utils.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/*************************************************************************/
|
2020-01-01 11:16:22 +01:00
|
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
2017-10-02 23:24:00 +02: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
|
|
|
|
2017-10-02 23:24:00 +02:00
|
|
|
#ifndef PATH_UTILS_H
|
|
|
|
#define PATH_UTILS_H
|
|
|
|
|
2019-07-08 15:16:35 +02:00
|
|
|
#include "core/string_builder.h"
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/ustring.h"
|
2017-10-02 23:24:00 +02:00
|
|
|
|
2019-07-08 15:16:35 +02:00
|
|
|
namespace path {
|
2017-10-02 23:24:00 +02:00
|
|
|
|
2019-07-08 15:16:35 +02:00
|
|
|
String join(const String &p_a, const String &p_b);
|
|
|
|
String join(const String &p_a, const String &p_b, const String &p_c);
|
|
|
|
String join(const String &p_a, const String &p_b, const String &p_c, const String &p_d);
|
2017-10-02 23:24:00 +02:00
|
|
|
|
2019-07-08 15:16:35 +02:00
|
|
|
/// Returns a normalized absolute path to the current working directory
|
|
|
|
String cwd();
|
2017-10-02 23:24:00 +02:00
|
|
|
|
2019-07-08 15:16:35 +02:00
|
|
|
/**
|
|
|
|
* Obtains a normalized absolute path to p_path. Symbolic links are
|
|
|
|
* not resolved. The path p_path might not exist in the file system.
|
|
|
|
*/
|
|
|
|
String abspath(const String &p_path);
|
2017-10-02 23:24:00 +02:00
|
|
|
|
2019-07-08 15:16:35 +02:00
|
|
|
/**
|
|
|
|
* Obtains a normalized path to p_path with symbolic links resolved.
|
|
|
|
* The resulting path might be either a relative or an absolute path.
|
|
|
|
*/
|
|
|
|
String realpath(const String &p_path);
|
|
|
|
|
2019-12-28 19:12:32 +01:00
|
|
|
String relative_to(const String &p_path, const String &p_relative_to);
|
|
|
|
|
2019-07-08 15:16:35 +02:00
|
|
|
} // namespace path
|
2017-10-02 23:24:00 +02:00
|
|
|
|
|
|
|
#endif // PATH_UTILS_H
|