file_util.h

Go to the documentation of this file.

#ifndef YAZE_UTIL_FILE_UTIL_H_
#define YAZE_UTIL_FILE_UTIL_H_
 
#include <functional>
#include <optional>
#include <string>
#include <vector>
 
namespace yaze {
namespace util {
 
struct FileDialogFilter {
  std::string label;
  std::string spec;  // Comma-delimited extensions (e.g., "sfc,smc") or "*".
};
 
struct FileDialogOptions {
  std::vector<FileDialogFilter> filters;
};
 
// One-shot destination-picker result for owned GUI tests. Empty means Cancel.
// Process-scoped because the test coroutine and UI may run on different threads.
class ScopedSaveFileDialogResultForTesting {
 public:
  explicit ScopedSaveFileDialogResultForTesting(std::string result);
  ~ScopedSaveFileDialogResultForTesting();
  ScopedSaveFileDialogResultForTesting(
      const ScopedSaveFileDialogResultForTesting&) = delete;
  ScopedSaveFileDialogResultForTesting& operator=(
      const ScopedSaveFileDialogResultForTesting&) = delete;
  bool consumed() const;
 
 private:
  friend class FileDialogWrapper;
  std::optional<std::string> result_;
  bool consumed_ = false;
};
 
class FileDialogWrapper {
 public:
  static std::optional<std::string> ConsumeSaveFileDialogResultForTesting();
  static std::string ShowOpenFileDialog();
  static std::string ShowOpenFileDialog(const FileDialogOptions& options);
  static void ShowOpenFileDialogAsync(
      const FileDialogOptions& options,
      std::function<void(const std::string&)> callback);
 
  static std::string ShowOpenFolderDialog();
 
  static std::string ShowSaveFileDialog(
      const std::string& default_name = "",
      const std::string& default_extension = "");
 
  // Specific implementations for testing
  static std::string ShowOpenFileDialogNFD();
  static std::string ShowOpenFileDialogBespoke();
  static std::string ShowSaveFileDialogNFD(
      const std::string& default_name = "",
      const std::string& default_extension = "");
  static std::string ShowSaveFileDialogBespoke(
      const std::string& default_name = "",
      const std::string& default_extension = "");
  static std::string ShowOpenFolderDialogNFD();
  static std::string ShowOpenFolderDialogBespoke();
  static std::vector<std::string> GetSubdirectoriesInFolder(
      const std::string& folder_path);
  static std::vector<std::string> GetFilesInFolder(
      const std::string& folder_path);
};
 
FileDialogOptions MakeRomFileDialogOptions(bool include_all_files = true);
 
std::string GetBundleResourcePath();
 
enum class Platform { kUnknown, kMacOS, kiOS, kWindows, kLinux };
 
std::string GetFileExtension(const std::string& filename);
 
std::string GetFileName(const std::string& filename);
std::string GetResourcePath(const std::string& resource_path);
void SaveFile(const std::string& filename, const std::string& data);
 
std::string LoadFile(const std::string& filename);
 
std::string LoadFileFromConfigDir(const std::string& filename);
 
}  // namespace util
}  // namespace yaze
 
#endif  // YAZE_UTIL_FILE_UTIL_H_