#pragma once #include "Result.hpp" #include "general.hpp" #include "../external/json/json_fwd.hpp" #include #include #include #include // allow converting ghc filesystem to json and back namespace ghc::filesystem { void GEODE_DLL to_json(nlohmann::json& json, path const& path); void GEODE_DLL from_json(nlohmann::json const& json, path& path); } namespace geode::utils::file { GEODE_DLL Result readString(ghc::filesystem::path const& path); GEODE_DLL Result readJson(ghc::filesystem::path const& path); GEODE_DLL Result readBinary(ghc::filesystem::path const& path); GEODE_DLL Result<> writeString(ghc::filesystem::path const& path, std::string const& data); GEODE_DLL Result<> writeBinary(ghc::filesystem::path const& path, ByteVector const& data); GEODE_DLL Result<> createDirectory(ghc::filesystem::path const& path); GEODE_DLL Result<> createDirectoryAll(ghc::filesystem::path const& path); GEODE_DLL Result> listFiles( ghc::filesystem::path const& path, bool recursive = false ); class GEODE_DLL Zip final { public: using Path = ghc::filesystem::path; private: class Impl; std::unique_ptr m_impl; Zip(); Zip(std::unique_ptr&& impl); Result<> addAllFromRecurse( Path const& dir, Path const& entry ); public: Zip(Zip const&) = delete; Zip(Zip&& other); ~Zip(); /** * Create zipper for file */ static Result create(Path const& file); /** * Path to the opened zip */ Path getPath() const; /** * Add an entry to the zip with data */ Result<> add(Path const& entry, ByteVector const& data); /** * Add an entry to the zip with string data */ Result<> add(Path const& entry, std::string const& data); /** * Add an entry to the zip from a file on disk. If you want to add the * file with a different name, read it into memory first and add it * with Zip::add * @param file File on disk * @param entryDir Folder to place the file in in the zip */ Result<> addFrom(Path const& file, Path const& entryDir = Path()); /** * Add an entry to the zip from a directory on disk * @param entry Path in the zip * @param dir Directory on disk */ Result<> addAllFrom(Path const& dir); /** * Add a folder entry to the zip. If you want to add a folder from disk, * use Zip::addAllFrom * @param entry Folder path in zip */ Result<> addFolder(Path const& entry); }; class GEODE_DLL Unzip final { private: class Impl; std::unique_ptr m_impl; Unzip(); Unzip(std::unique_ptr&& impl); public: Unzip(Unzip const&) = delete; Unzip(Unzip&& other); ~Unzip(); using Path = ghc::filesystem::path; /** * Create unzipper for file */ static Result create(Path const& file); /** * Path to the opened zip */ Path getPath() const; /** * Get all entries in zip */ std::vector getEntries() const; /** * Check if zip has entry * @param name Entry path in zip */ bool hasEntry(Path const& name); /** * Extract entry to memory * @param name Entry path in zip */ Result extract(Path const& name); /** * Extract entry to file * @param name Entry path in zip * @param path Target file path */ Result<> extractTo(Path const& name, Path const& path); /** * Extract all entries to directory * @param dir Directory to unzip the contents to */ Result<> extractAllTo(Path const& dir); /** * Helper method for quickly unzipping a file * @param from ZIP file to unzip * @param to Directory to unzip to * @param deleteZipAfter Whether to delete the zip after unzipping * @returns Succesful result on success, errorful result on error */ static Result<> intoDir( Path const& from, Path const& to, bool deleteZipAfter = false ); }; GEODE_DLL bool openFolder(ghc::filesystem::path const& path); enum class PickMode { OpenFile, SaveFile, OpenFolder, }; struct FilePickOptions { struct Filter { // Name of the filter std::string description; // Extensions (*.txt, *.doc, *.mp3, etc.) std::unordered_set files; }; ghc::filesystem::path defaultPath; std::vector filters; }; GEODE_DLL Result pickFile(PickMode mode, FilePickOptions const& options); GEODE_DLL Result> pickFiles(FilePickOptions const& options); }