Happy new year to the wonderful Godot community!
2020 has been a tough year for most of us personally, but a good year for
Godot development nonetheless with a huge amount of work done towards Godot
4.0 and great improvements backported to the long-lived 3.2 branch.
We've had close to 400 contributors to engine code this year, authoring near
7,000 commit! (And that's only for the `master` branch and for the engine code,
there's a lot more when counting docs, demos and other first-party repos.)
Here's to a great year 2021 for all Godot users 🎆
197 lines
5.9 KiB
C++
197 lines
5.9 KiB
C++
/*************************************************************************/
|
|
/* path_utils.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#include "path_utils.h"
|
|
|
|
#include "core/config/project_settings.h"
|
|
#include "core/os/dir_access.h"
|
|
#include "core/os/file_access.h"
|
|
#include "core/os/os.h"
|
|
|
|
#ifdef WINDOWS_ENABLED
|
|
#include <windows.h>
|
|
|
|
#define ENV_PATH_SEP ";"
|
|
#else
|
|
#include <limits.h>
|
|
#include <unistd.h>
|
|
|
|
#define ENV_PATH_SEP ":"
|
|
#endif
|
|
|
|
#include <stdlib.h>
|
|
|
|
namespace path {
|
|
|
|
String cwd() {
|
|
#ifdef WINDOWS_ENABLED
|
|
const DWORD expected_size = ::GetCurrentDirectoryW(0, nullptr);
|
|
|
|
Char16String buffer;
|
|
buffer.resize((int)expected_size);
|
|
if (::GetCurrentDirectoryW(expected_size, (wchar_t *)buffer.ptrw()) == 0)
|
|
return ".";
|
|
|
|
String result;
|
|
if (result.parse_utf16(buffer.ptr())) {
|
|
return ".";
|
|
}
|
|
return result.simplify_path();
|
|
#else
|
|
char buffer[PATH_MAX];
|
|
if (::getcwd(buffer, sizeof(buffer)) == nullptr) {
|
|
return ".";
|
|
}
|
|
|
|
String result;
|
|
if (result.parse_utf8(buffer)) {
|
|
return ".";
|
|
}
|
|
|
|
return result.simplify_path();
|
|
#endif
|
|
}
|
|
|
|
String abspath(const String &p_path) {
|
|
if (p_path.is_abs_path()) {
|
|
return p_path.simplify_path();
|
|
} else {
|
|
return path::join(path::cwd(), p_path).simplify_path();
|
|
}
|
|
}
|
|
|
|
String realpath(const String &p_path) {
|
|
#ifdef WINDOWS_ENABLED
|
|
// Open file without read/write access
|
|
HANDLE hFile = ::CreateFileW((LPCWSTR)(p_path.utf16().get_data()), 0,
|
|
FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
|
|
nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr);
|
|
|
|
if (hFile == INVALID_HANDLE_VALUE)
|
|
return p_path;
|
|
|
|
const DWORD expected_size = ::GetFinalPathNameByHandleW(hFile, nullptr, 0, FILE_NAME_NORMALIZED);
|
|
|
|
if (expected_size == 0) {
|
|
::CloseHandle(hFile);
|
|
return p_path;
|
|
}
|
|
|
|
Char16String buffer;
|
|
buffer.resize((int)expected_size);
|
|
::GetFinalPathNameByHandleW(hFile, (wchar_t *)buffer.ptrw(), expected_size, FILE_NAME_NORMALIZED);
|
|
|
|
::CloseHandle(hFile);
|
|
|
|
String result;
|
|
if (result.parse_utf16(buffer.ptr())) {
|
|
return p_path;
|
|
}
|
|
|
|
return result.simplify_path();
|
|
#elif UNIX_ENABLED
|
|
char *resolved_path = ::realpath(p_path.utf8().get_data(), nullptr);
|
|
|
|
if (!resolved_path) {
|
|
return p_path;
|
|
}
|
|
|
|
String result;
|
|
bool parse_ok = result.parse_utf8(resolved_path);
|
|
::free(resolved_path);
|
|
|
|
if (parse_ok) {
|
|
return p_path;
|
|
}
|
|
|
|
return result.simplify_path();
|
|
#endif
|
|
}
|
|
|
|
String join(const String &p_a, const String &p_b) {
|
|
if (p_a.is_empty()) {
|
|
return p_b;
|
|
}
|
|
|
|
const char32_t a_last = p_a[p_a.length() - 1];
|
|
if ((a_last == '/' || a_last == '\\') ||
|
|
(p_b.size() > 0 && (p_b[0] == '/' || p_b[0] == '\\'))) {
|
|
return p_a + p_b;
|
|
}
|
|
|
|
return p_a + "/" + p_b;
|
|
}
|
|
|
|
String join(const String &p_a, const String &p_b, const String &p_c) {
|
|
return path::join(path::join(p_a, p_b), p_c);
|
|
}
|
|
|
|
String join(const String &p_a, const String &p_b, const String &p_c, const String &p_d) {
|
|
return path::join(path::join(path::join(p_a, p_b), p_c), p_d);
|
|
}
|
|
|
|
String relative_to_impl(const String &p_path, const String &p_relative_to) {
|
|
// This function assumes arguments are normalized and absolute paths
|
|
|
|
if (p_path.begins_with(p_relative_to)) {
|
|
return p_path.substr(p_relative_to.length() + 1);
|
|
} else {
|
|
String base_dir = p_relative_to.get_base_dir();
|
|
|
|
if (base_dir.length() <= 2 && (base_dir.is_empty() || base_dir.ends_with(":"))) {
|
|
return p_path;
|
|
}
|
|
|
|
return String("..").plus_file(relative_to_impl(p_path, base_dir));
|
|
}
|
|
}
|
|
|
|
#ifdef WINDOWS_ENABLED
|
|
String get_drive_letter(const String &p_norm_path) {
|
|
int idx = p_norm_path.find(":/");
|
|
if (idx != -1 && idx < p_norm_path.find("/"))
|
|
return p_norm_path.substr(0, idx + 1);
|
|
return String();
|
|
}
|
|
#endif
|
|
|
|
String relative_to(const String &p_path, const String &p_relative_to) {
|
|
String relative_to_abs_norm = abspath(p_relative_to);
|
|
String path_abs_norm = abspath(p_path);
|
|
|
|
#ifdef WINDOWS_ENABLED
|
|
if (get_drive_letter(relative_to_abs_norm) != get_drive_letter(path_abs_norm)) {
|
|
return path_abs_norm;
|
|
}
|
|
#endif
|
|
|
|
return relative_to_impl(path_abs_norm, relative_to_abs_norm);
|
|
}
|
|
} // namespace path
|