ImHex/plugins/libimhex/include/hex/providers/provider.hpp

#pragma once

#include <hex.hpp>

#include <map>
#include <optional>
#include <string>
#include <vector>

#include <hex/helpers/shared_data.hpp>
#include <hex/providers/overlay.hpp>

namespace hex::prv {

    class Provider {
    public:
        constexpr static size_t PageSize = 0x1000'0000;

        Provider();
        virtual ~Provider();

        virtual bool isAvailable() = 0;
        virtual bool isReadable() = 0;
        virtual bool isWritable() = 0;

        virtual void read(u64 offset, void *buffer, size_t size, bool overlays = true);
        virtual void write(u64 offset, const void *buffer, size_t size);

        virtual void readRaw(u64 offset, void *buffer, size_t size) = 0;
        virtual void writeRaw(u64 offset, const void *buffer, size_t size) = 0;
        virtual size_t getActualSize() = 0;

        void applyOverlays(u64 offset, void *buffer, size_t size);

        std::map<u64, u8>& getPatches();
        void applyPatches();

        [[nodiscard]] Overlay* newOverlay();
        void deleteOverlay(Overlay *overlay);
        [[nodiscard]] const std::list<Overlay*>& getOverlays();

        u32 getPageCount();
        u32 getCurrentPage() const;
        void setCurrentPage(u32 page);

        virtual void setBaseAddress(u64 address);
        virtual u64 getBaseAddress();
        virtual size_t getSize();
        virtual std::optional<u32> getPageOfAddress(u64 address);

        virtual std::vector<std::pair<std::string, std::string>> getDataInformation() = 0;

    protected:
        u32 m_currPage = 0;
        u64 m_baseAddress = 0;

        std::vector<std::map<u64, u8>> m_patches;
        std::list<Overlay*> m_overlays;
    };

}