Files
2026-02-02 04:50:13 +01:00

303 lines
8.5 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#include "ags/shared/core/platform.h"
#if AGS_PLATFORM_OS_WINDOWS
#define NOMINMAX
//include <windows.h>
#endif
#include "ags/lib/allegro/file.h"
#include "ags/shared/util/path.h"
#include "ags/shared/util/stdio_compat.h"
#include "ags/shared/util/file.h"
namespace AGS3 {
namespace AGS {
namespace Shared {
namespace Path {
String get_filename(const String &path) {
Common::String p = path;
size_t i = p.findLastOf('/');
return (i == Common::String::npos) ? path : String(p.c_str() + i + 1);
}
String get_extension(const String &path) {
Common::String filename = get_filename(path);
size_t i = filename.findLastOf('.');
return (i == Common::String::npos) ?
filename : Common::String(filename.c_str() + i + 1);
}
String GetParent(const String &path) {
const char *cstr = path.GetCStr();
const char *ptr_end = cstr + path.GetLength();
for (const char *ptr = ptr_end; ptr >= cstr; --ptr) {
if (*ptr == '/' || *ptr == PATH_ALT_SEPARATOR)
return String(cstr, ptr - cstr);
}
return ".";
}
String GetFilename(const String &path) {
return get_filename(path.GetCStr());
}
String GetFileExtension(const String &path) {
return get_extension(path.GetCStr());
}
int ComparePaths(const String &path1, const String &path2) {
// Make minimal absolute paths
String fixed_path1 = MakeAbsolutePath(path1);
String fixed_path2 = MakeAbsolutePath(path2);
#if AGS_PLATFORM_OS_WINDOWS
// On Windows make sure both are represented as short names (at least until we support wide paths)
fixed_path1 = GetPathInASCII(fixed_path1);
fixed_path2 = GetPathInASCII(fixed_path2);
#endif
fixed_path1.TrimRight('/');
fixed_path2.TrimRight('/');
int cmp_result =
fixed_path1.CompareNoCase(fixed_path2);
return cmp_result;
}
String GetDirectoryPath(const String &path) {
if (File::IsDirectory(path))
return path;
String dir = path;
FixupPath(dir);
size_t slash_at = dir.FindCharReverse('/');
if (slash_at != String::NoIndex) {
dir.ClipMid(slash_at + 1);
return dir;
}
return "./";
}
bool IsSameOrSubDir(const String &parent, const String &path) {
char can_parent[MAX_PATH_SZ];
char can_path[MAX_PATH_SZ];
char relative[MAX_PATH_SZ];
// canonicalize_filename treats "." as "./." (file in working dir)
const char *use_parent = parent == "." ? "./" : parent.GetCStr();
const char *use_path = path == "." ? "./" : path.GetCStr();
canonicalize_filename(can_parent, use_parent, sizeof(can_parent));
canonicalize_filename(can_path, use_path, sizeof(can_path));
const char *pstr = make_relative_filename(relative, can_parent, can_path, sizeof(relative));
if (!pstr)
return false;
for (pstr = strstr(pstr, ".."); pstr && *pstr; pstr = strstr(pstr, "..")) {
pstr += 2;
if (*pstr == '/' || *pstr == '\\' || *pstr == 0)
return false;
}
return true;
}
bool IsRelativePath(const String &path) {
return is_relative_filename(path.GetCStr()) != 0;
}
void FixupPath(String &path) {
//#if AGS_PLATFORM_OS_WINDOWS
path.Replace('\\', '/'); // bring Windows path separators to uniform style
//#endif
path.MergeSequences('/');
}
String MakePathNoSlash(const String &path) {
String dir_path = path;
FixupPath(dir_path);
#if AGS_PLATFORM_OS_WINDOWS
// if the path is 'x:/' don't strip the slash
if (path.GetLength() == 3 && path[1u] == ':')
;
else
#endif
// if the path is '/' don't strip the slash
if (dir_path.GetLength() > 1)
dir_path.TrimRight('/');
return dir_path;
}
String MakeTrailingSlash(const String &path) {
if (path.GetLast() == '/' || path.GetLast() == '\\')
return path;
String dir_path = String::FromFormat("%s/", path.GetCStr());
FixupPath(dir_path);
return dir_path;
}
String MakeAbsolutePath(const String &path) {
if (path.IsEmpty()) {
return "";
}
// canonicalize_filename treats "." as "./." (file in working dir)
String abs_path = path == "." ? "./" : path;
#if AGS_PLATFORM_OS_WINDOWS
// NOTE: cannot use long path names in the engine, because it does not have unicode strings support
//
//char long_path_buffer[MAX_PATH_SZ];
//if (GetLongPathNameA(path, long_path_buffer, MAX_PATH_SZ) > 0)
//{
// abs_path = long_path_buffer;
//}
#endif
char buf[MAX_PATH_SZ];
canonicalize_filename(buf, abs_path.GetCStr(), sizeof(buf));
abs_path = buf;
FixupPath(abs_path);
return abs_path;
}
String MakeRelativePath(const String &base, const String &path) {
char can_parent[MAX_PATH_SZ];
char can_path[MAX_PATH_SZ];
char relative[MAX_PATH_SZ];
// canonicalize_filename treats "." as "./." (file in working dir)
const char *use_parent = base == "." ? "./" : base.GetCStr();
const char *use_path = path == "." ? "./" : path.GetCStr(); // FIXME?
canonicalize_filename(can_parent, use_parent, sizeof(can_parent));
canonicalize_filename(can_path, use_path, sizeof(can_path));
String rel_path = make_relative_filename(relative, can_parent, can_path, sizeof(relative));
FixupPath(rel_path);
return rel_path;
}
String &AppendPath(String &path, const String &child) {
if (path.IsEmpty())
path = child;
else if (!child.IsEmpty())
path.AppendFmt("/%s", child.GetCStr());
FixupPath(path);
return path;
}
String ConcatPaths(const String &parent, const String &child) {
if (parent.IsEmpty())
return child;
if (child.IsEmpty())
return parent;
String path = String::FromFormat("%s/%s", parent.GetCStr(), child.GetCStr());
FixupPath(path);
return path;
}
String ConcatPaths(String &buf, const String &parent, const String &child) {
if (parent.IsEmpty())
buf = child;
else if (child.IsEmpty())
buf = parent;
else
buf.Format("%s/%s", parent.GetCStr(), child.GetCStr());
FixupPath(buf);
return buf;
}
String MakePath(const String &parent, const String &filename) {
String path = String::FromFormat("%s/%s", parent.GetCStr(), filename.GetCStr());
FixupPath(path);
return path;
}
String MakePath(const String &parent, const String &filename, const String &ext) {
String path = String::FromFormat("%s/%s.%s", parent.GetCStr(), filename.GetCStr(), ext.GetCStr());
FixupPath(path);
return path;
}
std::vector<String> Split(const String &path) {
return path.Split('/');
}
String FixupSharedFilename(const String &filename) {
const char *illegal_chars = "\\/:?\"<>|*";
String fixed_name = filename;
for (size_t i = 0; i < filename.GetLength(); ++i) {
if (filename[i] < ' ') {
fixed_name.SetAt(i, '_');
} else {
for (const char *ch_ptr = illegal_chars; *ch_ptr; ++ch_ptr)
if (filename[i] == *ch_ptr)
fixed_name.SetAt(i, '_');
}
}
return fixed_name;
}
String GetPathInASCII(const String &path) {
#if AGS_PLATFORM_OS_WINDOWS
char ascii_buffer[MAX_PATH_SZ];
if (GetShortPathNameA(path.GetCStr(), ascii_buffer, MAX_PATH_SZ) == 0)
return "";
return ascii_buffer;
#else
// TODO: implement conversion for other platforms!
return path;
#endif
}
#if AGS_PLATFORM_OS_WINDOWS
String WidePathNameToAnsi(LPCWSTR pathw) {
WCHAR short_path[MAX_PATH_SZ];
char ascii_buffer[MAX_PATH_SZ];
LPCWSTR arg_path = pathw;
if (GetShortPathNameW(arg_path, short_path, MAX_PATH_SZ) == 0)
return "";
WideCharToMultiByte(CP_ACP, 0, short_path, -1, ascii_buffer, MAX_PATH_SZ, NULL, NULL);
return ascii_buffer;
}
#endif
String GetCmdLinePathInASCII(const char *arg, int arg_index) {
#if AGS_PLATFORM_OS_WINDOWS
// Hack for Windows in case there are unicode chars in the path.
// The normal argv[] array has ????? instead of the unicode chars
// and fails, so instead we manually get the short file name, which
// is always using ASCII chars.
int wargc = 0;
LPWSTR *wargv = CommandLineToArgvW(GetCommandLineW(), &wargc);
if (wargv == nullptr)
return "";
String path;
if (arg_index <= wargc)
path = WidePathNameToAnsi(wargv[arg_index]);
LocalFree(wargv);
return path;
#else
// TODO: implement conversion for other platforms!
return arg;
#endif
}
} // namespace Path
} // namespace Shared
} // namespace AGS
} // namespace AGS3