file.h

Go to the documentation of this file.

 
#pragma once
 
#include <filesystem>
#include <iosfwd>
#include <span>
#include <string>
#include <string_view>
#include <system_error>
#include <vector>
 
#include <rex/platform.h>
#include <rex/result.h>
#include <rex/types.h>
 
namespace rex::platform {

REX_API std::filesystem::path GetExecutablePath();

REX_API std::filesystem::path GetExecutableFolder();

REX_API std::filesystem::path GetLibraryFolder();

REX_API std::filesystem::path GetUserFolder();

[[nodiscard]] REX_API bool IsPackagedApp();

[[nodiscard]] REX_API std::filesystem::path GetUserConfigFolder(std::string_view app_name);

[[nodiscard]] REX_API std::filesystem::path GetAppRoot(std::string_view app_name);

[[nodiscard]] REX_API bool IsDirectoryWritable(const std::filesystem::path& dir);

[[nodiscard]] REX_API std::string SanitizeFolderName(std::string_view name,
                                                     std::string_view fallback = "default");

[[nodiscard]] REX_API Result<std::vector<u8>> ReadHostFile(const std::filesystem::path& path,
                                                           u64 offset = 0, u64 length = 0);

[[nodiscard]] REX_API Result<void> WriteHostFile(const std::filesystem::path& path,
                                                 std::span<const u8> data);

[[nodiscard]] REX_API Result<void> WriteHostFile(const std::filesystem::path& path,
                                                 std::string_view text);

[[nodiscard]] REX_API std::filesystem::path ResolveEntryCase(const std::filesystem::path& parent,
                                                             std::string_view name);

REX_API bool OpenStorageFile(std::fstream& file, const std::filesystem::path& path);

inline u64 GetStorageFileSize(const std::filesystem::path& path) {
  std::error_code error;
  const auto size = std::filesystem::file_size(path, error);
  return error ? 0 : static_cast<u64>(size);
}

REX_API size_t ReadStorageFile(std::fstream& file, void* data, size_t size);
 
REX_API void AppendStorageFile(std::fstream& file, const void* data, size_t size);

REX_API void ResetStorageFile(std::fstream& file, const std::filesystem::path& path, u64 length);
 
}  // namespace rex::platform