-
-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathOSCompatibilityLayer.h
160 lines (113 loc) · 6.56 KB
/
OSCompatibilityLayer.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
#ifndef OS_COMPATIBILITY_LAYER_H
#define OS_COMPATIBILITY_LAYER_H
// A module to abstract many Operating System dependent functions. To use it, link OSCommonLayer.cpp and either WinUtils.cpp or LinuxUtils.cpp, depending on
// your system (MacUtils.cpp is waiting on a friendly Apple developer to write it).
#include "Log.h"
#include <cstdint>
#include <filesystem>
#include <optional>
#include <set>
#include <string>
namespace commonItems
{
//
// Directory search functions
//
// Confirms the specified file exists (and is not a folder).
bool DoesFileExist(const std::filesystem::path& path);
[[deprecated("Use std::filesystem::path version")]] bool DoesFileExist(const std::string& path);
// Confirms the specified folder exists (and is actually a folder).
bool DoesFolderExist(const std::filesystem::path& path);
[[deprecated("Use std::filesystem::path version")]] bool DoesFolderExist(const std::string& path);
// Returns the names of all files in the specified folder.
std::set<std::filesystem::path> GetAllFilesInFolder(const std::filesystem::path& path);
[[deprecated("Use std::filesystem::path version")]] std::set<std::string> GetAllFilesInFolder(const std::string& path);
[[deprecated("Use std::set<std::filesystem::path> GetAllFilesInFolder(const std::filesystem::path& path)")]] void GetAllFilesInFolder(const std::string& path,
std::set<std::string>& fileNames);
// Returns the names of all subfolders in the specified folder.
std::set<std::filesystem::path> GetAllSubfolders(const std::filesystem::path& path);
[[deprecated("Use std::filesystem::path version")]] std::set<std::string> GetAllSubfolders(const std::string& path);
[[deprecated("Use std::set<std::filesystem::path> GetAllSubfolders(const std::filesystem::path& path)")]] void GetAllSubfolders(const std::string& path,
std::set<std::string>& subFolders);
// Returns the names of all files in the specified folder and all its subfolders.
std::set<std::filesystem::path> GetAllFilesInFolderRecursive(const std::filesystem::path& path);
[[deprecated("Use std::filesystem::path version")]] std::set<std::string> GetAllFilesInFolderRecursive(const std::string& path);
[[deprecated("Use std::set<std::filesystem::path> GetAllFilesInFolderRecursive(const std::filesystem::path& path)")]] void GetAllFilesInFolderRecursive(
const std::string& path,
std::set<std::string>& fileNames);
// Returns the current directory in UTF-16.
[[deprecated("Use std::filesystem::current_path")]] std::wstring GetCurrentDirectoryWString();
// Given a Steam AppId, returns the install path for the corresponding game.
std::optional<std::filesystem::path> getSteamInstallPath(const std::string& steamID);
//
// Directory modification functions
//
// Attempts to create the specified directory.
[[deprecated("Use std::filesystem::create_directories")]] bool TryCreateFolder(const std::string& path);
// Attempts to copy the specified file to the specified location, overwriting any existing file.
[[deprecated("Use std::filesystem::copy_file")]] bool TryCopyFile(const std::string& sourcePath, const std::string& destPath);
// Attempts to recursively copy to specified folder to the specified location.
[[deprecated("Use std::filesystem::copy")]] bool CopyFolder(const std::string& sourceFolder, const std::string& destFolder);
// Attempts to rename the specified folder to the specified name.
[[deprecated("Use std::filesystem::rename")]] bool RenameFolder(const std::string& sourceFolder, const std::string& destFolder);
// Attempt to delete the specified folder (and everything in it).
[[deprecated("Use std::filesystem::remove_all")]] bool DeleteFolder(const std::string& folder);
//
// Assorted functions
//
// Writes the specified message to the console at the specified log level. On Windows this colors the message appropriately.
void WriteToConsole(LogLevel level, const std::string& logMessage);
// Get the latest global error as a message.
std::string GetLastErrorString();
//
// Encoding conversion functions
//
// Attempt to convert the specified text from the first encoding to the second encoding.
std::string convertUTF8ToASCII(const std::string& UTF8);
std::string convertUTF8To8859_15(const std::string& UTF8);
std::string convertUTF8ToWin1252(const std::string& UTF8);
std::string UTF16ToUTF8(const std::wstring& UTF16);
[[deprecated("Use UTF16ToUTF8")]] inline std::string convertUTF16ToUTF8(const std::wstring& UTF16)
{
return UTF16ToUTF8(UTF16);
}
std::string convert8859_15ToASCII(const std::string& input);
std::string convert8859_15ToUTF8(const std::string& input);
std::wstring convert8859_15ToUTF16(const std::string& input);
std::string convertWin1252ToASCII(const std::string& Win1252);
std::string convertWin1252ToUTF8(const std::string& Win1252);
std::string convertWin1250ToUTF8(const std::string& Win1250);
std::wstring convertWin1252ToUTF16(const std::string& Win1252);
std::wstring convertWin1250ToUTF16(const std::string& Win1250);
std::wstring convertUTF8ToUTF16(const std::string& UTF8);
std::string convertWin1251ToUTF8(const std::string& Win1251);
std::string convertUTF8toWin1251(const std::string& UTF8);
std::string convertUTF8ToWin1251(const std::string& UTF8);
std::string convertUTF8ToWin1250(const std::string& UTF8);
// converts a string in the system dependent wchar_t encoding to UTF-8
std::string convertToUTF8(const std::wstring& input);
// Converts an UTF8 path to the system dependent filesystem path encoding and removes non - allowed characters.
std::string normalizeUTF8Path(const std::string& utf_8_path);
} // namespace commonItems
// Linux specific defines
#ifdef __linux
// sprintf_s is not implemented on Linux. It functions similarly to the function snprintf, but the return values are
// different. Since return values are not used, they are directly translated for now. If return values will some day be
// used, the compiler will give an error due to sprintf_s_Linux returning void.
void sprintf_s_Linux(char* __restrict __s, size_t __maxlength, const char* __restrict __format, ...);
const auto sprintf_s = sprintf_s_Linux;
// See sprintf_s_Linux
void strcpy_s_Linux(char* __restrict __dest, const char* __restrict __src);
const auto strcpy_s = strcpy_s_Linux;
// Very basic implementation, simply returns 0 if FILE* is not NULL
int fopen_s_Linux(FILE** file, const char* filename, const char* mode);
const auto fopen_s = fopen_s_Linux;
void fprintf_s_Linux(FILE* file, const char* format, ...);
const auto fprintf_s = fprintf_s_Linux;
using HANDLE = uint64_t;
constexpr int STD_OUTPUT_HANDLE = -11;
constexpr int INVALID_HANDLE_VALUE = -1;
HANDLE GetStdHandle(int nothing);
using errno_t = int;
#endif //__linux__
#endif // OS_COMPATIBILITY_LAYER_H