CLK/StaticAnalyser/StaticAnalyser.hpp

//
//  StaticAnalyser.hpp
//  Clock Signal
//
//  Created by Thomas Harte on 23/08/2016.
//  Copyright © 2016 Thomas Harte. All rights reserved.
//

#ifndef StaticAnalyser_hpp
#define StaticAnalyser_hpp

#include "../Storage/Tape/Tape.hpp"
#include "../Storage/Disk/Disk.hpp"
#include "../Storage/Cartridge/Cartridge.hpp"

#include <string>
#include <list>
#include <vector>

namespace StaticAnalyser {

enum class Vic20MemoryModel {
	Unexpanded,
	EightKB,
	ThirtyTwoKB
};

enum class Atari2600PagingModel {
	None,
	CommaVid,
	Atari8k,
	Atari16k,
	Atari32k,
	ActivisionStack,
	ParkerBros,
	Tigervision,
	CBSRamPlus,
	MNetwork,
	MegaBoy,
	Pitfall2
};

enum class ZX8081MemoryModel {
	Unexpanded,
	SixteenKB,
	SixtyFourKB
};

enum class AmstradCPCModel {
	CPC464,
	CPC664,
	CPC6128
};

/*!
	A list of disks, tapes and cartridges.
*/
struct Media {
	std::list<std::shared_ptr<Storage::Disk::Disk>> disks;
	std::list<std::shared_ptr<Storage::Tape::Tape>> tapes;
	std::list<std::shared_ptr<Storage::Cartridge::Cartridge>> cartridges;

	bool empty() const {
		return disks.empty() && tapes.empty() && cartridges.empty();
	}
};

/*!
	A list of disks, tapes and cartridges plus information about the machine to which to attach them and its configuration,
	and instructions on how to launch the software attached, plus a measure of confidence in this target's correctness.
*/
struct Target {
	enum Machine {
		AmstradCPC,
		Atari2600,
		Electron,
		MSX,
		Oric,
		Vic20,
		ZX8081
	} machine;
	float probability;

	// TODO: this is too C-like a solution; make Target a base class and
	// turn the following into information held by more specific subclasses.
	union {
		struct {
			bool has_adfs;
			bool has_dfs;
			bool should_shift_restart;
		} acorn;

		struct {
			Atari2600PagingModel paging_model;
			bool uses_superchip;
		} atari;

		struct {
			bool use_atmos_rom;
			bool has_microdisc;
		} oric;

		struct {
			Vic20MemoryModel memory_model;
			bool has_c1540;
		} vic20;

		struct {
			ZX8081MemoryModel memory_model;
			bool isZX81;
		} zx8081;

		struct {
			AmstradCPCModel model;
		} amstradcpc;
	};

	std::string loadingCommand;
	Media media;
};

/*!
	Attempts, through any available means, to return a list of potential targets for the file with the given name.

	@returns The list of potential targets, sorted from most to least probable.
*/
std::list<Target> GetTargets(const char *file_name);

/*!
	Inspects the supplied file and determines the media included.
*/
Media GetMedia(const char *file_name);

}

#endif /* StaticAnalyser_hpp */