CLK/OSBindings/Mac/Clock SignalTests/FUSETests.swift

//
//  FUSETests.swift
//  Clock Signal
//
//  Created by Thomas Harte on 21/05/2017.
//  Copyright © 2017 Thomas Harte. All rights reserved.
//

import XCTest
import Foundation

fileprivate func readHexInt16(from scanner: Scanner) -> UInt16 {
	var temporary: UInt32 = 0
	scanner.scanHexInt32(&temporary)
	return UInt16(temporary)
}

fileprivate func readHexInt8(from scanner: Scanner) -> UInt8 {
	var temporary: UInt32 = 0
	scanner.scanHexInt32(&temporary)
	return UInt8(temporary)
}

fileprivate struct RegisterState {
	let af: UInt16,		bc: UInt16,		de: UInt16,		hl: UInt16
	let afDash: UInt16, bcDash: UInt16, deDash: UInt16, hlDash: UInt16
	let ix: UInt16,		iy: UInt16,		sp: UInt16,		pc: UInt16
	let i: UInt8,		r: UInt8
	let	iff1: Bool,		iff2: Bool,		interruptMode: Int
	let isHalted: Bool
	let tStates: Int

	func set(onMachine machine: CSTestMachineZ80) {
		machine.setValue(af, for: .AF)
		machine.setValue(bc, for: .BC)
		machine.setValue(de, for: .DE)
		machine.setValue(hl, for: .HL)
		machine.setValue(afDash, for: .afDash)
		machine.setValue(bcDash, for: .bcDash)
		machine.setValue(deDash, for: .deDash)
		machine.setValue(hlDash, for: .hlDash)
		machine.setValue(ix, for: .IX)
		machine.setValue(iy, for: .IY)
		machine.setValue(sp, for: .stackPointer)
		machine.setValue(pc, for: .programCounter)
		machine.setValue(UInt16(i), for: .I)
		machine.setValue(UInt16(r), for: .R)
		machine.setValue(iff1 ? 1 : 0, for: .IFF1)
		machine.setValue(iff2 ? 1 : 0, for: .IFF2)
		machine.setValue(UInt16(interruptMode), for: .IM)
		// TODO: isHalted
	}

	init(scanner: Scanner) {
		af = readHexInt16(from: scanner)
		bc = readHexInt16(from: scanner)
		de = readHexInt16(from: scanner)
		hl = readHexInt16(from: scanner)

		afDash = readHexInt16(from: scanner)
		bcDash = readHexInt16(from: scanner)
		deDash = readHexInt16(from: scanner)
		hlDash = readHexInt16(from: scanner)

		ix = readHexInt16(from: scanner)
		iy = readHexInt16(from: scanner)

		sp = readHexInt16(from: scanner)
		pc = readHexInt16(from: scanner)

		i = readHexInt8(from: scanner)
		r = readHexInt8(from: scanner)

		iff1 = readHexInt8(from: scanner) != 0
		iff2 = readHexInt8(from: scanner) != 0

		var temporary: UInt32 = 0
		scanner.scanHexInt32(&temporary)
		interruptMode = Int(temporary)

		isHalted = readHexInt8(from: scanner) == 1

		scanner.scanHexInt32(&temporary)
		tStates = Int(temporary)
	}

	init(machine: CSTestMachineZ80) {
		af = machine.value(for: .AF)
		bc = machine.value(for: .BC)
		de = machine.value(for: .DE)
		hl = machine.value(for: .HL)

		afDash = machine.value(for: .afDash)
		bcDash = machine.value(for: .bcDash)
		deDash = machine.value(for: .deDash)
		hlDash = machine.value(for: .hlDash)

		ix = machine.value(for: .IX)
		iy = machine.value(for: .IY)

		sp = machine.value(for: .stackPointer)
		pc = machine.value(for: .programCounter)

		i = UInt8(machine.value(for: .I))
		r = UInt8(machine.value(for: .R))

		iff1 = machine.value(for: .IFF1) != 0
		iff2 = machine.value(for: .IFF2) != 0

		interruptMode = Int(machine.value(for: .IM))

		isHalted = false	// TODO
		tStates = 0			// TODO
	}
}

extension RegisterState: Equatable {}

fileprivate func ==(lhs: RegisterState, rhs: RegisterState) -> Bool {
	return	lhs.af == rhs.af &&
			lhs.bc == rhs.bc &&
			lhs.de == rhs.de &&
			lhs.hl == rhs.hl &&
			lhs.afDash == rhs.afDash &&
			lhs.bcDash == rhs.bcDash &&
			lhs.deDash == rhs.deDash &&
			lhs.hlDash == rhs.hlDash &&
			lhs.ix == rhs.ix &&
			lhs.iy == rhs.iy &&
			lhs.sp == rhs.sp &&
			lhs.pc == rhs.pc &&
			lhs.i == rhs.i &&
			lhs.r == rhs.r &&
			lhs.iff1 == rhs.iff1 &&
			lhs.iff2 == rhs.iff2 &&
			lhs.interruptMode == rhs.interruptMode
}

class FUSETests: XCTestCase {

	func testFUSE() {
		if	let inputFilename = Bundle(for: type(of: self)).path(forResource: "tests", ofType: "in"),
			let outputFilename = Bundle(for: type(of: self)).path(forResource: "tests", ofType: "expected") {
			if	let input = try? String(contentsOf: URL(fileURLWithPath: inputFilename), encoding: .utf8),
				let output = try? String(contentsOf: URL(fileURLWithPath: outputFilename), encoding: .utf8) {

				let inputScanner = Scanner(string: input)
				let outputScanner = Scanner(string: output)

				while !inputScanner.isAtEnd {
					autoreleasepool {
						var inputName: NSString?, outputName: NSString?
						inputScanner.scanUpToCharacters(from: CharacterSet.newlines, into: &inputName)
						outputScanner.scanUpToCharacters(from: CharacterSet.newlines, into: &outputName)

						var outputBlock = ""
						while true {
							var nextLine: NSString?
							outputScanner.scanUpTo("\n", into: &nextLine)
							if let nextLine = nextLine {
								print("!\(nextLine)")
								outputBlock = outputBlock + " " + (nextLine as String)
								if nextLine.length == 0 {
									break
								}
							} else {
								break
							}
						}

						if let inputName = inputName, let outputName = outputName {
							XCTAssertEqual(outputName, inputName)

							let machine = CSTestMachineZ80()
							let initialState = RegisterState(scanner: inputScanner)
							initialState.set(onMachine: machine)

							while true {
								var address: UInt32 = 0
								var negative: Int = 0
								if inputScanner.scanHexInt32(&address) {
									while true {
										var value: UInt32 = 0
										if inputScanner.scanHexInt32(&value) {
											machine.setValue(UInt8(value), atAddress: UInt16(address))
											address = address + 1
										} else {
											inputScanner.scanInt(&negative)
											break
										}
									}
								} else {
									inputScanner.scanInt(&negative)
									break
								}
							}

							print("\(inputName)")

							machine.captureBusActivity = true
							machine.runForNumber(ofCycles: Int32(initialState.tStates))
							machine.runToNextInstruction()

							// test that trapped memory accesses are correct
							while true {
								var indentation: NSString?
								outputScanner.scanCharacters(from: CharacterSet.whitespaces, into: &indentation)
								if indentation == nil {
									break
								}

								var nextMemoryAccess: NSString?
								outputScanner.scanUpToCharacters(from: CharacterSet.newlines, into: &nextMemoryAccess)
								print("\(indentation!): \(nextMemoryAccess)")
							}

							let finalState = RegisterState(machine: machine)



							print("\(machine.busOperationCaptures)")
						}
					}
				}
			}
		}
	}
}