mirror of
https://github.com/zoriya/ComSquare.git
synced 2025-12-20 22:25:11 +00:00
59 lines
2.3 KiB
C++
59 lines
2.3 KiB
C++
//
|
|
// Created by anonymus-raccoon on 1/28/20.
|
|
//
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include "AMemory.hpp"
|
|
|
|
namespace ComSquare::Memory
|
|
{
|
|
class MemoryShadow : public AMemory
|
|
{
|
|
private:
|
|
//! @brief Memory to shadow from.
|
|
IMemory &_initial;
|
|
public:
|
|
//! @brief Create a shadow for the memory given as parameter.
|
|
//! @param initial The memory to shadow
|
|
//! @param start The start position of the initial memory to shadow.
|
|
//! @param end The end position of the initial memory to shadow.
|
|
MemoryShadow(IMemory &initial, uint24_t start, uint24_t end);
|
|
//! @brief A memory shadow is copy constructable
|
|
MemoryShadow(const MemoryShadow &) = default;
|
|
//! @brief A memory shadow is not assignable.
|
|
MemoryShadow &operator=(const MemoryShadow &) = delete;
|
|
//! @brief A default destructor
|
|
~MemoryShadow() override = default;
|
|
|
|
//! @brief Read from the initial AMemory given.
|
|
//! @param addr The address to read from. The address 0x0 should refer to the first byte of the initial AMemory.
|
|
//! @throw InvalidAddress will be thrown if the address is more than the size of the initial AMemory.
|
|
//! @return Return the data at the address.
|
|
uint8_t read(uint24_t addr) override;
|
|
|
|
//! @brief Write data to the ram.
|
|
//! @param addr The address to write to. The address 0x0 should refer to the first byte of the initial AMemory.
|
|
//! @param data The data to write.
|
|
//! @throw InvalidAddress will be thrown if the address is more than the size of the initial AMemory.
|
|
void write(uint24_t addr, uint8_t data) override;
|
|
|
|
//! @brief Get the size of the data. This size can be lower than the mapped data.
|
|
//! @return The number of bytes inside this memory.
|
|
[[nodiscard]] uint24_t getSize() const override;
|
|
|
|
//! @brief Get the name of this accessor (used for debug purpose)
|
|
[[nodiscard]] std::string getName() const override;
|
|
//! @brief Get the component of this accessor (used for debug purpose)
|
|
[[nodiscard]] Component getComponent() const override;
|
|
|
|
//! @brief Get the name of the data at the address
|
|
//! @param addr The address (in local space)
|
|
[[nodiscard]] std::string getValueName(uint24_t addr) const override;
|
|
|
|
//! @brief Return the memory accessor this accessor mirror if any
|
|
//! @return nullptr if isMirror is false, the source otherwise.
|
|
[[nodiscard]] IMemory &getMirrored() const;
|
|
};
|
|
} |