#ifndef CHECKEDRAM_HH

#define CHECKEDRAM_HH

#include "Ram.hh"

#include "CacheLine.hh"

#include "TclCallback.hh"

#include "Observer.hh"

#include <bitset>

#include <cstdint>

#include <vector>

namespace openmsx {

class DeviceConfig;

class MSXCPU;

class Setting;

/**

 * This class keeps track of which bytes in the Ram have been written to. It

 * can be used for debugging MSX programs, because you can see if you are

 * trying to read/execute uninitialized memory. Currently all normal RAM

 * (MSXRam) and all normal memory mappers (MSXMemoryMappers) use CheckedRam. On

 * the turboR, only the normal memory mapper runs via CheckedRam. The RAM

 * accessed in DRAM mode or via the ROM mapper are unchecked! Note that there

 * is basically no overhead for using CheckedRam over Ram, thanks to Wouter.

 */

class CheckedRam final : private Observer<Setting>

{

public:

	CheckedRam(const DeviceConfig& config, const std::string& name,

	           static_string_view description, size_t size);

	~CheckedRam();

	[[nodiscard]] uint8_t read(size_t addr);

	[[nodiscard]] uint8_t peek(size_t addr) const { return ram[addr]; }

	void write(size_t addr, uint8_t value);

	[[nodiscard]] const uint8_t* getReadCacheLine(size_t addr) const;

	[[nodiscard]] uint8_t* getWriteCacheLine(size_t addr);

	[[nodiscard]] uint8_t* getRWCacheLines(size_t addr, size_t size);

	[[nodiscard]] size_t size() const { return ram.size(); }

	void clear();

	/**

	 * Give access to the unchecked Ram. No problem to use it, but there

	 * will just be no checking done! Keep in mind that you should use this

	 * consistently, so that the initialized-administration will be always

	 * up to date!

	 */

	[[nodiscard]] Ram& getUncheckedRam() { return ram; }

	// TODO

	//template<typename Archive>

	//void serialize(Archive& ar, unsigned version);

private:

	void init();

	// Observer<Setting>

	void update(const Setting& setting) noexcept override;

private:

	std::vector<bool> completely_initialized_cacheline;

	std::vector<std::bitset<CacheLine::SIZE>> uninitialized;

	Ram ram;

	MSXCPU& msxcpu;

	TclCallback umrCallback;

};

} // namespace openmsx

#endif