rom_image.hpp

Go to the documentation of this file.

#pragma once
 
#include "tabulasonora/table_manifest.hpp"
 
#include <cstdint>
#include <memory>
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
#include <vector>
 
namespace ts {

enum class RomVerification {
    full,
    quick,
    none,
};

class RomIdentityError : public std::runtime_error {
public:
    explicit RomIdentityError(const std::string& message) : std::runtime_error(message) {}
};

class RomImage {
public:
    [[nodiscard]] static RomImage open(const std::string& path,
                                       RomVerification verification = RomVerification::full,
                                       const TableManifest* manifest = nullptr);

    [[nodiscard]] static RomImage from_memory(std::span<const std::uint8_t> image,
                                              RomVerification verification = RomVerification::full,
                                              const TableManifest* manifest = nullptr,
                                              std::string name = "<memory>");
 
    RomImage(RomImage&&) noexcept;
    RomImage& operator=(RomImage&&) noexcept;
    RomImage(const RomImage&) = delete;
    RomImage& operator=(const RomImage&) = delete;
    ~RomImage();

    [[nodiscard]] const std::string& path() const noexcept { return path_; }

    [[nodiscard]] std::int64_t length() const noexcept { return length_; }

    [[nodiscard]] const TableManifest& manifest() const noexcept { return *manifest_; }

    void read(std::int64_t file_offset, std::span<std::uint8_t> destination) const;

    [[nodiscard]] std::vector<std::uint8_t> read(std::int64_t file_offset,
                                                 std::size_t length) const;

    [[nodiscard]] std::vector<std::uint8_t> read(const TableEntry& entry) const;

    [[nodiscard]] std::uint32_t read_pe_timestamp() const;

    [[nodiscard]] std::string compute_sha256() const;
 
private:
    class Source {
    public:
        virtual ~Source() = default;
        [[nodiscard]] virtual std::int64_t length() const noexcept = 0;
        [[nodiscard]] virtual std::size_t read(std::span<std::uint8_t> destination,
                                               std::int64_t offset) const = 0;
    };
 
    class FileSource;
    class MemorySource;
 
    RomImage(std::string path, std::unique_ptr<Source> source, const TableManifest& manifest);
 
    void verify(RomVerification verification) const;
 
    std::string path_;
    std::unique_ptr<Source> source_;
    const TableManifest* manifest_;
    std::int64_t length_ = 0;
};
 
} // namespace ts