linux-wallpaperengine/src/WallpaperEngine/FileSystem/Container.h

#pragma once

#include "Adapters/Types.h"
#include "Adapters/Virtual.h"

#include "WallpaperEngine/Data/Utils/BinaryReader.h"
#include <filesystem>

namespace WallpaperEngine::FileSystem {
using namespace WallpaperEngine::Data::Utils;
using namespace WallpaperEngine::FileSystem::Adapters;

class Container {
  public:
    Container ();
    ~Container () = default;

    /**
     * Opens the given file in read mode
     *
     * @param path The file to open
     * @return The input stream to read file's data off of
     */
    [[nodiscard]] ReadStreamSharedPtr read (const std::filesystem::path& path) const;

    /**
     * Opens the given file and reads it completely into memory
     *
     * @param path The file to open
     * @return The file's contents as std::string
     */
    [[nodiscard]] std::string readString (const std::filesystem::path& path) const;

    /**
     * Tries to resolve the given file into an absolute, real, filesystem path
     * to be used as info for other tools that might require it (like MPV)
     *
     * @param path The path to resolve to a real file
     * @return The full public, absolute path to the given file
     */
    [[nodiscard]] std::filesystem::path physicalPath (const std::filesystem::path& path) const;

    /**
     *
     * @param path Base of the mountpoint
     * @param mountPoint Where in the VFS to mount it
     */
    AdapterSharedPtr mount (const std::filesystem::path& path, const std::filesystem::path& mountPoint);

    /**
     * @return Access to the virtual file system adapter in this container instance
     */
    VirtualAdapter& getVFS () const;

  private:
    /**
     * Searches for an adapter to handle the given file
     *
     * @param path The path to the file
     * @return The adapter handling the file
     */
    Adapter& resolveAdapterForFile (const std::filesystem::path& path) const;
    /** The factories available for this container */
    std::vector<FactoryUniquePtr> m_factories;
    /** Mountpoints on this container */
    std::vector<std::pair<std::filesystem::path, AdapterSharedPtr>> m_mountpoints;
    /** Virtual file system adapter */
    std::shared_ptr<VirtualAdapter> m_vfs;
};

using ContainerUniquePtr = std::unique_ptr<Container>;
}