Merge pull request #2511 from lioncash/file-str

common/file_util: Minor cleanup
This commit is contained in:
bunnei 2019-05-25 22:59:16 -04:00 committed by GitHub
commit f97e206348
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 45 deletions

View file

@ -78,16 +78,17 @@ namespace FileUtil {
// Remove any ending forward slashes from directory paths // Remove any ending forward slashes from directory paths
// Modifies argument. // Modifies argument.
static void StripTailDirSlashes(std::string& fname) { static void StripTailDirSlashes(std::string& fname) {
if (fname.length() > 1) { if (fname.length() <= 1) {
std::size_t i = fname.length();
while (i > 0 && fname[i - 1] == DIR_SEP_CHR)
--i;
fname.resize(i);
}
return; return;
} }
// Returns true if file filename exists std::size_t i = fname.length();
while (i > 0 && fname[i - 1] == DIR_SEP_CHR) {
--i;
}
fname.resize(i);
}
bool Exists(const std::string& filename) { bool Exists(const std::string& filename) {
struct stat file_info; struct stat file_info;
@ -107,7 +108,6 @@ bool Exists(const std::string& filename) {
return (result == 0); return (result == 0);
} }
// Returns true if filename is a directory
bool IsDirectory(const std::string& filename) { bool IsDirectory(const std::string& filename) {
struct stat file_info; struct stat file_info;
@ -132,8 +132,6 @@ bool IsDirectory(const std::string& filename) {
return S_ISDIR(file_info.st_mode); return S_ISDIR(file_info.st_mode);
} }
// Deletes a given filename, return true on success
// Doesn't supports deleting a directory
bool Delete(const std::string& filename) { bool Delete(const std::string& filename) {
LOG_TRACE(Common_Filesystem, "file {}", filename); LOG_TRACE(Common_Filesystem, "file {}", filename);
@ -165,7 +163,6 @@ bool Delete(const std::string& filename) {
return true; return true;
} }
// Returns true if successful, or path already exists.
bool CreateDir(const std::string& path) { bool CreateDir(const std::string& path) {
LOG_TRACE(Common_Filesystem, "directory {}", path); LOG_TRACE(Common_Filesystem, "directory {}", path);
#ifdef _WIN32 #ifdef _WIN32
@ -194,7 +191,6 @@ bool CreateDir(const std::string& path) {
#endif #endif
} }
// Creates the full path of fullPath returns true on success
bool CreateFullPath(const std::string& fullPath) { bool CreateFullPath(const std::string& fullPath) {
int panicCounter = 100; int panicCounter = 100;
LOG_TRACE(Common_Filesystem, "path {}", fullPath); LOG_TRACE(Common_Filesystem, "path {}", fullPath);
@ -230,7 +226,6 @@ bool CreateFullPath(const std::string& fullPath) {
} }
} }
// Deletes a directory filename, returns true on success
bool DeleteDir(const std::string& filename) { bool DeleteDir(const std::string& filename) {
LOG_TRACE(Common_Filesystem, "directory {}", filename); LOG_TRACE(Common_Filesystem, "directory {}", filename);
@ -252,7 +247,6 @@ bool DeleteDir(const std::string& filename) {
return false; return false;
} }
// renames file srcFilename to destFilename, returns true on success
bool Rename(const std::string& srcFilename, const std::string& destFilename) { bool Rename(const std::string& srcFilename, const std::string& destFilename) {
LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename); LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename);
#ifdef _WIN32 #ifdef _WIN32
@ -268,7 +262,6 @@ bool Rename(const std::string& srcFilename, const std::string& destFilename) {
return false; return false;
} }
// copies file srcFilename to destFilename, returns true on success
bool Copy(const std::string& srcFilename, const std::string& destFilename) { bool Copy(const std::string& srcFilename, const std::string& destFilename) {
LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename); LOG_TRACE(Common_Filesystem, "{} --> {}", srcFilename, destFilename);
#ifdef _WIN32 #ifdef _WIN32
@ -324,7 +317,6 @@ bool Copy(const std::string& srcFilename, const std::string& destFilename) {
#endif #endif
} }
// Returns the size of filename (64bit)
u64 GetSize(const std::string& filename) { u64 GetSize(const std::string& filename) {
if (!Exists(filename)) { if (!Exists(filename)) {
LOG_ERROR(Common_Filesystem, "failed {}: No such file", filename); LOG_ERROR(Common_Filesystem, "failed {}: No such file", filename);
@ -351,7 +343,6 @@ u64 GetSize(const std::string& filename) {
return 0; return 0;
} }
// Overloaded GetSize, accepts file descriptor
u64 GetSize(const int fd) { u64 GetSize(const int fd) {
struct stat buf; struct stat buf;
if (fstat(fd, &buf) != 0) { if (fstat(fd, &buf) != 0) {
@ -361,7 +352,6 @@ u64 GetSize(const int fd) {
return buf.st_size; return buf.st_size;
} }
// Overloaded GetSize, accepts FILE*
u64 GetSize(FILE* f) { u64 GetSize(FILE* f) {
// can't use off_t here because it can be 32-bit // can't use off_t here because it can be 32-bit
u64 pos = ftello(f); u64 pos = ftello(f);
@ -377,7 +367,6 @@ u64 GetSize(FILE* f) {
return size; return size;
} }
// creates an empty file filename, returns true on success
bool CreateEmptyFile(const std::string& filename) { bool CreateEmptyFile(const std::string& filename) {
LOG_TRACE(Common_Filesystem, "{}", filename); LOG_TRACE(Common_Filesystem, "{}", filename);
@ -502,7 +491,6 @@ bool DeleteDirRecursively(const std::string& directory, unsigned int recursion)
return true; return true;
} }
// Create directory and copy contents (does not overwrite existing files)
void CopyDir(const std::string& source_path, const std::string& dest_path) { void CopyDir(const std::string& source_path, const std::string& dest_path) {
#ifndef _WIN32 #ifndef _WIN32
if (source_path == dest_path) if (source_path == dest_path)
@ -539,8 +527,7 @@ void CopyDir(const std::string& source_path, const std::string& dest_path) {
#endif #endif
} }
// Returns the current directory std::optional<std::string> GetCurrentDir() {
std::string GetCurrentDir() {
// Get the current working directory (getcwd uses malloc) // Get the current working directory (getcwd uses malloc)
#ifdef _WIN32 #ifdef _WIN32
wchar_t* dir; wchar_t* dir;
@ -550,7 +537,7 @@ std::string GetCurrentDir() {
if (!(dir = getcwd(nullptr, 0))) { if (!(dir = getcwd(nullptr, 0))) {
#endif #endif
LOG_ERROR(Common_Filesystem, "GetCurrentDirectory failed: {}", GetLastErrorMsg()); LOG_ERROR(Common_Filesystem, "GetCurrentDirectory failed: {}", GetLastErrorMsg());
return nullptr; return {};
} }
#ifdef _WIN32 #ifdef _WIN32
std::string strDir = Common::UTF16ToUTF8(dir); std::string strDir = Common::UTF16ToUTF8(dir);
@ -561,7 +548,6 @@ std::string GetCurrentDir() {
return strDir; return strDir;
} }
// Sets the current directory to the given directory
bool SetCurrentDir(const std::string& directory) { bool SetCurrentDir(const std::string& directory) {
#ifdef _WIN32 #ifdef _WIN32
return _wchdir(Common::UTF8ToUTF16W(directory).c_str()) == 0; return _wchdir(Common::UTF8ToUTF16W(directory).c_str()) == 0;
@ -673,8 +659,6 @@ std::string GetSysDirectory() {
return sysDir; return sysDir;
} }
// Returns a string with a yuzu data dir or file in the user's home
// directory. To be used in "multi-user" mode (that is, installed).
const std::string& GetUserPath(UserPath path, const std::string& new_path) { const std::string& GetUserPath(UserPath path, const std::string& new_path) {
static std::unordered_map<UserPath, std::string> paths; static std::unordered_map<UserPath, std::string> paths;
auto& user_path = paths[UserPath::UserDir]; auto& user_path = paths[UserPath::UserDir];
@ -762,11 +746,11 @@ std::string GetNANDRegistrationDir(bool system) {
return GetUserPath(UserPath::NANDDir) + "user/Contents/registered/"; return GetUserPath(UserPath::NANDDir) + "user/Contents/registered/";
} }
std::size_t WriteStringToFile(bool text_file, const std::string& str, const char* filename) { std::size_t WriteStringToFile(bool text_file, const std::string& filename, std::string_view str) {
return FileUtil::IOFile(filename, text_file ? "w" : "wb").WriteBytes(str.data(), str.size()); return IOFile(filename, text_file ? "w" : "wb").WriteString(str);
} }
std::size_t ReadFileToString(bool text_file, const char* filename, std::string& str) { std::size_t ReadFileToString(bool text_file, const std::string& filename, std::string& str) {
IOFile file(filename, text_file ? "r" : "rb"); IOFile file(filename, text_file ? "r" : "rb");
if (!file.IsOpen()) if (!file.IsOpen())
@ -776,13 +760,6 @@ std::size_t ReadFileToString(bool text_file, const char* filename, std::string&
return file.ReadArray(&str[0], str.size()); return file.ReadArray(&str[0], str.size());
} }
/**
* Splits the filename into 8.3 format
* Loosely implemented following https://en.wikipedia.org/wiki/8.3_filename
* @param filename The normal filename to use
* @param short_name A 9-char array in which the short name will be written
* @param extension A 4-char array in which the extension will be written
*/
void SplitFilename83(const std::string& filename, std::array<char, 9>& short_name, void SplitFilename83(const std::string& filename, std::array<char, 9>& short_name,
std::array<char, 4>& extension) { std::array<char, 4>& extension) {
const std::string forbidden_characters = ".\"/\\[]:;=, "; const std::string forbidden_characters = ".\"/\\[]:;=, ";

View file

@ -9,6 +9,7 @@
#include <fstream> #include <fstream>
#include <functional> #include <functional>
#include <limits> #include <limits>
#include <optional>
#include <string> #include <string>
#include <string_view> #include <string_view>
#include <type_traits> #include <type_traits>
@ -118,7 +119,7 @@ u64 ScanDirectoryTree(const std::string& directory, FSTEntry& parent_entry,
bool DeleteDirRecursively(const std::string& directory, unsigned int recursion = 256); bool DeleteDirRecursively(const std::string& directory, unsigned int recursion = 256);
// Returns the current directory // Returns the current directory
std::string GetCurrentDir(); std::optional<std::string> GetCurrentDir();
// Create directory and copy contents (does not overwrite existing files) // Create directory and copy contents (does not overwrite existing files)
void CopyDir(const std::string& source_path, const std::string& dest_path); void CopyDir(const std::string& source_path, const std::string& dest_path);
@ -146,9 +147,9 @@ const std::string& GetExeDirectory();
std::string AppDataRoamingDirectory(); std::string AppDataRoamingDirectory();
#endif #endif
std::size_t WriteStringToFile(bool text_file, const std::string& str, const char* filename); std::size_t WriteStringToFile(bool text_file, const std::string& filename, std::string_view str);
std::size_t ReadFileToString(bool text_file, const char* filename, std::string& str); std::size_t ReadFileToString(bool text_file, const std::string& filename, std::string& str);
/** /**
* Splits the filename into 8.3 format * Splits the filename into 8.3 format
@ -257,8 +258,8 @@ public:
return WriteArray(&object, 1); return WriteArray(&object, 1);
} }
std::size_t WriteString(const std::string& str) { std::size_t WriteString(std::string_view str) {
return WriteArray(str.c_str(), str.length()); return WriteArray(str.data(), str.length());
} }
bool IsOpen() const { bool IsOpen() const {
@ -286,8 +287,8 @@ private:
template <typename T> template <typename T>
void OpenFStream(T& fstream, const std::string& filename, std::ios_base::openmode openmode) { void OpenFStream(T& fstream, const std::string& filename, std::ios_base::openmode openmode) {
#ifdef _MSC_VER #ifdef _MSC_VER
fstream.open(Common::UTF8ToUTF16W(filename).c_str(), openmode); fstream.open(Common::UTF8ToUTF16W(filename), openmode);
#else #else
fstream.open(filename.c_str(), openmode); fstream.open(filename, openmode);
#endif #endif
} }

View file

@ -26,12 +26,12 @@ Config::Config() {
Config::~Config() = default; Config::~Config() = default;
bool Config::LoadINI(const std::string& default_contents, bool retry) { bool Config::LoadINI(const std::string& default_contents, bool retry) {
const char* location = this->sdl2_config_loc.c_str(); const std::string& location = this->sdl2_config_loc;
if (sdl2_config->ParseError() < 0) { if (sdl2_config->ParseError() < 0) {
if (retry) { if (retry) {
LOG_WARNING(Config, "Failed to load {}. Creating file from defaults...", location); LOG_WARNING(Config, "Failed to load {}. Creating file from defaults...", location);
FileUtil::CreateFullPath(location); FileUtil::CreateFullPath(location);
FileUtil::WriteStringToFile(true, default_contents, location); FileUtil::WriteStringToFile(true, location, default_contents);
sdl2_config = std::make_unique<INIReader>(location); // Reopen file sdl2_config = std::make_unique<INIReader>(location); // Reopen file
return LoadINI(default_contents, false); return LoadINI(default_contents, false);