//
// Created by anonymus-raccoon on 1/23/20.
//

#pragma once

#include <cstdint>
#include <vector>
#include <memory>
#include <string>
#include "../Models/Int24.hpp"
#include "../Models/Components.hpp"
#include "IMemory.hpp"

namespace ComSquare::Memory
{
	//! @brief Abstract class representing a continuous block of memory.
	class AMemory : public IMemory {
	protected:
		//! @brief The starting address mapped to this component.
		uint24_t _start = 0;
		//! @brief The last continuous address mapped to this components. For shadows, see the MemoryShadow class.
		uint24_t _end = 0;
	public:
		//! @brief Translate an absolute address to a relative address
		//! @param addr The absolute address (in the 24 bit bus)
		//! @return The local address (0 refers to the first byte of this component).
		//! @throw InvalidAddress is thrown if the address is not mapped by this component.
		virtual uint24_t getRelativeAddress(uint24_t addr) const override;
		//! @brief Change starting and ending points of this mapped memory.
		//! @param start The first address mapped to this component.
		//! @param end The last address mapped to this component.
		//! @warning The start/end address should be a continuous range. You can't map address 0x0 and 0x2 but not 0x1. To do that, use two AMemory.
		void setMemoryRegion(uint24_t start, uint24_t end);
		//! @brief Return true if this component has mapped the address.
		//! @param addr The address to check.
		//! @return True if this address is mapped to the component. False otherwise.
		virtual bool hasMemoryAt(uint24_t addr) const override;
		//! @brief Check if this memory is a mirror or not.
		//! @return True if this memory is a mirror. False otherwise.
		virtual bool isMirror() const override;
		//! @brief Get the name of the data at the address
		//! @param addr The address (in local space)
		virtual 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.
		virtual std::shared_ptr<IMemory> getMirrored() const override;
		virtual ~AMemory() override = default;
	};
}