Filesystem.hpp

Go to the documentation of this file.

#ifndef DONUT_FILESYSTEM_HPP
#define DONUT_FILESYSTEM_HPP
 
#include <donut/File.hpp>
 
#include <span>   // std::span
#include <string> // std::string
#include <vector> // std::vector
 
namespace donut {
 
enum class FilesystemMountPriority {
    LOWER,
 
    HIGHER,
};
 
struct FilesystemOptions {
    const char* organizationName = nullptr;
 
    const char* applicationName = nullptr;
 
    const char* dataDirectory = ".";
 
    const char* archiveSearchPath = nullptr;
 
    const char* archiveSearchFileExtension = nullptr;
 
    FilesystemMountPriority mountPriorityOfDataDirectoryRelativeToOutputDirectory = FilesystemMountPriority::LOWER;
 
    FilesystemMountPriority mountPriorityOfArchiveSearchRelativeToOutputDirectory = FilesystemMountPriority::LOWER;
 
    FilesystemMountPriority mountPriorityOfArchiveSearchRelativeToDataDirectory = FilesystemMountPriority::HIGHER;
 
    bool mountOutputDirectory = true;
};
 
class Filesystem {
public:
    explicit Filesystem(const char* programFilepath, const FilesystemOptions& options = {});
 
    ~Filesystem();
 
    Filesystem(const Filesystem&) = delete;
 
    Filesystem(Filesystem&&) = delete;
 
    Filesystem& operator=(const Filesystem&) = delete;
 
    Filesystem& operator=(Filesystem&&) = delete;
 
    [[nodiscard]] std::string getStandardOutputDirectory(const char* organizationName, const char* applicationName) const;
 
    [[nodiscard]] std::string getOutputDirectory() const;
 
    void setOutputDirectory(std::string path);
 
    void mountArchive(const char* path, FilesystemMountPriority priority = FilesystemMountPriority::HIGHER);
 
    void unmountArchive(const char* path);
 
    std::vector<std::string> mountArchives(const char* filepath, const char* archiveFileExtension, FilesystemMountPriority priority = FilesystemMountPriority::HIGHER);
 
    void unmountArchives(std::span<const std::string> paths);
 
    [[nodiscard]] const char* findArchiveOfFile(const char* filepath) const;
 
    void createDirectory(const char* filepath);
 
    void deleteFile(const char* filepath);
 
    [[nodiscard]] bool fileExists(const char* filepath) const;
 
    [[nodiscard]] File::Metadata getFileMetadata(const char* filepath) const;
 
    [[nodiscard]] std::vector<std::string> getFilenamesInDirectory(const char* filepath) const;
 
    [[nodiscard]] File openFile(const char* filepath) const;
 
    [[nodiscard]] File createFile(const char* filepath);
 
    [[nodiscard]] File appendFile(const char* filepath);
 
private:
    std::string outputDirectory{};
};
 
} // namespace donut
 
#endif