CLK/Machines/Commodore/1540/C1540.hpp

//
//  Commodore1540.hpp
//  Clock Signal
//
//  Created by Thomas Harte on 05/07/2016.
//  Copyright © 2016 Thomas Harte. All rights reserved.
//

#ifndef Commodore1540_hpp
#define Commodore1540_hpp

#include "../SerialBus.hpp"
#include "../../../Storage/Disk/Disk.hpp"
#include "Implementation/C1540Base.hpp"

namespace Commodore {
namespace C1540 {

/*!
	Provides an emulation of the C1540.
*/
class Machine: public MachineBase {
	public:
		/*!
			Sets the ROM image to use for this drive; it is asserted that the buffer provided is 16 kb in size.
		*/
		void set_rom(const std::vector<uint8_t> &rom);

		/*!
			Sets the serial bus to which this drive should attach itself.
		*/
		void set_serial_bus(std::shared_ptr<::Commodore::Serial::Bus> serial_bus);

		/// Advances time.
		void run_for(const Cycles cycles);

		/// Inserts @c disk into the drive.
		void set_disk(std::shared_ptr<Storage::Disk::Disk> disk);
};

}
}

#endif /* Commodore1540_hpp */
Created a namespace for `Commodore` and an empty container file for the 1540[/1] implementation. 2016-07-05 17:28:27 +00:00			`//`
			`// Commodore1540.hpp`
			`// Clock Signal`
			`//`
			`// Created by Thomas Harte on 05/07/2016.`
			`// Copyright © 2016 Thomas Harte. All rights reserved.`
			`//`

			`#ifndef Commodore1540_hpp`
			`#define Commodore1540_hpp`

Further fleshing out: added a serial port for the serial bus. 2016-07-05 21:27:02 +00:00			`#include "../SerialBus.hpp"`
Completed handing of the disk all the way to the 1540. 2016-07-10 20:24:46 +00:00			`#include "../../../Storage/Disk/Disk.hpp"`
Attempts better to hide C1540 implementation details from the reader. In this case not from the compiler, as it's desireable to keep `run_for` as a non-virtual call, and therefore everything else comes alone for the ride. 2017-09-05 00:58:00 +00:00			`#include "Implementation/C1540Base.hpp"`
Completed handing of the disk all the way to the 1540. 2016-07-10 20:24:46 +00:00
Furthered fleshing out of the 1540. Though it doesn't yet receive a ROM so won't even attempt to do anything meaningful. 2016-07-05 20:39:18 +00:00			`namespace Commodore {`
			`namespace C1540 {`

Started trying to clean up, including commuting the C1540 source file name to match its class name but mainly by adding documentation. 2016-07-10 11:46:20 +00:00			`/*!`
			`Provides an emulation of the C1540.`
			`*/`
Attempts better to hide C1540 implementation details from the reader. In this case not from the compiler, as it's desireable to keep `run_for` as a non-virtual call, and therefore everything else comes alone for the ride. 2017-09-05 00:58:00 +00:00			`class Machine: public MachineBase {`
Furthered fleshing out of the 1540. Though it doesn't yet receive a ROM so won't even attempt to do anything meaningful. 2016-07-05 20:39:18 +00:00			`public:`
Started trying to clean up, including commuting the C1540 source file name to match its class name but mainly by adding documentation. 2016-07-10 11:46:20 +00:00			`/*!`
Attempts better to hide C1540 implementation details from the reader. In this case not from the compiler, as it's desireable to keep `run_for` as a non-virtual call, and therefore everything else comes alone for the ride. 2017-09-05 00:58:00 +00:00			`Sets the ROM image to use for this drive; it is asserted that the buffer provided is 16 kb in size.`
Started trying to clean up, including commuting the C1540 source file name to match its class name but mainly by adding documentation. 2016-07-10 11:46:20 +00:00			`*/`
Switched to use of `std::vector` in those few remaining places where I was still using a `unique_ptr` to a native type and `new`ing for myself. So, some of my earliest bits of code. 2017-07-16 17:54:07 +00:00			`void set_rom(const std::vector<uint8_t> &rom);`
Started trying to clean up, including commuting the C1540 source file name to match its class name but mainly by adding documentation. 2016-07-10 11:46:20 +00:00
			`/*!`
			`Sets the serial bus to which this drive should attach itself.`
			`*/`
Further fleshing out: added a serial port for the serial bus. 2016-07-05 21:27:02 +00:00			`void set_serial_bus(std::shared_ptr<::Commodore::Serial::Bus> serial_bus);`
Furthered fleshing out of the 1540. Though it doesn't yet receive a ROM so won't even attempt to do anything meaningful. 2016-07-05 20:39:18 +00:00
Attempts better to hide C1540 implementation details from the reader. In this case not from the compiler, as it's desireable to keep `run_for` as a non-virtual call, and therefore everything else comes alone for the ride. 2017-09-05 00:58:00 +00:00			`/// Advances time.`
Standardises on `const [Half]Cycles` as the thing called and returned, rather than `const [Half]Cycles &` as it's explicitly defined to be only one `int` in size, so using a reference is overly weighty. 2017-07-28 02:05:29 +00:00			`void run_for(const Cycles cycles);`
Fixed framing and first-byte-after-sync signalling. Hacked together as parts of it are, loading now appears to work! 2016-08-01 08:25:11 +00:00
Attempts better to hide C1540 implementation details from the reader. In this case not from the compiler, as it's desireable to keep `run_for` as a non-virtual call, and therefore everything else comes alone for the ride. 2017-09-05 00:58:00 +00:00			`/// Inserts @c disk into the drive.`
			`void set_disk(std::shared_ptr<Storage::Disk::Disk> disk);`
Furthered fleshing out of the 1540. Though it doesn't yet receive a ROM so won't even attempt to do anything meaningful. 2016-07-05 20:39:18 +00:00			`};`

			`}`
			`}`
Created a namespace for `Commodore` and an empty container file for the 1540[/1] implementation. 2016-07-05 17:28:27 +00:00
			`#endif /* Commodore1540_hpp */`