BizHawk/BizHawk.Client.EmuHawk/tools/GameShark.cs

using System;
using System.Windows.Forms;
using BizHawk.Emulation.Common;
using BizHawk.Client.Common;
using BizHawk.Client.Common.cheats;

// TODO:
// Add Support/Handling for The Following Systems and Devices:
// GBA: Code Breaker (That uses unique Encryption keys)
// NES: Pro Action Rocky  (When someone asks)
// SNES: GoldFinger (Action Replay II) Support?
namespace BizHawk.Client.EmuHawk
{
	[Tool(true, new[] { "GB", "GBA", "GEN", "N64", "NES", "PSX", "SAT", "SMS", "SNES" }, new[] { "Snes9x" })]
	public partial class GameShark : Form, IToolForm, IToolFormAutoConfig
	{
		[RequiredService]
		// ReSharper disable once UnusedAutoPropertyAccessor.Local
		private IMemoryDomains MemoryDomains { get; set; }

		[RequiredService]
		// ReSharper disable once UnusedAutoPropertyAccessor.Local
		private IEmulator Emulator { get; set; }

		public GameShark()
		{
			InitializeComponent();
		}

		#region IToolForm

		public bool UpdateBefore => true;
		public bool AskSaveChanges() => true;

		public void FastUpdate()
		{
		}

		public void Restart()
		{
		}

		public void NewUpdate(ToolFormUpdateType type)
		{
		}

		public void UpdateValues()
		{
		}

		#endregion

		private void Go_Click(object sender, EventArgs e)
		{
			foreach (var l in txtCheat.Lines)
			{
				try
				{
					var code = l.ToUpper();
					switch (Emulator.SystemId)
					{
						case "GB":
							GameBoy(code);
							break;
						case "GBA":
							GBA(code);
							break;
						case "GEN":
							Gen(code);
							break;
						case "N64":
							N64(code);
							break;
						case "NES":
							Nes(code);
							break;
						case "PSX":
							Psx(code);
							break;
						case "SAT":
							Saturn(code);
							break;
						case "SMS":
							Sms(code);
							break;
						case "SNES":
							Snes(code);
							break;
					}
				}
				catch (Exception ex)
				{
					MessageBox.Show($"An Error occured: {ex.GetType()}", "Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
				}
			}

			txtCheat.Clear();
			txtDescription.Clear();
		}

		private void GameBoy(string code)
		{
			// Game Genie
			if (code.LastIndexOf("-") == 7 && code.IndexOf("-") == 3)
			{
				var result = GbGgGameGenieDecoder.Decode(code);
				AddCheat(code, result);
			}

			// Game Shark codes
			if (code.Length == 8 && !code.Contains("-"))
			{
				var result = GbGameSharkDecoder.Decode(code);
				AddCheat(code, result);
			}

			InputError($"Unknown code type: {code}");
		}

		private void GBA(string code)
		{
			if (code.Length == 12)
			{
				InputError("Codebreaker/GameShark SP/Xploder codes are not yet supported by this tool.");
			}

			var result = GbaGameSharkDecoder.Decode(code);
			AddCheat(code, result);
		}

		private void Gen(string code)
		{
			// Game Genie only
			if (code.Length == 9 && code.Contains("-"))
			{
				var result = GenesisGameGenieDecoder.Decode(code);
				AddCheat(code, result);
			}

			// Action Replay?
			if (code.Contains(":"))
			{
				// Problem: I don't know what the Non-FF Style codes are.
				// TODO: Fix that.
				if (code.StartsWith("FF") == false)
				{
					MessageBox.Show("This Action Replay Code, is not understood by this tool.", "Tool Error", MessageBoxButtons.OK, MessageBoxIcon.Exclamation);
					return;
				}

				var result = GenesisActionReplayDecoder.Decode(code);
				AddCheat(code, result);
			}

			InputError($"Unknown code type: {code}");
		}

		private void N64(string code)
		{
			var result = N64GameSharkDecoder.Decode(code);
			AddCheat(code, result, "RDRAM");
		}

		private void Nes(string code)
		{
			var result = NesGameGenieDecoder.Decode(code);
			AddCheat(code, result);
		}

		private void Psx(string code)
		{
			var result = PsxGameSharkDecoder.Decode(code);
			AddCheat(code, result, "MainRAM");
		}

		private void Saturn(string code)
		{
			var result = SaturnGameSharkDecoder.Decode(code);

			// Work RAM High may be incorrect?
			AddCheat(code, result, "Work Ram High");
		}

		// Note: this also handles Game Gear due to shared hardware
		private void Sms(string code)
		{
			// Game Genie
			if (code.LastIndexOf("-") == 7 && code.IndexOf("-") == 3)
			{
				var result = GbGgGameGenieDecoder.Decode(code);
				AddCheat(code, result);
			}

			// Action Replay
			else if (code.IndexOf("-") == 3 && code.Length == 9)
			{
				var result = SmsActionReplayDecoder.Decode(code);
				AddCheat(code, result);
			}

			InputError($"Unknown code type: {code}");
		}

		private void Snes(string code)
		{
			if (code.Contains("-") && code.Length == 9)
			{
				MessageBox.Show("Game genie codes are not currently supported for SNES", "SNES Game Genie not supported", MessageBoxButtons.OK, MessageBoxIcon.Error);
				////var result = SnesGameGenieDecoder.Decode(code);
				////AddCheat(code, result, "CART ROM");
			}
			else if (code.Length == 8)
			{
				var result = GbGameSharkDecoder.Decode(code);
				AddCheat(code, result);
			}
			
			InputError($"Unknown code type: {code}");
		}

		private void BtnClear_Click(object sender, EventArgs e)
		{
			// Clear old Inputs
			var result = MessageBox.Show("Are you sure you want to clear this form?", "Clear Form", MessageBoxButtons.YesNo, MessageBoxIcon.Question);
			if (result == DialogResult.Yes)
			{
				txtDescription.Clear();
				txtCheat.Clear();
			}
		}

		private void AddCheat(string code, IDecodeResult result, string domain = null)
		{
			var memoryDomain = domain == null
				? MemoryDomains.SystemBus
				: MemoryDomains[domain];

			if (result.IsValid)
			{
				var description = !string.IsNullOrWhiteSpace(txtDescription.Text)
					? txtDescription.Text
					: code;
				Global.CheatList.Add(result.ToCheat(memoryDomain, description));
			}
			else
			{
				InputError(result.Error);
			}
		}

		private void InputError(string message)
		{
			MessageBox.Show(message, "Input Error", MessageBoxButtons.OK, MessageBoxIcon.Error);
		}
	}
}