Rebrand Common FS Path functions

src/common/fs/path_util.h

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project
+// SPDX-FileCopyrightText: Copyright 2021 yuzu Emulator Project & 2024 suyu Emulator Project
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #pragma once
@@ -10,8 +10,8 @@
 
 namespace Common::FS {
 
-enum class YuzuPath {
-    YuzuDir,        // Where yuzu stores its data.
+enum class SuyuPath {
+    SuyuDir,        // Where suyu stores its data.
     AmiiboDir,      // Where Amiibo backups are stored.
     CacheDir,       // Where cached filesystem data is stored.
     ConfigDir,      // Where config files are stored.
@@ -22,7 +22,7 @@ enum class YuzuPath {
     LogDir,         // Where log files are stored.
     NANDDir,        // Where the emulated NAND is stored.
     PlayTimeDir,    // Where play time data is stored.
-    ScreenshotsDir, // Where yuzu screenshots are stored.
+    ScreenshotsDir, // Where suyu screenshots are stored.
     SDMCDir,        // Where the emulated SDMC is stored.
     ShaderDir,      // Where shaders are stored.
     TASDir,         // Where TAS scripts are stored.
@@ -193,39 +193,39 @@ template <typename Path>
 void SetAppDirectory(const std::string& app_directory);
 
 /**
- * Gets the filesystem path associated with the YuzuPath enum.
+ * Gets the filesystem path associated with the SuyuPath enum.
  *
- * @param yuzu_path YuzuPath enum
+ * @param suyu_path SuyuPath enum
  *
- * @returns The filesystem path associated with the YuzuPath enum.
+ * @returns The filesystem path associated with the SuyuPath enum.
  */
-[[nodiscard]] const std::filesystem::path& GetYuzuPath(YuzuPath yuzu_path);
+[[nodiscard]] const std::filesystem::path& GetSuyuPath(SuyuPath suyu_path);
 
 /**
- * Gets the filesystem path associated with the YuzuPath enum as a UTF-8 encoded std::string.
+ * Gets the filesystem path associated with the SuyuPath enum as a UTF-8 encoded std::string.
  *
- * @param yuzu_path YuzuPath enum
+ * @param suyu_path SuyuPath enum
  *
- * @returns The filesystem path associated with the YuzuPath enum as a UTF-8 encoded std::string.
+ * @returns The filesystem path associated with the SuyuPath enum as a UTF-8 encoded std::string.
  */
-[[nodiscard]] std::string GetYuzuPathString(YuzuPath yuzu_path);
+[[nodiscard]] std::string GetSuyuPathString(SuyuPath suyu_path);
 
 /**
- * Sets a new filesystem path associated with the YuzuPath enum.
+ * Sets a new filesystem path associated with the SuyuPath enum.
  * If the filesystem object at new_path is not a directory, this function will not do anything.
  *
- * @param yuzu_path YuzuPath enum
+ * @param suyu_path SuyuPath enum
  * @param new_path New filesystem path
  */
-void SetYuzuPath(YuzuPath yuzu_path, const std::filesystem::path& new_path);
+void SetSuyuPath(SuyuPath suyu_path, const std::filesystem::path& new_path);
 
 #ifdef _WIN32
 template <typename Path>
-void SetYuzuPath(YuzuPath yuzu_path, const Path& new_path) {
+void SetSuyuPath(SuyuPath suyu_path, const Path& new_path) {
     if constexpr (IsChar<typename Path::value_type>) {
-        SetYuzuPath(yuzu_path, ToU8String(new_path));
+        SetSuyuPath(suyu_path, ToU8String(new_path));
     } else {
-        SetYuzuPath(yuzu_path, std::filesystem::path{new_path});
+        SetSuyuPath(suyu_path, std::filesystem::path{new_path});
     }
 }
 #endif
@@ -257,14 +257,14 @@ void SetYuzuPath(YuzuPath yuzu_path, const Path& new_path) {
 [[nodiscard]] std::filesystem::path GetHomeDirectory();
 
 /**
- * Gets the relevant paths for yuzu to store its data based on the given XDG environment variable.
+ * Gets the relevant paths for suyu to store its data based on the given XDG environment variable.
  * See https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
  * Defaults to $HOME/.local/share for main application data,
  * $HOME/.cache for cached data, and $HOME/.config for configuration files.
  *
  * @param env_name XDG environment variable name
  *
- * @returns The path where yuzu should store its data.
+ * @returns The path where suyu should store its data.
  */
 [[nodiscard]] std::filesystem::path GetDataDirectory(const std::string& env_name);
 
@@ -288,11 +288,11 @@ enum class DirectorySeparator {
 };
 
 // Splits the path on '/' or '\' and put the components into a vector
-// i.e. "C:\Users\Yuzu\Documents\save.bin" becomes {"C:", "Users", "Yuzu", "Documents", "save.bin" }
+// i.e. "C:\Users\Suyu\Documents\save.bin" becomes {"C:", "Users", "Suyu", "Documents", "save.bin" }
 [[nodiscard]] std::vector<std::string_view> SplitPathComponents(std::string_view filename);
 
 // Splits the path on '/' or '\' and put the components into a vector
-// i.e. "C:\Users\Yuzu\Documents\save.bin" becomes {"C:", "Users", "Yuzu", "Documents", "save.bin" }
+// i.e. "C:\Users\Suyu\Documents\save.bin" becomes {"C:", "Users", "Suyu", "Documents", "save.bin" }
 [[nodiscard]] std::vector<std::string> SplitPathComponentsCopy(std::string_view filename);
 
 // Removes trailing slash, makes all '\\' into '/', and removes duplicate '/'. Makes '/' into '\\'